Introduction

Last updated: Fri, 29 Aug 2008

Phar

phpdoc:classref

The Phar class

Introduction

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

Synopsis de la classe

Phar

class Phar extends DirectoryIterator implements Countable , ArrayAccess {

/* Properties */

/* Methods */

bool addEmptyDir ( string $dirname )

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

bool 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 ] )

bool canWrite ( void )

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

bool compressAllFilesBZIP2 ( void )

bool compressAllFilesGZ ( void )

bool compressFiles ( int $compression )

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

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

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

bool copy ( string $oldfile , string $newfile )

int count ( void )

string createDefaultStub ( void )

object decompress ([ string $extension ] )

bool decompressFiles ( void )

int delMetadata ( void )

int delete ( string $entry )

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

int getMetaData ( void )

bool getModified ( void )

array getSignature ( void )

string getStub ( void )

array getSupportedCompression ( void )

array getSupportedSignatures ( void )

string getVersion ( void )

int hasMetadata ( void )

void interceptFileFuncs ( void )

bool isBuffering ( void )

mixed isCompressed ( void )

bool isFileFormat ( int $format )

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

bool isWritable ( void )

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

mixed mapPhar ([ string $alias [, int $dataoffset ]] )

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 )

bool running ([ bool $retphar ] )

bool setAlias ( string $alias )

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

void setMetadata ( mixed $metadata )

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

void 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 )

}

/phpdoc:classref phpdoc:classref

The PharData class

Introduction

The PharData class provides a high-level interface to accessing and creating non-executable tar and zip archives. Because these archives do not contain a stub and cannot be executed by the phar extension, it is possible to create and manipulate regular zip and tar files using the PharData class even if phar.readonly php.ini setting is 1.

Synopsis de la classe

PharData

class PharData extends Phar {

/* Properties */

/* Methods */

bool addEmptyDir ( string $dirname )

bool Phar::addFile ( string $file [, string $localname ] )

bool addFromString ( string $localname , string $contents )

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

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

object compress ( int $compression , string $extension )

bool compressFiles ( int $compression )

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

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

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

bool copy ( string $oldfile , string $newfile )

object decompress ([ string $extension ] )

bool decompressFiles ( void )

int delMetadata ( void )

int delete ( string $entry )

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

bool isWritable ( void )

void offsetSet ( string $offset , string $value )

bool offsetUnset ( string $offset )

bool setAlias ( string $alias )

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

void Phar::setMetadata ( mixed $metadata )

array Phar::setSignatureAlgorithm ( int $sigtype )

void setStub ( string $stub )

/* Inherited methods */

bool Phar::addEmptyDir ( string $dirname )

bool Phar::addFile ( string $file [, string $localname ] )

bool Phar::addFromString ( string $localname , string $contents )

string Phar::apiVersion ( void )

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

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

bool Phar::canCompress ([ int $type ] )

bool Phar::canWrite ( void )

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

bool Phar::compressAllFilesBZIP2 ( void )

bool Phar::compressAllFilesGZ ( void )

bool Phar::compressFiles ( int $compression )

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

PharData Phar::convertToData ([ int $format [, int $compression [, string $extension ]]] )

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

bool Phar::copy ( string $oldfile , string $newfile )

int Phar::count ( void )

string Phar::createDefaultStub ( void )

object Phar::decompress ([ string $extension ] )

bool Phar::decompressFiles ( void )

int Phar::delMetadata ( void )

int Phar::delete ( string $entry )

int Phar::extractTo ( string $pathto [, string|array $files [, bool $overwrite ]] )

int Phar::getMetaData ( void )

bool Phar::getModified ( void )

array Phar::getSignature ( void )

string Phar::getStub ( void )

array Phar::getSupportedCompression ( void )

array Phar::getSupportedSignatures ( void )

string Phar::getVersion ( void )

int Phar::hasMetadata ( void )

void Phar::interceptFileFuncs ( void )

bool Phar::isBuffering ( void )

mixed Phar::isCompressed ( void )

bool Phar::isFileFormat ( int $format )

bool Phar::isValidPharFilename ( string $filename [, bool $executable ] )

bool Phar::isWritable ( void )

mixed Phar::loadPhar ( string $filename [, string $alias ] )

mixed Phar::mapPhar ([ string $alias [, int $dataoffset ]] )

void Phar::mount ( string $pharpath , string $externalpath )

void Phar::mungServer ( array $munglist )

bool Phar::offsetExists ( string $offset )

int Phar::offsetGet ( string $offset )

void Phar::offsetSet ( string $offset , string $value )

bool Phar::offsetUnset ( string $offset )

bool Phar::running ([ bool $retphar ] )

bool Phar::setAlias ( string $alias )

void Phar::setDefaultStub ([ string $index [, string $webindex ]] )

void Phar::setMetadata ( mixed $metadata )

array Phar::setSignatureAlgorithm ( int $sigtype [, string $privatekey ] )

void Phar::setStub ( string $stub )

void Phar::startBuffering ( void )

void Phar::stopBuffering ( void )

bool Phar::uncompressAllFiles ( void )

bool Phar::unlinkArchive ( string $archive )

void Phar::webPhar ( string $alias , string $index , string $f404 , array $mimetypes , array $rewrites )

}

/phpdoc:classref phpdoc:classref

The PharFileInfo class

Introduction

The PharFileInfo class provides a high-level interface to the contents and attributes of a single file within a phar archive.

Synopsis de la classe

PharFileInfo

class PharFileInfo extends SplFileInfo {

/* Properties */

/* Methods */

void chmod ( int $permissions )

bool compress ( int $compression )

void __construct ( string $entry )

bool decompress ( void )

bool delMetadata ( void )

int getCRC32 ( void )

int getCompressedSize ( void )

int getMetaData ( void )

int getPharFlags ( void )

int hasMetadata ( void )

bool isCRCChecked ( void )

bool isCompressed ( void )

bool isCompressedBZIP2 ( void )

bool isCompressedGZ ( void )

bool setCompressedBZIP2 ( void )

bool setCompressedGZ ( void )

void setMetaData ( mixed $metadata )

bool setUncompressed ( void )

}

/phpdoc:classref phpdoc:exceptionref

The PharException class

Introduction

The PharException class provides a phar-specific exception class for try/catch blocks.

Synopsis de la classe

PharException

class PharException extends Exception {

/* Properties */

}

/phpdoc:exceptionref

Introduction
Installation/Configuration
- Installation
- Configuration à l'exécution
- Types de ressources
Constantes pré-définies
Using Phar Archives
- Using Phar Archives: the phar stream wrapper
- Using Phar Archives: the Phar and PharData class
Creating Phar Archives
What makes a phar a phar and not a tar or a zip?
- Phar file stub
- Head-to-head comparison of Phar, Tar and Zip
- Tar-based phars
- Zip-based phars
- Phar File Format
- Global Phar bitmapped flags
- Phar manifest file entry definition
- Phar Signature format
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 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 — 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
PharData::addEmptyDir — Add an empty directory to the tar/zip archive
PharData::addFile — Add a file from the filesystem to the tar/zip archive
PharData::addFromString — Add a file from the filesystem to the tar/zip archive
PharData::buildFromDirectory — Construct a tar/zip archive from the files within a directory.
PharData::buildFromIterator — Construct a tar or zip archive from an iterator.
PharData::compress — Compresses the entire tar/zip archive using Gzip or Bzip2 compression
PharData::compressFiles — Compresses all files in the current tar/zip archive
PharData::__construct — Construct a non-executable tar or zip archive object
PharData::convertToData — Convert a phar archive to a non-executable tar or zip file
PharData::convertToExecutable — Convert a non-executable tar/zip archive to an executable phar archive
PharData::copy — Copy a file internal to the phar archive to another new file within the phar
PharData::decompress — Decompresses the entire Phar archive
PharData::decompressFiles — Decompresses all files in the current zip archive
PharData::delMetadata — Deletes the global metadata of a zip archive
PharData::delete — Delete a file within a tar/zip archive
PharData::extractTo — Extract the contents of a tar/zip archive to a directory
PharData::isWritable — Returns true if the tar/zip archive can be modified
PharData::offsetSet — set the contents of a file within the tar/zip to those of an external file or string
PharData::offsetUnset — remove a file from a tar/zip archive
PharData::setAlias — dummy function (Phar::setAlias is not valid for PharData)
PharData::setDefaultStub — dummy function (Phar::setDefaultStub is not valid for PharData)
Phar::setMetadata — Sets phar archive meta-data
Phar::setSignatureAlgorithm — set the signature algorithm for a phar and apply it. The
PharData::setStub — dummy function (Phar::setStub is not valid for PharData)
PharFileInfo::chmod — Sets file-specific permission bits
PharFileInfo::compress — Compresses the current Phar entry with either zlib or bzip2 compression
PharFileInfo::__construct — Construct a Phar entry object
PharFileInfo::decompress — Decompresses the current Phar entry within the phar
PharFileInfo::delMetadata — Deletes the metadata of the entry
PharFileInfo::getCRC32 — Returns CRC32 code or throws an exception if CRC has not been verified
PharFileInfo::getCompressedSize — Returns the actual size of the file (with compression) inside the Phar archive
PharFileInfo::getMetaData — Returns file-specific meta-data saved with a file
PharFileInfo::getPharFlags — Returns the Phar file entry flags
PharFileInfo::hasMetadata — Returns the metadata of the entry
PharFileInfo::isCRCChecked — Returns whether file entry has had its CRC verified
PharFileInfo::isCompressed — Returns whether the entry is compressed
PharFileInfo::isCompressedBZIP2 — Returns whether the entry is compressed using bzip2
PharFileInfo::isCompressedGZ — Returns whether the entry is compressed using gz
PharFileInfo::setCompressedBZIP2 — Compresses the current Phar entry within the phar using Bzip2 compression
PharFileInfo::setCompressedGZ — Compresses the current Phar entry within the phar using gz compression
PharFileInfo::setMetaData — Sets file-specific meta-data saved with a file
PharFileInfo::setUncompressed — Uncompresses the current Phar entry within the phar, if it is compressed
PharException — The PharException class provides a phar-specific exception class for try/catch blocks.

add a note User Contributed Notes
Phar

There are no user contributed notes for this page.

Introduction

lzf_optimized_for

Last updated: Fri, 29 Aug 2008