PHP: Phar - Manual (original) (raw)

class **Phar extends RecursiveDirectoryIterator implements Countable,ArrayAccess {

/* Inherited constants */

public const int FilesystemIterator::CURRENT_MODE_MASK;

public const int FilesystemIterator::CURRENT_AS_PATHNAME;

public const int FilesystemIterator::CURRENT_AS_FILEINFO;

public const int FilesystemIterator::CURRENT_AS_SELF;

public const int FilesystemIterator::KEY_MODE_MASK;

public const int FilesystemIterator::KEY_AS_PATHNAME;

public const int FilesystemIterator::FOLLOW_SYMLINKS;

public const int FilesystemIterator::KEY_AS_FILENAME;

public const int FilesystemIterator::NEW_CURRENT_AND_KEY;

public const int FilesystemIterator::OTHER_MODE_MASK;

public const int FilesystemIterator::SKIP_DOTS;

public const int FilesystemIterator::UNIX_PATHS;

/* Constants */

const int BZ2;

const int GZ;

const int NONE;

const int PHAR;

const int TAR;

const int ZIP;

const int COMPRESSED;

const int PHP;

const int PHPS;

const int MD5;

const int OPENSSL;

const int OPENSSL_SHA256;

const int OPENSSL_SHA512;

const int SHA1;

const int SHA256;

const int SHA512;

/* Methods */

public function __construct(string $filename, int $flags = FilesystemIterator::SKIP_DOTS | FilesystemIterator::UNIX_PATHS, ?string $alias = [null](reserved.constants.php#constant.null))

public function addEmptyDir(string $directory): void

public function addFile(string $filename, ?string $localName = [null](reserved.constants.php#constant.null)): void

public function addFromString(string $localName, string $contents): void

final public static function apiVersion(): string

public function buildFromDirectory(string $directory, string $pattern = ""): array

public function buildFromIterator(Traversable $iterator, ?string $baseDirectory = [null](reserved.constants.php#constant.null)): array

final public static function canCompress(int $compression = 0): bool

final public static function canWrite(): bool

public function compress(int $compression, ?string $extension = [null](reserved.constants.php#constant.null)): ?Phar

public function compressFiles(int $compression): void

public function convertToData(?int $format = [null](reserved.constants.php#constant.null), ?int $compression = [null](reserved.constants.php#constant.null), ?string $extension = [null](reserved.constants.php#constant.null)): ?PharData

public function convertToExecutable(?int $format = [null](reserved.constants.php#constant.null), ?int $compression = [null](reserved.constants.php#constant.null), ?string $extension = [null](reserved.constants.php#constant.null)): ?Phar

public function copy(string $from, string $to): true

public function count(int $mode = [COUNT_NORMAL](array.constants.php#constant.count-normal)): int

final public static function createDefaultStub(?string $index = [null](reserved.constants.php#constant.null), ?string $webIndex = [null](reserved.constants.php#constant.null)): string

public function decompress(?string $extension = [null](reserved.constants.php#constant.null)): ?Phar

public function decompressFiles(): true

public function delMetadata(): true

public function delete(string $localName): true

public function extractTo(string $directory, array|string|null $files = [null](reserved.constants.php#constant.null), bool $overwrite = [false](reserved.constants.php#constant.false)): bool

public function getAlias(): ?string

public function getMetadata(array $unserializeOptions = []): mixed

public function getModified(): bool

public function getPath(): string

public function getSignature(): array|false

public function getStub(): string

final public static function getSupportedCompression(): array

final public static function getSupportedSignatures(): array

public function getVersion(): string

public function hasMetadata(): bool

final public static function interceptFileFuncs(): void

public function isBuffering(): bool

public function isCompressed(): int|false

public function isFileFormat(int $format): bool

final public static function isValidPharFilename(string $filename, bool $executable = [true](reserved.constants.php#constant.true)): bool

public function isWritable(): bool

final public static function loadPhar(string $filename, ?string $alias = [null](reserved.constants.php#constant.null)): bool

final public static function mapPhar(?string $alias = [null](reserved.constants.php#constant.null), int $offset = 0): bool

final public static function mount(string $pharPath, string $externalPath): void

final public static function mungServer(array $variables): void

public function offsetExists(string $localName): bool

public function offsetGet(string $localName): SplFileInfo

public function offsetSet(string $localName, resource|string $value): void

public function offsetUnset(string $localName): void

final public static function running(bool $returnPhar = [true](reserved.constants.php#constant.true)): string

public function setAlias(string $alias): true

public function setDefaultStub(?string $index = [null](reserved.constants.php#constant.null), ?string $webIndex = [null](reserved.constants.php#constant.null)): true

public function setMetadata(mixed $metadata): void

public function setSignatureAlgorithm(int $algo, ?string $privateKey = [null](reserved.constants.php#constant.null)): void

public function setStub(resource|string $stub, int $length = -1): true

public function startBuffering(): void

public function stopBuffering(): void

final public static function unlinkArchive(string $filename): true

final public static function webPhar(
?string $alias = [null](reserved.constants.php#constant.null),
?string $index = [null](reserved.constants.php#constant.null),
?string $fileNotFoundScript = [null](reserved.constants.php#constant.null),
array $mimeTypes = [],
?callable $rewrite = [null](reserved.constants.php#constant.null)
): void

public function __destruct()

/* Inherited methods */

public function RecursiveDirectoryIterator::getChildren(): RecursiveDirectoryIterator

public function RecursiveDirectoryIterator::getSubPath(): string

public function RecursiveDirectoryIterator::getSubPathname(): string

public function RecursiveDirectoryIterator::hasChildren(bool $allowLinks = [false](reserved.constants.php#constant.false)): bool

public function RecursiveDirectoryIterator::key(): string

public function RecursiveDirectoryIterator::next(): void

public function RecursiveDirectoryIterator::rewind(): void

public function FilesystemIterator::current(): string|SplFileInfo|FilesystemIterator

public function FilesystemIterator::getFlags(): int

public function FilesystemIterator::key(): string

public function FilesystemIterator::next(): void

public function FilesystemIterator::rewind(): void

public function FilesystemIterator::setFlags(int $flags): void

public function DirectoryIterator::current(): mixed

public function DirectoryIterator::getBasename(string $suffix = ""): string

public function DirectoryIterator::getExtension(): string

public function DirectoryIterator::getFilename(): string

public function DirectoryIterator::isDot(): bool

public function DirectoryIterator::key(): mixed

public function DirectoryIterator::next(): void

public function DirectoryIterator::rewind(): void

public function DirectoryIterator::seek(int $offset): void

public function DirectoryIterator::__toString(): string

public function DirectoryIterator::valid(): bool

public function SplFileInfo::getATime(): int|false

public function SplFileInfo::getBasename(string $suffix = ""): string

public function SplFileInfo::getCTime(): int|false

public function SplFileInfo::getExtension(): string

public function SplFileInfo::getFileInfo(?string $class = [null](reserved.constants.php#constant.null)): SplFileInfo

public function SplFileInfo::getFilename(): string

public function SplFileInfo::getGroup(): int|false

public function SplFileInfo::getInode(): int|false

public function SplFileInfo::getLinkTarget(): string|false

public function SplFileInfo::getMTime(): int|false

public function SplFileInfo::getOwner(): int|false

public function SplFileInfo::getPath(): string

public function SplFileInfo::getPathInfo(?string $class = [null](reserved.constants.php#constant.null)): ?SplFileInfo

public function SplFileInfo::getPathname(): string

public function SplFileInfo::getPerms(): int|false

public function SplFileInfo::getRealPath(): string|false

public function SplFileInfo::getSize(): int|false

public function SplFileInfo::getType(): string|false

public function SplFileInfo::isDir(): bool

public function SplFileInfo::isExecutable(): bool

public function SplFileInfo::isFile(): bool

public function SplFileInfo::isLink(): bool

public function SplFileInfo::isReadable(): bool

public function SplFileInfo::isWritable(): bool

public function SplFileInfo::openFile(string $mode = "r", bool $useIncludePath = [false](reserved.constants.php#constant.false), ?resource $context = [null](reserved.constants.php#constant.null)): SplFileObject

public function SplFileInfo::setFileClass(string $class = SplFileObject::class): void

public function SplFileInfo::setInfoClass(string $class = SplFileInfo::class): void

public function SplFileInfo::__toString(): string

}