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

Copy
1<?php
2
3/**
4 * Pharアーカイブ内のエントリがディレクトリであるかを判定するサンプルコード
5 *
6 * このスクリプトは以下の手順を実行します。
7 * 1. テスト用のPharアーカイブを一時的に作成します。
8 * 2. 作成したアーカイブ内にファイルとディレクトリを追加します。
9 * 3. アーカイブを読み込み、各エントリがディレクトリであるかをPharFileInfo::isDir()メソッドで判定し、表示します。
10 * 4. 作成したPharアーカイブファイルをクリーンアップとして削除します。
11 */
12
13// 一時的なPharアーカイブファイル名とエイリアスを定義
14$pharFileName = __DIR__ . '/example.phar';
15$pharAlias = 'example.phar';
16
17// --- Pharアーカイブの作成と内容の追加 ---
18try {
19    // 既存のPharアーカイブがあれば削除
20    // これにより、スクリプトを複数回実行しても常にクリーンな状態から開始できます。
21    if (file_exists($pharFileName)) {
22        \Phar::unlinkArchive($pharFileName);
23        echo "既存のPharアーカイブ '{$pharFileName}' を削除しました。\n";
24    }
25
26    // 新しいPharアーカイブを書き込みモードで作成
27    // 第1引数: 作成するPharファイルのパス
28    // 第2引数: フラグ (0またはPhar::DEFAULT_PHAR_FLAGSで十分)
29    // 第3引数: このPharアーカイブのエイリアス（内部で参照される名前）
30    $phar = new \Phar($pharFileName, 0, $pharAlias);
31
32    // 書き込みバッファリングを開始
33    // これにより、複数のファイルやディレクトリを追加する際のI/Oオーバーヘッドを削減できます。
34    $phar->startBuffering();
35
36    // ファイルをアーカイブに追加
37    $phar->addFromString('readme.txt', 'This is a test file.');
38    $phar->addFromString('src/main.php', '<?php echo "Hello from Phar!";');
39
40    // 空のディレクトリをアーカイブに追加
41    // PharFileInfo::isDir() メソッドは、これらのエントリをディレクトリとして認識します。
42    $phar->addEmptyDir('assets');
43    $phar->addEmptyDir('lib');
44
45    // 書き込みを確定し、バッファをフラッシュ
46    $phar->stopBuffering();
47
48    echo "Pharアーカイブ '{$pharFileName}' が正常に作成され、ファイルとディレクトリが追加されました。\n\n";
49
50} catch (\Exception $e) {
51    echo "Pharアーカイブ作成中にエラーが発生しました: " . $e->getMessage() . "\n";
52    // エラーが発生した場合はスクリプトを終了
53    exit(1);
54}
55
56// --- Pharアーカイブからエントリを読み込み、isDir()メソッドを使用 ---
57try {
58    // 作成したPharアーカイブを読み込みモードで開く
59    // 既存のPharファイルを扱う際は、ファイルパスのみ指定すれば十分です。
60    $phar = new \Phar($pharFileName);
61
62    echo "Pharアーカイブ '{$pharFileName}' の内容を確認します:\n";
63
64    // Pharアーカイブ内の各エントリを走査
65    // Pharオブジェクトをforeachでイテレートすると、各エントリは \PharFileInfo オブジェクトとして取得されます。
66    foreach ($phar as $name => $file) {
67        // \PharFileInfo::isDir() メソッドは、現在処理しているエントリがディレクトリであるかを判定します。
68        // 結果はブール値（true: ディレクトリ、false: ファイル）で返されます。
69        if ($file->isDir()) {
70            echo "  [D] {$name}\n"; // ディレクトリの場合の表示
71        } else {
72            echo "  [F] {$name} (サイズ: {$file->getSize()} バイト)\n"; // ファイルの場合の表示
73        }
74    }
75    echo "\n";
76
77} catch (\Exception $e) {
78    echo "Pharアーカイブ読み込み中にエラーが発生しました: " . $e->getMessage() . "\n";
79    // エラーが発生した場合はスクリプトを終了
80    exit(1);
81} finally {
82    // --- クリーンアップ ---
83    // 作成した一時的なPharアーカイブファイルを削除します。
84    // \Phar::unlinkArchive() は static メソッドで、指定されたPharファイルを安全に削除します。
85    if (file_exists($pharFileName)) {
86        try {
87            \Phar::unlinkArchive($pharFileName);
88            echo "Pharアーカイブ '{$pharFileName}' が削除されました。\n";
89        } catch (\Exception $e) {
90            echo "Pharアーカイブ削除中にエラーが発生しました: " . $e->getMessage() . "\n";
91        }
92    }
93}

PharFileInfo::isDir()は、PHPのPharアーカイブ（複数のファイルを一つにまとめたファイル）内に含まれる個々のエントリがディレクトリであるかどうかを判断するためのメソッドです。

このメソッドは引数を必要とせず、対象のエントリがディレクトリであれば真（true）を、ファイルであれば偽（false）をブール値として返します。Pharアーカイブの中身をプログラムで読み込み、ファイルとディレクトリを区別して処理する必要がある際に非常に役立ちます。

サンプルコードでは、まずテスト用にPharアーカイブを作成し、その中にreadme.txtやsrc/main.phpといったファイル、そしてassetsやlibといった空のディレクトリを追加しています。その後、作成したアーカイブを読み込み、各エントリを一つずつ調べます。その際、isDir()メソッドを使って、現在処理しているエントリがディレクトリなのかファイルなのかを判別し、その結果に基づいて「[D]」または「[F]」という記号を付けて表示しています。これにより、assetsやlibが正しくディレクトリとして認識され、「[D]」と表示されることが確認できます。この機能は、Pharアーカイブの構造を理解し、内容を適切に管理・操作する上で不可欠なツールとなります。

Copy
1<?php
2
3/**
4 * Phar::isDir() メソッドの使用例を示します。
5 * このメソッドは、Pharアーカイブ内の指定されたエントリがディレクトリであるかを判定します。
6 *
7 * 注: このスクリプトを実行するには、PHPの設定ファイル (php.ini) で 'phar.readonly' を '0' に設定するか、
8 * スクリプト内で ini_set('phar.readonly', '0') を使用して一時的に設定を変更する必要があります。
9 * 運用環境では 'phar.readonly' を '1' に設定しておくことが推奨されます。
10 */
11
12// 一時的なPharアーカイブのファイル名
13$pharFileName = 'example_archive.phar';
14
15try {
16    // Pharアーカイブの作成には 'phar.readonly' が '0' である必要があります。
17    // 必要であれば、一時的に設定を変更します。
18    if (ini_get('phar.readonly') == '1') {
19        echo "注意: php.ini の 'phar.readonly' が '1' に設定されています。\n";
20        echo "このサンプルを実行するため、一時的に 'phar.readonly' を '0' に設定します。\n";
21        ini_set('phar.readonly', '0');
22    }
23
24    // 既存のPharファイルがあれば削除し、クリーンな状態から開始
25    if (file_exists($pharFileName)) {
26        Phar::unlinkphar($pharFileName);
27        echo "既存の '{$pharFileName}' を削除しました。\n";
28    }
29
30    // 新しいPharアーカイブを作成
31    $phar = new Phar($pharFileName);
32
33    // Pharアーカイブへの書き込みを開始
34    $phar->startBuffering();
35
36    // アーカイブ内にファイルを追加
37    $phar->addFromString('my_file.txt', 'これはPharアーカイブ内のファイルです。');
38
39    // アーカイブ内にディレクトリを追加
40    $phar->addEmptyDir('my_directory/');
41
42    // ディレクトリ内にファイルを追加
43    $phar->addFromString('my_directory/another_file.txt', 'これはディレクトリ内のファイルです。');
44
45    // Pharアーカイブへの書き込みを終了し、変更を保存
46    $phar->stopBuffering();
47
48    echo "Pharアーカイブ '{$pharFileName}' を作成しました。\n";
49    echo "アーカイブの内容を検証します。\n\n";
50
51    // 作成したPharアーカイブを読み込みモードで開く
52    $phar = new Phar($pharFileName);
53
54    // アーカイブ内の各エントリをループし、isDir() メソッドで種類を判定
55    foreach ($phar as $entryName => $entry) {
56        // エントリがディレクトリであるかをチェック
57        if ($entry->isDir()) {
58            echo "- エントリ: '{$entryName}' はディレクトリです。\n";
59        } else {
60            echo "- エントri: '{$entryName}' はファイルです。\n";
61        }
62    }
63
64} catch (PharException $e) {
65    // Phar関連のエラーが発生した場合
66    echo "Phar 操作中にエラーが発生しました: " . $e->getMessage() . "\n";
67} catch (Exception $e) {
68    // その他のエラーが発生した場合
69    echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
70} finally {
71    // 後処理: 作成したPharファイルを削除
72    if (file_exists($pharFileName)) {
73        Phar::unlinkphar($pharFileName);
74        echo "\nPharアーカイブ '{$pharFileName}' を削除しました。\n";
75    }
76}

PHPのPhar::isDir()メソッドは、Phar（PHPアーカイブ）ファイル内の特定のエントリがディレクトリであるかどうかを判定するために使用される拡張機能のメソッドです。このメソッドは引数を取らず、戻り値として真偽値（bool）を返します。Pharアーカイブ内のエントリがディレクトリであればtrueを、ファイルなどのディレクトリ以外であればfalseを返します。

サンプルコードでは、まずexample_archive.pharという名前の一時的なPharアーカイブを作成しています。このアーカイブには、my_file.txtというファイルとmy_directory/という空のディレクトリ、そしてそのディレクトリ内にanother_file.txtが追加されます。Pharアーカイブの作成や書き込みには、PHPの設定であるphar.readonlyを一時的に0に設定する必要があります。アーカイブが作成された後、読み込みモードでアーカイブを再度開き、foreachループを使ってアーカイブ内の各エントリを一つずつ処理します。ループ内で、各エントリ（$entry）に対してisDir()メソッドを呼び出し、その戻り値に基づいて、現在処理しているエントリがディレクトリなのかファイルなのかを判別して表示しています。このように、isDir()メソッドを利用することで、Pharアーカイブ内のコンテンツの種類をプログラムで容易に識別し、適切な処理を行うことが可能になります。