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

Copy
1<?php
2
3/**
4 * FilesystemIterator::setFlags メソッドの使用例をデモンストレーションします。
5 *
6 * この関数は、一時ディレクトリを作成し、FilesystemIterator を使用して
7 * ディレクトリの内容を様々なフラグ設定でイテレートする方法を示します。
8 * 初心者にも理解しやすいよう、コメントと簡潔な例が含まれています。
9 */
10function demonstrateFilesystemIteratorSetFlags(): void
11{
12    // 一時ディレクトリのパスを定義
13    $tempDir = __DIR__ . '/_temp_fs_iterator_example';
14
15    // 一時ディレクトリが存在しない場合は作成
16    if (!is_dir($tempDir)) {
17        mkdir($tempDir, 0777, true);
18    }
19
20    // テスト用のファイルとサブディレクトリを作成
21    file_put_contents($tempDir . '/example_file1.txt', 'Hello World 1');
22    file_put_contents($tempDir . '/example_file2.log', 'Hello World 2');
23    mkdir($tempDir . '/sub_directory', 0777);
24    file_put_contents($tempDir . '/sub_directory/nested_file.txt', 'Nested content');
25
26    echo "FilesystemIterator::setFlags メソッドのデモンストレーション\n";
27    echo "=========================================================\n\n";
28
29    // ---------------------------------------------------------------------
30    // 1. デフォルトのフラグ設定での挙動
31    //    - FilesystemIterator::SKIP_DOTS: "." と ".." をスキップします。
32    //    - FilesystemIterator::CURRENT_AS_FILEINFO: 値として SplFileInfo オブジェクトを返します。
33    //    - FilesystemIterator::KEY_AS_FILENAME: キーとしてファイル名を返します。
34    // ---------------------------------------------------------------------
35    echo "1. デフォルト設定でのイテレーション:\n";
36    echo "   ( '.' と '..' はスキップされ、キーはファイル名、値はファイル情報オブジェクトです )\n";
37    $iteratorDefault = new FilesystemIterator($tempDir);
38    // setFlags は通常コンストラクタで指定するか、デフォルトを使うことが多いですが、
39    // ここではデフォルトの挙動を確認するために、あえて設定しないでおきます。
40    foreach ($iteratorDefault as $key => $fileInfo) {
41        printf("  キー: %s, 名前: %s, タイプ: %s\n", $key, $fileInfo->getFilename(), $fileInfo->getType());
42    }
43    echo "\n";
44
45    // ---------------------------------------------------------------------
46    // 2. フラグ設定: CURRENT_AS_PATHNAME | KEY_AS_PATHNAME
47    //    - FilesystemIterator::CURRENT_AS_PATHNAME: 値としてフルパス名文字列を返します。
48    //    - FilesystemIterator::KEY_AS_PATHNAME: キーとしてフルパス名文字列を返します。
49    //    FilesystemIterator::SKIP_DOTS が指定されていないため、'.' と '..' も表示されます。
50    // ---------------------------------------------------------------------
51    echo "2. フラグ設定: CURRENT_AS_PATHNAME と KEY_AS_PATHNAME:\n";
52    echo "   ( '.' と '..' を含め、キーも値もフルパス名文字列になります )\n";
53    $iteratorAsPathname = new FilesystemIterator($tempDir);
54    // setFlags メソッドを使用してフラグを設定
55    $iteratorAsPathname->setFlags(FilesystemIterator::CURRENT_AS_PATHNAME | FilesystemIterator::KEY_AS_PATHNAME);
56    foreach ($iteratorAsPathname as $key => $pathname) {
57        printf("  キー: %s, 値: %s\n", $key, $pathname);
58    }
59    echo "\n";
60
61    // ---------------------------------------------------------------------
62    // 3. フラグ設定: CURRENT_AS_SELF | SKIP_DOTS
63    //    - FilesystemIterator::CURRENT_AS_SELF: 値として FilesystemIterator オブジェクト自身を返します。
64    //    - FilesystemIterator::SKIP_DOTS: "." と ".." をスキップします。
65    //    これにより、イテレータのメソッドを直接呼び出して情報を取得できます。
66    // ---------------------------------------------------------------------
67    echo "3. フラグ設定: CURRENT_AS_SELF と SKIP_DOTS:\n";
68    echo "   ( '.' と '..' をスキップし、値はFilesystemIteratorオブジェクト自身になります )\n";
69    $iteratorAsSelf = new FilesystemIterator($tempDir);
70    // setFlags メソッドを使用してフラグを設定
71    $iteratorAsSelf->setFlags(FilesystemIterator::CURRENT_AS_SELF | FilesystemIterator::SKIP_DOTS);
72    foreach ($iteratorAsSelf as $key => $iteratorItem) {
73        // $iteratorItem は現在の要素を表す FilesystemIterator のインスタンス
74        printf("  キー: %s, 名前: %s, パス名: %s\n", $key, $iteratorItem->getFilename(), $iteratorItem->getPathname());
75    }
76    echo "\n";
77
78    // ---------------------------------------------------------------------
79    // 後処理: 作成した一時ディレクトリとファイルを削除
80    // ---------------------------------------------------------------------
81    echo "後処理: 一時ディレクトリとファイルをクリーンアップしています...\n";
82    // ディレクトリとその中身を再帰的に削除するヘルパー関数
83    $deleteDir = function (string $dirPath) use (&$deleteDir) {
84        if (!is_dir($dirPath)) {
85            return;
86        }
87        $items = new FilesystemIterator($dirPath, FilesystemIterator::SKIP_DOTS);
88        foreach ($items as $item) {
89            if ($item->isDir()) {
90                $deleteDir($item->getRealPath()); // サブディレクトリを再帰的に削除
91            } else {
92                unlink($item->getRealPath()); // ファイルを削除
93            }
94        }
95        rmdir($dirPath); // 空になったディレクトリを削除
96    };
97
98    $deleteDir($tempDir);
99    echo "クリーンアップが完了しました。\n";
100}
101
102// 関数を実行してデモンストレーションを開始
103demonstrateFilesystemIteratorSetFlags();

PHP 8のFilesystemIterator::setFlagsメソッドは、ディレクトリ内の要素を反復処理するFilesystemIteratorオブジェクトの挙動を制御します。int $flags引数にFilesystemIteratorクラスの定数を組み合わせて渡すことで、イテレーションの方法を細かく設定します。このメソッドに特定の戻り値はありません。

サンプルコードは、setFlagsを使って、ディレクトリ内のファイルやサブディレクトリを様々な形式で取得する方法を示しています。例えば、FilesystemIterator::SKIP_DOTSで特殊なディレクトリ「.」と「..」をスキップしたり、CURRENT_AS_PATHNAMEとKEY_AS_PATHNAMEでキーと値をフルパス名にしたり、CURRENT_AS_SELFでイテレータ自身を値として返してファイル情報にアクセスしたりできます。これにより、ファイルシステムの走査方法を柔軟にカスタマイズできます。