The Phar class

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 1.0.0)

Introduction

The Phar class provides a high-level interface to accessing and creating phar archives.

Class synopsis

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)

public function addEmptyDir(string $directory): void

public function addFile(string $filename, ?string $localName = 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): array

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

final public static function canWrite(): bool

public function compress(int $compression, ?string $extension = null): ?Phar

public function compressFiles(int $compression): void

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

public function convertToExecutable(?int $format = null, ?int $compression = null, ?string $extension = null): ?Phar

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

public function count(int $mode = COUNT_NORMAL): int

final public static function createDefaultStub(?string $index = null, ?string $webIndex = null): string

public function decompress(?string $extension = 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, bool $overwrite = 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): bool

public function isWritable(): bool

final public static function loadPhar(string $filename, ?string $alias = null): bool

final public static function mapPhar(?string $alias = 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): string

public function setAlias(string $alias): true

public function setDefaultStub(?string $index = null, ?string $webIndex = null): true

public function setMetadata(mixed $metadata): void

public function setSignatureAlgorithm(int $algo, ?string $privateKey = 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,
    ?string $index = null,
    ?string $fileNotFoundScript = null,
    array $mimeTypes = [],
    ?callable $rewrite = 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): 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): 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): ?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, ?resource $context = 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

}

Changelog

Version	Description
8.4.0	Added support for the Unix timestamp extension for Zip-based archives.
8.0.0	Meta-data is no longer deserialized upon opening the archive, but is deferred until Phar::getMetadata() is called.

Notes

Caution

Prior to PHP 8.0.0, the meta-data was deserialized upon opening the archive. This could lead to security vulnerabilities. Starting with PHP 8.0.0, meta-data is only deserialized when calling Phar::getMetadata(), which has options to restrict deserialization for security reasons.

Phar::addEmptyDir — Add an empty directory to the phar archive
Phar::addFile — Add a file from the filesystem to the phar archive
Phar::addFromString — Add a file from a string to the phar archive
Phar::apiVersion — Returns the api version
Phar::buildFromDirectory — Construct a phar archive from the files within a directory
Phar::buildFromIterator — Construct a phar archive from an iterator
Phar::canCompress — Returns whether phar extension supports compression using either zlib or bzip2
Phar::canWrite — Returns whether phar extension supports writing and creating phars
Phar::compress — Compresses the entire Phar archive using Gzip or Bzip2 compression
Phar::compressFiles — Compresses all files in the current Phar archive
Phar::__construct — Construct a Phar archive object
Phar::convertToData — Convert a phar archive to a non-executable tar or zip file
Phar::convertToExecutable — Convert a phar archive to another executable phar archive file format
Phar::copy — Copy a file internal to the phar archive to another new file within the phar
Phar::count — Returns the number of entries (files) in the Phar archive
Phar::createDefaultStub — Create a phar-file format specific stub
Phar::decompress — Decompresses the entire Phar archive
Phar::decompressFiles — Decompresses all files in the current Phar archive
Phar::delMetadata — Deletes the global metadata of the phar
Phar::delete — Delete a file within a phar archive
Phar::__destruct — Destructs a Phar archive object
Phar::extractTo — Extract the contents of a phar archive to a directory
Phar::getAlias — Get the alias for Phar
Phar::getMetadata — Returns phar archive meta-data
Phar::getModified — Return whether phar was modified
Phar::getPath — Get the real path to the Phar archive on disk
Phar::getSignature — Return MD5/SHA1/SHA256/SHA512/OpenSSL signature of a Phar archive
Phar::getStub — Return the PHP loader or bootstrap stub of a Phar archive
Phar::getSupportedCompression — Return array of supported compression algorithms
Phar::getSupportedSignatures — Return array of supported signature types
Phar::getVersion — Return version info of Phar archive
Phar::hasMetadata — Returns whether phar has global meta-data
Phar::interceptFileFuncs — Instructs phar to intercept fopen, file_get_contents, opendir, and all of the stat-related functions
Phar::isBuffering — Used to determine whether Phar write operations are being buffered, or are flushing directly to disk
Phar::isCompressed — Returns Phar::GZ or PHAR::BZ2 if the entire phar archive is compressed (.tar.gz/tar.bz and so on)
Phar::isFileFormat — Returns true if the phar archive is based on the tar/phar/zip file format depending on the parameter
Phar::isValidPharFilename — Returns whether the given filename is a valid phar filename
Phar::isWritable — Returns true if the phar archive can be modified
Phar::loadPhar — Loads any phar archive with an alias
Phar::mapPhar — Reads the currently executed file (a phar) and registers its manifest
Phar::mount — Mount an external path or file to a virtual location within the phar archive
Phar::mungServer — Defines a list of up to 4 $_SERVER variables that should be modified for execution
Phar::offsetExists — Determines whether a file exists in the phar
Phar::offsetGet — Gets a PharFileInfo object for a specific file
Phar::offsetSet — Set the contents of an internal file to those of an external file
Phar::offsetUnset — Remove a file from a phar
Phar::running — Returns the full path on disk or full phar URL to the currently executing Phar archive
Phar::setAlias — Set the alias for the Phar archive
Phar::setDefaultStub — Used to set the PHP loader or bootstrap stub of a Phar archive to the default loader
Phar::setMetadata — Sets phar archive meta-data
Phar::setSignatureAlgorithm — Set the signature algorithm for a phar and apply it
Phar::setStub — Used to set the PHP loader or bootstrap stub of a Phar archive
Phar::startBuffering — Start buffering Phar write operations, do not modify the Phar object on disk
Phar::stopBuffering — Stop buffering write requests to the Phar archive, and save changes to disk
Phar::unlinkArchive — Completely remove a phar archive from disk and from memory
Phar::webPhar — Routes a request from a web browser to an internal file within the phar archive

The Phar class

Introduction

Class synopsis

Changelog

Notes

Table of Contents