The Phar class

Introduction

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

Class synopsis

Phar

Phar extends DirectoryIterator implements Countable , ArrayAccess {

/* Properties */

/* Methods */

void addEmptyDir ( string $dirname )

void addFile ( string $file [, string $localname ] )

void addFromString ( string $localname , string $contents )

string apiVersion ( void )

array buildFromDirectory ( string $base_dir [, string $regex ] )

array buildFromIterator ( Iterator $iter [, string $base_directory ] )

bool canCompress ([ int $type=0 ] )

bool canWrite ( void )

object compress ( int $compression [, string $extension ] )

bool compressAllFilesBZIP2 ( void )

bool compressAllFilesGZ ( void )

void compressFiles ( int $compression )

void __construct ( string $fname [, int $flags [, string $alias ]] )

PharData convertToData ([ int $format=9021976 [, int $compression=9021976 [, string $extension ]]] )

Phar convertToExecutable ([ int $format=9021976 [, int $compression=9021976 [, string $extension ]]] )

bool copy ( string $oldfile , string $newfile )

int count ( void )

string createDefaultStub ([ string $indexfile [, string $webindexfile ]] )

object decompress ([ string $extension ] )

bool decompressFiles ( void )

bool delMetadata ( void )

bool delete ( string $entry )

bool extractTo ( string $pathto [, string|array $files [, bool $overwrite=false ]] )

mixed getMetaData ( void )

bool getModified ( void )

array getSignature ( void )

string getStub ( void )

array getSupportedCompression ( void )

array getSupportedSignatures ( void )

string getVersion ( void )

bool hasMetadata ( void )

void interceptFileFuncs ( void )

bool isBuffering ( void )

mixed isCompressed ( void )

bool isFileFormat ( int $format )

bool isValidPharFilename ( string $filename [, bool $executable=true ] )

bool isWritable ( void )

bool loadPhar ( string $filename [, string $alias ] )

bool mapPhar ([ string $alias [, int $dataoffset=0 ]] )

void mount ( string $pharpath , string $externalpath )

void mungServer ( array $munglist )

bool offsetExists ( string $offset )

int offsetGet ( string $offset )

void offsetSet ( string $offset , string $value )

bool offsetUnset ( string $offset )

string running ([ bool $retphar=true ] )

bool setAlias ( string $alias )

bool setDefaultStub ([ string $index [, string $webindex ]] )

void setMetadata ( mixed $metadata )

void setSignatureAlgorithm ( int $sigtype [, string $privatekey ] )

bool setStub ( string $stub )

void startBuffering ( void )

void stopBuffering ( void )

bool uncompressAllFiles ( void )

bool unlinkArchive ( string $archive )

void webPhar ([ string $alias [, string $index [, string $f404 [, array $mimetypes [, array $rewrites ]]]]] )

}

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 the filesystem 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::compressAllFilesBZIP2 � Compresses all files in the current Phar archive using Bzip2 compression
Phar::compressAllFilesGZ � Compresses all files in the current Phar archive using Gzip 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 � Return the PHP loader or bootstrap stub of a Phar archive
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::extractTo � Extract the contents of a phar archive to a directory
Phar::getMetaData � Returns phar archive meta-data
Phar::getModified � Return whether phar was modified
Phar::getSignature � Return MD5/SHA1/SHA256/SHA512 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 b 4 $_SERVER variables that should be modified for execution
Phar::offsetExists — determines whether a file exists in the phar
Phar::offsetGet — get 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::uncompressAllFiles — Uncompresses all files in the current Phar archive
Phar::unlinkArchive — Completely remove a phar archive from disk and from memory
Phar::webPhar — mapPhar for web-based phars. front controller for web applications

The Phar class

Introduction

Class synopsis

Table of Contents