- converted from zzip to zip

- renamed functions as per ext/zip/zip.c
- still need examples and documentation
  for zip_entry_open and zip_entry_read
  before adding a reference to manual.xml.in


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@48951 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Daniel Beckham 2001-05-31 19:36:57 +00:00
parent bb42f2b2f2
commit 7d131904cf

View file

@ -41,178 +41,177 @@
</sect1>
</partintro>
<refentry id="function.zzip-close">
<refentry id="function.zip-close">
<refnamediv>
<refname>zzip_close</refname>
<refpurpose>Close a ZZip Entry</refpurpose>
<refname>zip_close</refname>
<refpurpose>Close a Zip File Archive</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>zzip_close</function></funcdef>
<paramdef>resource <parameter>zzip_entry</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Closes a directory entry specified by
<parameter>zzip_entry</parameter>. The parameter
<parameter>zzip_entry</parameter> must be a valid directory entry
opened by <function>zzip_open</function>.
</para>
<para>
This function has no return value.
</para>
<para>
See also <function>zzip_open</function> and
<function>zzip_read</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.zzip-closedir">
<refnamediv>
<refname>zzip_closedir</refname>
<refpurpose>Close a ZIP File Archive</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>zzip_closedir</function></funcdef>
<paramdef>resource <parameter>zzip</parameter></paramdef>
<funcdef>void <function>zip_close</function></funcdef>
<paramdef>resource <parameter>zip</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Closes a zip file archive. The parameter
<parameter>zzip</parameter> must be a zip archive previously
opened by <function>zzip_opendir</function>.
<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>zzip_opendir</function> and
<function>zzip_readdir</function>.
See also <function>zip_open</function> and
<function>zip_read</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.zzip-entry-compressedsize">
<refentry id="function.zip-entry-close">
<refnamediv>
<refname>zzip_entry_compressedsize</refname>
<refpurpose>Retrive the Compressed Size of a ZZIP Entry</refpurpose>
<refname>zip_close</refname>
<refpurpose>Close a Zip Entry</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>zzip_entry_compressedsize</function></funcdef>
<paramdef>resource <parameter>zzip_entry</parameter></paramdef>
<funcdef>void <function>zip_close</function></funcdef>
<paramdef>resource <parameter>zip_entry</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<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-compressedsize">
<refnamediv>
<refname>zip_entry_compressedsize</refname>
<refpurpose>Retrive the Compressed Size of a Zip Entry</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>zip_entry_compressedsize</function></funcdef>
<paramdef>resource <parameter>zip_entry</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns the compressed size of the directory entry specified by
<parameter>zzip_entry</parameter>. The parameter
<parameter>zzip_entry</parameter> is a valid directory entry
returned by <function>zzip_readdir</function>.
<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>zzip_opendir</function> and
<function>zzip_readdir</function>.
See also <function>zip_open</function> and
<function>zip_read</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.zzip-entry-compressionmethod">
<refentry id="function.zip-entry-compressionmethod">
<refnamediv>
<refname>zzip_entry_compressionmethod</refname>
<refpurpose>Retrive the Compression Method of a ZZIP Entry</refpurpose>
<refname>zip_entry_compressionmethod</refname>
<refpurpose>Retrive the Compression Method of a Zip Entry</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>zzip_entry_compressionmethod</function></funcdef>
<paramdef>resource <parameter>zzip_entry</parameter></paramdef>
<funcdef>string <function>zip_entry_compressionmethod</function></funcdef>
<paramdef>resource <parameter>zip_entry</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns the compression method of the directory entry specified by
<parameter>zzip_entry</parameter>. The parameter
<parameter>zzip_entry</parameter> is a valid directory entry
returned by <function>zzip_readdir</function>.
<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>zzip_opendir</function> and
<function>zzip_readdir</function>.
See also <function>zip_open</function> and
<function>zip_read</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.zzip-entry-filesize">
<refentry id="function.zip-entry-filesize">
<refnamediv>
<refname>zzip_entry_filesize</refname>
<refpurpose>Retrive the Actual File Size of a ZZIP Entry</refpurpose>
<refname>zip_entry_filesize</refname>
<refpurpose>Retrive the Actual File Size of a Zip Entry</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>zzip_entry_filesize</function></funcdef>
<paramdef>resource <parameter>zzip_entry</parameter></paramdef>
<funcdef>int <function>zip_entry_filesize</function></funcdef>
<paramdef>resource <parameter>zip_entry</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns the actual size of the directory entry specified by
<parameter>zzip_entry</parameter>. The parameter
<parameter>zzip_entry</parameter> is a valid directory entry
returned by <function>zzip_readdir</function>.
<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>zzip_opendir</function> and
<function>zzip_readdir</function>.
See also <function>zip_open</function> and
<function>zip_read</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.zzip-entry-name">
<refentry id="function.zip-entry-name">
<refnamediv>
<refname>zzip_entry_name</refname>
<refpurpose>Retrive the Name of a ZZIP Entry</refpurpose>
<refname>zip_entry_name</refname>
<refpurpose>Retrive the Name of a Zip Entry</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>zzip_entry_name</function></funcdef>
<paramdef>resource <parameter>zzip_entry</parameter></paramdef>
<funcdef>string <function>zip_entry_name</function></funcdef>
<paramdef>resource <parameter>zip_entry</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns the name of the directory entry specified by
<parameter>zzip_entry</parameter>. The parameter
<parameter>zzip_entry</parameter> is a valid directory entry
returned by <function>zzip_readdir</function>.
<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>zzip_opendir</function> and
<function>zzip_readdir</function>.
See also <function>zip_open</function> and
<function>zip_read</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.zzip-opendir">
<refentry id="function.zip-open">
<refnamediv>
<refname>zzip_opendir</refname>
<refpurpose>Open a ZIP File Archive</refpurpose>
<refname>zip_open</refname>
<refpurpose>Open a Zip File Archive</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>resource <function>zzip_opendir</function></funcdef>
<funcdef>resource <function>zip_open</function></funcdef>
<paramdef>string <parameter>filename</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@ -223,45 +222,45 @@
</para>
<para>
Returns a resource handle for later use with
<function>zzip_readdir</function> and
<function>zzip_closedir</function> or returns
<function>zip_read</function> and
<function>zip_close</function> or returns
<literal>false</literal> if <parameter>filename</parameter> does
not exist.
</para>
<para>
See also <function>zzip_readdir</function> and
<function>zzip_closedir</function>.
See also <function>zip_read</function> and
<function>zip_close</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.zzip-readdir">
<refentry id="function.zip-read">
<refnamediv>
<refname>zzip_readdir</refname>
<refpurpose>Reads Next Entry in a ZIP File Archive</refpurpose>
<refname>zip_read</refname>
<refpurpose>Reads Next Entry in a Zip File Archive</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>resource <function>zzip_readdir</function></funcdef>
<paramdef>resource <parameter>zzip</parameter></paramdef>
<funcdef>resource <function>zip_read</function></funcdef>
<paramdef>resource <parameter>zip</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Reads the next entry in a zip file archive. The parameter
<parameter>zzip</parameter> must be a zip archive previously
opened by <function>zzip_opendir</function>.
<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
<function>zzip_open</function>, <function>zzip_read</function> and
the <function>zzip_entry_...</function> functions.
Returns a directory entry resource for later use with the
<function>zip_entry_...</function> functions.
</para>
<para>
See also <function>zzip_opendir</function>,
<function>zzip_closedir</function>,
<function>zzip_open</function> and <function>zzip_read</function>.
See also <function>zip_open</function>,
<function>zip_close</function>,
<function>zip_entry_open</function> and
<function>zip_entry_read</function>.
</para>
</refsect1>
</refentry>