From bb42f2b2f291acbebe7243b87daf9132363c04e9 Mon Sep 17 00:00:00 2001 From: Daniel Beckham Date: Wed, 30 May 2001 16:38:18 +0000 Subject: [PATCH] Initial addition to CVS... - hasn't been added to the manual.xml.in file - function names are still old versions before lib change from zzip to zip. - no function examples yet git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@48885 c90b9560-bf6c-de11-be94-00142212c4b1 --- functions/zip.xml | 286 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 286 insertions(+) create mode 100644 functions/zip.xml diff --git a/functions/zip.xml b/functions/zip.xml new file mode 100644 index 0000000000..1141d4f991 --- /dev/null +++ b/functions/zip.xml @@ -0,0 +1,286 @@ + + Zip File Functions (Read Only Access) + Zip + + + This module uses the functions of the ZZIPlib library by Guido Draheim to + transparently read ZIP compressed archives and the files + inside them. + + + Please note that ZZIPlib only provides a subset of functions + provided in a full implementation of the ZIP compression algorithm + and can only read ZIP file archives. A normal ZIP utility is + needed to create the ZIP file archives read by this library. + + + Zip support in PHP is not enabled by default. You will need to + use the --with-zip + configuration option when compiling PHP to enable zip + support. This module requires ZZIPlib version >= 0.10.6. + + + + Example Usage + + This example opens a ZIP file archive, reads each file in the + archive and prints out its contents. The + test2.php archive used in this example is + one of the test archives in the ZZIPlib source distribution. + + + Zip Usage Example + +<?PHP + +?> + + + + + + + + zzip_close + Close a ZZip Entry + + + Description + + + void zzip_close + resource zzip_entry + + + + Closes a directory entry specified by + zzip_entry. The parameter + zzip_entry must be a valid directory entry + opened by zzip_open. + + + This function has no return value. + + + See also zzip_open and + zzip_read. + + + + + + + zzip_closedir + Close a ZIP File Archive + + + Description + + + void zzip_closedir + resource zzip + + + + Closes a zip file archive. The parameter + zzip must be a zip archive previously + opened by zzip_opendir. + + + This function has no return value. + + + See also zzip_opendir and + zzip_readdir. + + + + + + + + zzip_entry_compressedsize + Retrive the Compressed Size of a ZZIP Entry + + + Description + + + int zzip_entry_compressedsize + resource zzip_entry + + + + Returns the compressed size of the directory entry specified by + zzip_entry. The parameter + zzip_entry is a valid directory entry + returned by zzip_readdir. + + + See also zzip_opendir and + zzip_readdir. + + + + + + + zzip_entry_compressionmethod + Retrive the Compression Method of a ZZIP Entry + + + Description + + + string zzip_entry_compressionmethod + resource zzip_entry + + + + Returns the compression method of the directory entry specified by + zzip_entry. The parameter + zzip_entry is a valid directory entry + returned by zzip_readdir. + + + See also zzip_opendir and + zzip_readdir. + + + + + + + zzip_entry_filesize + Retrive the Actual File Size of a ZZIP Entry + + + Description + + + int zzip_entry_filesize + resource zzip_entry + + + + Returns the actual size of the directory entry specified by + zzip_entry. The parameter + zzip_entry is a valid directory entry + returned by zzip_readdir. + + + See also zzip_opendir and + zzip_readdir. + + + + + + + zzip_entry_name + Retrive the Name of a ZZIP Entry + + + Description + + + string zzip_entry_name + resource zzip_entry + + + + Returns the name of the directory entry specified by + zzip_entry. The parameter + zzip_entry is a valid directory entry + returned by zzip_readdir. + + + See also zzip_opendir and + zzip_readdir. + + + + + + + zzip_opendir + Open a ZIP File Archive + + + Description + + + resource zzip_opendir + string filename + + + + Opens a new zip archive for reading. The + filename parameter is the filename of the + zip archive to open. + + + Returns a resource handle for later use with + zzip_readdir and + zzip_closedir or returns + false if filename does + not exist. + + + See also zzip_readdir and + zzip_closedir. + + + + + + + zzip_readdir + Reads Next Entry in a ZIP File Archive + + + Description + + + resource zzip_readdir + resource zzip + + + + Reads the next entry in a zip file archive. The parameter + zzip must be a zip archive previously + opened by zzip_opendir. + + + Returns a directory entry resource for later use with + zzip_open, zzip_read and + the zzip_entry_... functions. + + + See also zzip_opendir, + zzip_closedir, + zzip_open and zzip_read. + + + + + + +