【PHP8.x】Phar::key()メソッドの使い方

Copy
1<?php
2
3/**
4 * Phar::key() メソッドの使用例を示します。
5 * Phar::key() は、Phar アーカイブをイテレートする際に、現在のエントリのキー（ファイル名）を返します。
6 *
7 * 注意: Phar アーカイブを作成・変更するには、php.ini で 'phar.readonly' を 'Off' に設定する必要があります。
8 */
9
10// 一時的なPharアーカイブファイル名
11$pharFileName = __DIR__ . '/my_archive.phar';
12
13try {
14    // 既存のアーカイブを削除（テスト実行時に残っている場合）
15    if (file_exists($pharFileName)) {
16        unlink($pharFileName);
17    }
18
19    // 新しいPharアーカイブを作成
20    $phar = new Phar($pharFileName);
21
22    // Pharアーカイブの書き込みを有効にする
23    // これにより、ファイル追加などの変更が可能になります
24    $phar->startBuffering();
25
26    // アーカイブにファイルを追加
27    $phar->addFromString('file1.txt', 'これはファイル1の内容です。');
28    $phar->addFromString('sub/file2.txt', 'これはサブディレクトリ内のファイル2の内容です。');
29    $phar->addFromString('script.php', '<?php echo "Hello from script.php!";');
30
31    // Pharアーカイブのビルドを完了し、ディスクに書き込む
32    $phar->stopBuffering();
33
34    echo "Pharアーカイブ '{$pharFileName}' が正常に作成されました。\n\n";
35
36    echo "Pharアーカイブをイテレートし、Phar::key()で各エントリのキーを取得します:\n";
37
38    // イテレータをPharアーカイブの先頭にリセット
39    $phar->rewind();
40
41    // イテレータが有効な間（次のエントリがある間）ループを続行
42    while ($phar->valid()) {
43        // Phar::key() メソッドを呼び出し、現在のエントリのキー（ファイル名）を取得
44        echo "取得されたキー: " . $phar->key() . "\n";
45
46        // 次のエントリに進む
47        $phar->next();
48    }
49
50} catch (PharException $e) {
51    // Phar関連のエラーが発生した場合
52    echo "Pharに関するエラーが発生しました: " . $e->getMessage() . "\n";
53    echo "Pharアーカイブの作成には、php.iniで 'phar.readonly' を 'Off' に設定する必要がある場合があります。\n";
54} catch (Exception $e) {
55    // その他の予期せぬエラー
56    echo "エラーが発生しました: " . $e->getMessage() . "\n";
57} finally {
58    // 後処理: 作成したPharアーカイブを削除
59    if (file_exists($pharFileName)) {
60        unlink($pharFileName);
61        echo "\nPharアーカイブ '{$pharFileName}' が削除されました。\n";
62    }
63}

Phar::key()は、PHPのPhar（PHPアーカイブ）クラスに属するメソッドで、Pharアーカイブ内のファイルやディレクトリを順に処理する際に利用されます。このメソッドは引数を一切取らず、現在のイテレーション位置にあるエントリ（ファイルまたはディレクトリ）のキー、つまりアーカイブ内でのパス名を文字列として返します。

サンプルコードでは、まず一時的なPharアーカイブファイルを作成し、addFromString()メソッドを使って複数のファイルを追加しています。Pharアーカイブを変更するには、php.iniでphar.readonly設定をOffにする必要がある点に注意してください。

アーカイブが完成した後、rewind()でイテレータを先頭に戻し、while ($phar->valid())と$phar->next()を使ってアーカイブ内のエントリを一つずつ巡回します。このループの中で$phar->key()を呼び出すことで、現在処理しているエントリのファイル名やパス（例: file1.txt、sub/file2.txt）を文字列として取得し、表示しています。これにより、Pharアーカイブの内容を一つ一つ確認しながら処理を進めることが可能になります。最終的に、作成したアーカイブは削除されます。