Last updated: Fri, 02 Jan 2009

ZipArchive::open

(No version information available, might be only in CVS)

ZipArchive::open — Open a ZIP file archive

Description

mixed ZipArchive::open ( string $filename [, int $flags ] )

Opens a new zip archive for reading, writing or modifying.

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

Return Values

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

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.

Example #1 Open and extract


<?php
$zip = new ZipArchive;
$res = $zip->open('test.zip');
if ($res === TRUE) {
    echo 'ok';
    $zip->extractTo('test');
    $zip->close();
} else {
    echo 'failed, code:' . $res;
}
?>

Example #2 Create an archive


<?php
$zip = new ZipArchive;
$res = $zip->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';
}
?>

ZipArchive::renameIndex

ZipArchive::locateName

Last updated: Fri, 02 Jan 2009

add a note User Contributed Notes
ZipArchive::open

jj at icglink dot com
04-Dec-2008 08:09


if you are echoing out the output and confused about the number...maybe this will help.  i'm not totally sure it is accurate though.



ZIPARCHIVE::ER_EXISTS - 10

ZIPARCHIVE::ER_INCONS - 21

ZIPARCHIVE::ER_INVAL - 18

ZIPARCHIVE::ER_MEMORY - 14

ZIPARCHIVE::ER_NOENT - 9

ZIPARCHIVE::ER_NOZIP - 19

ZIPARCHIVE::ER_OPEN - 11

ZIPARCHIVE::ER_READ - 5

ZIPARCHIVE::ER_SEEK - 4

azsymvelik at gmail dot com
01-Aug-2008 10:25


<?php





/*


Hi!





I made a little script about checking content and "secure repacking"


*/





$somefile = "zip.zip";


$someurl = "/some/url"


$zip = new ZipArchive;


$open = $zip->open($somefile, ZIPARCHIVE::CHECKCONS);


// If the archive is broken(or just another file renamed to *.zip) the function will return error on httpd under windows, so it's good to check if the archive is ok with ZIPARCHIVE::CHECKCONS


if ($open === TRUE) {


if(!$zip->extractTo($someurl)) {


die ("Error during extracting");


}


$zip->close();


}


$new_archive_name = "new.zip";


$new_zip = new ZipArchive;


$new_open = $new_zip->open($new_archive_name, ZIPARCHIVE::CREATE);


if ($new_open === TRUE) {


$dir = opendir($someurl);


while ($file = readdir($dir)) {


 if ($file == "." || $file == "..") { } else {


 //We do not wanna this files in the new zip archive


  if (!$new_zip->addFile($file)) {


     print $file."was not added!<br />";


   }


  }


 }


}


$new_zip->close();


?>

Jonathan Baltazar
23-Jul-2008 04:14


The file name does not need to end in '.zip' if it is created using tempnam().  You just need to overwrite the file instead of trying to read it:





<?php


$file = tempnam("tmp", "zip");


    


$zip = new ZipArchive();





// Zip will open and overwrite the file, rather than try to read it.


$zip->open($file, ZipArchive::OVERWRITE);





$zip->close();





// Stream the file to the client


header("Content-Type: application/zip");


header("Content-Length: " . filesize($file));


header("Content-Disposition: attachment; filename=\"a_zip_file.zip\"");


readfile($file);





unlink($file);


?>

olivier pons
16-May-2008 09:26


If you try this to open a file with creation in mind (= empty zip to fill with other files), this may not work :



$res = $zip->open($zip_file, ZipArchive::CREATE);



// you may get false



Try this instead, it should work :



$res = $zip->open($zip_file, ZIPARCHIVE::OVERWRITE);

Anonymous
19-Dec-2007 03:26


It seems the filename has to end in '.zip', so this suffix must be added when using tempnam() to create a random temporary file name.

rickky at gmail dot com
02-Jul-2007 02:07


If the directory you are writing or saving into does not have the correct permissions set, you won't get any error messages and it will look like everything worked fine... except it won't have changed!



Instead make sure you collect the return value of ZipArchive::close(). If it is false... it didn't work.

add a note

ZipArchive::renameIndex

ZipArchive::locateName

Last updated: Fri, 02 Jan 2009