cvs: phpdoc /en/reference/phar/Phar isFileFormat.xml isPhar.xml isTar.xml isZip.xml

From: Date: Fri, 02 May 2008 05:14:02 +0000
Subject: cvs: phpdoc /en/reference/phar/Phar isFileFormat.xml isPhar.xml isTar.xml isZip.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-1581@lists.php.net to get a copy of this message
cellog Fri May 2 05:14:02 2008 UTC Added files: /phpdoc/en/reference/phar/Phar isFileFormat.xml Removed files: /phpdoc/en/reference/phar/Phar isPhar.xml isTar.xml isZip.xml Log: update docs to reflect phar refactoring of isTar/isZip/isPhar to isFileFormat http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/phar/Phar/isFileFormat.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/phar/Phar/isFileFormat.xml +++ phpdoc/en/reference/phar/Phar/isFileFormat.xml <?xml version="1.0" encoding="utf-8"?> <!-- $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::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::isFileFormat</methodname> <methodparam><type>int</type><parameter>format</parameter></methodparam> </methodsynopsis> <para> </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <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 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> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <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 -->

« previous php.doc.cvs (#1581) next »