API Reference Document
« lzf_optimized_for
简介 »
PHP Manual
压缩与归档扩展
Phar
Phar
简介
安装/配置
需求
安装
运行时配置
资源类型
预定义常量
Using Phar Archives
Using Phar Archives: Introduction
Using Phar Archives: the phar stream wrapper
Using Phar Archives: the Phar and PharData class
Creating Phar Archives
Creating Phar Archives: Introduction
What makes a phar a phar and not a tar or a zip?
Ingredients of all Phar archives, independent of file format
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::addEmptyDir
— 添加一个空目录到 phar 档案
Phar::addFile
— 将一个文件从文件系统添加到 phar 档案中
Phar::addFromString
— 以字符串的形式添加一个文件到 phar 档案
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
— 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
— 删除 phar 档案中的一个文件
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::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
— The PharData class
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
PharData::setStub
— Dummy function (Phar::setStub is not valid for PharData)
PharFileInfo
— The PharFileInfo class
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::getContent
— Get the complete file contents of the entry
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