【PHP8.x】GlobIterator::KEY_AS_FILENAME定数の使い方

Copy
1<?php
2
3/**
4 * 一時的なテストファイルとディレクトリを作成します。
5 *
6 * @param string $dir テストファイルを作成するディレクトリのパス
7 */
8function setupTestFiles(string $dir): void
9{
10    // ディレクトリが存在しない場合は作成します。
11    if (!is_dir($dir)) {
12        mkdir($dir, 0777, true);
13    }
14    // テスト用のテキストファイルをいくつか作成します。
15    file_put_contents($dir . '/report_alpha.txt', 'Alpha Report Content');
16    file_put_contents($dir . '/image_beta.png', 'Binary Image Data'); // 検索対象外のファイル
17    file_put_contents($dir . '/data_gamma.txt', 'Gamma Data Content');
18}
19
20/**
21 * 作成した一時的なテストファイルとディレクトリを削除し、クリーンアップします。
22 *
23 * @param string $dir クリーンアップするディレクトリのパス
24 */
25function cleanupTestFiles(string $dir): void
26{
27    // ディレクトリ内のすべてのファイルを削除します。
28    foreach (glob($dir . '/*') as $file) {
29        if (is_file($file)) {
30            unlink($file);
31        }
32    }
33    // ディレクトリ自体を削除します。
34    if (is_dir($dir)) {
35        rmdir($dir);
36    }
37}
38
39/**
40 * GlobIterator::KEY_AS_FILENAME 定数を使用してファイルリストのキー名がどのように変わるかを示します。
41 *
42 * システムエンジニアを目指す初心者の方へ：
43 * PHPの GlobIterator は、ファイルシステムから特定のパターン（例：*.txt）に
44 * 一致するファイルを効率的に見つけ、リストとして扱えるようにするツールです。
45 *
46 * KEY_AS_FILENAME 定数は、このファイルリストをループで処理する際に、
47 * 各ファイルの「名前」（PHPの配列でいう「キー」）をどうするかを指定する特別な設定です。
48 * これを使うと、デフォルトの連番のキーではなく、ファイルパスそのものをキーとして利用できるようになり、
49 * 「どのファイルがどの情報に対応するか」をより直感的に扱えるようになります。
50 */
51function demonstrateGlobIteratorKeyAsFilename(): void
52{
53    // 一時的なテストディレクトリを設定します。
54    $testDir = __DIR__ . '/temp_glob_iterator_example';
55    // 検索するファイルのパターン（このディレクトリ内のすべての.txtファイル）
56    $pattern = $testDir . '/*.txt';
57
58    // --- テストファイルを準備 ---
59    setupTestFiles($testDir);
60    echo "--- 検索パターン: {$pattern} ---\n\n";
61
62    // --- 1. KEY_AS_FILENAME を使用しない場合 (デフォルトのキー) ---
63    echo "--- 1. GlobIterator::KEY_AS_FILENAME を使用しない場合 (デフォルト: 数値インデックスがキー) ---\n";
64    echo "   （PHPは通常、リストの項目に0, 1, 2...のような連番をキーとして割り当てます）\n";
65    // GlobIterator を初期化します。第2引数に0（または何も指定しない）とすると、
66    // デフォルトの動作（キーは数値インデックス）になります。
67    $iteratorDefault = new GlobIterator($pattern, 0); // フラグを明示的に0に設定
68
69    // 見つかったファイルを一つずつ処理し、キーとファイルパスを表示
70    foreach ($iteratorDefault as $key => $fileInfo) {
71        // $fileInfo は SplFileInfo オブジェクトで、ファイルに関する詳細情報を持っています。
72        echo "   キー: " . $key . ", ファイルパス: " . $fileInfo->getPathname() . "\n";
73    }
74    echo "\n";
75
76    // --- 2. KEY_AS_FILENAME を使用する場合 ---
77    echo "--- 2. GlobIterator::KEY_AS_FILENAME を使用する場合 (ファイルパスがキー) ---\n";
78    echo "   （KEY_AS_FILENAME を指定すると、ファイルパスそのものがキーとして使われます）\n";
79    // GlobIterator を初期化します。第2引数に GlobIterator::KEY_AS_FILENAME を渡すことで、
80    // 各項目のキーがファイルパスになります。
81    $iteratorWithFilenameKey = new GlobIterator($pattern, GlobIterator::KEY_AS_FILENAME);
82
83    // 見つかったファイルを一つずつ処理し、キーとファイルパスを表示
84    foreach ($iteratorWithFilenameKey as $key => $fileInfo) {
85        // ここでは、$key がファイルパスそのものになります。
86        echo "   キー: " . $key . ", ファイルパス: " . $fileInfo->getPathname() . "\n";
87    }
88    echo "\n";
89
90    // --- テストファイルをクリーンアップ ---
91    cleanupTestFiles($testDir);
92    echo "--- テストディレクトリ '{$testDir}' をクリーンアップしました。 ---\n";
93}
94
95// 上記のデモンストレーション関数を実行します。
96demonstrateGlobIteratorKeyAsFilename();

PHPのGlobIterator::KEY_AS_FILENAME定数は、ファイルシステムから特定のパターンに一致するファイルを効率的に検索するGlobIteratorクラスの動作を調整するための設定（フラグ）です。この定数自体は引数を取らず、内部的な設定を示すint型の値として機能します。

通常、GlobIteratorを使ってファイルリストをループ処理すると、各ファイルのデータ（SplFileInfoオブジェクト）には、0, 1, 2...のような数値インデックスがキーとして割り当てられます。しかし、GlobIteratorのコンストラクタにこのKEY_AS_FILENAME定数を第2引数として指定すると、キーの挙動が変更されます。具体的には、各ファイルのキーがデフォルトの数値インデックスではなく、そのファイルの完全なパス名そのものになります。

サンプルコードは、この定数を使わない場合と使う場合で、foreachループを通じて取得されるキーがどのように変化するかを具体的に示しています。定数を使用しない場合は数値がキーとなり、使用した場合はファイルパスが直接キーとして利用されるため、どのファイルの情報であるかをより直感的に扱うことが可能になります。これは、ファイルパスを直接参照したい場合に便利な機能です。

Copy
1<?php
2
3/**
4 * GlobIterator::KEY_AS_FILENAME 定数を使用して、イテレータのキーがファイル名になる動作をデモンストレーションします。
5 *
6 * この関数は、一時ディレクトリとテストファイルを作成し、
7 * デフォルトのGlobIterator (キーがファイルのフルパス) の動作と、
8 * GlobIterator::KEY_AS_FILENAME フラグを使用したGlobIterator (キーがファイル名) の動作を比較して示します。
9 *
10 * システムエンジニアを目指す初心者の方へ:
11 * GlobIterator は、特定のパターンに一致するファイルを反復処理するためのクラスです。
12 * 通常、foreach ループで使うと、キーはファイルの完全なパスになります。
13 * しかし、GlobIterator::KEY_AS_FILENAME を指定することで、キーをファイル名に変更できます。
14 * これは、例えばファイルの内容をファイル名と関連付けて処理したい場合などに便利です。
15 */
16function demonstrateGlobIteratorKeyAsFilename(): void
17{
18    // --- 1. 一時ディレクトリとテストファイルのセットアップ ---
19    // 一意な名前で一時ディレクトリを作成します。
20    $tempDir = sys_get_temp_dir() . '/glob_iterator_example_' . uniqid();
21    if (!mkdir($tempDir) && !is_dir($tempDir)) {
22        throw new \RuntimeException(sprintf('ディレクトリ "%s" を作成できませんでした。', $tempDir));
23    }
24
25    // いくつかのテストファイルを作成します。
26    file_put_contents($tempDir . '/report_2023.txt', '2023年のデータ');
27    file_put_contents($tempDir . '/log_errors.log', 'エラーログ');
28    file_put_contents($tempDir . '/config.ini', '設定ファイル');
29
30    // 一時ディレクトリ内のすべてのファイルを対象とするパターン
31    $pattern = $tempDir . '/*';
32
33    // --- 2. デフォルトのGlobIteratorの動作 (キーがファイルのフルパス) ---
34    echo "--- デフォルトのGlobIteratorの動作 (キーはファイルのフルパス) ---\n";
35    $iteratorDefault = new \GlobIterator($pattern);
36    foreach ($iteratorDefault as $key => $fileInfo) {
37        // デフォルトでは、`$key` 変数にはファイルの完全なパスが格納されます。
38        echo "キー: " . $key . ", ファイル名: " . $fileInfo->getFilename() . "\n";
39    }
40    echo "\n";
41
42    // --- 3. GlobIterator::KEY_AS_FILENAME を使用した場合 (キーがファイル名) ---
43    echo "--- GlobIterator::KEY_AS_FILENAME を使用した場合 (キーはファイル名) ---\n";
44    // GlobIterator::KEY_AS_FILENAME フラグを指定することで、キーの動作を変更します。
45    $iteratorFilenameKey = new \GlobIterator($pattern, \GlobIterator::KEY_AS_FILENAME);
46    foreach ($iteratorFilenameKey as $key => $fileInfo) {
47        // KEY_AS_FILENAME フラグにより、`$key` 変数にはファイルのフルパスではなく、ファイル名が格納されます。
48        // これが「キー名 変更」の具体的な例です。
49        echo "キー: " . $key . ", ファイル名: " . $fileInfo->getFilename() . "\n";
50    }
51
52    // --- 4. クリーンアップ (作成した一時ディレクトリとファイルを削除) ---
53    if (is_dir($tempDir)) {
54        // ディレクトリ内のファイルを削除します。
55        foreach (new \FilesystemIterator($tempDir) as $file) {
56            unlink($file->getPathname());
57        }
58        // 空になったディレクトリを削除します。
59        rmdir($tempDir);
60    }
61}
62
63// 上記のデモンストレーション関数を実行します。
64demonstrateGlobIteratorKeyAsFilename();
65
66?>

PHP 8のGlobIterator::KEY_AS_FILENAMEは、GlobIteratorクラスで使用される定数です。GlobIteratorは、指定されたファイルパスパターン（例: *.txt）に一致するファイルを効率的に反復処理（ループで一つずつ取り出すこと）するためのクラスです。

この定数KEY_AS_FILENAMEは、GlobIteratorのコンストラクタの第二引数として渡す「フラグ」として機能し、その戻り値は整数型です。この定数自体には引数はありません。デフォルトでは、GlobIteratorをforeachループで使う際、ループのキー（$key変数）にはファイルの完全なパスが格納されます。しかし、GlobIterator::KEY_AS_FILENAMEを指定すると、このキーの挙動が変更され、ファイルの完全なパスではなく、ファイル名のみがキーとして使用されるようになります。

サンプルコードでは、まず一時ディレクトリにいくつかのテストファイルを作成します。次に、デフォルトのGlobIteratorを使ってファイルパスがキーになる様子を示し、その後にGlobIterator::KEY_AS_FILENAMEを適用して、キーがファイル名に変更される具体的な挙動を比較しています。このようにキー名を変更する機能は、例えばファイル名と関連付けてデータを整理したり、特定のファイル名のファイルを効率的に見つけたりする場合に非常に役立ちます。