トップページ　→関数リファレンス　→圧縮およびアーカイブ　→Rar　→RarArchive

関数・クラス解説

RarArchive::getEntries

rar_list

version:PECL rar >= 2.0.0 (公式)

RAR アーカイブからエントリの全一覧を取得する

公式リファレンス

書式

public RarArchive::getEntries ( ) : array|false

rar_list ( RarArchive $rarfile ) : array|false

説明

オブジェクト指向型 (メソッド)

手続き型:

エントリ (ファイルおよびディレクトリ) の一覧を RAR アーカイブから取得します。

注意:
アーカイブの中に同じ名前のエントリが存在する場合は、このメソッドを RarArchive の foreach と組み合わせて数値添字の配列形式で処理するのが唯一のアクセス方法となります (つまり、 RarArchive::getEntry() と rar:// ラッパーは使えないということです)。

パラメータ

rarfile: rar_open() でオープンした RarArchive オブジェクト。

返値

rar_list() は RarEntry オブジェクトの配列を返します。失敗した場合に FALSE を返します。

更新履歴

バージョン	説明
PECL rar 3.0.0	エントリ名が繰り返される RAR アーカイブも対応するようになりました。

サンプル

例1 オブジェクト指向型 

$rar_arch = RarArchive::open('solid.rar');
if ($rar_arch === FALSE)
    die("Could not open RAR archive.");

$rar_entries = $rar_arch->getEntries();
if ($rar_entries === FALSE)
    die("Could not retrieve entries.");

echo "Found " . count($rar_entries) . " entries.\n";

foreach ($rar_entries as $e) {
    echo $e;
    echo "\n";
}
$rar_arch->close();

 上の例の出力は、たとえば以下のようになります。 
Found 2 entries.
RarEntry for file "tese.txt" (23b93a7a)
RarEntry for file "unrardll.txt" (2ed64b6e)
 例2 手続き型 

$rar_arch = rar_open('solid.rar');
if ($rar_arch === FALSE)
    die("Could not open RAR archive.");

$rar_entries = rar_list($rar_arch);
if ($rar_entries === FALSE)
    die("Could retrieve entries.");

echo "Found " . count($rar_entries) . " entries.\n";

foreach ($rar_entries as $e) {
    echo $e;
    echo "\n";
}
rar_close($rar_arch);