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
This commit is contained in:
Greg Beaver 2008-05-02 05:14:02 +00:00
parent d328869534
commit 5095f84b7d
3 changed files with 27 additions and 140 deletions

View file

@ -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>

View file

@ -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
-->

View file

@ -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
-->