# ZipArchive クラス

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

## はじめに

Zip で圧縮されたファイルアーカイブです。

## クラス概要

ZipArchive implements Countable {
/* プロパティ */
int $status;
int $statusSys;
int $numFiles;
string $filename;
string $comment;
/* メソッド */
addEmptyDir ( string `$dirname` ) : bool
addFile ( string `$filename` [, string `$localname` = `NULL` [, int `$start` = 0 [, int `$length` = 0 ]]] ) : bool
addFromString ( string `$localname` , string `$contents` ) : bool
addGlob ( string `$pattern` [, int `$flags` = 0 [, array `$options` = array() ]] ) : bool
addPattern ( string `$pattern` [, string `$path` = "." [, array `$options` = array() ]] ) : bool
close ( void ) : bool
public count ( void ) : int
deleteIndex ( int `$index` ) : bool
deleteName ( string `$name` ) : bool
extractTo ( string `$destination` [, mixed `$entries` ] ) : bool
getArchiveComment ([ int `$flags` ] ) : string
getCommentIndex ( int `$index` [, int `$flags` ] ) : string
getCommentName ( string `$name` [, int `$flags` ] ) : string
GetExternalAttributesIndex ( int `$index` , int `&$opsys` , int `&$attr` [, int `$flags` ] ) : bool
getExternalAttributesName ( string `$name` , int `&$opsys` , int `&$attr` [, int `$flags` ] ) : bool
getFromIndex ( int `$index` [, int `$length` = 0 [, int `$flags` ]] ) : string
getFromName ( string `$name` [, int `$length` = 0 [, int `$flags` ]] ) : string
getNameIndex ( int `$index` [, int `$flags` ] ) : string
getStatusString ( void ) : string
getStream ( string `$name` ) : resource
locateName ( string `$name` [, int `$flags` ] ) : int
open ( string `$filename` [, int `$flags` ] ) : mixed
renameIndex ( int `$index` , string `$newname` ) : bool
renameName ( string `$name` , string `$newname` ) : bool
setArchiveComment ( string `$comment` ) : bool
setCommentIndex ( int `$index` , string `$comment` ) : bool
setCommentName ( string `$name` , string `$comment` ) : bool
setCompressionIndex ( int `$index` , int `$comp_method` [, int `$comp_flags` = 0 ] ) : bool
setCompressionName ( string `$name` , int `$comp_method` [, int `$comp_flags` = 0 ] ) : bool
setEncryptionIndex ( int `$index` , string `$method` [, string `$password` ] ) : bool
setEncryptionName ( string `$name` , int `$method` [, string `$password` ] ) : bool
setExternalAttributesIndex ( int `$index` , int `$opsys` , int `$attr` [, int `$flags` ] ) : bool
setExternalAttributesName ( string `$name` , int `$opsys` , int `$attr` [, int `$flags` ] ) : bool
public setPassword ( string `$password` ) : bool
statIndex ( int `$index` [, int `$flags` ] ) : array
statName ( string `$name` [, int `$flags` ] ) : array
unchangeAll ( void ) : bool
unchangeArchive ( void ) : bool
unchangeIndex ( int `$index` ) : bool
unchangeName ( string `$name` ) : bool
}

## プロパティ

status

  Zip アーカイブの状態

statusSys

  Zip アーカイブのシステム状態

numFiles

  アーカイブ内のファイル数

filename

  ファイルシステム上のファイル名

comment

  アーカイブのコメント

## 目次

- ZipArchive::addEmptyDir — 新しいディレクトリを追加する
- ZipArchive::addFile — 指定したパスからファイルを ZIP アーカイブに追加する
- ZipArchive::addFromString — 内容を指定して、ファイルを ZIP アーカイブに追加する
- ZipArchive::addGlob — ディレクトリから、glob パターンを使ってファイルを追加する
- ZipArchive::addPattern — ディレクトリから、PCRE パターンを使ってファイルを追加する
- ZipArchive::close — アクティブな (オープンされた、あるいは新しく作成された) アーカイブを閉じる
- ZipArchive::count — Counts the number of files in the achive
- ZipArchive::deleteIndex — インデックスを使用して、アーカイブ内のエントリを削除する
- ZipArchive::deleteName — 名前を使用して、アーカイブからエントリを削除する
- ZipArchive::extractTo — アーカイブの内容を展開する
- ZipArchive::getArchiveComment — ZIP アーカイブのコメントを返す
- ZipArchive::getCommentIndex — エントリのインデックスを使用して、エントリのコメントを返す
- ZipArchive::getCommentName — エントリ名を使用して、エントリのコメントを返す
- ZipArchive::getExternalAttributesIndex — Retrieve the external attributes of an entry defined by its index
- ZipArchive::getExternalAttributesName — Retrieve the external attributes of an entry defined by its name
- ZipArchive::getFromIndex — インデックスを使用して、エントリの内容を返す
- ZipArchive::getFromName — 名前を使用して、エントリの内容を返す
- ZipArchive::getNameIndex — インデックスを使用して、エントリの名前を返す
- ZipArchive::getStatusString — システムエラー、または ZIP メッセージに関するエラー情報を返す
- ZipArchive::getStream — 名前を使用して、エントリのファイルハンドラ (読み込み専用) を取得する
- ZipArchive::locateName — アーカイブ内のエントリのインデックスを返す
- ZipArchive::open — ZIP ファイルアーカイブをオープンする
- ZipArchive::renameIndex — インデックスを使用してエントリ名を変更する
- ZipArchive::renameName — 名前を使用してエントリ名を変更する
- ZipArchive::setArchiveComment — ZIP アーカイブのコメントを設定する
- ZipArchive::setCommentIndex — インデックスを使用してエントリのコメントを設定する
- ZipArchive::setCommentName — 名前を使用してエントリのコメントを設定する
- ZipArchive::setCompressionIndex — Set the compression method of an entry defined by its index
- ZipArchive::setCompressionName — Set the compression method of an entry defined by its name
- ZipArchive::setEncryptionIndex — Set the encryption method of an entry defined by its index
- ZipArchive::setEncryptionName — Set the encryption method of an entry defined by its name
- ZipArchive::setExternalAttributesIndex — Set the external attributes of an entry defined by its index
- ZipArchive::setExternalAttributesName — Set the external attributes of an entry defined by its name
- ZipArchive::setPassword — アクティブなアーカイブにパスワードを設定する
- ZipArchive::statIndex — インデックスを使用してエントリの詳細を取得する
- ZipArchive::statName — 名前を使用してエントリの詳細を取得する
- ZipArchive::unchangeAll — アーカイブに対するすべての変更を取り消す
- ZipArchive::unchangeArchive — アーカイブ全体に対して行われたすべての変更を取り消す
- ZipArchive::unchangeIndex — 指定したインデックスのエントリに対するすべての変更を取り消す
- ZipArchive::unchangeName — 指定した名前のエントリに対するすべての変更を取り消す