From 5095f84b7daf4e35f4fe8b40b79acb4656daa912 Mon Sep 17 00:00:00 2001
From: Greg Beaver <cellog@php.net>
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 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.3 $ -->
-<refentry xml:id="phar.istar" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<!-- $Revision: 1.1 $ -->
+<refentry xml:id="phar.isfileformat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
-  <refname>Phar::isTar</refname>
-  <refpurpose>Returns true if the phar archive is based on the tar file format</refpurpose>
+  <refname>Phar::isFileFormat</refname>
+  <refpurpose>Returns true if the phar archive is based on the tar/phar/zip file format depending on the parameter</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>bool</type><methodname>Phar::isTar</methodname>
-   <void/>
+   <type>bool</type><methodname>Phar::isFileFormat</methodname>
+   <methodparam><type>int</type><parameter>format</parameter></methodparam>
   </methodsynopsis>
   <para>
   </para>
@@ -19,14 +19,33 @@
  <refsect1 role="parameters">
   &reftitle.parameters;
   <para>
-   No parameters.
+   <variablelist>
+    <varlistentry>
+     <term><parameter>format</parameter></term>
+     <listitem>
+      <para>
+       Either <literal>Phar::PHAR</literal>, <literal>Phar::TAR</literal>, or
+       <literal>Phar::ZIP</literal> to test for the format of the archive.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
   </para>
 
  </refsect1>
+
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   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
+  </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   <classname>PharException</classname> is thrown if the parameter is an unknown file
+   format specifier.
   </para>
  </refsect1>
 
@@ -34,8 +53,6 @@
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><function>Phar::isPhar</function></member>
-    <member><function>Phar::isZip</function></member>
     <member><function>Phar::convertToExecutable</function></member>
     <member><function>Phar::convertToData</function></member>
    </simplelist>
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 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.3 $ -->
-<refentry xml:id="phar.isphar" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
- <refnamediv>
-  <refname>Phar::isPhar</refname>
-  <refpurpose>Returns true if the phar archive is based on the phar file format</refpurpose>
- </refnamediv>
-
- <refsect1 role="description">
-  &reftitle.description;
-  <methodsynopsis>
-   <type>bool</type><methodname>Phar::isPhar</methodname>
-   <void/>
-  </methodsynopsis>
-  <para>
-  </para>
- </refsect1>
-
- <refsect1 role="parameters">
-  &reftitle.parameters;
-  <para>
-   No parameters.
-  </para>
-
- </refsect1>
- <refsect1 role="returnvalues">
-  &reftitle.returnvalues;
-  <para>
-   Returns &true; if the phar archive is based on the phar file format.
-  </para>
- </refsect1>
- <refsect1 role="seealso">
-  &reftitle.seealso;
-  <para>
-   <simplelist>
-    <member><function>Phar::isTar</function></member>
-    <member><function>Phar::isZip</function></member>
-    <member><function>Phar::convertToExecutable</function></member>
-    <member><function>Phar::convertToData</function></member>
-   </simplelist>
-  </para>
- </refsect1>
-
-</refentry>
-
-<!-- Keep this comment at the end of the file
-Local variables:
-mode: sgml
-sgml-omittag:t
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-indent-tabs-mode:nil
-sgml-parent-document:nil
-sgml-default-dtd-file:"../../../../manual.ced"
-sgml-exposed-tags:nil
-sgml-local-catalogs:nil
-sgml-local-ecat-files:nil
-End:
-vim600: syn=xml fen fdm=syntax fdl=2 si
-vim: et tw=78 syn=sgml
-vi: ts=1 sw=1
--->
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 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.3 $ -->
-<refentry xml:id="phar.iszip" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
- <refnamediv>
-  <refname>Phar::isZip</refname>
-  <refpurpose>Returns true if the phar archive is based on the Zip file format</refpurpose>
- </refnamediv>
-
- <refsect1 role="description">
-  &reftitle.description;
-  <methodsynopsis>
-   <type>bool</type><methodname>Phar::isZip</methodname>
-   <void/>
-  </methodsynopsis>
-  <para>
-  </para>
- </refsect1>
-
- <refsect1 role="parameters">
-  &reftitle.parameters;
-  <para>
-   No parameters.
-  </para>
-
- </refsect1>
- <refsect1 role="returnvalues">
-  &reftitle.returnvalues;
-  <para>
-   Returns &true; if the phar archive is based on the Zip file format
-  </para>
- </refsect1>
- <refsect1 role="seealso">
-  &reftitle.seealso;
-  <para>
-   <simplelist>
-    <member><function>Phar::isPhar</function></member>
-    <member><function>Phar::isTar</function></member>
-    <member><function>Phar::convertToExecutable</function></member>
-    <member><function>Phar::convertToData</function></member>
-   </simplelist>
-  </para>
- </refsect1>
-
-</refentry>
-
-<!-- Keep this comment at the end of the file
-Local variables:
-mode: sgml
-sgml-omittag:t
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-indent-tabs-mode:nil
-sgml-parent-document:nil
-sgml-default-dtd-file:"../../../../manual.ced"
-sgml-exposed-tags:nil
-sgml-local-catalogs:nil
-sgml-local-ecat-files:nil
-End:
-vim600: syn=xml fen fdm=syntax fdl=2 si
-vim: et tw=78 syn=sgml
-vi: ts=1 sw=1
--->