cvs: phpdoc /en/reference/zip/functions zip-close.xml zip-entry-close.xml zip-entry-compressedsize.xml zip-entry-compressionmethod.xml
zip-entry-filesize.xml zip-entry-name.xml zip-entry-open.xml zip-entry-read.xml zip-open.xml zip-read.xml
| From: | Mehdi Achour | Date: | Thu, 30 Dec 2004 23:08:25 +0000 |
| Subject: | cvs: phpdoc /en/reference/zip/functions zip-close.xml zip-entry-close.xml zip-entry-compressedsize.xml zip-entry-compressionmethod.xml zip-entry-filesize.xml zip-entry-name.xml zip-entry-open.xml zip-entry-read.xml zip-open.xml zip-read.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969365721@lists.php.net to get a copy of this message | ||
didou Thu Dec 30 18:08:25 2004 EDT
Modified files:
/phpdoc/en/reference/zip/functions zip-close.xml
zip-entry-close.xml
zip-entry-compressedsize.xml
zip-entry-compressionmethod.xml
zip-entry-filesize.xml
zip-entry-name.xml
zip-entry-open.xml
zip-entry-read.xml zip-open.xml
zip-read.xml
Log:
Switch ref.zip to the new structure
http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-close.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/zip/functions/zip-close.xml diff -u phpdoc/en/reference/zip/functions/zip-close.xml:1.4 phpdoc/en/reference/zip/functions/zip-close.xml:1.5 --- phpdoc/en/reference/zip/functions/zip-close.xml:1.4 Fri Oct 24 12:21:40 2003 +++ phpdoc/en/reference/zip/functions/zip-close.xml Thu Dec 30 18:08:25 2004 @@ -1,31 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-close"> - <refnamediv> - <refname>zip_close</refname> - <refpurpose>Close a Zip File Archive</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>void</type><methodname>zip_close</methodname> - <methodparam><type>resource</type><parameter>zip</parameter></methodparam> - </methodsynopsis> - <para> - Closes a zip file archive. The parameter - <parameter>zip</parameter> must be a zip archive previously - opened by <function>zip_open</function>. - </para> - <para> - This function has no return value. - </para> - <para> - See also <function>zip_open</function> and - <function>zip_read</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-close"> + <refnamediv> + <refname>zip_close</refname> + <refpurpose>Close a ZIP file archive</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <void /><methodname>zip_close</methodname> + <methodparam><type>resource</type><parameter>zip</parameter></methodparam> + </methodsynopsis> + <para> + Closes the given ZIP file archive. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zip</parameter></term> + <listitem> + <para> + A ZIP file previously opened with <function>zip_open</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_open</function></member> + <member><function>zip_read</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-entry-close.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/zip/functions/zip-entry-close.xml diff -u phpdoc/en/reference/zip/functions/zip-entry-close.xml:1.4 phpdoc/en/reference/zip/functions/zip-entry-close.xml:1.5 --- phpdoc/en/reference/zip/functions/zip-entry-close.xml:1.4 Fri Oct 24 12:21:40 2003 +++ phpdoc/en/reference/zip/functions/zip-entry-close.xml Thu Dec 30 18:08:25 2004 @@ -1,32 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-entry-close"> - <refnamediv> - <refname>zip_entry_close</refname> - <refpurpose>Close a Directory Entry</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>void</type><methodname>zip_entry_close</methodname> - <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> - </methodsynopsis> - <para> - Closes a directory entry specified by - <parameter>zip_entry</parameter>. The parameter - <parameter>zip_entry</parameter> must be a valid directory entry - opened by <function>zip_entry_open</function>. - </para> - <para> - This function has no return value. - </para> - <para> - See also <function>zip_entry_open</function> and - <function>zip_entry_read</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-entry-close"> + <refnamediv> + <refname>zip_entry_close</refname> + <refpurpose>Close a directory entry</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <void /><methodname>zip_entry_close</methodname> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + </methodsynopsis> + <para> + Closes the specified directory entry. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zip_entry</parameter></term> + <listitem> + <para> + A directory entry previously opened <function>zip_entry_open</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_entry_open</function></member> + <member><function>zip_entry_read</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-entry-compressedsize.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/zip/functions/zip-entry-compressedsize.xml diff -u phpdoc/en/reference/zip/functions/zip-entry-compressedsize.xml:1.2 phpdoc/en/reference/zip/functions/zip-entry-compressedsize.xml:1.3 --- phpdoc/en/reference/zip/functions/zip-entry-compressedsize.xml:1.2 Wed Apr 17 02:45:29 2002 +++ phpdoc/en/reference/zip/functions/zip-entry-compressedsize.xml Thu Dec 30 18:08:25 2004 @@ -1,29 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-entry-compressedsize"> - <refnamediv> - <refname>zip_entry_compressedsize</refname> - <refpurpose>Retrieve the Compressed Size of a Directory Entry</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>zip_entry_compressedsize</methodname> - <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> - </methodsynopsis> - <para> - Returns the compressed size of the directory entry specified by - <parameter>zip_entry</parameter>. The parameter - <parameter>zip_entry</parameter> is a valid directory entry - returned by <function>zip_read</function>. - </para> - <para> - See also <function>zip_open</function> and - <function>zip_read</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-entry-compressedsize"> + <refnamediv> + <refname>zip_entry_compressedsize</refname> + <refpurpose>Retrieve the compressed size of a directory entry</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>int</type><methodname>zip_entry_compressedsize</methodname> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + </methodsynopsis> + <para> + Returns the compressed size of the specified directory entry. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zip_entry</parameter></term> + <listitem> + <para> + A directory entry returned by <function>zip_read</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The compressed size. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_open</function></member> + <member><function>zip_read</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-entry-compressionmethod.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/zip/functions/zip-entry-compressionmethod.xml diff -u phpdoc/en/reference/zip/functions/zip-entry-compressionmethod.xml:1.2 phpdoc/en/reference/zip/functions/zip-entry-compressionmethod.xml:1.3 --- phpdoc/en/reference/zip/functions/zip-entry-compressionmethod.xml:1.2 Wed Apr 17 02:45:29 2002 +++ phpdoc/en/reference/zip/functions/zip-entry-compressionmethod.xml Thu Dec 30 18:08:25 2004 @@ -1,29 +1,53 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-entry-compressionmethod"> - <refnamediv> - <refname>zip_entry_compressionmethod</refname> - <refpurpose>Retrieve the Compression Method of a Directory Entry</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>zip_entry_compressionmethod</methodname> - <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> - </methodsynopsis> - <para> - Returns the compression method of the directory entry specified - by <parameter>zip_entry</parameter>. The parameter - <parameter>zip_entry</parameter> is a valid directory entry - returned by <function>zip_read</function>. - </para> - <para> - See also <function>zip_open</function> and - <function>zip_read</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-entry-compressionmethod"> + <refnamediv> + <refname>zip_entry_compressionmethod</refname> + <refpurpose>Retrieve the compression method of a directory entry</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>zip_entry_compressionmethod</methodname> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + </methodsynopsis> + <para> + Returns the compression method of the directory entry specified + by <parameter>zip_entry</parameter>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zip_entry</parameter></term> + <listitem> + <para> + A directory entry returned by <function>zip_read</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The compression method. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_open</function></member> + <member><function>zip_read</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-entry-filesize.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/zip/functions/zip-entry-filesize.xml diff -u phpdoc/en/reference/zip/functions/zip-entry-filesize.xml:1.2 phpdoc/en/reference/zip/functions/zip-entry-filesize.xml:1.3 --- phpdoc/en/reference/zip/functions/zip-entry-filesize.xml:1.2 Wed Apr 17 02:45:29 2002 +++ phpdoc/en/reference/zip/functions/zip-entry-filesize.xml Thu Dec 30 18:08:25 2004 @@ -1,29 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-entry-filesize"> - <refnamediv> - <refname>zip_entry_filesize</refname> - <refpurpose>Retrieve the Actual File Size of a Directory Entry</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>zip_entry_filesize</methodname> - <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> - </methodsynopsis> - <para> - Returns the actual size of the directory entry specified by - <parameter>zip_entry</parameter>. The parameter - <parameter>zip_entry</parameter> is a valid directory entry - returned by <function>zip_read</function>. - </para> - <para> - See also <function>zip_open</function> and - <function>zip_read</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-entry-filesize"> + <refnamediv> + <refname>zip_entry_filesize</refname> + <refpurpose>Retrieve the actual file size of a directory entry</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>int</type><methodname>zip_entry_filesize</methodname> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + </methodsynopsis> + <para> + Returns the actual size of the specified directory entry. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zip_entry</parameter></term> + <listitem> + <para> + A directory entry returned by <function>zip_read</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The size of the directory entry. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_open</function></member> + <member><function>zip_read</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-entry-name.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/zip/functions/zip-entry-name.xml diff -u phpdoc/en/reference/zip/functions/zip-entry-name.xml:1.2 phpdoc/en/reference/zip/functions/zip-entry-name.xml:1.3 --- phpdoc/en/reference/zip/functions/zip-entry-name.xml:1.2 Wed Apr 17 02:45:29 2002 +++ phpdoc/en/reference/zip/functions/zip-entry-name.xml Thu Dec 30 18:08:25 2004 @@ -1,29 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-entry-name"> - <refnamediv> - <refname>zip_entry_name</refname> - <refpurpose>Retrieve the Name of a Directory Entry</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>zip_entry_name</methodname> - <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> - </methodsynopsis> - <para> - Returns the name of the directory entry specified by - <parameter>zip_entry</parameter>. The parameter - <parameter>zip_entry</parameter> is a valid directory entry - returned by <function>zip_read</function>. - </para> - <para> - See also <function>zip_open</function> and - <function>zip_read</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-entry-name"> + <refnamediv> + <refname>zip_entry_name</refname> + <refpurpose>Retrieve the name of a directory entry</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>zip_entry_name</methodname> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + </methodsynopsis> + <para> + Returns the name of the specified directory entry. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zip_entry</parameter></term> + <listitem> + <para> + A directory entry returned by <function>zip_read</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The name of the directory entry. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_open</function></member> + <member><function>zip_read</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-entry-open.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/zip/functions/zip-entry-open.xml diff -u phpdoc/en/reference/zip/functions/zip-entry-open.xml:1.3 phpdoc/en/reference/zip/functions/zip-entry-open.xml:1.4 --- phpdoc/en/reference/zip/functions/zip-entry-open.xml:1.3 Tue Sep 30 04:33:47 2003 +++ phpdoc/en/reference/zip/functions/zip-entry-open.xml Thu Dec 30 18:08:25 2004 @@ -1,54 +1,86 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-entry-open"> - <refnamediv> - <refname>zip_entry_open</refname> - <refpurpose>Open a Directory Entry for Reading</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>zip_entry_open</methodname> - <methodparam><type>resource</type><parameter>zip</parameter></methodparam> - <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>mode</parameter></methodparam> - </methodsynopsis> - <para> - Opens a directory entry in a zip file for reading. The parameter - <parameter>zip</parameter> is a valid resource handle returned by - <function>zip_open</function>. The parameter - <parameter>zip_entry</parameter> is a directory entry resource - returned by <function>zip_read</function>. The optional - parameter <parameter>mode</parameter> can be any of the modes - specified in the documentation for <function>fopen</function>. - </para> - <note> - <para> - Currently, <parameter>mode</parameter> is ignored and is always - <literal>"rb"</literal>. This is due to the fact that zip - support in PHP is read only access. Please see - <function>fopen</function> for an explanation of various modes, - including <literal>"rb"</literal>. - </para> - </note> - <para> - &return.success; - </para> - <note> - <para> - Unlike <function>fopen</function> and other similar functions, - the return value of <function>zip_entry_open</function> only - indicates the result of the operation and is not needed for - reading or closing the directory entry. - </para> - </note> - <para> - See also <function>zip_entry_read</function> and - <function>zip_entry_close</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-entry-open"> + <refnamediv> + <refname>zip_entry_open</refname> + <refpurpose>Open a directory entry for reading</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>zip_entry_open</methodname> + <methodparam><type>resource</type><parameter>zip</parameter></methodparam> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>mode</parameter></methodparam> + </methodsynopsis> + <para> + Opens a directory entry in a zip file for reading. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zip</parameter></term> + <listitem> + <para> + A valid resource handle returned by <function>zip_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>zip_entry</parameter></term> + <listitem> + <para> + A directory entry returned by <function>zip_read</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + Any of the modes specified in the documentation of + <function>fopen</function>. + </para> + <note> + <para> + Currently, <parameter>mode</parameter> is ignored and is always + <literal>"rb"</literal>. This is due to the fact that zip support + in PHP is read only access. + </para> + </note> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + <note> + <para> + Unlike <function>fopen</function> and other similar functions, + the return value of <function>zip_entry_open</function> only + indicates the result of the operation and is not needed for + reading or closing the directory entry. + </para> + </note> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_entry_close</function></member> + <member><function>zip_entry_read</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-entry-read.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/zip/functions/zip-entry-read.xml diff -u phpdoc/en/reference/zip/functions/zip-entry-read.xml:1.2 phpdoc/en/reference/zip/functions/zip-entry-read.xml:1.3 --- phpdoc/en/reference/zip/functions/zip-entry-read.xml:1.2 Wed Apr 17 02:45:30 2002 +++ phpdoc/en/reference/zip/functions/zip-entry-read.xml Thu Dec 30 18:08:25 2004 @@ -1,43 +1,69 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-entry-read"> - <refnamediv> - <refname>zip_entry_read</refname> - <refpurpose>Read From an Open Directory Entry</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>zip_entry_read</methodname> - <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> - </methodsynopsis> - <para> - Reads up to <parameter>length</parameter> bytes from an open - directory entry. If <parameter>length</parameter> is not - specified, then <function>zip_entry_read</function> will attempt - to read 1024 bytes. The parameter - <parameter>zip_entry</parameter> is a valid directory entry - returned by <function>zip_read</function>. - </para> - <note> - <para> - The <parameter>length</parameter> parameter should be the - uncompressed length you wish to read. - </para> - </note> - <para> - Returns the data read, or &false; if the end of the file is - reached. - </para> - <para> - See also <function>zip_entry_open</function>, - <function>zip_entry_close</function> and - <function>zip_entry_filesize</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-entry-read"> + <refnamediv> + <refname>zip_entry_read</refname> + <refpurpose>Read from an open directory entry</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>zip_entry_read</methodname> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> + <para> + Reads from an open directory entry. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zip_entry</parameter></term> + <listitem> + <para> + A directory entry returned by <function>zip_read</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>length</parameter></term> + <listitem> + <para> + The number of bytes to return. If not specified, this function will + attempt to read 1024 bytes. + </para> + <note> + <para> + This should be the uncompressed length you wish to read. + </para> + </note> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the data read, or &false; if the end of the file is + reached. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_entry_open</function></member> + <member><function>zip_entry_close</function></member> + <member><function>zip_entry_filesize</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-open.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/zip/functions/zip-open.xml diff -u phpdoc/en/reference/zip/functions/zip-open.xml:1.2 phpdoc/en/reference/zip/functions/zip-open.xml:1.3 --- phpdoc/en/reference/zip/functions/zip-open.xml:1.2 Wed Apr 17 02:45:30 2002 +++ phpdoc/en/reference/zip/functions/zip-open.xml Thu Dec 30 18:08:25 2004 @@ -1,34 +1,55 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-open"> - <refnamediv> - <refname>zip_open</refname> - <refpurpose>Open a Zip File Archive</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>zip_open</methodname> - <methodparam><type>string</type><parameter>filename</parameter></methodparam> - </methodsynopsis> - <para> - Opens a new zip archive for reading. The - <parameter>filename</parameter> parameter is the filename of the - zip archive to open. - </para> - <para> - Returns a resource handle for later use with - <function>zip_read</function> and <function>zip_close</function> - or returns &false; if <parameter>filename</parameter> does not - exist. - </para> - <para> - See also <function>zip_read</function> and - <function>zip_close</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-open"> + <refnamediv> + <refname>zip_open</refname> + <refpurpose>Open a ZIP file archive</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>resource</type><methodname>zip_open</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> + <para> + Opens a new zip archive for reading. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The file name of the ZIP archive to open. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a resource handle for later use with + <function>zip_read</function> and <function>zip_close</function> + or returns &false; if <parameter>filename</parameter> does not + exist. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_read</function></member> + <member><function>zip_close</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-read.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/zip/functions/zip-read.xml diff -u phpdoc/en/reference/zip/functions/zip-read.xml:1.4 phpdoc/en/reference/zip/functions/zip-read.xml:1.5 --- phpdoc/en/reference/zip/functions/zip-read.xml:1.4 Thu Aug 12 18:20:24 2004 +++ phpdoc/en/reference/zip/functions/zip-read.xml Thu Dec 30 18:08:25 2004 @@ -1,35 +1,56 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-read"> - <refnamediv> - <refname>zip_read</refname> - <refpurpose>Read Next Entry in a Zip File Archive</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>zip_read</methodname> - <methodparam><type>resource</type><parameter>zip</parameter></methodparam> - </methodsynopsis> - <para> - Reads the next entry in a zip file archive. The parameter - <parameter>zip</parameter> must be a zip archive previously - opened by <function>zip_open</function>. - </para> - <para> - Returns a directory entry resource for later use with the - <literal>zip_entry_...</literal> functions or &false; if - there's no more entries to read. - </para> - <para> - See also <function>zip_open</function>, - <function>zip_close</function>, - <function>zip_entry_open</function>, and - <function>zip_entry_read</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-read"> + <refnamediv> + <refname>zip_read</refname> + <refpurpose>Read next entry in a ZIP file archive</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>resource</type><methodname>zip_read</methodname> + <methodparam><type>resource</type><parameter>zip</parameter></methodparam> + </methodsynopsis> + <para> + Reads the next entry in a zip file archive. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zip</parameter></term> + <listitem> + <para> + A ZIP file previously opened with <function>zip_open</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a directory entry resource for later use with the + <literal>zip_entry_...</literal> functions or &false; if + there's no more entries to read. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_open</function></member> + <member><function>zip_close</function></member> + <member><function>zip_entry_open</function></member> + <member><function>zip_entry_read</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables:
http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-close.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/zip/functions/zip-close.xml diff -u phpdoc/en/reference/zip/functions/zip-close.xml:1.4 phpdoc/en/reference/zip/functions/zip-close.xml:1.5 --- phpdoc/en/reference/zip/functions/zip-close.xml:1.4 Fri Oct 24 12:21:40 2003 +++ phpdoc/en/reference/zip/functions/zip-close.xml Thu Dec 30 18:08:25 2004 @@ -1,31 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-close"> - <refnamediv> - <refname>zip_close</refname> - <refpurpose>Close a Zip File Archive</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>void</type><methodname>zip_close</methodname> - <methodparam><type>resource</type><parameter>zip</parameter></methodparam> - </methodsynopsis> - <para> - Closes a zip file archive. The parameter - <parameter>zip</parameter> must be a zip archive previously - opened by <function>zip_open</function>. - </para> - <para> - This function has no return value. - </para> - <para> - See also <function>zip_open</function> and - <function>zip_read</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-close"> + <refnamediv> + <refname>zip_close</refname> + <refpurpose>Close a ZIP file archive</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <void /><methodname>zip_close</methodname> + <methodparam><type>resource</type><parameter>zip</parameter></methodparam> + </methodsynopsis> + <para> + Closes the given ZIP file archive. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zip</parameter></term> + <listitem> + <para> + A ZIP file previously opened with <function>zip_open</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_open</function></member> + <member><function>zip_read</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-entry-close.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/zip/functions/zip-entry-close.xml diff -u phpdoc/en/reference/zip/functions/zip-entry-close.xml:1.4 phpdoc/en/reference/zip/functions/zip-entry-close.xml:1.5 --- phpdoc/en/reference/zip/functions/zip-entry-close.xml:1.4 Fri Oct 24 12:21:40 2003 +++ phpdoc/en/reference/zip/functions/zip-entry-close.xml Thu Dec 30 18:08:25 2004 @@ -1,32 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-entry-close"> - <refnamediv> - <refname>zip_entry_close</refname> - <refpurpose>Close a Directory Entry</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>void</type><methodname>zip_entry_close</methodname> - <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> - </methodsynopsis> - <para> - Closes a directory entry specified by - <parameter>zip_entry</parameter>. The parameter - <parameter>zip_entry</parameter> must be a valid directory entry - opened by <function>zip_entry_open</function>. - </para> - <para> - This function has no return value. - </para> - <para> - See also <function>zip_entry_open</function> and - <function>zip_entry_read</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-entry-close"> + <refnamediv> + <refname>zip_entry_close</refname> + <refpurpose>Close a directory entry</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <void /><methodname>zip_entry_close</methodname> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + </methodsynopsis> + <para> + Closes the specified directory entry. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zip_entry</parameter></term> + <listitem> + <para> + A directory entry previously opened <function>zip_entry_open</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_entry_open</function></member> + <member><function>zip_entry_read</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-entry-compressedsize.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/zip/functions/zip-entry-compressedsize.xml diff -u phpdoc/en/reference/zip/functions/zip-entry-compressedsize.xml:1.2 phpdoc/en/reference/zip/functions/zip-entry-compressedsize.xml:1.3 --- phpdoc/en/reference/zip/functions/zip-entry-compressedsize.xml:1.2 Wed Apr 17 02:45:29 2002 +++ phpdoc/en/reference/zip/functions/zip-entry-compressedsize.xml Thu Dec 30 18:08:25 2004 @@ -1,29 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-entry-compressedsize"> - <refnamediv> - <refname>zip_entry_compressedsize</refname> - <refpurpose>Retrieve the Compressed Size of a Directory Entry</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>zip_entry_compressedsize</methodname> - <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> - </methodsynopsis> - <para> - Returns the compressed size of the directory entry specified by - <parameter>zip_entry</parameter>. The parameter - <parameter>zip_entry</parameter> is a valid directory entry - returned by <function>zip_read</function>. - </para> - <para> - See also <function>zip_open</function> and - <function>zip_read</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-entry-compressedsize"> + <refnamediv> + <refname>zip_entry_compressedsize</refname> + <refpurpose>Retrieve the compressed size of a directory entry</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>int</type><methodname>zip_entry_compressedsize</methodname> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + </methodsynopsis> + <para> + Returns the compressed size of the specified directory entry. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zip_entry</parameter></term> + <listitem> + <para> + A directory entry returned by <function>zip_read</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The compressed size. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_open</function></member> + <member><function>zip_read</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-entry-compressionmethod.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/zip/functions/zip-entry-compressionmethod.xml diff -u phpdoc/en/reference/zip/functions/zip-entry-compressionmethod.xml:1.2 phpdoc/en/reference/zip/functions/zip-entry-compressionmethod.xml:1.3 --- phpdoc/en/reference/zip/functions/zip-entry-compressionmethod.xml:1.2 Wed Apr 17 02:45:29 2002 +++ phpdoc/en/reference/zip/functions/zip-entry-compressionmethod.xml Thu Dec 30 18:08:25 2004 @@ -1,29 +1,53 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-entry-compressionmethod"> - <refnamediv> - <refname>zip_entry_compressionmethod</refname> - <refpurpose>Retrieve the Compression Method of a Directory Entry</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>zip_entry_compressionmethod</methodname> - <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> - </methodsynopsis> - <para> - Returns the compression method of the directory entry specified - by <parameter>zip_entry</parameter>. The parameter - <parameter>zip_entry</parameter> is a valid directory entry - returned by <function>zip_read</function>. - </para> - <para> - See also <function>zip_open</function> and - <function>zip_read</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-entry-compressionmethod"> + <refnamediv> + <refname>zip_entry_compressionmethod</refname> + <refpurpose>Retrieve the compression method of a directory entry</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>zip_entry_compressionmethod</methodname> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + </methodsynopsis> + <para> + Returns the compression method of the directory entry specified + by <parameter>zip_entry</parameter>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zip_entry</parameter></term> + <listitem> + <para> + A directory entry returned by <function>zip_read</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The compression method. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_open</function></member> + <member><function>zip_read</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-entry-filesize.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/zip/functions/zip-entry-filesize.xml diff -u phpdoc/en/reference/zip/functions/zip-entry-filesize.xml:1.2 phpdoc/en/reference/zip/functions/zip-entry-filesize.xml:1.3 --- phpdoc/en/reference/zip/functions/zip-entry-filesize.xml:1.2 Wed Apr 17 02:45:29 2002 +++ phpdoc/en/reference/zip/functions/zip-entry-filesize.xml Thu Dec 30 18:08:25 2004 @@ -1,29 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-entry-filesize"> - <refnamediv> - <refname>zip_entry_filesize</refname> - <refpurpose>Retrieve the Actual File Size of a Directory Entry</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>zip_entry_filesize</methodname> - <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> - </methodsynopsis> - <para> - Returns the actual size of the directory entry specified by - <parameter>zip_entry</parameter>. The parameter - <parameter>zip_entry</parameter> is a valid directory entry - returned by <function>zip_read</function>. - </para> - <para> - See also <function>zip_open</function> and - <function>zip_read</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-entry-filesize"> + <refnamediv> + <refname>zip_entry_filesize</refname> + <refpurpose>Retrieve the actual file size of a directory entry</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>int</type><methodname>zip_entry_filesize</methodname> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + </methodsynopsis> + <para> + Returns the actual size of the specified directory entry. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zip_entry</parameter></term> + <listitem> + <para> + A directory entry returned by <function>zip_read</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The size of the directory entry. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_open</function></member> + <member><function>zip_read</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-entry-name.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/zip/functions/zip-entry-name.xml diff -u phpdoc/en/reference/zip/functions/zip-entry-name.xml:1.2 phpdoc/en/reference/zip/functions/zip-entry-name.xml:1.3 --- phpdoc/en/reference/zip/functions/zip-entry-name.xml:1.2 Wed Apr 17 02:45:29 2002 +++ phpdoc/en/reference/zip/functions/zip-entry-name.xml Thu Dec 30 18:08:25 2004 @@ -1,29 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-entry-name"> - <refnamediv> - <refname>zip_entry_name</refname> - <refpurpose>Retrieve the Name of a Directory Entry</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>zip_entry_name</methodname> - <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> - </methodsynopsis> - <para> - Returns the name of the directory entry specified by - <parameter>zip_entry</parameter>. The parameter - <parameter>zip_entry</parameter> is a valid directory entry - returned by <function>zip_read</function>. - </para> - <para> - See also <function>zip_open</function> and - <function>zip_read</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-entry-name"> + <refnamediv> + <refname>zip_entry_name</refname> + <refpurpose>Retrieve the name of a directory entry</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>zip_entry_name</methodname> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + </methodsynopsis> + <para> + Returns the name of the specified directory entry. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zip_entry</parameter></term> + <listitem> + <para> + A directory entry returned by <function>zip_read</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The name of the directory entry. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_open</function></member> + <member><function>zip_read</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-entry-open.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/zip/functions/zip-entry-open.xml diff -u phpdoc/en/reference/zip/functions/zip-entry-open.xml:1.3 phpdoc/en/reference/zip/functions/zip-entry-open.xml:1.4 --- phpdoc/en/reference/zip/functions/zip-entry-open.xml:1.3 Tue Sep 30 04:33:47 2003 +++ phpdoc/en/reference/zip/functions/zip-entry-open.xml Thu Dec 30 18:08:25 2004 @@ -1,54 +1,86 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-entry-open"> - <refnamediv> - <refname>zip_entry_open</refname> - <refpurpose>Open a Directory Entry for Reading</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>zip_entry_open</methodname> - <methodparam><type>resource</type><parameter>zip</parameter></methodparam> - <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>mode</parameter></methodparam> - </methodsynopsis> - <para> - Opens a directory entry in a zip file for reading. The parameter - <parameter>zip</parameter> is a valid resource handle returned by - <function>zip_open</function>. The parameter - <parameter>zip_entry</parameter> is a directory entry resource - returned by <function>zip_read</function>. The optional - parameter <parameter>mode</parameter> can be any of the modes - specified in the documentation for <function>fopen</function>. - </para> - <note> - <para> - Currently, <parameter>mode</parameter> is ignored and is always - <literal>"rb"</literal>. This is due to the fact that zip - support in PHP is read only access. Please see - <function>fopen</function> for an explanation of various modes, - including <literal>"rb"</literal>. - </para> - </note> - <para> - &return.success; - </para> - <note> - <para> - Unlike <function>fopen</function> and other similar functions, - the return value of <function>zip_entry_open</function> only - indicates the result of the operation and is not needed for - reading or closing the directory entry. - </para> - </note> - <para> - See also <function>zip_entry_read</function> and - <function>zip_entry_close</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-entry-open"> + <refnamediv> + <refname>zip_entry_open</refname> + <refpurpose>Open a directory entry for reading</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>zip_entry_open</methodname> + <methodparam><type>resource</type><parameter>zip</parameter></methodparam> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>mode</parameter></methodparam> + </methodsynopsis> + <para> + Opens a directory entry in a zip file for reading. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zip</parameter></term> + <listitem> + <para> + A valid resource handle returned by <function>zip_open</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>zip_entry</parameter></term> + <listitem> + <para> + A directory entry returned by <function>zip_read</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + Any of the modes specified in the documentation of + <function>fopen</function>. + </para> + <note> + <para> + Currently, <parameter>mode</parameter> is ignored and is always + <literal>"rb"</literal>. This is due to the fact that zip support + in PHP is read only access. + </para> + </note> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + <note> + <para> + Unlike <function>fopen</function> and other similar functions, + the return value of <function>zip_entry_open</function> only + indicates the result of the operation and is not needed for + reading or closing the directory entry. + </para> + </note> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_entry_close</function></member> + <member><function>zip_entry_read</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-entry-read.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/zip/functions/zip-entry-read.xml diff -u phpdoc/en/reference/zip/functions/zip-entry-read.xml:1.2 phpdoc/en/reference/zip/functions/zip-entry-read.xml:1.3 --- phpdoc/en/reference/zip/functions/zip-entry-read.xml:1.2 Wed Apr 17 02:45:30 2002 +++ phpdoc/en/reference/zip/functions/zip-entry-read.xml Thu Dec 30 18:08:25 2004 @@ -1,43 +1,69 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-entry-read"> - <refnamediv> - <refname>zip_entry_read</refname> - <refpurpose>Read From an Open Directory Entry</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>zip_entry_read</methodname> - <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> - </methodsynopsis> - <para> - Reads up to <parameter>length</parameter> bytes from an open - directory entry. If <parameter>length</parameter> is not - specified, then <function>zip_entry_read</function> will attempt - to read 1024 bytes. The parameter - <parameter>zip_entry</parameter> is a valid directory entry - returned by <function>zip_read</function>. - </para> - <note> - <para> - The <parameter>length</parameter> parameter should be the - uncompressed length you wish to read. - </para> - </note> - <para> - Returns the data read, or &false; if the end of the file is - reached. - </para> - <para> - See also <function>zip_entry_open</function>, - <function>zip_entry_close</function> and - <function>zip_entry_filesize</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-entry-read"> + <refnamediv> + <refname>zip_entry_read</refname> + <refpurpose>Read from an open directory entry</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>zip_entry_read</methodname> + <methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> + </methodsynopsis> + <para> + Reads from an open directory entry. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zip_entry</parameter></term> + <listitem> + <para> + A directory entry returned by <function>zip_read</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>length</parameter></term> + <listitem> + <para> + The number of bytes to return. If not specified, this function will + attempt to read 1024 bytes. + </para> + <note> + <para> + This should be the uncompressed length you wish to read. + </para> + </note> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the data read, or &false; if the end of the file is + reached. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_entry_open</function></member> + <member><function>zip_entry_close</function></member> + <member><function>zip_entry_filesize</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-open.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/zip/functions/zip-open.xml diff -u phpdoc/en/reference/zip/functions/zip-open.xml:1.2 phpdoc/en/reference/zip/functions/zip-open.xml:1.3 --- phpdoc/en/reference/zip/functions/zip-open.xml:1.2 Wed Apr 17 02:45:30 2002 +++ phpdoc/en/reference/zip/functions/zip-open.xml Thu Dec 30 18:08:25 2004 @@ -1,34 +1,55 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-open"> - <refnamediv> - <refname>zip_open</refname> - <refpurpose>Open a Zip File Archive</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>zip_open</methodname> - <methodparam><type>string</type><parameter>filename</parameter></methodparam> - </methodsynopsis> - <para> - Opens a new zip archive for reading. The - <parameter>filename</parameter> parameter is the filename of the - zip archive to open. - </para> - <para> - Returns a resource handle for later use with - <function>zip_read</function> and <function>zip_close</function> - or returns &false; if <parameter>filename</parameter> does not - exist. - </para> - <para> - See also <function>zip_read</function> and - <function>zip_close</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-open"> + <refnamediv> + <refname>zip_open</refname> + <refpurpose>Open a ZIP file archive</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>resource</type><methodname>zip_open</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> + <para> + Opens a new zip archive for reading. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The file name of the ZIP archive to open. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a resource handle for later use with + <function>zip_read</function> and <function>zip_close</function> + or returns &false; if <parameter>filename</parameter> does not + exist. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_read</function></member> + <member><function>zip_close</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/zip/functions/zip-read.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/zip/functions/zip-read.xml diff -u phpdoc/en/reference/zip/functions/zip-read.xml:1.4 phpdoc/en/reference/zip/functions/zip-read.xml:1.5 --- phpdoc/en/reference/zip/functions/zip-read.xml:1.4 Thu Aug 12 18:20:24 2004 +++ phpdoc/en/reference/zip/functions/zip-read.xml Thu Dec 30 18:08:25 2004 @@ -1,35 +1,56 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/zip.xml, last change in rev 1.11 --> - <refentry id="function.zip-read"> - <refnamediv> - <refname>zip_read</refname> - <refpurpose>Read Next Entry in a Zip File Archive</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>zip_read</methodname> - <methodparam><type>resource</type><parameter>zip</parameter></methodparam> - </methodsynopsis> - <para> - Reads the next entry in a zip file archive. The parameter - <parameter>zip</parameter> must be a zip archive previously - opened by <function>zip_open</function>. - </para> - <para> - Returns a directory entry resource for later use with the - <literal>zip_entry_...</literal> functions or &false; if - there's no more entries to read. - </para> - <para> - See also <function>zip_open</function>, - <function>zip_close</function>, - <function>zip_entry_open</function>, and - <function>zip_entry_read</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.zip-read"> + <refnamediv> + <refname>zip_read</refname> + <refpurpose>Read next entry in a ZIP file archive</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>resource</type><methodname>zip_read</methodname> + <methodparam><type>resource</type><parameter>zip</parameter></methodparam> + </methodsynopsis> + <para> + Reads the next entry in a zip file archive. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zip</parameter></term> + <listitem> + <para> + A ZIP file previously opened with <function>zip_open</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a directory entry resource for later use with the + <literal>zip_entry_...</literal> functions or &false; if + there's no more entries to read. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>zip_open</function></member> + <member><function>zip_close</function></member> + <member><function>zip_entry_open</function></member> + <member><function>zip_entry_read</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: