* The file name of the ZIP archive to open. *
* @param flags int[optional]* The mode to use to open the archive. * * *
* ZipArchive::OVERWRITE *
* @return mixed Error codes * ** Returns true on success or the error code. * * *
* ZipArchive::ER_EXISTS *
** File already exists. *
* * ** ZipArchive::ER_INCONS *
** Zip archive inconsistent. *
* * ** ZipArchive::ER_INVAL *
** Invalid argument. *
* * ** ZipArchive::ER_MEMORY *
** Malloc failure. *
* * ** ZipArchive::ER_NOENT *
** No such file. *
* * ** ZipArchive::ER_NOZIP *
** Not a zip archive. *
* * ** ZipArchive::ER_OPEN *
** Can't open file. *
* * ** ZipArchive::ER_READ *
** Read error. *
* * ** ZipArchive::ER_SEEK *
** Seek error. *
* * * */ public function open ($filename, $flags = null) {} /** * Set the password for the active archive * @link http://www.php.net/manual/en/ziparchive.setpassword.php * @param password string* The password to add to the archive. *
* @return bool Returns true on success, false on failure. */ public function setPassword ($password) {} /** * Close the active archive (opened or newly created) * @link http://www.php.net/manual/en/ziparchive.close.php * @return bool Returns true on success, false on failure. */ public function close () {} /** * Returns the status error message, system and/or zip messages * @link http://www.php.net/manual/en/ziparchive.getstatusstring.php * @return string a string with the status message on success&return.falseforfailure;. */ public function getStatusString () {} /** * Add a new directory * @link http://www.php.net/manual/en/ziparchive.addemptydir.php * @param dirname string* The directory to add. *
* @return bool Returns true on success, false on failure. */ public function addEmptyDir ($dirname) {} /** * Add a file to a ZIP archive using its contents * @link http://www.php.net/manual/en/ziparchive.addfromstring.php * @param localname string* The name of the entry to create. *
* @param contents string* The contents to use to create the entry. It is used in a binary * safe mode. *
* @return bool Returns true on success, false on failure. */ public function addFromString ($localname, $contents) {} /** * Adds a file to a ZIP archive from the given path * @link http://www.php.net/manual/en/ziparchive.addfile.php * @param filename string* The path to the file to add. *
* @param localname string[optional]* If supplied, this is the local name inside the ZIP archive that will override the filename. *
* @param start int[optional]* This parameter is not used but is required to extend ZipArchive. *
* @param length int[optional]* This parameter is not used but is required to extend ZipArchive. *
* @return bool Returns true on success, false on failure. */ public function addFile ($filename, $localname = null, $start = null, $length = null) {} /** * Add files from a directory by glob pattern * @link http://www.php.net/manual/en/ziparchive.addglob.php * @param pattern * @param flags[optional] * @param options[optional] */ public function addGlob ($pattern, $flags, $options) {} /** * Add files from a directory by PCRE pattern * @link http://www.php.net/manual/en/ziparchive.addpattern.php * @param pattern * @param path[optional] * @param options[optional] */ public function addPattern ($pattern, $path, $options) {} /** * Renames an entry defined by its index * @link http://www.php.net/manual/en/ziparchive.renameindex.php * @param index int* Index of the entry to rename. *
* @param newname string* New name. *
* @return bool Returns true on success, false on failure. */ public function renameIndex ($index, $newname) {} /** * Renames an entry defined by its name * @link http://www.php.net/manual/en/ziparchive.renamename.php * @param name string* Name of the entry to rename. *
* @param newname string* New name. *
* @return bool Returns true on success, false on failure. */ public function renameName ($name, $newname) {} /** * Set the comment of a ZIP archive * @link http://www.php.net/manual/en/ziparchive.setarchivecomment.php * @param comment string* The contents of the comment. *
* @return bool Returns true on success, false on failure. */ public function setArchiveComment ($comment) {} /** * Returns the Zip archive comment * @link http://www.php.net/manual/en/ziparchive.getarchivecomment.php * @param flags int[optional]* If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged * comment is returned. *
* @return string the Zip archive comment&return.falseforfailure;. */ public function getArchiveComment ($flags = null) {} /** * Set the comment of an entry defined by its index * @link http://www.php.net/manual/en/ziparchive.setcommentindex.php * @param index int* Index of the entry. *
* @param comment string* The contents of the comment. *
* @return bool Returns true on success, false on failure. */ public function setCommentIndex ($index, $comment) {} /** * Set the comment of an entry defined by its name * @link http://www.php.net/manual/en/ziparchive.setcommentname.php * @param name string* Name of the entry. *
* @param comment string* The contents of the comment. *
* @return bool Returns true on success, false on failure. */ public function setCommentName ($name, $comment) {} /** * Returns the comment of an entry using the entry index * @link http://www.php.net/manual/en/ziparchive.getcommentindex.php * @param index int* Index of the entry *
* @param flags int[optional]* If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged * comment is returned. *
* @return string the comment on success&return.falseforfailure;. */ public function getCommentIndex ($index, $flags = null) {} /** * Returns the comment of an entry using the entry name * @link http://www.php.net/manual/en/ziparchive.getcommentname.php * @param name string* Name of the entry *
* @param flags int[optional]* If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged * comment is returned. *
* @return string the comment on success&return.falseforfailure;. */ public function getCommentName ($name, $flags = null) {} /** * delete an entry in the archive using its index * @link http://www.php.net/manual/en/ziparchive.deleteindex.php * @param index int* Index of the entry to delete. *
* @return bool Returns true on success, false on failure. */ public function deleteIndex ($index) {} /** * delete an entry in the archive using its name * @link http://www.php.net/manual/en/ziparchive.deletename.php * @param name string* Name of the entry to delete. *
* @return bool Returns true on success, false on failure. */ public function deleteName ($name) {} /** * Get the details of an entry defined by its name. * @link http://www.php.net/manual/en/ziparchive.statname.php * @param name string* Name of the entry *
* @param flags int[optional]* The flags argument specifies how the name lookup should be done. * Also, ZipArchive::FL_UNCHANGED may be ORed to it to request * information about the original file in the archive, * ignoring any changes made. * * *
* ZipArchive::FL_NOCASE *
* @return array an array containing the entry details &return.falseforfailure;. */ public function statName ($name, $flags = null) {} /** * Get the details of an entry defined by its index. * @link http://www.php.net/manual/en/ziparchive.statindex.php * @param index int* Index of the entry *
* @param flags int[optional]* ZipArchive::FL_UNCHANGED may be ORed to it to request * information about the original file in the archive, * ignoring any changes made. *
* @return array an array containing the entry details&return.falseforfailure;. */ public function statIndex ($index, $flags = null) {} /** * Returns the index of the entry in the archive * @link http://www.php.net/manual/en/ziparchive.locatename.php * @param name string* The name of the entry to look up *
* @param flags int[optional]* The flags are specified by ORing the following values, * or 0 for none of them. * * *
* ZipArchive::FL_NOCASE *
* @return int the index of the entry on success&return.falseforfailure;. */ public function locateName ($name, $flags = null) {} /** * Returns the name of an entry using its index * @link http://www.php.net/manual/en/ziparchive.getnameindex.php * @param index int* Index of the entry. *
* @param flags int[optional]* If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged * name is returned. *
* @return string the name on success&return.falseforfailure;. */ public function getNameIndex ($index, $flags = null) {} /** * Revert all global changes done in the archive. * @link http://www.php.net/manual/en/ziparchive.unchangearchive.php * @return bool Returns true on success, false on failure. */ public function unchangeArchive () {} /** * Undo all changes done in the archive * @link http://www.php.net/manual/en/ziparchive.unchangeall.php * @return bool Returns true on success, false on failure. */ public function unchangeAll () {} /** * Revert all changes done to an entry at the given index * @link http://www.php.net/manual/en/ziparchive.unchangeindex.php * @param index int* Index of the entry. *
* @return bool Returns true on success, false on failure. */ public function unchangeIndex ($index) {} /** * Revert all changes done to an entry with the given name. * @link http://www.php.net/manual/en/ziparchive.unchangename.php * @param name string* Name of the entry. *
* @return bool Returns true on success, false on failure. */ public function unchangeName ($name) {} /** * Extract the archive contents * @link http://www.php.net/manual/en/ziparchive.extractto.php * @param destination string* Location where to extract the files. *
* @param entries mixed[optional]* The entries to extract. It accepts either a single entry name or * an array of names. *
* @return bool Returns true on success, false on failure. */ public function extractTo ($destination, $entries = null) {} /** * Returns the entry contents using its name * @link http://www.php.net/manual/en/ziparchive.getfromname.php * @param name string* Name of the entry *
* @param length int[optional]* The length to be read from the entry. If 0, then the * entire entry is read. *
* @param flags int[optional]* The flags to use to open the archive. the following values may * be ORed to it. * * *
* ZipArchive::FL_UNCHANGED *
* @return string the contents of the entry on success&return.falseforfailure;. */ public function getFromName ($name, $length = null, $flags = null) {} /** * Returns the entry contents using its index * @link http://www.php.net/manual/en/ziparchive.getfromindex.php * @param index int* Index of the entry *
* @param length int[optional]* The length to be read from the entry. If 0, then the * entire entry is read. *
* @param flags int[optional]* The flags to use to open the archive. the following values may * be ORed to it. * * *
* ZipArchive::FL_UNCHANGED *
* @return string the contents of the entry on success&return.falseforfailure;. */ public function getFromIndex ($index, $length = null, $flags = null) {} /** * Get a file handler to the entry defined by its name (read only). * @link http://www.php.net/manual/en/ziparchive.getstream.php * @param name string* The name of the entry to use. *
* @return resource a file pointer (resource) on success&return.falseforfailure;. */ public function getStream ($name) {} /** * Set the external attributes of an entry defined by its name * @link http://www.php.net/manual/en/ziparchive.setexternalattributesname.php * @param name string* Name of the entry. *
* @param opsys int* The operating system code defined by one of the ZipArchive::OPSYS_ constants. *
* @param attr int* The external attributes. Value depends on operating system. *
* @param flags int[optional]* Optional flags. Currently unused. *
* @return bool Returns true on success, false on failure. */ public function setExternalAttributesName ($name, $opsys, $attr, $flags = null) {} /** * Set the external attributes of an entry defined by its index * @link http://www.php.net/manual/en/ziparchive.setexternalattributesindex.php * @param index int* Index of the entry. *
* @param opsys int* The operating system code defined by one of the ZipArchive::OPSYS_ constants. *
* @param attr int* The external attributes. Value depends on operating system. *
* @param flags int[optional]* Optional flags. Currently unused. *
* @return bool Returns true on success, false on failure. */ public function setExternalAttributesIndex ($index, $opsys, $attr, $flags = null) {} /** * Retrieve the external attributes of an entry defined by its name * @link http://www.php.net/manual/en/ziparchive.getexternalattributesname.php * @param name string* Name of the entry. *
* @param opsys int* On success, receive the operating system code defined by one of the ZipArchive::OPSYS_ constants. *
* @param attr int* On success, receive the external attributes. Value depends on operating system. *
* @param flags int[optional]* If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged * attributes are returned. *
* @return bool Returns true on success, false on failure. */ public function getExternalAttributesName ($name, &$opsys, &$attr, $flags = null) {} /** * Retrieve the external attributes of an entry defined by its index * @link http://www.php.net/manual/en/ziparchive.getexternalattributesindex.php * @param index int* Index of the entry. *
* @param opsys int* On success, receive the operating system code defined by one of the ZipArchive::OPSYS_ constants. *
* @param attr int* On success, receive the external attributes. Value depends on operating system. *
* @param flags int[optional]* If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged * attributes are returned. *
* @return bool Returns true on success, false on failure. */ public function getExternalAttributesIndex ($index, &$opsys, &$attr, $flags = null) {} } /** * Open a ZIP file archive * @link http://www.php.net/manual/en/function.zip-open.php * @param filename string* The file name of the ZIP archive to open. *
* @return resource a resource handle for later use with * zip_read and zip_close * or returns the number of error if filename does not * exist or in case of other error. */ function zip_open ($filename) {} /** * Close a ZIP file archive * @link http://www.php.net/manual/en/function.zip-close.php * @param zip resource* A ZIP file previously opened with zip_open. *
* @return void */ function zip_close ($zip) {} /** * Read next entry in a ZIP file archive * @link http://www.php.net/manual/en/function.zip-read.php * @param zip resource* A ZIP file previously opened with zip_open. *
* @return resource a directory entry resource for later use with the * zip_entry_... functions, or false if * there are no more entries to read, or an error code if an error * occurred. */ function zip_read ($zip) {} /** * Open a directory entry for reading * @link http://www.php.net/manual/en/function.zip-entry-open.php * @param zip resource* A valid resource handle returned by zip_open. *
* @param zip_entry resource* A directory entry returned by zip_read. *
* @param mode string[optional]* 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. *
* @return bool Returns true on success, false on failure. * * ** 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. */ function zip_entry_open ($zip, $zip_entry, $mode = null) {} /** * Close a directory entry * @link http://www.php.net/manual/en/function.zip-entry-close.php * @param zip_entry resource
* A directory entry previously opened zip_entry_open. *
* @return bool Returns true on success, false on failure. */ function zip_entry_close ($zip_entry) {} /** * Read from an open directory entry * @link http://www.php.net/manual/en/function.zip-entry-read.php * @param zip_entry resource* A directory entry returned by zip_read. *
* @param length int[optional]* The number of bytes to return. *
* ** This should be the uncompressed length you wish to read. *
* @return string the data read, empty string on end of a file, or false on error. */ function zip_entry_read ($zip_entry, $length = null) {} /** * Retrieve the actual file size of a directory entry * @link http://www.php.net/manual/en/function.zip-entry-filesize.php * @param zip_entry resource* A directory entry returned by zip_read. *
* @return int The size of the directory entry. */ function zip_entry_filesize ($zip_entry) {} /** * Retrieve the name of a directory entry * @link http://www.php.net/manual/en/function.zip-entry-name.php * @param zip_entry resource* A directory entry returned by zip_read. *
* @return string The name of the directory entry. */ function zip_entry_name ($zip_entry) {} /** * Retrieve the compressed size of a directory entry * @link http://www.php.net/manual/en/function.zip-entry-compressedsize.php * @param zip_entry resource* A directory entry returned by zip_read. *
* @return int The compressed size. */ function zip_entry_compressedsize ($zip_entry) {} /** * Retrieve the compression method of a directory entry * @link http://www.php.net/manual/en/function.zip-entry-compressionmethod.php * @param zip_entry resource* A directory entry returned by zip_read. *
* @return string The compression method. */ function zip_entry_compressionmethod ($zip_entry) {} // End of zip v.1.12.4 ?>