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

Copy
1<?php
2
3// PHP 8 で GlobIterator::setFlags メソッドを使用するサンプルコードです。
4// このメソッドは、GlobIterator のイテレーション挙動を制御するフラグを設定します。
5// ファイルシステムを操作するため、実行する環境のディレクトリ作成・削除権限が必要です。
6
7// 1. テスト用のディレクトリとファイルを作成します。
8$testDir = __DIR__ . '/glob_example_dir';
9if (!is_dir($testDir)) {
10    mkdir($testDir, 0777, true);
11}
12file_put_contents($testDir . '/document.txt', 'This is document.txt');
13file_put_contents($testDir . '/image.jpg', 'This is image.jpg');
14// サブディレクトリも作成し、GlobIteratorがデフォルトでディレクトリも検出することを確認
15if (!is_dir($testDir . '/subfolder')) {
16    mkdir($testDir . '/subfolder', 0777, true);
17}
18file_put_contents($testDir . '/subfolder/report.pdf', 'This is report.pdf');
19
20echo "--- GlobIterator::setFlags メソッドの動作確認 ---\n\n";
21
22// 2. GlobIterator を初期化します。
23//    コンストラクタの第2引数を省略すると、FilesystemIterator のデフォルトフラグが適用されます。
24//    デフォルトフラグは以下の組み合わせです:
25//    - FilesystemIterator::KEY_AS_PATHNAME: キーとしてファイルのフルパスを返します。
26//    - FilesystemIterator::CURRENT_AS_FILEINFO: 各要素を SplFileInfo オブジェクトとして返します。
27//    - FilesystemIterator::SKIP_DOTS: "." (カレントディレクトリ) と ".." (親ディレクトリ) をスキップします。
28$iterator = new GlobIterator($testDir . '/*');
29
30echo "--- (1) デフォルトフラグでのイテレーション ---\n";
31echo "  (キーはフルパス、値は SplFileInfo オブジェクト)\n";
32foreach ($iterator as $key => $fileInfo) {
33    // $fileInfo は SplFileInfo オブジェクトです。
34    // getPathname() でフルパス、getFilename() でファイル名を取得できます。
35    echo "  キー: " . $key . "\n";
36    echo "  値 (getPathname()): " . $fileInfo->getPathname() . "\n";
37    echo "  値 (getFilename()): " . $fileInfo->getFilename() . "\n";
38    echo "  ---\n";
39}
40echo "\n";
41
42// 3. setFlags メソッドを使用してフラグを変更します。
43//    今回は FilesystemIterator::CURRENT_AS_PATHNAME と FilesystemIterator::KEY_AS_FILENAME を設定します。
44//    setFlags() を呼び出すと、既存のフラグは上書きされるため、
45//    SKIP_DOTS を維持したい場合は、新しいフラグの組み合わせに再度含める必要があります。
46//    - FilesystemIterator::CURRENT_AS_PATHNAME: 各要素をパス名の文字列として返します。
47//    - FilesystemIterator::KEY_AS_FILENAME: キーとしてファイル名のみを返します。
48//    - FilesystemIterator::SKIP_DOTS: "." と ".." ディレクトリをスキップします (再指定)。
49$newFlags = FilesystemIterator::CURRENT_AS_PATHNAME
50          | FilesystemIterator::KEY_AS_FILENAME
51          | FilesystemIterator::SKIP_DOTS;
52
53$iterator->setFlags($newFlags);
54
55echo "--- (2) setFlags でフラグ変更後でのイテレーション ---\n";
56echo "  (キーはファイル名、値はパス名文字列)\n";
57// setFlags の後、イテレータの状態をリセットするために rewind() を呼び出します。
58$iterator->rewind();
59foreach ($iterator as $key => $pathName) {
60    // $pathName はパス名の文字列です。
61    echo "  キー (ファイル名): " . $key . "\n";
62    echo "  値 (パス名): " . $pathName . "\n";
63    echo "  ---\n";
64}
65echo "\n";
66
67// 4. 後処理: 作成したディレクトリとファイルを削除します。
68//    再帰的にディレクトリを削除するためのヘルパー関数です。
69function rrmdir(string $dir): void
70{
71    if (!is_dir($dir)) {
72        return;
73    }
74    $files = array_diff(scandir($dir), ['.', '..']);
75    foreach ($files as $file) {
76        (is_dir("$dir/$file")) ? rrmdir("$dir/$file") : unlink("$dir/$file");
77    }
78    rmdir($dir);
79}
80
81rrmdir($testDir);
82echo "テスト環境のクリーンアップが完了しました。\n";
83
84?>

PHP 8のGlobIterator::setFlagsメソッドは、ファイルシステムを走査するGlobIteratorオブジェクトの動作を詳細に制御するために使用されます。このメソッドは、int $flagsという整数型の引数を一つ受け取ります。この引数には、FilesystemIteratorクラスで定義されている複数の定数をビット演算子（|）で組み合わせて指定することで、イテレーションの際に取得される要素の形式や、キーおよび値にどのような情報が設定されるかを定義できます。例えば、各要素をSplFileInfoオブジェクトとして取得するか、あるいはパス名の文字列として取得するかなどを設定します。setFlagsを呼び出すと、それまでのフラグ設定はすべて新しいフラグの組み合わせで上書きされるため、必要なフラグはすべて含めて指定し直す必要があります。このメソッドは値を返しません。

サンプルコードでは、まずデフォルトのフラグ設定でGlobIteratorを初期化し、キーがファイルのフルパス、値がSplFileInfoオブジェクトとなる挙動を示しています。次に、setFlagsメソッドを使ってFilesystemIterator::CURRENT_AS_PATHNAMEやFilesystemIterator::KEY_AS_FILENAMEなどのフラグを設定することで、キーがファイル名、値がパス名文字列となるようにイテレーションの挙動を変更しています。フラグ変更後、イテレータをリセットするためにrewind()メソッドを呼び出すことで、新しいフラグ設定が適用された状態でファイルが再走査されることを確認できます。