Inheritance diagram for PharData:

Public Member Functions
	__construct (string $filename, int $flags=FilesystemIterator::SKIP_DOTS\|FilesystemIterator::UNIX_PATHS, ?string $alias=null, int $format=0)

	__destruct ()

	addEmptyDir (string $directory)

	addFile (string $filename, ?string $localName=null)

	addFromString (string $localName, string $contents)

	buildFromDirectory (string $directory, string $pattern="")

	buildFromIterator (Traversable $iterator, ?string $baseDirectory=null)

	compressFiles (int $compression)

	decompressFiles ()

	compress (int $compression, ?string $extension=null)

	decompress (?string $extension=null)

	convertToExecutable (?int $format=null, ?int $compression=null, ?string $extension=null)

	convertToData (?int $format=null, ?int $compression=null, ?string $extension=null)

	copy (string $from, string $to)

	count (int $mode=COUNT_NORMAL)

	delete (string $localName)

	delMetadata ()

	extractTo (string $directory, array\|string\|null $files=null, bool $overwrite=false)

	getAlias ()

	getPath ()

	getMetadata (array $unserializeOptions=[])

	getModified ()

	getSignature ()

	getStub ()

	getVersion ()

	hasMetadata ()

	isBuffering ()

	isCompressed ()

	isFileFormat (int $format)

	isWritable ()

	offsetExists ($localName)

	offsetGet ($localName)

	offsetSet ($localName, $value)

	offsetUnset ($localName)

	setAlias (string $alias)

	setDefaultStub (?string $index=null, ?string $webIndex=null)

	setMetadata (mixed $metadata)

	setSignatureAlgorithm (int $algo, ?string $privateKey=null)

	setStub ($stub, int $length=UNKNOWN)

	startBuffering ()

	stopBuffering ()

Public Member Functions inherited from RecursiveDirectoryIterator
	__construct (string $directory, int $flags=FilesystemIterator::KEY_AS_PATHNAME\|FilesystemIterator::CURRENT_AS_FILEINFO)

	hasChildren (bool $allowLinks=false)

	getChildren ()

	getSubPath ()

	getSubPathname ()

Public Member Functions inherited from FilesystemIterator
	rewind ()

	key ()

	current ()

	getFlags ()

	setFlags (int $flags)

Public Member Functions inherited from DirectoryIterator
	__construct (string $directory)

	getFilename ()

	getExtension ()

	getBasename (string $suffix="")

	isDot ()

	valid ()

	next ()

	seek (int $offset)

	__toString ()

Public Member Functions inherited from SplFileInfo
	getPathname ()

	getPerms ()

	getInode ()

	getSize ()

	getOwner ()

	getGroup ()

	getATime ()

	getMTime ()

	getCTime ()

	getType ()

	isReadable ()

	isExecutable ()

	isFile ()

	isDir ()

	isLink ()

	getLinkTarget ()

	getRealPath ()

	getFileInfo (?string $class=null)

	getPathInfo (?string $class=null)

	openFile (string $mode="r", bool $useIncludePath=false, $context=null)

	setFileClass (string $class=SplFileObject::class)

	setInfoClass (string $class=SplFileInfo::class)

	__debugInfo ()

	_bad_state_ex ()

Public Member Functions inherited from RecursiveIterator
	hasChildren ()

Public Member Functions inherited from Countable
	count ()

Public Member Functions inherited from ArrayAccess
	offsetExists (mixed $offset)

	offsetGet (mixed $offset)

	offsetSet (mixed $offset, mixed $value)

	offsetUnset (mixed $offset)

Static Public Member Functions
static	apiVersion ()

static	canCompress (int $compression=0)

static	canWrite ()

static	createDefaultStub (?string $index=null, ?string $webIndex=null)

static	getSupportedCompression ()

static	getSupportedSignatures ()

static	interceptFileFuncs ()

static	isValidPharFilename (string $filename, bool $executable=true)

static	loadPhar (string $filename, ?string $alias=null)

static	mapPhar (?string $alias=null, int $offset=0)

static	running (bool $returnPhar=true)

static	mount (string $pharPath, string $externalPath)

static	mungServer (array $variables)

static	unlinkArchive (string $filename)

static	webPhar (?string $alias=null, ?string $index=null, ?string $fileNotFoundScript=null, array $mimeTypes=[], ?callable $rewrite=null)

Additional Inherited Members
Data Fields inherited from FilesystemIterator
const int	CURRENT_MODE_MASK = UNKNOWN

const int	CURRENT_AS_PATHNAME = UNKNOWN

const int	CURRENT_AS_FILEINFO = UNKNOWN

const int	CURRENT_AS_SELF = UNKNOWN

const int	KEY_MODE_MASK = UNKNOWN

const int	KEY_AS_PATHNAME = UNKNOWN

const int	FOLLOW_SYMLINKS = UNKNOWN

const int	KEY_AS_FILENAME = UNKNOWN

const int	NEW_CURRENT_AND_KEY = UNKNOWN

const int	OTHER_MODE_MASK = UNKNOWN

const int	SKIP_DOTS = UNKNOWN

const int	UNIX_PATHS = UNKNOWN

Detailed Description

Definition at line 246 of file phar_object.stub.php.

Constructor & Destructor Documentation

◆ __construct()

PharData::__construct	(	string	$filename,
		int	$flags = FilesystemIterator::SKIP_DOTS\|FilesystemIterator::UNIX_PATHS,
		?string	$alias = null,
		int	$format = 0 )

@implementation-alias Phar\__construct

Definition at line 249 of file phar_object.stub.php.

◆ __destruct()

PharData::__destruct ( )

@implementation-alias Phar\__destruct

Definition at line 252 of file phar_object.stub.php.

Member Function Documentation

◆ addEmptyDir()

PharData::addEmptyDir ( string $directory )

@tentative-return-type @implementation-alias Phar\addEmptyDir

Definition at line 258 of file phar_object.stub.php.

◆ addFile()

PharData::addFile	(	string	$filename,
		?string	$localName = null )

@tentative-return-type @implementation-alias Phar\addFile

Definition at line 264 of file phar_object.stub.php.

◆ addFromString()

PharData::addFromString	(	string	$localName,
		string	$contents )

@tentative-return-type @implementation-alias Phar\addFromString

Definition at line 270 of file phar_object.stub.php.

◆ apiVersion()

static PharData::apiVersion ( )

staticfinal

@implementation-alias Phar\apiVersion

Definition at line 494 of file phar_object.stub.php.

◆ buildFromDirectory()

PharData::buildFromDirectory	(	string	$directory,
		string	$pattern = "" )

@tentative-return-type @implementation-alias Phar\buildFromDirectory

Definition at line 276 of file phar_object.stub.php.

◆ buildFromIterator()

PharData::buildFromIterator	(	Traversable	$iterator,
		?string	$baseDirectory = null )

@tentative-return-type @implementation-alias Phar\buildFromIterator

Definition at line 282 of file phar_object.stub.php.

◆ canCompress()

static PharData::canCompress ( int $compression = 0 )

staticfinal

@implementation-alias Phar\canCompress

Definition at line 497 of file phar_object.stub.php.

◆ canWrite()

static PharData::canWrite ( )

staticfinal

@implementation-alias Phar\canWrite

Definition at line 500 of file phar_object.stub.php.

◆ compress()

PharData::compress	(	int	$compression,
		?string	$extension = null )

@tentative-return-type @implementation-alias Phar\compress

Definition at line 300 of file phar_object.stub.php.

◆ compressFiles()

PharData::compressFiles ( int $compression )

@tentative-return-type @implementation-alias Phar\compressFiles

Definition at line 288 of file phar_object.stub.php.

◆ convertToData()

PharData::convertToData	(	?int	$format = null,
		?int	$compression = null,
		?string	$extension = null )

@tentative-return-type @implementation-alias Phar\convertToData

Definition at line 318 of file phar_object.stub.php.

◆ convertToExecutable()

PharData::convertToExecutable	(	?int	$format = null,
		?int	$compression = null,
		?string	$extension = null )

@tentative-return-type @implementation-alias Phar\convertToExecutable

Definition at line 312 of file phar_object.stub.php.

◆ copy()

PharData::copy	(	string	$from,
		string	$to )

@tentative-return-type @implementation-alias Phar\copy

Definition at line 324 of file phar_object.stub.php.

◆ count()

PharData::count ( int $mode = COUNT_NORMAL )

@tentative-return-type @implementation-alias Phar\count

Definition at line 330 of file phar_object.stub.php.

◆ createDefaultStub()

static PharData::createDefaultStub	(	?string	$index = null,
		?string	$webIndex = null )

staticfinal

@implementation-alias Phar\createDefaultStub

Definition at line 503 of file phar_object.stub.php.

◆ decompress()

PharData::decompress ( ?string $extension = null )

@tentative-return-type @implementation-alias Phar\decompress

Definition at line 306 of file phar_object.stub.php.

◆ decompressFiles()

PharData::decompressFiles ( )

@tentative-return-type @implementation-alias Phar\decompressFiles

Definition at line 294 of file phar_object.stub.php.

◆ delete()

PharData::delete ( string $localName )

@tentative-return-type @implementation-alias Phar\delete

Definition at line 336 of file phar_object.stub.php.

◆ delMetadata()

PharData::delMetadata ( )

@tentative-return-type @implementation-alias Phar\delMetadata

Definition at line 342 of file phar_object.stub.php.

◆ extractTo()

PharData::extractTo	(	string	$directory,
		array\|string\|null	$files = null,
		bool	$overwrite = false )

@tentative-return-type @implementation-alias Phar\extractTo

Definition at line 348 of file phar_object.stub.php.

◆ getAlias()

PharData::getAlias ( )

@tentative-return-type @implementation-alias Phar\getAlias

Definition at line 354 of file phar_object.stub.php.

◆ getMetadata()

PharData::getMetadata ( array $unserializeOptions = [] )

@tentative-return-type @implementation-alias Phar\getMetadata

Definition at line 366 of file phar_object.stub.php.

◆ getModified()

PharData::getModified ( )

@tentative-return-type @implementation-alias Phar\getModified

Definition at line 372 of file phar_object.stub.php.

◆ getPath()

PharData::getPath ( )

@tentative-return-type @implementation-alias Phar\getPath

Reimplemented from SplFileInfo.

Definition at line 360 of file phar_object.stub.php.

◆ getSignature()

PharData::getSignature ( )

@tentative-return-type @implementation-alias Phar\getSignature

Definition at line 378 of file phar_object.stub.php.

◆ getStub()

PharData::getStub ( )

@tentative-return-type @implementation-alias Phar\getStub

Definition at line 384 of file phar_object.stub.php.

◆ getSupportedCompression()

static PharData::getSupportedCompression ( )

staticfinal

@implementation-alias Phar\getSupportedCompression

Definition at line 506 of file phar_object.stub.php.

◆ getSupportedSignatures()

static PharData::getSupportedSignatures ( )

staticfinal

@implementation-alias Phar\getSupportedSignatures

Definition at line 509 of file phar_object.stub.php.

◆ getVersion()

PharData::getVersion ( )

@tentative-return-type @implementation-alias Phar\getVersion

Definition at line 390 of file phar_object.stub.php.

◆ hasMetadata()

PharData::hasMetadata ( )

@tentative-return-type @implementation-alias Phar\hasMetadata

Definition at line 396 of file phar_object.stub.php.

◆ interceptFileFuncs()

static PharData::interceptFileFuncs ( )

staticfinal

@implementation-alias Phar\interceptFileFuncs

Definition at line 512 of file phar_object.stub.php.

◆ isBuffering()

PharData::isBuffering ( )

@tentative-return-type @implementation-alias Phar\isBuffering

Definition at line 402 of file phar_object.stub.php.

◆ isCompressed()

PharData::isCompressed ( )

@tentative-return-type @implementation-alias Phar\isCompressed

Definition at line 408 of file phar_object.stub.php.

◆ isFileFormat()

PharData::isFileFormat ( int $format )

@tentative-return-type @implementation-alias Phar\isFileFormat

Definition at line 414 of file phar_object.stub.php.

◆ isValidPharFilename()

static PharData::isValidPharFilename	(	string	$filename,
		bool	$executable = true )

staticfinal

@implementation-alias Phar\isValidPharFilename

Definition at line 515 of file phar_object.stub.php.

◆ isWritable()

PharData::isWritable ( )

@tentative-return-type @implementation-alias Phar\isWritable

Reimplemented from SplFileInfo.

Definition at line 420 of file phar_object.stub.php.

◆ loadPhar()

static PharData::loadPhar	(	string	$filename,
		?string	$alias = null )

staticfinal

@implementation-alias Phar\loadPhar

Definition at line 518 of file phar_object.stub.php.

◆ mapPhar()

static PharData::mapPhar	(	?string	$alias = null,
		int	$offset = 0 )

staticfinal

@implementation-alias Phar\mapPhar

Definition at line 521 of file phar_object.stub.php.

◆ mount()

static PharData::mount	(	string	$pharPath,
		string	$externalPath )

staticfinal

@implementation-alias Phar\mount

Definition at line 527 of file phar_object.stub.php.

◆ mungServer()

static PharData::mungServer ( array $variables )

staticfinal

@implementation-alias Phar\mungServer

Definition at line 530 of file phar_object.stub.php.

◆ offsetExists()

PharData::offsetExists ( $localName )

Parameters

string $localName @tentative-return-type @implementation-alias Phar\offsetExists

Definition at line 427 of file phar_object.stub.php.

◆ offsetGet()

PharData::offsetGet ( $localName )

Parameters

string $localName @tentative-return-type @implementation-alias Phar\offsetGet

Definition at line 434 of file phar_object.stub.php.

◆ offsetSet()

PharData::offsetSet	(		$localName,
			$value )

Parameters

string	$localName
resource \| string	$value	@tentative-return-type @implementation-alias Phar\offsetSet

Definition at line 442 of file phar_object.stub.php.

◆ offsetUnset()

PharData::offsetUnset ( $localName )

Parameters

string $localName @tentative-return-type @implementation-alias Phar\offsetUnset

Definition at line 449 of file phar_object.stub.php.

◆ running()

static PharData::running ( bool $returnPhar = true )

staticfinal

@implementation-alias Phar\running

Definition at line 524 of file phar_object.stub.php.

◆ setAlias()

PharData::setAlias ( string $alias )

@tentative-return-type @implementation-alias Phar\setAlias

Definition at line 455 of file phar_object.stub.php.

◆ setDefaultStub()

PharData::setDefaultStub	(	?string	$index = null,
		?string	$webIndex = null )

@tentative-return-type @implementation-alias Phar\setDefaultStub

Definition at line 461 of file phar_object.stub.php.

◆ setMetadata()

PharData::setMetadata ( mixed $metadata )

@tentative-return-type @implementation-alias Phar\setMetadata

Definition at line 467 of file phar_object.stub.php.

◆ setSignatureAlgorithm()

PharData::setSignatureAlgorithm	(	int	$algo,
		?string	$privateKey = null )

@tentative-return-type @implementation-alias Phar\setSignatureAlgorithm

Definition at line 473 of file phar_object.stub.php.

◆ setStub()

PharData::setStub	(		$stub,
		int	$length = UNKNOWN )

Parameters

resource | string $stub @implementation-alias Phar\setStub

Definition at line 479 of file phar_object.stub.php.

◆ startBuffering()

PharData::startBuffering ( )

@tentative-return-type @implementation-alias Phar\startBuffering

Definition at line 485 of file phar_object.stub.php.

◆ stopBuffering()

PharData::stopBuffering ( )

@tentative-return-type @implementation-alias Phar\stopBuffering

Definition at line 491 of file phar_object.stub.php.

◆ unlinkArchive()

static PharData::unlinkArchive ( string $filename )

staticfinal

@implementation-alias Phar\unlinkArchive

Definition at line 533 of file phar_object.stub.php.

◆ webPhar()

static PharData::webPhar	(	?string	$alias = null,
		?string	$index = null,
		?string	$fileNotFoundScript = null,
		array	$mimeTypes = [],
		?callable	$rewrite = null )

staticfinal

@implementation-alias Phar\webPhar

Definition at line 536 of file phar_object.stub.php.

The documentation for this class was generated from the following file:

ext/phar/phar_object.stub.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ addEmptyDir()

◆ addFile()

◆ addFromString()

◆ apiVersion()

◆ buildFromDirectory()

◆ buildFromIterator()

◆ canCompress()

◆ canWrite()

◆ compress()

◆ compressFiles()

◆ convertToData()

◆ convertToExecutable()

◆ copy()

◆ count()

◆ createDefaultStub()

◆ decompress()

◆ decompressFiles()

◆ delete()

◆ delMetadata()

◆ extractTo()

◆ getAlias()

◆ getMetadata()

◆ getModified()

◆ getPath()

◆ getSignature()

◆ getStub()

◆ getSupportedCompression()

◆ getSupportedSignatures()

◆ getVersion()

◆ hasMetadata()

◆ interceptFileFuncs()

◆ isBuffering()

◆ isCompressed()

◆ isFileFormat()

◆ isValidPharFilename()

◆ isWritable()

◆ loadPhar()

◆ mapPhar()

◆ mount()

◆ mungServer()

◆ offsetExists()

◆ offsetGet()

◆ offsetSet()

◆ offsetUnset()

◆ running()

◆ setAlias()

◆ setDefaultStub()

◆ setMetadata()

◆ setSignatureAlgorithm()

◆ setStub()

◆ startBuffering()

◆ stopBuffering()

◆ unlinkArchive()

◆ webPhar()