From f45d3cb1100539b3e4d2993608eb5521dc2ba62f Mon Sep 17 00:00:00 2001 From: Greg Beaver Date: Mon, 21 Jan 2008 21:54:18 +0000 Subject: [PATCH] fix xml:id for methods, document webPhar, add xml:id to all
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@251096 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/phar/Phar/apiVersion.xml | 4 +- reference/phar/Phar/buildFromIterator.xml | 4 +- reference/phar/Phar/canCompress.xml | 4 +- reference/phar/Phar/canWrite.xml | 4 +- reference/phar/Phar/compressAllFilesBZIP2.xml | 4 +- reference/phar/Phar/compressAllFilesGZ.xml | 4 +- reference/phar/Phar/construct.xml | 4 +- reference/phar/Phar/convertToPhar.xml | 4 +- reference/phar/Phar/convertToTar.xml | 4 +- reference/phar/Phar/convertToZip.xml | 4 +- reference/phar/Phar/copy.xml | 4 +- reference/phar/Phar/count.xml | 4 +- reference/phar/Phar/createDefaultStub.xml | 4 +- reference/phar/Phar/delMetadata.xml | 4 +- reference/phar/Phar/getMetadata.xml | 4 +- reference/phar/Phar/getModified.xml | 4 +- reference/phar/Phar/getSignature.xml | 4 +- reference/phar/Phar/getStub.xml | 4 +- .../phar/Phar/getSupportedCompression.xml | 4 +- .../phar/Phar/getSupportedSignatures.xml | 4 +- reference/phar/Phar/getVersion.xml | 4 +- reference/phar/Phar/hasMetadata.xml | 4 +- reference/phar/Phar/interceptFileFuncs.xml | 4 +- reference/phar/Phar/isBuffering.xml | 4 +- reference/phar/Phar/isCompressed.xml | 4 +- reference/phar/Phar/isPhar.xml | 4 +- reference/phar/Phar/isTar.xml | 4 +- reference/phar/Phar/isValidPharFilename.xml | 4 +- reference/phar/Phar/isZip.xml | 4 +- reference/phar/Phar/loadPhar.xml | 4 +- reference/phar/Phar/mapPhar.xml | 8 +- reference/phar/Phar/mungServer.xml | 4 +- reference/phar/Phar/offsetExists.xml | 4 +- reference/phar/Phar/offsetGet.xml | 4 +- reference/phar/Phar/offsetSet.xml | 4 +- reference/phar/Phar/offsetUnset.xml | 4 +- reference/phar/Phar/setAlias.xml | 4 +- reference/phar/Phar/setMetadata.xml | 4 +- reference/phar/Phar/setSignatureAlgorithm.xml | 4 +- reference/phar/Phar/setStub.xml | 4 +- reference/phar/Phar/startBuffering.xml | 4 +- reference/phar/Phar/stopBuffering.xml | 4 +- reference/phar/Phar/uncompressAllFiles.xml | 4 +- reference/phar/Phar/webPhar.xml | 155 ++++++++++++------ reference/phar/PharFileInfo/chmod.xml | 4 +- reference/phar/PharFileInfo/construct.xml | 4 +- reference/phar/PharFileInfo/delMetadata.xml | 4 +- reference/phar/PharFileInfo/getCRC32.xml | 4 +- .../phar/PharFileInfo/getCompressedSize.xml | 4 +- reference/phar/PharFileInfo/getMetadata.xml | 4 +- reference/phar/PharFileInfo/getPharFlags.xml | 4 +- reference/phar/PharFileInfo/hasMetadata.xml | 4 +- reference/phar/PharFileInfo/isCRCChecked.xml | 4 +- reference/phar/PharFileInfo/isCompressed.xml | 4 +- .../phar/PharFileInfo/isCompressedBZIP2.xml | 4 +- .../phar/PharFileInfo/isCompressedGZ.xml | 4 +- .../phar/PharFileInfo/setCompressedBZIP2.xml | 4 +- .../phar/PharFileInfo/setCompressedGZ.xml | 4 +- reference/phar/PharFileInfo/setMetadata.xml | 4 +- .../phar/PharFileInfo/setUncompressed.xml | 4 +- reference/phar/creating.xml | 4 +- reference/phar/fileformat.xml | 20 +-- reference/phar/using.xml | 6 +- 63 files changed, 242 insertions(+), 183 deletions(-) diff --git a/reference/phar/Phar/apiVersion.xml b/reference/phar/Phar/apiVersion.xml index 202c4d31c2..4111f7ed74 100644 --- a/reference/phar/Phar/apiVersion.xml +++ b/reference/phar/Phar/apiVersion.xml @@ -1,6 +1,6 @@ - - + + Phar::apiVersion Returns the api version diff --git a/reference/phar/Phar/buildFromIterator.xml b/reference/phar/Phar/buildFromIterator.xml index 0ea3d98624..c1ea20ce58 100644 --- a/reference/phar/Phar/buildFromIterator.xml +++ b/reference/phar/Phar/buildFromIterator.xml @@ -1,6 +1,6 @@ - - + + Phar::buildFromIterator Construct a phar archive from an iterator. diff --git a/reference/phar/Phar/canCompress.xml b/reference/phar/Phar/canCompress.xml index a4c02e961f..567c7670fe 100644 --- a/reference/phar/Phar/canCompress.xml +++ b/reference/phar/Phar/canCompress.xml @@ -1,6 +1,6 @@ - - + + Phar::canCompress Returns whether phar extension supports compression using either zlib or bzip2 diff --git a/reference/phar/Phar/canWrite.xml b/reference/phar/Phar/canWrite.xml index 29d82e21e6..74a6b549af 100644 --- a/reference/phar/Phar/canWrite.xml +++ b/reference/phar/Phar/canWrite.xml @@ -1,6 +1,6 @@ - - + + Phar::canWrite Returns whether phar extension supports writing and creating phars diff --git a/reference/phar/Phar/compressAllFilesBZIP2.xml b/reference/phar/Phar/compressAllFilesBZIP2.xml index 8459f2ec26..00fc86c8ad 100644 --- a/reference/phar/Phar/compressAllFilesBZIP2.xml +++ b/reference/phar/Phar/compressAllFilesBZIP2.xml @@ -1,6 +1,6 @@ - - + + Phar::compressAllFilesBZIP2 Compresses all files in the current Phar archive using Bzip2 compression diff --git a/reference/phar/Phar/compressAllFilesGZ.xml b/reference/phar/Phar/compressAllFilesGZ.xml index ec3e84add9..b6720f3cdb 100644 --- a/reference/phar/Phar/compressAllFilesGZ.xml +++ b/reference/phar/Phar/compressAllFilesGZ.xml @@ -1,6 +1,6 @@ - - + + Phar::compressAllFilesGZ Compresses all files in the current Phar archive using Gzip compression diff --git a/reference/phar/Phar/construct.xml b/reference/phar/Phar/construct.xml index a3f08d572e..b27026a383 100644 --- a/reference/phar/Phar/construct.xml +++ b/reference/phar/Phar/construct.xml @@ -1,6 +1,6 @@ - - + + Phar::__construct Construct a Phar archive object diff --git a/reference/phar/Phar/convertToPhar.xml b/reference/phar/Phar/convertToPhar.xml index 50281a8196..d720b454b8 100644 --- a/reference/phar/Phar/convertToPhar.xml +++ b/reference/phar/Phar/convertToPhar.xml @@ -1,6 +1,6 @@ - - + + Phar::convertToPhar Convert the phar archive to the phar file format, optionally compressing the entire archive using gzip or bzip2 compression diff --git a/reference/phar/Phar/convertToTar.xml b/reference/phar/Phar/convertToTar.xml index b027d91ce3..c0133d5118 100644 --- a/reference/phar/Phar/convertToTar.xml +++ b/reference/phar/Phar/convertToTar.xml @@ -1,6 +1,6 @@ - - + + Phar::convertToTar Convert the phar archive to the tar file format, optionally compressing the entire archive using gzip or bzip2 compression diff --git a/reference/phar/Phar/convertToZip.xml b/reference/phar/Phar/convertToZip.xml index 937569da4b..c816793d28 100644 --- a/reference/phar/Phar/convertToZip.xml +++ b/reference/phar/Phar/convertToZip.xml @@ -1,6 +1,6 @@ - - + + Phar::convertToZip Convert the phar archive to the zip file format diff --git a/reference/phar/Phar/copy.xml b/reference/phar/Phar/copy.xml index 3d2e0234fb..241325339f 100644 --- a/reference/phar/Phar/copy.xml +++ b/reference/phar/Phar/copy.xml @@ -1,6 +1,6 @@ - - + + Phar::copy Copy a file internal to the phar archive to another new file within the phar diff --git a/reference/phar/Phar/count.xml b/reference/phar/Phar/count.xml index 8ea9a2e3e6..bc9635e75f 100644 --- a/reference/phar/Phar/count.xml +++ b/reference/phar/Phar/count.xml @@ -1,6 +1,6 @@ - - + + Phar::count Returns the number of entries (files) in the Phar archive diff --git a/reference/phar/Phar/createDefaultStub.xml b/reference/phar/Phar/createDefaultStub.xml index bcd374c3b3..157d50422e 100644 --- a/reference/phar/Phar/createDefaultStub.xml +++ b/reference/phar/Phar/createDefaultStub.xml @@ -1,6 +1,6 @@ - - + + Phar::createDefaultStub Return the PHP loader or bootstrap stub of a Phar archive diff --git a/reference/phar/Phar/delMetadata.xml b/reference/phar/Phar/delMetadata.xml index b020875a41..71f73222e7 100644 --- a/reference/phar/Phar/delMetadata.xml +++ b/reference/phar/Phar/delMetadata.xml @@ -1,6 +1,6 @@ - - + + Phar::delMetadata Deletes the global metadata of the phar diff --git a/reference/phar/Phar/getMetadata.xml b/reference/phar/Phar/getMetadata.xml index 87b66863dc..67aa148d95 100644 --- a/reference/phar/Phar/getMetadata.xml +++ b/reference/phar/Phar/getMetadata.xml @@ -1,6 +1,6 @@ - - + + Phar::getMetaData Returns phar archive meta-data diff --git a/reference/phar/Phar/getModified.xml b/reference/phar/Phar/getModified.xml index 3d73856e89..c83f6e51b0 100644 --- a/reference/phar/Phar/getModified.xml +++ b/reference/phar/Phar/getModified.xml @@ -1,6 +1,6 @@ - - + + Phar::getModified Return whether phar was modified diff --git a/reference/phar/Phar/getSignature.xml b/reference/phar/Phar/getSignature.xml index 9416499715..d1e8c76e8f 100644 --- a/reference/phar/Phar/getSignature.xml +++ b/reference/phar/Phar/getSignature.xml @@ -1,6 +1,6 @@ - - + + Phar::getSignature Return MD5/SHA1/SHA256/SHA512 signature of a Phar archive diff --git a/reference/phar/Phar/getStub.xml b/reference/phar/Phar/getStub.xml index d183e164eb..836216e52c 100644 --- a/reference/phar/Phar/getStub.xml +++ b/reference/phar/Phar/getStub.xml @@ -1,6 +1,6 @@ - - + + Phar::getStub Return the PHP loader or bootstrap stub of a Phar archive diff --git a/reference/phar/Phar/getSupportedCompression.xml b/reference/phar/Phar/getSupportedCompression.xml index 0b49aa61e4..a76fcfedc1 100644 --- a/reference/phar/Phar/getSupportedCompression.xml +++ b/reference/phar/Phar/getSupportedCompression.xml @@ -1,6 +1,6 @@ - - + + Phar::getSupportedCompression Return array of supported compression algorithms diff --git a/reference/phar/Phar/getSupportedSignatures.xml b/reference/phar/Phar/getSupportedSignatures.xml index 2ebf4499f1..4cd8ad80d1 100644 --- a/reference/phar/Phar/getSupportedSignatures.xml +++ b/reference/phar/Phar/getSupportedSignatures.xml @@ -1,6 +1,6 @@ - - + + Phar::getSupportedSignatures Return array of supported signature types diff --git a/reference/phar/Phar/getVersion.xml b/reference/phar/Phar/getVersion.xml index b2a2cf2cd9..da7059c1e2 100644 --- a/reference/phar/Phar/getVersion.xml +++ b/reference/phar/Phar/getVersion.xml @@ -1,6 +1,6 @@ - - + + Phar::getVersion Return version info of Phar archive diff --git a/reference/phar/Phar/hasMetadata.xml b/reference/phar/Phar/hasMetadata.xml index 889ecca633..cc7179695c 100644 --- a/reference/phar/Phar/hasMetadata.xml +++ b/reference/phar/Phar/hasMetadata.xml @@ -1,6 +1,6 @@ - - + + Phar::hasMetaData Returns whether phar has global meta-data diff --git a/reference/phar/Phar/interceptFileFuncs.xml b/reference/phar/Phar/interceptFileFuncs.xml index b364ea22a7..72a664115b 100644 --- a/reference/phar/Phar/interceptFileFuncs.xml +++ b/reference/phar/Phar/interceptFileFuncs.xml @@ -1,6 +1,6 @@ - - + + Phar::interceptFileFuncs instructs phar to intercept fopen, file_get_contents, opendir, and all of the stat-related functions diff --git a/reference/phar/Phar/isBuffering.xml b/reference/phar/Phar/isBuffering.xml index d239dd7322..2a36a5ee19 100644 --- a/reference/phar/Phar/isBuffering.xml +++ b/reference/phar/Phar/isBuffering.xml @@ -1,6 +1,6 @@ - - + + Phar::isBuffering Used to determine whether Phar write operations are being buffered, or are flushing directly to disk diff --git a/reference/phar/Phar/isCompressed.xml b/reference/phar/Phar/isCompressed.xml index bccbb67d22..a7d9c717e4 100644 --- a/reference/phar/Phar/isCompressed.xml +++ b/reference/phar/Phar/isCompressed.xml @@ -1,6 +1,6 @@ - - + + Phar::isCompressed Returns Phar::GZ or PHAR::BZ2 if the entire phar archive is compressed (.tar.gz/tar.bz and so on) diff --git a/reference/phar/Phar/isPhar.xml b/reference/phar/Phar/isPhar.xml index 64f10ccbcf..a13ef37904 100644 --- a/reference/phar/Phar/isPhar.xml +++ b/reference/phar/Phar/isPhar.xml @@ -1,6 +1,6 @@ - - + + Phar::isPhar Returns true if the phar archive is based on the phar file format diff --git a/reference/phar/Phar/isTar.xml b/reference/phar/Phar/isTar.xml index 4bb0f8734b..c38ce747d0 100644 --- a/reference/phar/Phar/isTar.xml +++ b/reference/phar/Phar/isTar.xml @@ -1,6 +1,6 @@ - - + + Phar::isTar Returns true if the phar archive is based on the tar file format diff --git a/reference/phar/Phar/isValidPharFilename.xml b/reference/phar/Phar/isValidPharFilename.xml index 49cb16dc36..90a4718fb7 100644 --- a/reference/phar/Phar/isValidPharFilename.xml +++ b/reference/phar/Phar/isValidPharFilename.xml @@ -1,6 +1,6 @@ - - + + Phar::isValidPharFilename Returns whether the given filename is a valid phar filename diff --git a/reference/phar/Phar/isZip.xml b/reference/phar/Phar/isZip.xml index 5e0a6e4861..7030472297 100644 --- a/reference/phar/Phar/isZip.xml +++ b/reference/phar/Phar/isZip.xml @@ -1,6 +1,6 @@ - - + + Phar::isZip Returns true if the phar archive is based on the Zip file format diff --git a/reference/phar/Phar/loadPhar.xml b/reference/phar/Phar/loadPhar.xml index 10f7301745..a1c0a2fc57 100644 --- a/reference/phar/Phar/loadPhar.xml +++ b/reference/phar/Phar/loadPhar.xml @@ -1,6 +1,6 @@ - - + + Phar::loadPhar Loads any phar archive with an alias diff --git a/reference/phar/Phar/mapPhar.xml b/reference/phar/Phar/mapPhar.xml index 9f3b011815..fb5ef075e3 100644 --- a/reference/phar/Phar/mapPhar.xml +++ b/reference/phar/Phar/mapPhar.xml @@ -1,6 +1,6 @@ - - + + Phar::mapPhar Reads the currently executed file (a phar) and registers its manifest @@ -28,7 +28,8 @@ alias - The alias with which this phar should be referred to. + The alias that can be used in phar:// URLs to + refer to this archive, rather than its full path. @@ -36,6 +37,7 @@ dataoffset + Unused variable, here for compatibility with PEAR's PHP_Archive. diff --git a/reference/phar/Phar/mungServer.xml b/reference/phar/Phar/mungServer.xml index b46d4e11db..03a31df09e 100644 --- a/reference/phar/Phar/mungServer.xml +++ b/reference/phar/Phar/mungServer.xml @@ -1,6 +1,6 @@ - - + + Phar::mungServer Defines a list of up to 4 $_SERVER variables that should be modified for execution diff --git a/reference/phar/Phar/offsetExists.xml b/reference/phar/Phar/offsetExists.xml index 32811b29f1..108d2e4e52 100644 --- a/reference/phar/Phar/offsetExists.xml +++ b/reference/phar/Phar/offsetExists.xml @@ -1,6 +1,6 @@ - - + + Phar::offsetExists determines whether a file exists in the phar diff --git a/reference/phar/Phar/offsetGet.xml b/reference/phar/Phar/offsetGet.xml index 30d4ae7207..d5b2b6426d 100644 --- a/reference/phar/Phar/offsetGet.xml +++ b/reference/phar/Phar/offsetGet.xml @@ -1,6 +1,6 @@ - - + + Phar::offsetGet get a PharFileInfo object for a specific file diff --git a/reference/phar/Phar/offsetSet.xml b/reference/phar/Phar/offsetSet.xml index 0c171b5f65..fcee17872a 100644 --- a/reference/phar/Phar/offsetSet.xml +++ b/reference/phar/Phar/offsetSet.xml @@ -1,6 +1,6 @@ - - + + Phar::offsetSet set the contents of an internal file to those of an external file diff --git a/reference/phar/Phar/offsetUnset.xml b/reference/phar/Phar/offsetUnset.xml index c8bee88e54..1c27bce39e 100644 --- a/reference/phar/Phar/offsetUnset.xml +++ b/reference/phar/Phar/offsetUnset.xml @@ -1,6 +1,6 @@ - - + + Phar::offsetUnset remove a file from a phar diff --git a/reference/phar/Phar/setAlias.xml b/reference/phar/Phar/setAlias.xml index 85f596a3f3..3f2da045ca 100644 --- a/reference/phar/Phar/setAlias.xml +++ b/reference/phar/Phar/setAlias.xml @@ -1,6 +1,6 @@ - - + + Phar::setAlias Set the alias for the Phar archive diff --git a/reference/phar/Phar/setMetadata.xml b/reference/phar/Phar/setMetadata.xml index 135e77ae40..cff547c58a 100644 --- a/reference/phar/Phar/setMetadata.xml +++ b/reference/phar/Phar/setMetadata.xml @@ -1,6 +1,6 @@ - - + + Phar::setMetadata Sets phar archive meta-data diff --git a/reference/phar/Phar/setSignatureAlgorithm.xml b/reference/phar/Phar/setSignatureAlgorithm.xml index fbae10c886..069f46f89d 100644 --- a/reference/phar/Phar/setSignatureAlgorithm.xml +++ b/reference/phar/Phar/setSignatureAlgorithm.xml @@ -1,6 +1,6 @@ - - + + Phar::setSignatureAlgorithm set the signature algorithm for a phar and apply it. The diff --git a/reference/phar/Phar/setStub.xml b/reference/phar/Phar/setStub.xml index d5f6a881ec..f9cf913e0f 100644 --- a/reference/phar/Phar/setStub.xml +++ b/reference/phar/Phar/setStub.xml @@ -1,6 +1,6 @@ - - + + Phar::setStub Used to set the PHP loader or bootstrap stub of a Phar archive diff --git a/reference/phar/Phar/startBuffering.xml b/reference/phar/Phar/startBuffering.xml index fb57359848..c624e0966b 100644 --- a/reference/phar/Phar/startBuffering.xml +++ b/reference/phar/Phar/startBuffering.xml @@ -1,6 +1,6 @@ - - + + Phar::startBuffering Start buffering Phar write operations, do not modify the Phar object on disk diff --git a/reference/phar/Phar/stopBuffering.xml b/reference/phar/Phar/stopBuffering.xml index 6eb107824f..bc997b8e02 100644 --- a/reference/phar/Phar/stopBuffering.xml +++ b/reference/phar/Phar/stopBuffering.xml @@ -1,6 +1,6 @@ - - + + Phar::stopBuffering Stop buffering write requests to the Phar archive, and save changes to disk diff --git a/reference/phar/Phar/uncompressAllFiles.xml b/reference/phar/Phar/uncompressAllFiles.xml index 8e9bc87563..d342d1c4a4 100644 --- a/reference/phar/Phar/uncompressAllFiles.xml +++ b/reference/phar/Phar/uncompressAllFiles.xml @@ -1,6 +1,6 @@ - - + + Phar::uncompressAllFiles Uncompresses all files in the current Phar archive diff --git a/reference/phar/Phar/webPhar.xml b/reference/phar/Phar/webPhar.xml index 7670475903..2aeac0ad37 100644 --- a/reference/phar/Phar/webPhar.xml +++ b/reference/phar/Phar/webPhar.xml @@ -1,9 +1,9 @@ - - + + Phar::webPhar - mapPhar for web-based phars. Reads the currently executed file (a phar) + mapPhar for web-based phars. front controller for web applications @@ -16,9 +16,20 @@ arraymimetypes arrayrewrites - &warn.undocumented.func; - mapPhar for web-based phars. Reads the currently executed file (a phar) + Phar::mapPhar for web-based phars. This method parses + $_SERVER['REQUEST_URI'] and routes a request from a web + browser to an internal file within the phar archive. In essence, it simulates + a web server, routing requests to the correct file, echoing the correct headers + and parsing PHP files as needed. This powerful method is part of what makes it easy + to convert an existing PHP application into a phar archive. Combined with + Phar::mungServer and Phar::interceptFileFuncs, + any web application can be used unmodified from a phar archive. + + + Phar::webPhar should only be + called from the stub of a phar archive (see here + for more information on what a stub is). @@ -30,6 +41,8 @@ alias + The alias that can be used in phar:// URLs to + refer to this archive, rather than its full path. @@ -37,6 +50,8 @@ index + The location within the phar of the directory index, defaults to + index.php. @@ -44,6 +59,8 @@ f404 + The location of the script to run when a file is not found. This + script should output the proper HTTP 404 headers. @@ -51,6 +68,54 @@ mimetypes + An array mapping additional file extensions to MIME type. By default, + these extensions are mapped to these mime types: + + 2, // pass to highlight_file() + 'c' => 'text/plain', + 'cc' => 'text/plain', + 'cpp' => 'text/plain', + 'c++' => 'text/plain', + 'dtd' => 'text/plain', + 'h' => 'text/plain', + 'log' => 'text/plain', + 'rng' => 'text/plain', + 'txt' => 'text/plain', + 'xsd' => 'text/plain', + 'php' => 1, // parse as PHP + 'inc' => 1, // parse as PHP + 'avi' => 'video/avi', + 'bmp' => 'image/bmp', + 'css' => 'text/css', + 'gif' => 'image/gif', + 'htm' => 'text/html', + 'html' => 'text/html', + 'htmls' => 'text/html', + 'ico' => 'image/x-ico', + 'jpe' => 'image/jpeg', + 'jpg' => 'image/jpeg', + 'jpeg' => 'image/jpeg', + 'js' => 'application/x-javascript', + 'midi' => 'audio/midi', + 'mid' => 'audio/midi', + 'mod' => 'audio/mod', + 'mov' => 'movie/quicktime', + 'mp3' => 'audio/mp3', + 'mpg' => 'video/mpeg', + 'mpeg' => 'video/mpeg', + 'pdf' => 'application/pdf', + 'png' => 'image/png', + 'swf' => 'application/shockwave-flash', + 'tif' => 'image/tiff', + 'tiff' => 'image/tiff', + 'wav' => 'audio/wav', + 'xbm' => 'image/xbm', + 'xml' => 'text/xml', +); + ]]> + @@ -58,6 +123,19 @@ rewrites + An array mapping URI to internal file, simulating mod_rewrite of apache. + For example: + + 'myinfo.php' +); + ]]> + + would route calls to http://<host>/myphar.phar/myinfo + to the file phar:///path/to/myphar.phar/myinfo.php, preserving + GET/POST. This does not quite work like mod_rewrite in that it would not + match http://<host>/myphar.phar/myinfo/another. @@ -68,84 +146,63 @@ &reftitle.returnvalues; + No return values - - - - - diff --git a/reference/phar/PharFileInfo/chmod.xml b/reference/phar/PharFileInfo/chmod.xml index 88b58b4b42..c61e923f1b 100644 --- a/reference/phar/PharFileInfo/chmod.xml +++ b/reference/phar/PharFileInfo/chmod.xml @@ -1,6 +1,6 @@ - - + + PharFileInfo::chmod Sets file-specific permission bits diff --git a/reference/phar/PharFileInfo/construct.xml b/reference/phar/PharFileInfo/construct.xml index ad2d88aeac..18e5a2ca01 100644 --- a/reference/phar/PharFileInfo/construct.xml +++ b/reference/phar/PharFileInfo/construct.xml @@ -1,6 +1,6 @@ - - + + PharFileInfo::__construct Construct a Phar entry object diff --git a/reference/phar/PharFileInfo/delMetadata.xml b/reference/phar/PharFileInfo/delMetadata.xml index 05e9a4eebe..cc79059c39 100644 --- a/reference/phar/PharFileInfo/delMetadata.xml +++ b/reference/phar/PharFileInfo/delMetadata.xml @@ -1,6 +1,6 @@ - - + + PharFileInfo::delMetadata Deletes the metadata of the entry diff --git a/reference/phar/PharFileInfo/getCRC32.xml b/reference/phar/PharFileInfo/getCRC32.xml index 5040f0985b..17f6501e94 100644 --- a/reference/phar/PharFileInfo/getCRC32.xml +++ b/reference/phar/PharFileInfo/getCRC32.xml @@ -1,6 +1,6 @@ - - + + PharFileInfo::getCRC32 Returns CRC32 code or throws an exception if CRC has not been verified diff --git a/reference/phar/PharFileInfo/getCompressedSize.xml b/reference/phar/PharFileInfo/getCompressedSize.xml index caf203ef08..aa7c419289 100644 --- a/reference/phar/PharFileInfo/getCompressedSize.xml +++ b/reference/phar/PharFileInfo/getCompressedSize.xml @@ -1,6 +1,6 @@ - - + + PharFileInfo::getCompressedSize Returns the actual size of the file (with compression) inside the Phar archive diff --git a/reference/phar/PharFileInfo/getMetadata.xml b/reference/phar/PharFileInfo/getMetadata.xml index 6e90e02257..a67456d6fc 100644 --- a/reference/phar/PharFileInfo/getMetadata.xml +++ b/reference/phar/PharFileInfo/getMetadata.xml @@ -1,6 +1,6 @@ - - + + PharFileInfo::getMetaData Returns file-specific meta-data saved with a file diff --git a/reference/phar/PharFileInfo/getPharFlags.xml b/reference/phar/PharFileInfo/getPharFlags.xml index 64bb8a75c8..597de36245 100644 --- a/reference/phar/PharFileInfo/getPharFlags.xml +++ b/reference/phar/PharFileInfo/getPharFlags.xml @@ -1,6 +1,6 @@ - - + + PharFileInfo::getPharFlags Returns the Phar file entry flags diff --git a/reference/phar/PharFileInfo/hasMetadata.xml b/reference/phar/PharFileInfo/hasMetadata.xml index ddc091c7d6..c61f51d3c7 100644 --- a/reference/phar/PharFileInfo/hasMetadata.xml +++ b/reference/phar/PharFileInfo/hasMetadata.xml @@ -1,6 +1,6 @@ - - + + PharFileInfo::hasMetadata Returns the metadata of the entry diff --git a/reference/phar/PharFileInfo/isCRCChecked.xml b/reference/phar/PharFileInfo/isCRCChecked.xml index 09b1fc8e5a..e4686ad143 100644 --- a/reference/phar/PharFileInfo/isCRCChecked.xml +++ b/reference/phar/PharFileInfo/isCRCChecked.xml @@ -1,6 +1,6 @@ - - + + PharFileInfo::isCRCChecked Returns whether file entry has had its CRC verified diff --git a/reference/phar/PharFileInfo/isCompressed.xml b/reference/phar/PharFileInfo/isCompressed.xml index 1b073fa1fc..406c2b02eb 100644 --- a/reference/phar/PharFileInfo/isCompressed.xml +++ b/reference/phar/PharFileInfo/isCompressed.xml @@ -1,6 +1,6 @@ - - + + PharFileInfo::isCompressed Returns whether the entry is compressed diff --git a/reference/phar/PharFileInfo/isCompressedBZIP2.xml b/reference/phar/PharFileInfo/isCompressedBZIP2.xml index e2a2defccd..534ae1e30f 100644 --- a/reference/phar/PharFileInfo/isCompressedBZIP2.xml +++ b/reference/phar/PharFileInfo/isCompressedBZIP2.xml @@ -1,6 +1,6 @@ - - + + PharFileInfo::isCompressedBZIP2 Returns whether the entry is compressed using bzip2 diff --git a/reference/phar/PharFileInfo/isCompressedGZ.xml b/reference/phar/PharFileInfo/isCompressedGZ.xml index abc4d42afe..003b7b15d5 100644 --- a/reference/phar/PharFileInfo/isCompressedGZ.xml +++ b/reference/phar/PharFileInfo/isCompressedGZ.xml @@ -1,6 +1,6 @@ - - + + PharFileInfo::isCompressedGZ Returns whether the entry is compressed using gz diff --git a/reference/phar/PharFileInfo/setCompressedBZIP2.xml b/reference/phar/PharFileInfo/setCompressedBZIP2.xml index 89e414a91b..97a3efbc57 100644 --- a/reference/phar/PharFileInfo/setCompressedBZIP2.xml +++ b/reference/phar/PharFileInfo/setCompressedBZIP2.xml @@ -1,6 +1,6 @@ - - + + PharFileInfo::setCompressedBZIP2 Compresses the current Phar entry within the phar using Bzip2 compression diff --git a/reference/phar/PharFileInfo/setCompressedGZ.xml b/reference/phar/PharFileInfo/setCompressedGZ.xml index bdd57089ee..eb106b3e4a 100644 --- a/reference/phar/PharFileInfo/setCompressedGZ.xml +++ b/reference/phar/PharFileInfo/setCompressedGZ.xml @@ -1,6 +1,6 @@ - - + + PharFileInfo::setCompressedGZ Compresses the current Phar entry within the phar using gz compression diff --git a/reference/phar/PharFileInfo/setMetadata.xml b/reference/phar/PharFileInfo/setMetadata.xml index f477366b0c..0619945594 100644 --- a/reference/phar/PharFileInfo/setMetadata.xml +++ b/reference/phar/PharFileInfo/setMetadata.xml @@ -1,6 +1,6 @@ - - + + PharFileInfo::setMetaData Sets file-specific meta-data saved with a file diff --git a/reference/phar/PharFileInfo/setUncompressed.xml b/reference/phar/PharFileInfo/setUncompressed.xml index 3e3496bc49..ce63b253a0 100644 --- a/reference/phar/PharFileInfo/setUncompressed.xml +++ b/reference/phar/PharFileInfo/setUncompressed.xml @@ -1,6 +1,6 @@ - - + + PharFileInfo::setUncompressed Uncompresses the current Phar entry within the phar, if it is compressed diff --git a/reference/phar/creating.xml b/reference/phar/creating.xml index 7e4787c352..85300ebece 100644 --- a/reference/phar/creating.xml +++ b/reference/phar/creating.xml @@ -1,9 +1,9 @@ - + Creating Phar Archives -
+
Creating Phar Archives: Introduction To be written fully in the near future. Before reading this, be sure to read diff --git a/reference/phar/fileformat.xml b/reference/phar/fileformat.xml index 9a4dadd610..1a9d44a5d7 100644 --- a/reference/phar/fileformat.xml +++ b/reference/phar/fileformat.xml @@ -1,8 +1,8 @@ - + What makes a phar a phar and not a tar or a zip? -
+
Ingredients of all Phar archives, independent of file format All Phar archives contain three to four sections: @@ -22,7 +22,7 @@
-
+
Phar file stub A Phar's stub is a simple PHP file. The smallest possible stub follows: @@ -67,7 +67,7 @@ __HALT_COMPILER(); .phar/alias.txt file as plain text.
-
+
Head-to-head comparison of Phar, Tar and Zip What are the good and the bad things about the three supported file formats in @@ -173,7 +173,7 @@ __HALT_COMPILER();
-
+
Tar-based phars Archives based on the tar file format follow the more modern USTAR @@ -190,7 +190,7 @@ __HALT_COMPILER(); archive, use Phar::uncompressAllFiles
-
+
Zip-based phars Archives based on the zip file format support several features built into @@ -203,7 +203,7 @@ __HALT_COMPILER(); as files with a trailing slash like my/directory/
-
+
Phar File Format The phar file format is literally laid out as stub/manifest/contents/signature, and @@ -277,7 +277,7 @@ __HALT_COMPILER();
-
+
Global Phar bitmapped flags Here are the bitmapped flags currently recognized by the Phar extension @@ -317,7 +317,7 @@ __HALT_COMPILER();
-
+
Phar manifest file entry definition Each file in the manifest contains the following information: @@ -416,7 +416,7 @@ __HALT_COMPILER();
-
+
Phar Signature format Phars containing a signature always have the signature appended to the diff --git a/reference/phar/using.xml b/reference/phar/using.xml index 45e8184ae9..8a487521d9 100644 --- a/reference/phar/using.xml +++ b/reference/phar/using.xml @@ -1,9 +1,9 @@ - + Using Phar Archives -
+
Using Phar Archives: Introduction Phar archives are similar in concept to Java JAR archives, but are @@ -182,7 +182,7 @@ $a->stopBuffering();
-
+
Using Phar Archives: the phar stream wrapper The Phar stream wrapper fully supports fopen for