From 5095f84b7daf4e35f4fe8b40b79acb4656daa912 Mon Sep 17 00:00:00 2001 From: Greg Beaver Date: Fri, 2 May 2008 05:14:02 +0000 Subject: [PATCH] update docs to reflect phar refactoring of isTar/isZip/isPhar to isFileFormat git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@258892 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../phar/Phar/{isTar.xml => isFileFormat.xml} | 37 ++++++++--- reference/phar/Phar/isPhar.xml | 65 ------------------- reference/phar/Phar/isZip.xml | 65 ------------------- 3 files changed, 27 insertions(+), 140 deletions(-) rename reference/phar/Phar/{isTar.xml => isFileFormat.xml} (53%) delete mode 100644 reference/phar/Phar/isPhar.xml delete mode 100644 reference/phar/Phar/isZip.xml diff --git a/reference/phar/Phar/isTar.xml b/reference/phar/Phar/isFileFormat.xml similarity index 53% rename from reference/phar/Phar/isTar.xml rename to reference/phar/Phar/isFileFormat.xml index 3c71506abc..caa87c8f1f 100644 --- a/reference/phar/Phar/isTar.xml +++ b/reference/phar/Phar/isFileFormat.xml @@ -1,16 +1,16 @@ - - + + - Phar::isTar - Returns true if the phar archive is based on the tar file format + Phar::isFileFormat + Returns true if the phar archive is based on the tar/phar/zip file format depending on the parameter &reftitle.description; - boolPhar::isTar - + boolPhar::isFileFormat + intformat @@ -19,14 +19,33 @@ &reftitle.parameters; - No parameters. + + + format + + + Either Phar::PHAR, Phar::TAR, or + Phar::ZIP to test for the format of the archive. + + + + + &reftitle.returnvalues; - Returns &true; if the phar archive is based on the tar file format + Returns &true; if the phar archive matches the file format requested by the parameter + + + + + &reftitle.errors; + + PharException is thrown if the parameter is an unknown file + format specifier. @@ -34,8 +53,6 @@ &reftitle.seealso; - Phar::isPhar - Phar::isZip Phar::convertToExecutable Phar::convertToData diff --git a/reference/phar/Phar/isPhar.xml b/reference/phar/Phar/isPhar.xml deleted file mode 100644 index e4ec755357..0000000000 --- a/reference/phar/Phar/isPhar.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - Phar::isPhar - Returns true if the phar archive is based on the phar file format - - - - &reftitle.description; - - boolPhar::isPhar - - - - - - - - &reftitle.parameters; - - No parameters. - - - - - &reftitle.returnvalues; - - Returns &true; if the phar archive is based on the phar file format. - - - - &reftitle.seealso; - - - Phar::isTar - Phar::isZip - Phar::convertToExecutable - Phar::convertToData - - - - - - - diff --git a/reference/phar/Phar/isZip.xml b/reference/phar/Phar/isZip.xml deleted file mode 100644 index 62e4a3dc00..0000000000 --- a/reference/phar/Phar/isZip.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - Phar::isZip - Returns true if the phar archive is based on the Zip file format - - - - &reftitle.description; - - boolPhar::isZip - - - - - - - - &reftitle.parameters; - - No parameters. - - - - - &reftitle.returnvalues; - - Returns &true; if the phar archive is based on the Zip file format - - - - &reftitle.seealso; - - - Phar::isPhar - Phar::isTar - Phar::convertToExecutable - Phar::convertToData - - - - - - -