From 3b90a603baf298d8144a070ab22d10985712f55b Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Thu, 30 Dec 2004 23:08:25 +0000 Subject: [PATCH] Switch ref.zip to the new structure git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@176099 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/zip/functions/zip-close.xml | 73 ++++++---- reference/zip/functions/zip-entry-close.xml | 74 ++++++---- .../functions/zip-entry-compressedsize.xml | 71 ++++++---- .../functions/zip-entry-compressionmethod.xml | 72 ++++++---- .../zip/functions/zip-entry-filesize.xml | 71 ++++++---- reference/zip/functions/zip-entry-name.xml | 71 ++++++---- reference/zip/functions/zip-entry-open.xml | 130 +++++++++++------- reference/zip/functions/zip-entry-read.xml | 102 +++++++++----- reference/zip/functions/zip-open.xml | 79 +++++++---- reference/zip/functions/zip-read.xml | 81 +++++++---- 10 files changed, 529 insertions(+), 295 deletions(-) diff --git a/reference/zip/functions/zip-close.xml b/reference/zip/functions/zip-close.xml index 14ff12453e..74c52c02b8 100644 --- a/reference/zip/functions/zip-close.xml +++ b/reference/zip/functions/zip-close.xml @@ -1,31 +1,52 @@ - + - - - zip_close - Close a Zip File Archive - - - Description - - voidzip_close - resourcezip - - - Closes a zip file archive. The parameter - zip must be a zip archive previously - opened by zip_open. - - - This function has no return value. - - - See also zip_open and - zip_read. - - - + + + zip_close + Close a ZIP file archive + + + &reftitle.description; + + zip_close + resourcezip + + + Closes the given ZIP file archive. + + + + &reftitle.parameters; + + + + zip + + + A ZIP file previously opened with zip_open. + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + &reftitle.seealso; + + + zip_open + zip_read + + + + + - - - zip_entry_close - Close a Directory Entry - - - Description - - voidzip_entry_close - resourcezip_entry - - - Closes a directory entry specified by - zip_entry. The parameter - zip_entry must be a valid directory entry - opened by zip_entry_open. - - - This function has no return value. - - - See also zip_entry_open and - zip_entry_read. - - - + + + zip_entry_close + Close a directory entry + + + &reftitle.description; + + zip_entry_close + resourcezip_entry + + + Closes the specified directory entry. + + + + &reftitle.parameters; + + + + zip_entry + + + A directory entry previously opened zip_entry_open. + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + &reftitle.seealso; + + + zip_entry_open + zip_entry_read + + + + + - - - zip_entry_compressedsize - Retrieve the Compressed Size of a Directory Entry - - - Description - - intzip_entry_compressedsize - resourcezip_entry - - - Returns the compressed size of the directory entry specified by - zip_entry. The parameter - zip_entry is a valid directory entry - returned by zip_read. - - - See also zip_open and - zip_read. - - - + + + zip_entry_compressedsize + Retrieve the compressed size of a directory entry + + + &reftitle.description; + + intzip_entry_compressedsize + resourcezip_entry + + + Returns the compressed size of the specified directory entry. + + + + &reftitle.parameters; + + + + zip_entry + + + A directory entry returned by zip_read. + + + + + + + + &reftitle.returnvalues; + + The compressed size. + + + + &reftitle.seealso; + + + zip_open + zip_read + + + + + - - - zip_entry_compressionmethod - Retrieve the Compression Method of a Directory Entry - - - Description - - stringzip_entry_compressionmethod - resourcezip_entry - - - Returns the compression method of the directory entry specified - by zip_entry. The parameter - zip_entry is a valid directory entry - returned by zip_read. - - - See also zip_open and - zip_read. - - - + + + zip_entry_compressionmethod + Retrieve the compression method of a directory entry + + + &reftitle.description; + + stringzip_entry_compressionmethod + resourcezip_entry + + + Returns the compression method of the directory entry specified + by zip_entry. + + + + &reftitle.parameters; + + + + zip_entry + + + A directory entry returned by zip_read. + + + + + + + + &reftitle.returnvalues; + + The compression method. + + + + &reftitle.seealso; + + + zip_open + zip_read + + + + + - - - zip_entry_filesize - Retrieve the Actual File Size of a Directory Entry - - - Description - - intzip_entry_filesize - resourcezip_entry - - - Returns the actual size of the directory entry specified by - zip_entry. The parameter - zip_entry is a valid directory entry - returned by zip_read. - - - See also zip_open and - zip_read. - - - + + + zip_entry_filesize + Retrieve the actual file size of a directory entry + + + &reftitle.description; + + intzip_entry_filesize + resourcezip_entry + + + Returns the actual size of the specified directory entry. + + + + &reftitle.parameters; + + + + zip_entry + + + A directory entry returned by zip_read. + + + + + + + + &reftitle.returnvalues; + + The size of the directory entry. + + + + &reftitle.seealso; + + + zip_open + zip_read + + + + + - - - zip_entry_name - Retrieve the Name of a Directory Entry - - - Description - - stringzip_entry_name - resourcezip_entry - - - Returns the name of the directory entry specified by - zip_entry. The parameter - zip_entry is a valid directory entry - returned by zip_read. - - - See also zip_open and - zip_read. - - - + + + zip_entry_name + Retrieve the name of a directory entry + + + &reftitle.description; + + stringzip_entry_name + resourcezip_entry + + + Returns the name of the specified directory entry. + + + + &reftitle.parameters; + + + + zip_entry + + + A directory entry returned by zip_read. + + + + + + + + &reftitle.returnvalues; + + The name of the directory entry. + + + + &reftitle.seealso; + + + zip_open + zip_read + + + + + - - - zip_entry_open - Open a Directory Entry for Reading - - - Description - - boolzip_entry_open - resourcezip - resourcezip_entry - stringmode - - - Opens a directory entry in a zip file for reading. The parameter - zip is a valid resource handle returned by - zip_open. The parameter - zip_entry is a directory entry resource - returned by zip_read. The optional - parameter mode can be any of the modes - specified in the documentation for fopen. - - - - Currently, mode is ignored and is always - "rb". This is due to the fact that zip - support in PHP is read only access. Please see - fopen for an explanation of various modes, - including "rb". - - - - &return.success; - - - - Unlike fopen and other similar functions, - the return value of zip_entry_open only - indicates the result of the operation and is not needed for - reading or closing the directory entry. - - - - See also zip_entry_read and - zip_entry_close. - - - + + + zip_entry_open + Open a directory entry for reading + + + &reftitle.description; + + boolzip_entry_open + resourcezip + resourcezip_entry + stringmode + + + Opens a directory entry in a zip file for reading. + + + + &reftitle.parameters; + + + + zip + + + A valid resource handle returned by zip_open. + + + + + zip_entry + + + A directory entry returned by zip_read. + + + + + mode + + + Any of the modes specified in the documentation of + fopen. + + + + Currently, mode is ignored and is always + "rb". This is due to the fact that zip support + in PHP is read only access. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + Unlike fopen and other similar functions, + the return value of zip_entry_open only + indicates the result of the operation and is not needed for + reading or closing the directory entry. + + + + + &reftitle.seealso; + + + zip_entry_close + zip_entry_read + + + + + - - - zip_entry_read - Read From an Open Directory Entry - - - Description - - stringzip_entry_read - resourcezip_entry - intlength - - - Reads up to length bytes from an open - directory entry. If length is not - specified, then zip_entry_read will attempt - to read 1024 bytes. The parameter - zip_entry is a valid directory entry - returned by zip_read. - - - - The length parameter should be the - uncompressed length you wish to read. - - - - Returns the data read, or &false; if the end of the file is - reached. - - - See also zip_entry_open, - zip_entry_close and - zip_entry_filesize. - - - + + + zip_entry_read + Read from an open directory entry + + + &reftitle.description; + + stringzip_entry_read + resourcezip_entry + intlength + + + Reads from an open directory entry. + + + + &reftitle.parameters; + + + + zip_entry + + + A directory entry returned by zip_read. + + + + + length + + + The number of bytes to return. If not specified, this function will + attempt to read 1024 bytes. + + + + This should be the uncompressed length you wish to read. + + + + + + + + + &reftitle.returnvalues; + + Returns the data read, or &false; if the end of the file is + reached. + + + + &reftitle.seealso; + + + zip_entry_open + zip_entry_close + zip_entry_filesize + + + + + - - - zip_open - Open a Zip File Archive - - - Description - - resourcezip_open - stringfilename - - - 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 - zip_read and zip_close - or returns &false; if filename does not - exist. - - - See also zip_read and - zip_close. - - - + + + zip_open + Open a ZIP file archive + + + &reftitle.description; + + resourcezip_open + stringfilename + + + Opens a new zip archive for reading. + + + + &reftitle.parameters; + + + + filename + + + The file name of the ZIP archive to open. + + + + + + + + &reftitle.returnvalues; + + Returns a resource handle for later use with + zip_read and zip_close + or returns &false; if filename does not + exist. + + + + &reftitle.seealso; + + + zip_read + zip_close + + + + + - - - zip_read - Read Next Entry in a Zip File Archive - - - Description - - resourcezip_read - resourcezip - - - Reads the next entry in a zip file archive. The parameter - zip must be a zip archive previously - opened by zip_open. - - - Returns a directory entry resource for later use with the - zip_entry_... functions or &false; if - there's no more entries to read. - - - See also zip_open, - zip_close, - zip_entry_open, and - zip_entry_read. - - - + + + zip_read + Read next entry in a ZIP file archive + + + &reftitle.description; + + resourcezip_read + resourcezip + + + Reads the next entry in a zip file archive. + + + + &reftitle.parameters; + + + + zip + + + A ZIP file previously opened with zip_open. + + + + + + + + &reftitle.returnvalues; + + Returns a directory entry resource for later use with the + zip_entry_... functions or &false; if + there's no more entries to read. + + + + &reftitle.seealso; + + + zip_open + zip_close + zip_entry_open + zip_entry_read + + + +