php類PclZip簡介與使用

 

PclZip介紹
PclZip library可以壓縮與解壓縮Zip格式的壓縮檔(WinZip、PKZIP);且能對此類類檔案進行處理,包括產生壓縮檔、列出壓縮檔的內容以及解壓縮檔案等等。因爲可以在伺服器端進行壓縮與解壓縮的動做,因此至關方便使用。
PclZip定義一個PclZip類別,其類別物件可視爲一個ZIP檔案,亦提供method來進行處理。php

如何使用PclZip
1.基礎
全部的功能都由pclzip.lib.php這個檔案提供,PclZip library可於其首頁(www.phpconcept.net/pclzip/index.en.php)下載。全部的PKZIP檔案其實就是一個PclZip的類別物件。當產生一個PclZip檔案(ie, PclZip類別物件),就會先產生一個壓縮檔,且檔名已經指定,但此壓縮檔的內容還沒有存在:html

< ?PHP
         require_once('pclzip.lib.php');
         $archive = new PclZip("archive.zip");
?>

此物件提供了一些public method可用來處理此檔案。

 

2.參數
每個method有其各自可以使用的參數,包括有必須與非必須的參數:post

< ?PHP
         require_once('pclzip.lib.php');
         $archive = new PclZip('archive.zip');
 
         $v_list = $archive->add('dev/file.txt',
                                    PCLZIP_OPT_REMOVE_PATH, 'dev');
?>

上例中的'dev/file.txt'就是必須參數;'PCLZIP_OPT_REMOVE_PATH'則爲非必須參數。固然有些method也能夠只包含非必須的參數:
< ?PHP
         $list = $archive->extract(PCLZIP_OPT_PATH, "folder",
                          PCLZIP_OPT_REMOVE_PATH, "data",
                                PCLZIP_CB_PRE_EXTRACT, "callback_pre_extract",);
?>

上例中本來壓縮檔內檔案存放的路徑爲/data,不過你能夠指定解壓縮至/folder中。此外,在解壓縮以前,會呼叫callback function('callback_pre_extract()'),此function可以讓使用者在解壓縮的過程當中變動檔案存放路徑與檔名,或是選擇某些檔案不解壓縮。
全部可用的非必要參數可參考網址(www.phpconcept.net/pclzip/man/en/index.php)。

 

3.回傳值
每一個method所回傳的值可能會不一樣,將會在每一個method中說明。不過大部分的method回傳0、error或是陣列。ui

4.錯誤處理
從版本1.3以後,錯誤處理已經整合至PclZip類別中,當一個method回傳錯誤碼,能夠得知一些額外的訊息以方便錯誤處理:
* errorName():回傳錯誤名稱
* errorCode():回傳錯誤碼
* errorInfo():回傳錯誤的描述spa

接下來會舉幾個例子來講明如何使用PclZip。.net

PclZip實例一、產生ZIP壓縮檔
PclZip($zipname):爲PclZip constructor,$zipname爲PKZIP壓縮檔的檔名。
主要是產生一個PclZip物件,即一個PKZIP壓縮檔;但此時,只有壓縮檔產生出來,並作一些檢查(例如是否有開啓zlib extension...等),除此以外,並無作其餘動做。
create($filelist, [optional arguments list]):將參數$filelist指定的檔案或目錄(包含當中全部檔案與子目錄)加入上述所產生的壓縮檔中。
而非必要的參數則可以修改壓縮檔內的檔案存放路徑。
此method可用的參數能夠參考網誌(www.phpconcept.net/pclzip/man/en/index.php)。htm

下面的示例說明如何產生PKZIP壓縮檔(檔名爲archive.zip),並將file.txt、data/text.txt以及目錄folder(包含當中的檔案與子目錄)加入剛剛產生的archive.zip中:ip

< ?PHP
        include_once('pclzip.lib.php');
        $archive = new PclZip('archive.zip');
        $v_list = $archive->create('file.txt,data/text.txt,folder');
        if ($v_list == 0) {
            die("Error : ".$archive->errorInfo(true));
        }
?>

下面的示例說明基本上與上例同樣產生archive.zip,但在將file.txt與text.txt壓縮於其中時,將路徑由data/改成install/ ;所以,在archive.zip中這兩個檔案的路徑會是install/file.txt與install/text.txt
< ?PHP
        include_once('pclzip.lib.php');
        $archive = new PclZip('archive.zip');
        $v_list = $archive->create('data/file.txt,data/text.txt',
                                         PCLZIP_OPT_REMOVE_PATH, 'data',
                                         PCLZIP_OPT_ADD_PATH, 'install');
        if ($v_list == 0) {
            die("Error : ".$archive->errorInfo(true));
        }
?>

PclZip實例二、列出壓縮檔內容
listContent( ) :列出壓縮檔中的內容,包括檔案的屬性與目錄:文檔

< ?PHP
        include_once('pclzip.lib.php');
        $zip = new PclZip("test.zip");
 
        if (($list = $zip->listContent()) == 0) {
        die("Error : ".$zip->errorInfo(true));
        }
 
        for ($i=0; $i<sizeof ($list); $i++) {
            for(reset($list[$i]); $key = key($list[$i]); next($list[$i])) {
                echo "File $i / [$key] = ".$list[$i][$key]."<br/>";
            }
            echo "<br/>";
        }
?></sizeof>

上例將會回傳結果:
File 0 / [filename] = data/file1.txt
File 0 / [stored_filename] = data/file1.txt
File 0 / [size] = 53
File 0 / [compressed_size] = 36
File 0 / [mtime] = 1010440428
File 0 / [comment] =
File 0 / [folder] = 0
File 0 / [index] = 0
File 0 / [status] = ok

 

File 1 / [filename] = data/file2.txt
File 1 / [stored_filename] = data/file2.txt
File 1 / [size] = 54
File 1 / [compressed_size] = 53
File 1 / [mtime] = 1011197724
File 1 / [comment] =
File 1 / [folder] = 0
File 1 / [index] = 1
File 1 / [status] = okget

PclZip實例三、解壓縮檔案
extract([options list]) :解壓縮PKZIP中的檔案或目錄。
[options list]可用的參數可參考網址(www.phpconcept.net/pclzip/man/en/index.php)。這些參數能讓使用者在解壓縮的時候有更多的選項,譬如指定變動解壓縮檔案的路徑、指定只解壓縮某些檔案或不解壓縮某些檔案或者是將檔案解壓縮成字串輸出(可用於readme檔)。

下例是一個簡單的解壓縮檔案示例,將壓縮檔archive.zip內的檔案解壓縮至目前的目錄:

< ?PHP
        require_once('pclzip.lib.php');
        $archive = new PclZip('archive.zip');
 
 
        if ($archive->extract() == 0) {
            die("Error : ".$archive->errorInfo(true));
        }
?>

下例是進階的解壓縮檔案使用,archive.zip中全部檔案都解壓縮於data/中,而特別指明在install/release中的全部檔案也直接丟於data/中,而非data/install/ release:
< ?PHP
        include('pclzip.lib.php');
        $archive = new PclZip('archive.zip');
        if ($archive->extract(PCLZIP_OPT_PATH, 'data',
                  PCLZIP_OPT_REMOVE_PATH, 'install/release') == 0) {
                                die("Error : ".$archive->errorInfo(true));
        }
?>

相關文檔:
PclZip官方地址:http://www.phpconcept.net/pclzip/index.php
PclZip手冊地址:http://www.phpconcept.net/pclzip/man/en/index.php
PEAR類建立ZIP檔案文件:http://www.ccvita.com/10.html
PclZip簡介與使用:http://www.ccvita.com/59.html
PclZip:強大的PHP壓縮與解壓縮zip類:http://www.ccvita.com/330.html

相關文章
相關標籤/搜索