From c35314db676e77fdecd7f17fba50fcb51c6b37af Mon Sep 17 00:00:00 2001 From: Damien Seguy Date: Thu, 23 Apr 2009 21:18:59 +0000 Subject: [PATCH] moving to oo structure git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@279214 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../zip/functions/ziparchive-addemptydir.xml | 87 -------- .../zip/functions/ziparchive-addfile.xml | 95 --------- .../functions/ziparchive-addfromstring.xml | 108 ---------- reference/zip/functions/ziparchive-close.xml | 46 ----- .../zip/functions/ziparchive-deleteindex.xml | 80 -------- .../zip/functions/ziparchive-deletename.xml | 80 -------- .../zip/functions/ziparchive-extractto.xml | 115 ----------- .../ziparchive-getarchivecomment.xml | 66 ------ .../functions/ziparchive-getcommentindex.xml | 89 -------- .../functions/ziparchive-getcommentname.xml | 89 -------- .../zip/functions/ziparchive-getfromindex.xml | 101 --------- .../zip/functions/ziparchive-getfromname.xml | 116 ----------- .../zip/functions/ziparchive-getnameindex.xml | 60 ------ .../zip/functions/ziparchive-getstream.xml | 119 ----------- .../zip/functions/ziparchive-locatename.xml | 121 ----------- reference/zip/functions/ziparchive-open.xml | 193 ------------------ .../zip/functions/ziparchive-renameindex.xml | 89 -------- .../zip/functions/ziparchive-renamename.xml | 89 -------- .../ziparchive-setarchivecomment.xml | 82 -------- .../functions/ziparchive-setcommentindex.xml | 90 -------- .../functions/ziparchive-setcommentname.xml | 90 -------- .../zip/functions/ziparchive-statindex.xml | 109 ---------- .../zip/functions/ziparchive-statname.xml | 127 ------------ .../zip/functions/ziparchive-unchangeall.xml | 45 ---- .../functions/ziparchive-unchangearchive.xml | 46 ----- .../functions/ziparchive-unchangeindex.xml | 60 ------ .../zip/functions/ziparchive-unchangename.xml | 60 ------ 27 files changed, 2452 deletions(-) delete mode 100644 reference/zip/functions/ziparchive-addemptydir.xml delete mode 100644 reference/zip/functions/ziparchive-addfile.xml delete mode 100644 reference/zip/functions/ziparchive-addfromstring.xml delete mode 100644 reference/zip/functions/ziparchive-close.xml delete mode 100644 reference/zip/functions/ziparchive-deleteindex.xml delete mode 100644 reference/zip/functions/ziparchive-deletename.xml delete mode 100644 reference/zip/functions/ziparchive-extractto.xml delete mode 100644 reference/zip/functions/ziparchive-getarchivecomment.xml delete mode 100644 reference/zip/functions/ziparchive-getcommentindex.xml delete mode 100644 reference/zip/functions/ziparchive-getcommentname.xml delete mode 100644 reference/zip/functions/ziparchive-getfromindex.xml delete mode 100644 reference/zip/functions/ziparchive-getfromname.xml delete mode 100644 reference/zip/functions/ziparchive-getnameindex.xml delete mode 100644 reference/zip/functions/ziparchive-getstream.xml delete mode 100644 reference/zip/functions/ziparchive-locatename.xml delete mode 100644 reference/zip/functions/ziparchive-open.xml delete mode 100644 reference/zip/functions/ziparchive-renameindex.xml delete mode 100644 reference/zip/functions/ziparchive-renamename.xml delete mode 100644 reference/zip/functions/ziparchive-setarchivecomment.xml delete mode 100644 reference/zip/functions/ziparchive-setcommentindex.xml delete mode 100644 reference/zip/functions/ziparchive-setcommentname.xml delete mode 100644 reference/zip/functions/ziparchive-statindex.xml delete mode 100644 reference/zip/functions/ziparchive-statname.xml delete mode 100644 reference/zip/functions/ziparchive-unchangeall.xml delete mode 100644 reference/zip/functions/ziparchive-unchangearchive.xml delete mode 100644 reference/zip/functions/ziparchive-unchangeindex.xml delete mode 100644 reference/zip/functions/ziparchive-unchangename.xml diff --git a/reference/zip/functions/ziparchive-addemptydir.xml b/reference/zip/functions/ziparchive-addemptydir.xml deleted file mode 100644 index 3de7c5f677..0000000000 --- a/reference/zip/functions/ziparchive-addemptydir.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - ZipArchive::addEmptyDir - Add a new directory - - - &reftitle.description; - - boolZipArchive::addEmptyDir - stringdirname - - - Adds an empty directory in the archive. - - - - - &reftitle.parameters; - - - - dirname - - - The directory to add. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - Create a new directory in an archive - -open('test.zip') === TRUE) { - if($zip->addEmptyDir('newDirectory')) { - echo 'Created a new root directory'; - } else { - echo 'Could not create the directory'; - } - $zip->close(); -} else { - echo 'failed'; -} -?> -]]> - - - - - - - diff --git a/reference/zip/functions/ziparchive-addfile.xml b/reference/zip/functions/ziparchive-addfile.xml deleted file mode 100644 index 530eb3f5f8..0000000000 --- a/reference/zip/functions/ziparchive-addfile.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - ZipArchive::addFile - Adds a file to a ZIP archive from the given path - - - &reftitle.description; - - boolZipArchive::addFile - stringfilename - stringlocalname - - - Adds a file to a ZIP archive from a given path - - - - &reftitle.parameters; - - - - filename - - - The path to the file to add. - - - - - localname - - - local name inside ZIP archive. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - This example opens a ZIP file archive - test.zip and add - the file /path/to/index.txt. - as newname.txt. - - - Open and extract - -open('test.zip') === TRUE) { - $zip->addFile('/path/to/index.txt', 'newname.txt'); - $zip->close(); - echo 'ok'; -} else { - echo 'failed'; -} -?> -]]> - - - - - - diff --git a/reference/zip/functions/ziparchive-addfromstring.xml b/reference/zip/functions/ziparchive-addfromstring.xml deleted file mode 100644 index 426db1a806..0000000000 --- a/reference/zip/functions/ziparchive-addfromstring.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - ZipArchive::addFromString - Add a file to a ZIP archive using its contents - - - &reftitle.description; - - boolZipArchive::addFromString - stringlocalname - stringcontents - - - Add a file to a ZIP archive using its contents. - - - - &reftitle.parameters; - - - - localname - - - The name of the entry to create. - - - - - contents - - - The contents to use to create the entry. It is used in a binary - safe mode. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Add an entry to a new archive - -open('test.zip', ZipArchive::CREATE); -if ($res === TRUE) { - $zip->addFromString('test.txt', 'file content goes here'); - $zip->close(); - echo 'ok'; -} else { - echo 'failed'; -} -?> -]]> - - - - Add file to a directory inside an archive - -open('test.zip') === TRUE) { - $zip->addFromString('dir/test.txt', 'file content goes here'); - $zip->close(); - echo 'ok'; -} else { - echo 'failed'; -} -?> -]]> - - - - - - diff --git a/reference/zip/functions/ziparchive-close.xml b/reference/zip/functions/ziparchive-close.xml deleted file mode 100644 index 8ac63ab274..0000000000 --- a/reference/zip/functions/ziparchive-close.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - ZipArchive::close - Close the active archive (opened or newly created) - - - &reftitle.description; - - boolZipArchive::close - - - - Close opened or created archive and save changes. This method is - automatically called at the end of the script. - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/zip/functions/ziparchive-deleteindex.xml b/reference/zip/functions/ziparchive-deleteindex.xml deleted file mode 100644 index 92b0a6302d..0000000000 --- a/reference/zip/functions/ziparchive-deleteindex.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - ZipArchive::deleteIndex - delete an entry in the archive using its index - - - &reftitle.description; - - boolZipArchive::deleteIndex - intindex - - - Delete an entry in the archive using its index. - - - - &reftitle.parameters; - - - - index - - - Index of the entry to delete. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Delete file from archive using its index - -open('test.zip') === TRUE) { - $zip->deleteIndex(2); - $zip->close(); - echo 'ok'; -} else { - echo 'failed'; -} -?> -]]> - - - - - - diff --git a/reference/zip/functions/ziparchive-deletename.xml b/reference/zip/functions/ziparchive-deletename.xml deleted file mode 100644 index 754f94cdd8..0000000000 --- a/reference/zip/functions/ziparchive-deletename.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - ZipArchive::deleteName - delete an entry in the archive using its name - - - &reftitle.description; - - boolZipArchive::deleteName - stringname - - - Delete an entry in the archive using its name. - - - - &reftitle.parameters; - - - - name - - - Name of the entry to delete. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Delete file from archive using its name - -open('test1.zip') === TRUE) { - $zip->deleteName('testfromfile.php'); - $zip->close(); - echo 'ok'; -} else { - echo 'failed'; -} -?> -]]> - - - - - - diff --git a/reference/zip/functions/ziparchive-extractto.xml b/reference/zip/functions/ziparchive-extractto.xml deleted file mode 100644 index d813031b28..0000000000 --- a/reference/zip/functions/ziparchive-extractto.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - ZipArchive::extractTo - Extract the archive contents - - - &reftitle.description; - - boolZipArchive::extractTo - stringdestination - mixedentries - - - Extract the complete archive or the given files to the specified - destination. - - - - &reftitle.parameters; - - - - destination - - - Location where to extract the files. - - - - - entries - - - The entries to extract. It accepts either a single entry name or - an array of names. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - This example opens a ZIP file archive, reads each file in the - archive and prints out its contents. The - test2.zip archive used in this example is - one of the test archives in the ZZIPlib source distribution. - - - Extract all entries - -open('test.zip') === TRUE) { - $zip->extractTo('/my/destination/dir/'); - $zip->close(); - echo 'ok'; -} else { - echo 'failed'; -} -?> -]]> - - - - Extract only two entries - -open('test_im.zip'); -if ($res === TRUE) { - $zip->extractTo('/my/destination/dir/', array('pear_item.gif', 'testfromfile.php')); - $zip->close(); - echo 'ok'; -} else { - echo 'failed'; -} -?> -]]> - - - - - - diff --git a/reference/zip/functions/ziparchive-getarchivecomment.xml b/reference/zip/functions/ziparchive-getarchivecomment.xml deleted file mode 100644 index 97c4d2711f..0000000000 --- a/reference/zip/functions/ziparchive-getarchivecomment.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - ZipArchive::getArchiveComment - Returns the Zip archive comment - - - &reftitle.description; - - stringZipArchive::getArchiveComment - - - - Returns the Zip archive comment. - - - - &reftitle.returnvalues; - - Returns the Zip archive comment or &false; on failure. - - - - &reftitle.examples; - - Dump an archive comment - -open('test_with_comment.zip'); -if ($res === TRUE) { - var_dump($zip->getArchiveComment()); - /* Or using the archive property */ - var_dump($zip->comment); -} else { - echo 'failed, code:' . $res; -} -?> -]]> - - - - - - diff --git a/reference/zip/functions/ziparchive-getcommentindex.xml b/reference/zip/functions/ziparchive-getcommentindex.xml deleted file mode 100644 index 89b5f77ec4..0000000000 --- a/reference/zip/functions/ziparchive-getcommentindex.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - ZipArchive::getCommentIndex - Returns the comment of an entry using the entry index - - - &reftitle.description; - - stringZipArchive::getCommentIndex - intindex - intflags - - - Returns the comment of an entry using the entry index. - - - - &reftitle.parameters; - - - - index - - - Index of the entry - - - - - flags - - - If flags is set to ZIPARCHIVE::FL_UNCHANGED, the original unchanged - comment is returned. - - - - - - - - &reftitle.returnvalues; - - Returns the comment on success or &false; on failure. - - - - &reftitle.examples; - - Dump an entry comment - -open('test1.zip'); -if ($res === TRUE) { - var_dump($zip->getCommentIndex(1)); -} else { - echo 'failed, code:' . $res; -} -?> -]]> - - - - - - diff --git a/reference/zip/functions/ziparchive-getcommentname.xml b/reference/zip/functions/ziparchive-getcommentname.xml deleted file mode 100644 index 273d466557..0000000000 --- a/reference/zip/functions/ziparchive-getcommentname.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - ZipArchive::getCommentName - Returns the comment of an entry using the entry name - - - &reftitle.description; - - stringZipArchive::getCommentName - stringname - intflags - - - Returns the comment of an entry using the entry name. - - - - &reftitle.parameters; - - - - name - - - Name of the entry - - - - - flags - - - If flags is set to ZIPARCHIVE::FL_UNCHANGED, the original unchanged - comment is returned. - - - - - - - - &reftitle.returnvalues; - - Returns the comment on success or &false; on failure. - - - - &reftitle.examples; - - Dump an entry comment - -open('test1.zip'); -if ($res === TRUE) { - var_dump($zip->getCommentName('test/entry1.txt')); -} else { - echo 'failed, code:' . $res; -} -?> -]]> - - - - - - diff --git a/reference/zip/functions/ziparchive-getfromindex.xml b/reference/zip/functions/ziparchive-getfromindex.xml deleted file mode 100644 index 55a546f5c9..0000000000 --- a/reference/zip/functions/ziparchive-getfromindex.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - ZipArchive::getFromIndex - Returns the entry contents using its index. - - - &reftitle.description; - - mixedZipArchive::getFromIndex - intindex - intflags - - - Returns the entry contents using its index. - - - - &reftitle.parameters; - - - - index - - - Index of the entry - - - - - flags - - - The flags to use to open the archive. the following values may - be ORed to it. - - - - ZIPARCHIVE::FL_UNCHANGED - - - - - ZIPARCHIVE::FL_COMPRESSED - - - - - - - - - - - &reftitle.returnvalues; - - Returns the contents of the entry on success or &false; on failure. - - - - &reftitle.examples; - - Get the file contents - -open('test.zip') === TRUE) { - echo $zip->getFromIndex(2); - $zip->close(); -} else { - echo 'failed'; -} -?> -]]> - - - - - - diff --git a/reference/zip/functions/ziparchive-getfromname.xml b/reference/zip/functions/ziparchive-getfromname.xml deleted file mode 100644 index bc520779f3..0000000000 --- a/reference/zip/functions/ziparchive-getfromname.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - ZipArchive::getFromName - Returns the entry contents using its name. - - - &reftitle.description; - - mixedZipArchive::getFromName - stringname - intflags - - - Returns the entry contents using its name. - - - - &reftitle.parameters; - - - - name - - - Name of the entry - - - - - flags - - - The flags to use to open the archive. the following values may - be ORed to it. - - - - ZIPARCHIVE::FL_UNCHANGED - - - - - ZIPARCHIVE::FL_COMPRESSED - - - - - - - - - - - &reftitle.returnvalues; - - Returns the contents of the entry on success or &false; on failure. - - - - &reftitle.examples; - - Get the file contents - -open('test1.zip') === TRUE) { - echo $zip->getFromName('testfromfile.php'); - $zip->close(); -} else { - echo 'failed'; -} -?> -]]> - - - - Convert an image from a zip entry - -open(dirname(__FILE__) . '/test_im.zip')) { - $im_string = $z->getFromName("pear_item.gif"); - $im = imagecreatefromstring($im_string); - imagepng($im, 'b.png'); -} -?> -]]> - - - - - - diff --git a/reference/zip/functions/ziparchive-getnameindex.xml b/reference/zip/functions/ziparchive-getnameindex.xml deleted file mode 100644 index 4d5c8b0e4c..0000000000 --- a/reference/zip/functions/ziparchive-getnameindex.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - ZipArchive::getNameIndex - Returns the name of an entry using its index - - - &reftitle.description; - - stringZipArchive::getNameIndex - intindex - - - Returns the name of an entry using its index. - - - - &reftitle.parameters; - - - - index - - - Index of the entry. - - - - - - - - &reftitle.returnvalues; - - Returns the name on success or &false; on failure. - - - - - diff --git a/reference/zip/functions/ziparchive-getstream.xml b/reference/zip/functions/ziparchive-getstream.xml deleted file mode 100644 index bc0376554c..0000000000 --- a/reference/zip/functions/ziparchive-getstream.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - ZipArchive::getStream - Get a file handler to the entry defined by its name (read only). - - - &reftitle.description; - - resourceZipArchive::getStream - stringname - - - Get a file handler to the entry defined by its name. For now it only - supports read operations. - - - - &reftitle.parameters; - - - - name - - - The name of the entry to use. - - - - - - - - &reftitle.returnvalues; - - Returns a file pointer (resource) on success or &false; on failure. - - - - &reftitle.examples; - - Get the entry contents with <function>fread</function> and store it - -open('test.zip')) { - $fp = $z->getStream('test'); - if(!$fp) exit("failed\n"); - - while (!feof($fp)) { - $contents .= fread($fp, 2); - } - - fclose($fp); - file_put_contents('t',$contents); - echo "done.\n"; -} -?> -]]> - - - - Same as the previous example but with <function>fopen</function> and the zip - stream wrapper - - -]]> - - - - Stream wrapper and image, can be used with the xml function - as well - - -]]> - - - - - - diff --git a/reference/zip/functions/ziparchive-locatename.xml b/reference/zip/functions/ziparchive-locatename.xml deleted file mode 100644 index 614aff4e37..0000000000 --- a/reference/zip/functions/ziparchive-locatename.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - ZipArchive::locateName - Returns the index of the entry in the archive - - - &reftitle.description; - - mixedZipArchive::locateName - stringname - intflags - - - Locates an entry using its name. - - - - &reftitle.parameters; - - - - name - - - The name of the entry to look up - - - - - flags - - - The function returns the index of the file named fname in - archive. The flags are specified by ORing the following values, - or 0 for none of them. - - - - ZIPARCHIVE::FL_NOCASE - - - - - ZIPARCHIVE::FL_NODIR - - - - - - - - - - - &reftitle.returnvalues; - - Returns the index of the entry on success or &false; on failure. - - - - &reftitle.examples; - - Create an archive and then use it with locateName - -open($file, ZIPARCHIVE::CREATE) !== TRUE) { - exit('failed'); -} - -$zip->addFromString('entry1.txt', 'entry #1'); -$zip->addFromString('entry2.txt', 'entry #2'); -$zip->addFromString('dir/entry2d.txt', 'entry #2'); - -if (!$zip->status == ZIPARCHIVE::ER_OK) { - echo "failed to write zip\n"; -} -$zip->close(); - -if ($zip->open($file) !== TRUE) { - exit('failed'); -} - -echo $zip->locateName('entry1.txt') . "\n"; -echo $zip->locateName('eNtry2.txt') . "\n"; -echo $zip->locateName('eNtry2.txt', ZIPARCHIVE::FL_NOCASE) . "\n"; -echo $zip->locateName('enTRy2d.txt', ZIPARCHIVE::FL_NOCASE|ZIPARCHIVE::FL_NODIR) . "\n"; -$zip->close(); - -?> -]]> - - - - - - diff --git a/reference/zip/functions/ziparchive-open.xml b/reference/zip/functions/ziparchive-open.xml deleted file mode 100644 index 9df926187d..0000000000 --- a/reference/zip/functions/ziparchive-open.xml +++ /dev/null @@ -1,193 +0,0 @@ - - - - - ZipArchive::open - Open a ZIP file archive - - - &reftitle.description; - - mixedZipArchive::open - stringfilename - intflags - - - Opens a new zip archive for reading, writing or modifying. - - - - &reftitle.parameters; - - - - filename - - - The file name of the ZIP archive to open. - - - - - flags - - - The mode to use to open the archive. - - - - ZIPARCHIVE::OVERWRITE - - - - - ZIPARCHIVE::CREATE - - - - - ZIPARCHIVE::EXCL - - - - - ZIPARCHIVE::CHECKCONS - - - - - - - - - - - &reftitle.returnvalues; - - - - Error codes - - - Returns &true; on success or the error code. - - - - ZIPARCHIVE::ER_EXISTS - - - - - ZIPARCHIVE::ER_INCONS - - - - - ZIPARCHIVE::ER_INVAL - - - - - ZIPARCHIVE::ER_MEMORY - - - - - ZIPARCHIVE::ER_NOENT - - - - - ZIPARCHIVE::ER_NOZIP - - - - - ZIPARCHIVE::ER_OPEN - - - - - ZIPARCHIVE::ER_READ - - - - - ZIPARCHIVE::ER_SEEK - - - - - - - - - - - &reftitle.examples; - - This example opens a ZIP file archive, reads each file in the - archive and prints out its contents. The - test2.zip archive used in this example is - one of the test archives in the ZZIPlib source distribution. - - - Open and extract - -open('test.zip'); -if ($res === TRUE) { - echo 'ok'; - $zip->extractTo('test'); - $zip->close(); -} else { - echo 'failed, code:' . $res; -} -?> -]]> - - - - Create an archive - -open('test.zip', ZipArchive::CREATE); -if ($res === TRUE) { - $zip->addFromString('test.txt', 'file content goes here'); - $zip->addFile('data.txt', 'entryname.txt'); - $zip->close(); - echo 'ok'; -} else { - echo 'failed'; -} -?> -]]> - - - - - - diff --git a/reference/zip/functions/ziparchive-renameindex.xml b/reference/zip/functions/ziparchive-renameindex.xml deleted file mode 100644 index 8a69cc1621..0000000000 --- a/reference/zip/functions/ziparchive-renameindex.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - ZipArchive::renameIndex - Renames an entry defined by its index - - - &reftitle.description; - - boolZipArchive::renameIndex - intindex - stringnewname - - - Renames an entry defined by its index. - - - - &reftitle.parameters; - - - - index - - - Index of the entry to rename. - - - - - newname - - - New name. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Rename one entry - -open('test.zip'); -if ($res === TRUE) { - $zip->renameIndex(2,'newname.txt'); - $zip->close(); -} else { - echo 'failed, code:' . $res; -} -?> -]]> - - - - - - diff --git a/reference/zip/functions/ziparchive-renamename.xml b/reference/zip/functions/ziparchive-renamename.xml deleted file mode 100644 index 3a22767d6d..0000000000 --- a/reference/zip/functions/ziparchive-renamename.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - ZipArchive::renameName - Renames an entry defined by its name - - - &reftitle.description; - - boolZipArchive::renameName - stringname - stringnewname - - - Renames an entry defined by its name. - - - - &reftitle.parameters; - - - - name - - - Name of the entry to rename. - - - - - newname - - - New name. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Rename one entry - -open('test.zip'); -if ($res === TRUE) { - $zip->renameName('currentname.txt','newname.txt'); - $zip->close(); -} else { - echo 'failed, code:' . $res; -} -?> -]]> - - - - - - diff --git a/reference/zip/functions/ziparchive-setarchivecomment.xml b/reference/zip/functions/ziparchive-setarchivecomment.xml deleted file mode 100644 index 5306264334..0000000000 --- a/reference/zip/functions/ziparchive-setarchivecomment.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - ZipArchive::setArchiveComment - Set the comment of a ZIP archive - - - &reftitle.description; - - mixedZipArchive::setArchiveComment - stringcomment - - - Set the comment of a ZIP archive. - - - - &reftitle.parameters; - - - - comment - - - The contents of the comment. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Create an archive and set a comment - -open('test.zip', ZipArchive::CREATE); -if ($res === TRUE) { - $zip->addFromString('test.txt', 'file content goes here'); - $zip->setArchiveComment('new archive comment'); - $zip->close(); - echo 'ok'; -} else { - echo 'failed'; -} -?> -]]> - - - - - - diff --git a/reference/zip/functions/ziparchive-setcommentindex.xml b/reference/zip/functions/ziparchive-setcommentindex.xml deleted file mode 100644 index a602fb46b6..0000000000 --- a/reference/zip/functions/ziparchive-setcommentindex.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - ZipArchive::setCommentIndex - Set the comment of an entry defined by its index - - - &reftitle.description; - - mixedZipArchive::setCommentIndex - intindex - stringcomment - - - Set the comment of an entry defined by its index. - - - - &reftitle.parameters; - - - - index - - - Index of the entry. - - - - - comment - - - The contents of the comment. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Open an archive and set a comment for an entry - -open('test.zip'); -if ($res === TRUE) { - $zip->setCommentIndex(2, 'new entry comment'); - $zip->close(); - echo 'ok'; -} else { - echo 'failed'; -} -?> -]]> - - - - - - diff --git a/reference/zip/functions/ziparchive-setcommentname.xml b/reference/zip/functions/ziparchive-setcommentname.xml deleted file mode 100644 index d2c2b37da0..0000000000 --- a/reference/zip/functions/ziparchive-setcommentname.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - ZipArchive::setCommentName - Set the comment of an entry defined by its name - - - &reftitle.description; - - mixedZipArchive::setCommentName - stringname - stringcomment - - - Set the comment of an entry defined by its name. - - - - &reftitle.parameters; - - - - name - - - Name of the entry. - - - - - comment - - - The contents of the comment. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - Open an archive and set a comment for an entry - -open('test.zip'); -if ($res === TRUE) { - $zip->setCommentName('entry1.txt', 'new entry comment'); - $zip->close(); - echo 'ok'; -} else { - echo 'failed'; -} -?> -]]> - - - - - - diff --git a/reference/zip/functions/ziparchive-statindex.xml b/reference/zip/functions/ziparchive-statindex.xml deleted file mode 100644 index eb18def530..0000000000 --- a/reference/zip/functions/ziparchive-statindex.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - ZipArchive::statIndex - Get the details of an entry defined by its index. - - - &reftitle.description; - - mixedZipArchive::statIndex - intindex - intflags - - - The function obtains information about the entry defined by its - index. - - - - &reftitle.parameters; - - - - index - - - Index of the entry - - - - - flags - - - ZIPARCHIVE::FL_UNCHANGED may be ORed to it to request - information about the original file in the archive, - ignoring any changes made. - - - - - - - - &reftitle.returnvalues; - - Returns an array containing the entry details or &false; on failure. - - - - &reftitle.examples; - - Dump the stat info of an entry - -open('test.zip'); -if ($res === TRUE) { - print_r($zip->statIndex(3)); - $zip->close(); -} else { - echo 'failed, code:' . $res; -} -?> -]]> - - &example.outputs.similar; - - foobar/baz - [index] => 3 - [crc] => 499465816 - [size] => 27 - [mtime] => 1123164748 - [comp_size] => 24 - [comp_method] => 8 -) -]]> - - - - - - - - diff --git a/reference/zip/functions/ziparchive-statname.xml b/reference/zip/functions/ziparchive-statname.xml deleted file mode 100644 index 3ffb49fec9..0000000000 --- a/reference/zip/functions/ziparchive-statname.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - ZipArchive::statName - Get the details of an entry defined by its name. - - - &reftitle.description; - - mixedZipArchive::statName - namename - intflags - - - The function obtains information about the entry defined by its - name. - - - - &reftitle.parameters; - - - - name - - - Name of the entry - - - - - flags - - - 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 - - - - - ZIPARCHIVE::FL_NODIR - - - - - ZIPARCHIVE::FL_UNCHANGED - - - - - - - - - - - &reftitle.returnvalues; - - Returns an array containing the entry details or &false; on failure. - - - - &reftitle.examples; - - Dump the stat info of an entry - -open('test.zip'); -if ($res === TRUE) { - print_r($zip->statName('foobar/baz')); - $zip->close(); -} else { - echo 'failed, code:' . $res; -} -?> -]]> - - &example.outputs.similar; - - foobar/baz - [index] => 3 - [crc] => 499465816 - [size] => 27 - [mtime] => 1123164748 - [comp_size] => 24 - [comp_method] => 8 -) -]]> - - - - - - - - diff --git a/reference/zip/functions/ziparchive-unchangeall.xml b/reference/zip/functions/ziparchive-unchangeall.xml deleted file mode 100644 index a321954879..0000000000 --- a/reference/zip/functions/ziparchive-unchangeall.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - ZipArchive::unchangeAll - Undo all changes done in the archive. - - - &reftitle.description; - - mixedZipArchive::unchangeAll - - - - Undo all changes done in the archive. - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/zip/functions/ziparchive-unchangearchive.xml b/reference/zip/functions/ziparchive-unchangearchive.xml deleted file mode 100644 index 3bb3e4d0e6..0000000000 --- a/reference/zip/functions/ziparchive-unchangearchive.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - ZipArchive::unchangeArchive - Revert all global changes done in the archive. - - - &reftitle.description; - - mixedZipArchive::unchangeArchive - - - - Revert all global changes to the archive archive. For now, this - only reverts archive comment changes. - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/zip/functions/ziparchive-unchangeindex.xml b/reference/zip/functions/ziparchive-unchangeindex.xml deleted file mode 100644 index b0a1d02d4c..0000000000 --- a/reference/zip/functions/ziparchive-unchangeindex.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - ZipArchive::unchangeIndex - Revert all changes done to an entry at the given index. - - - &reftitle.description; - - mixedZipArchive::unchangeIndex - intindex - - - Revert all changes done to an entry at the given index. - - - - &reftitle.parameters; - - - - index - - - Index of the entry. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/zip/functions/ziparchive-unchangename.xml b/reference/zip/functions/ziparchive-unchangename.xml deleted file mode 100644 index b7c0363b03..0000000000 --- a/reference/zip/functions/ziparchive-unchangename.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - ZipArchive::unchangeName - Revert all changes done to an entry with the given name. - - - &reftitle.description; - - mixedZipArchive::unchangeName - stringname - - - Revert all changes done to an entry. - - - - &reftitle.parameters; - - - - name - - - Name of the entry. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - -