lzf_optimized_for
Introduction
Compression Extensions
PHP Manual

# Phar

- Introduction
- Installing/Configuring
  - Installation
  - Runtime Configuration
  - Resource Types
- Predefined Constants
- 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 — The Phar class
  - Phar::apiVersion — Returns the api version
  - 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::__construct — Construct a Phar archive object
  - Phar::convertToPhar — Convert the phar archive to the phar file format
  - Phar::convertToTar — Convert the phar archive to the tar file format, optionally compressing the entire archive using gzip or bzip2 compression
  - Phar::convertToZip — Convert the phar archive to the zip 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::delMetadata — Deletes the global metadata of the phar
  - 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::isPhar — Returns true if the phar archive is based on the phar file format
  - Phar::isTar — Returns true if the phar archive is based on the tar file format
  - Phar::isValidPharFilename — Returns whether the given filename is a valid phar filename
  - Phar::isZip — Returns true if the phar archive is based on the Zip file format
  - Phar::loadPhar — Loads any phar archive with an alias
  - Phar::mapPhar — Reads the currently executed file (a phar) and registers its manifest
  - 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::setAlias — Set the alias for the Phar archive
  - Phar::setMetadata — Sets phar archive meta-data
  - Phar::setSignatureAlgorithm — set the signature algorithm for a phar and apply it. The
  - 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::webPhar — mapPhar for web-based phars. front controller for web applications
- PharData — The PharData class
  - PharData::buildFromIterator — Construct a tar or zip archive from an iterator.
  - PharData::compressAllFilesBZIP2 — Compresses all files in the current tar/zip archive using Bzip2 compression
  - PharData::compressAllFilesGZ — Compresses all files in the current tar/zip archive using Gzip compression
  - PharData::__construct — Construct a non-executable tar or zip archive object
  - PharData::convertToPhar — Convert the tar/zip archive to the phar file format
  - PharData::convertToTar — Convert a zip archive to the tar file format
  - PharData::convertToZip — Convert a tar archive to the zip file format
  - PharData::copy — Copy a file internal to the phar archive to another new file within the phar
  - PharData::delMetadata — Deletes the global metadata of a zip archive
  - PharData::offsetSet — set the contents of a file within the tar/zip to those of an external file or string
  - PharData::setAlias — dummy function (Phar::setAlias is not valid for PharData)
  - PharData::setStub — dummy function (Phar::setStub is not valid for PharData)
- PharFileInfo — The PharFileInfo class
  - PharFileInfo::chmod — Sets file-specific permission bits
  - PharFileInfo::__construct — Construct a Phar entry object
  - 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
  - PharException — The PharException class provides a phar-specific exception class for try/catch blocks.

lzf_optimized_for
Introduction
Compression Extensions
PHP Manual