【PHP8.x】Phar::SKIP_DOTS定数の使い方

Copy
1<?php
2
3/**
4 * Pharアーカイブを作成し、FilesystemIterator::SKIP_DOTSフラグを使用して
5 * ディレクトリの "." (カレントディレクトリ) および ".." (親ディレクトリ) エントリを
6 * スキップする方法を示すサンプル関数です。
7 * これは、提供されたリファレンス情報「Phar::SKIP_DOTS」が示す意図を実現します。
8 *
9 * @return void
10 */
11function createPharArchiveSkippingDots(): void
12{
13    // Pharファイルの作成には一時的に phar.readonly を '0' (書き込み可能) に設定する必要があります。
14    // この設定はセキュリティ上の理由から、本番環境では慎重に行うべきです。
15    ini_set('phar.readonly', '0');
16
17    // 一時的なテストディレクトリとPharアーカイブのパスを定義します。
18    $tempDir = sys_get_temp_dir() . '/phar_skip_dots_example_' . uniqid();
19    $pharFilePath = $tempDir . '/my_archive.phar';
20
21    // スクリプト終了時に、作成された一時ファイルやディレクトリをクリーンアップする関数を登録します。
22    register_shutdown_function(function () use ($tempDir, $pharFilePath) {
23        // phar.readonly を元の設定に戻します。
24        ini_set('phar.readonly', '1');
25
26        // Pharアーカイブが存在すれば、Pharクラスでアンリンク（削除）します。
27        if (file_exists($pharFilePath)) {
28            @Phar::unlinkArchive($pharFilePath);
29        }
30
31        // 一時ディレクトリが存在すれば、その内容を再帰的に削除します。
32        if (is_dir($tempDir)) {
33            $files = new RecursiveIteratorIterator(
34                new RecursiveDirectoryIterator($tempDir, FilesystemIterator::SKIP_DOTS),
35                RecursiveIteratorIterator::CHILD_FIRST
36            );
37            foreach ($files as $fileinfo) {
38                if ($fileinfo->isDir()) {
39                    @rmdir($fileinfo->getRealPath());
40                } else {
41                    @unlink($fileinfo->getRealPath());
42                }
43            }
44            @rmdir($tempDir);
45        }
46    });
47
48    // Pharアーカイブに含めるためのテストディレクトリとファイルを作成します。
49    if (!mkdir($tempDir, 0777, true) && !is_dir($tempDir)) {
50        echo "エラー: 作業ディレクトリ '{$tempDir}' を作成できませんでした。\n";
51        return;
52    }
53    file_put_contents($tempDir . '/file1.txt', 'これはファイル1の内容です。');
54    file_put_contents($tempDir . '/index.php', '<?php echo "Hello from Phar archive!";');
55
56    // サブディレクトリも作成します。
57    $subDir = $tempDir . '/assets';
58    if (!mkdir($subDir, 0777, true) && !is_dir($subDir)) {
59        echo "エラー: サブディレクトリ '{$subDir}' を作成できませんでした。\n";
60        return;
61    }
62    file_put_contents($subDir . '/style.css', 'body { color: blue; }');
63
64    echo "テストディレクトリ '{$tempDir}' を作成し、サンプルファイルを配置しました。\n\n";
65
66    try {
67        // 新しいPharアーカイブオブジェクトを作成します。
68        $phar = new Phar($pharFilePath);
69        $phar->setMetadata(['description' => 'Phar::SKIP_DOTS example']);
70
71        // RecursiveDirectoryIterator を使用してディレクトリを走査します。
72        // FilesystemIterator::SKIP_DOTS フラグを指定することで、
73        // "." (カレントディレクトリ) と ".." (親ディレクトリ) のエントリはスキップされます。
74        // これにより、Pharアーカイブに不要なディレクトリ参照が含まれるのを防ぎます。
75        $iterator = new RecursiveIteratorIterator(
76            new RecursiveDirectoryIterator($tempDir, FilesystemIterator::SKIP_DOTS),
77            RecursiveIteratorIterator::LEAVES_ONLY // ファイルのみを処理し、ディレクトリ自体はスキップ
78        );
79
80        // イテレータからPharアーカイブを構築します。
81        // 第二引数にはアーカイブ内でのパスの基点となるディレクトリを指定します。
82        $phar->buildFromIterator($iterator, $tempDir);
83
84        // Pharファイルの実行可能なスタブ（ブートストラップコード）を設定します。
85        $phar->setStub($phar->createDefaultStub('index.php'));
86
87        echo "Pharアーカイブ '{$pharFilePath}' を正常に作成しました。\n";
88        echo "アーカイブ内のファイル一覧:\n";
89
90        // 作成されたPharアーカイブの内容を列挙し、ドットエントリがスキップされていることを確認します。
91        $archive = new Phar($pharFilePath);
92        foreach ($archive as $file) {
93            echo "- " . $file->getPathname() . "\n";
94        }
95
96        echo "\nFilesystemIterator::SKIP_DOTS の効果により、カレントディレクトリ(.)と親ディレクトリ(..)はアーカイブに含まれていません。\n";
97
98    } catch (Exception $e) {
99        echo "エラー: Pharアーカイブの作成中に問題が発生しました。\n";
100        echo "メッセージ: " . $e->getMessage() . "\n";
101    }
102}
103
104// 関数を実行してサンプルコードの動作を確認します。
105createPharArchiveSkippingDots();

PHPのPhar::SKIP_DOTSは、ファイルシステムを反復処理する際に、カレントディレクトリを表す「.」と親ディレクトリを表す「..」という特殊なディレクトリ参照をスキップするための定数です。この定数自体は引数を持たず、内部的には整数値（int）として定義されており、主にFilesystemIteratorなどのイテレータのコンストラクタにフラグとして渡して使用します。

このサンプルコードは、一時的なディレクトリとファイル群を用意し、それらを使ってPhar形式のアーカイブを作成する過程を示しています。特に注目すべきは、RecursiveDirectoryIteratorを初期化する際にFilesystemIterator::SKIP_DOTSフラグ（これはPhar::SKIP_DOTSと同じ整数値です）を指定している点です。これにより、イテレータがディレクトリを走査する際に、「.」と「..」のエントリが自動的に無視され、結果としてこれらがPharアーカイブに含まれるのを防ぎます。

この設定は、アーカイブファイルが不要なディレクトリ参照を持たず、管理しやすく、より正確な内容で構築されるために非常に有用です。システムエンジニアを目指す初心者の方も、Pharアーカイブ作成時にディレクトリの内容をクリーンに保つための便利な機能として、このフラグの活用をぜひ理解しておくと良いでしょう。

Copy
1<?php
2
3/**
4 * 指定されたディレクトリの内容を読み込み、特殊なドットエントリ (. と ..) を除外して表示する関数です。
5 *
6 * `Phar::SKIP_DOTS` 定数は、Pharアーカイブ作成時（例えば、`Phar::buildFromDirectory` メソッド使用時）に
7 * ドットエントリをアーカイブに含めないようにするために使用されます。
8 * `scandir` 関数自体には直接適用されませんが、本コードでは同様にディレクトリ内の不要な
9 * 「.」や「..」エントリを無視するという目的を、PHPの組み込み関数で達成する方法を示します。
10 *
11 * @param string $directoryPath 読み込むディレクトリのパス
12 * @return void
13 */
14function listDirectoryContentsSkippingDots(string $directoryPath): void
15{
16    // ディレクトリが存在しない場合はエラーを表示して終了
17    if (!is_dir($directoryPath)) {
18        echo "エラー: ディレクトリ '{$directoryPath}' が見つかりません。\n";
19        return;
20    }
21
22    echo "--- ディレクトリ '{$directoryPath}' の内容 ---\n";
23
24    // scandir関数でディレクトリ内のすべてのエントリを取得（'.' と '..' を含む）
25    $allContents = scandir($directoryPath);
26
27    if ($allContents === false) {
28        echo "エラー: ディレクトリ '{$directoryPath}' を読み込めませんでした。\n";
29        return;
30    }
31
32    echo "\n[ドットエントリを含む場合]:\n";
33    foreach ($allContents as $item) {
34        echo "- {$item}\n";
35    }
36
37    // '.' と '..' を配列から除外する
38    // `Phar::SKIP_DOTS` はPharクラスで特定の目的で使われる定数ですが、
39    // ここでは、`scandir` の結果から手動でドットをスキップする一般的な方法を示しています。
40    $filteredContents = array_diff($allContents, ['.', '..']);
41
42    echo "\n[ドットエントリを除外した場合]:\n";
43    if (empty($filteredContents)) {
44        echo "  (コンテンツなし)\n";
45    } else {
46        foreach ($filteredContents as $item) {
47            echo "- {$item}\n";
48        }
49    }
50}
51
52// --- サンプルコードの実行部分 ---
53
54// 一時ディレクトリを作成し、テスト用のファイルやサブディレクトリを配置します
55$tempDir = __DIR__ . '/_temp_test_dir'; // _temp_test_dir という名前で作成
56if (!mkdir($tempDir) && !is_dir($tempDir)) {
57    echo "エラー: 一時ディレクトリ '{$tempDir}' を作成できませんでした。\n";
58    exit(1);
59}
60file_put_contents($tempDir . '/example_file_1.txt', 'This is a test file.');
61file_put_contents($tempDir . '/another_file.log', 'Log entry.');
62mkdir($tempDir . '/sub_directory');
63file_put_contents($tempDir . '/sub_directory/nested_file.txt', 'Nested content.');
64
65// 作成した一時ディレクトリに対して関数を実行
66listDirectoryContentsSkippingDots($tempDir);
67
68// --- クリーンアップ ---
69
70/**
71 * ディレクトリとその内容を再帰的に削除するヘルパー関数
72 * @param string $dir 削除するディレクトリのパス
73 * @return void
74 */
75function rrmdir(string $dir): void
76{
77    if (!is_dir($dir)) {
78        return;
79    }
80    $files = array_diff(scandir($dir), ['.', '..']);
81    foreach ($files as $file) {
82        (is_dir("$dir/$file")) ? rrmdir("$dir/$file") : unlink("$dir/$file");
83    }
84    rmdir($dir);
85}
86
87// 一時ディレクトリを削除してクリーンアップ
88rrmdir($tempDir);
89echo "\n一時ディレクトリ '{$tempDir}' をクリーンアップしました。\n";
90
91?>

PHP 8のPhar::SKIP_DOTS定数は、Pharアーカイブを作成する際に、「.」（カレントディレクトリ）や「..」（親ディレクトリ）といった特殊なディレクトリ参照（ドットエントリ）をアーカイブから除外します。このサンプルコードは、この定数を直接使用する代わりに、scandir関数で読み込んだディレクトリの内容から、array_diff関数を用いてドットエントリを手動で除外する一般的な方法を解説しています。

listDirectoryContentsSkippingDots関数は、引数$directoryPathで指定されたディレクトリの内容からドットエントリを除外してコンソールに表示します。戻り値はvoidで、処理結果を直接出力します。具体的には、まずscandir関数がディレクトリ内のすべてのファイルやサブディレクトリ名を配列として取得します。この結果には「.」と「..」が含まれるため、次にarray_diff関数を使ってこれらの要素を取り除き、ドットエントリを除外したリストを得ます。これにより、PHPでのファイルシステム操作において、不要なドットエントリを処理する手法を理解できます。