[edit] Last updated: Fri, 25 May 2012

ZipArchive::open

(PHP 5 >= 5.2.0, PECL zip >= 1.1.0)

ZipArchive::open — ZIP ファイルアーカイブをオープンする

説明

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

新しい zip アーカイブを、読み込み/書き込み/変更用にオープンします。

パラメータ

filename

オープンする ZIP アーカイブのファイル名。

flags

アーカイブのオープンに使用するモード。

ZIPARCHIVE::OVERWRITE
ZIPARCHIVE::CREATE
ZIPARCHIVE::EXCL
ZIPARCHIVE::CHECKCONS

返り値

エラーコード

成功した場合に TRUE、それ以外の場合にエラーコードを返します。

ZIPARCHIVE::ER_EXISTS

ファイルが既に存在します。
ZIPARCHIVE::ER_INCONS

Zip アーカイブに矛盾があります。
ZIPARCHIVE::ER_INVAL

無効な引数です。
ZIPARCHIVE::ER_MEMORY

メモリの確保に失敗しました。
ZIPARCHIVE::ER_NOENT

ファイルが存在しません。
ZIPARCHIVE::ER_NOZIP

zip アーカイブではありません。
ZIPARCHIVE::ER_OPEN

ファイルを開けません。
ZIPARCHIVE::ER_READ

読み込みエラー。
ZIPARCHIVE::ER_SEEK

シークエラー。

例

例1 オープンおよび展開


<?php
$zip = new ZipArchive;
$res = $zip->open('test.zip');
if ($res === TRUE) {
    echo '成功';
    $zip->extractTo('test');
    $zip->close();
} else {
    echo '失敗、コード:' . $res;
}
?>

例2 アーカイブの作成


<?php
$zip = new ZipArchive;
$res = $zip->open('test.zip', ZipArchive::CREATE);
if ($res === TRUE) {
    $zip->addFromString('test.txt', 'ここにファイルの内容を書きます');
    $zip->addFile('data.txt', 'entryname.txt');
    $zip->close();
    echo '成功';
} else {
    echo '失敗';
}
?>

ZipArchive::renameIndex

ZipArchive::locateName

[edit] Last updated: Fri, 25 May 2012

add a note User Contributed Notes ZipArchive::open

YiiWanAB at hotmail dot com 30-Aug-2011 07:06


Most of the time people iterate over a directory with 'opendir' or 'readdir' to add files to a zip. Like...



while ($file = readdir($dir)) { ... $zip->addFile($file) }



Note that $zip->addFile($file) will only work in the current directory if your at the root. You will need to add the correct path to that $file string variable to have the full file name like ...



$zip->addFile($dir . DIRECTORY_SEPARATOR . $file); will work.



This may identify why you may get a read error when closing the file. 



Enjoy.

sunil dt bhave at gmail dt com 17-Mar-2011 07:44


Even though the api specifies that the flags are optional I found that I had to specify the flag ZIPARCHIVE::CREATE for an archive to be opened. 

This is on a Windows 7 system with PHP 5.3.0

Jan Vavra 10-Mar-2011 09:04


As discussed in http://bugs.php.net/bug.php?id=54128 on Windows Server systems (2003, 2008) and IIS there is a problem when you want to unzip file stored in C:\Windows\Temp folder.

User of worker process IUSR_XXX has no directory listing right for C:\Windows\Temp and this is a reason why ZipArchive::open() fails with error 11 (error open). So it is not a good idea to store file for unzipping in folder defined by sys_get_temp_dir().

sebwoolford at gmail dot com 23-Oct-2009 12:29


Further to what rickky at gmail dot com was saying, I've had that problem while trying to cache zip files and found that I had to set the permissions of the containing folder to 777 to get it to work.



Because this is a potential security weakness if on a public viewable folder, I'd recommend moving the folder so that it is no longer within public_html. You can then use readfile() to output the archive to the browser, with some HTTP headers to tell the browser it is a zip file.

michael202 at gmx dot de 29-Jul-2009 03:33


to anyone getting an error ZIPARCHIVE::ER_READ = 5, when

doing $zip->open($zipfile) with a ZIP file containing a total of more then (around) 800 files (even when they are in sub-directories).



possibly related bugs 40873, 8714:



1. it was not an OS limit, because it worked when called from windows via samba on the same file at the same place



2. it wasn't working under 32bit linux



with php 5.3.0 the issue seems to be resolved.

eric at webdeveric dot com 06-Feb-2009 04:06


With php 5.2.6, the following code created a new zip or replaced a existing zip.

Note that I am only using the ZIPARCHIVE::OVERWRITE flag.



<?php

    $zip = new ZipArchive();

    $opened = $zip->open( $zipFileName, ZIPARCHIVE::OVERWRITE );

    if( $opened !== true ){

        die("cannot open {$zipFileName} for writing.");

    }

    $zip->addFromString( $name, $contents );

    $zip->close();

?>



Now, with php 5.2.8, it does not work and gives this warning:



Warning: ZipArchive::addFromString() [ziparchive.addfromstring]: Invalid or unitialized Zip object in [myfile] on line [myline]



To fix this, you must specify the flags as create or overwrite.



<?php

    $zip = new ZipArchive();

    $opened = $zip->open( $zipFileName, ZIPARCHIVE::CREATE | ZIPARCHIVE::OVERWRITE );

    if( $opened !== true ){

        die("cannot open {$zipFileName} for writing.");

    }

    $zip->addFromString( $name, $contents );

    $zip->close();

?>



When googling for the error message I found a lot of people that had it but couldn't figure out why they were getting it.

I hope this helps someone.

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