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

Copy
1<?php
2
3// Create a temporary directory and files for demonstration purposes.
4$tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_glob_example_' . uniqid('glob_');
5mkdir($tempDir);
6file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file1.txt', 'Sample Content 1');
7file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file2.log', 'Sample Content 2');
8
9try {
10    // Define the glob pattern to match all files in the temporary directory.
11    $pattern = $tempDir . DIRECTORY_SEPARATOR . '*';
12
13    echo "--- Understanding GlobIterator::KEY_MODE_MASK and key() behavior ---\n";
14
15    // Scenario 1: Default key() behavior for GlobIterator.
16    // By default, GlobIterator often uses KEY_AS_PATHNAME for its keys.
17    $iterator = new GlobIterator($pattern);
18    echo "\n[Scenario 1: Default Behavior]\n";
19    echo "Current raw flags: " . $iterator->getFlags() . "\n";
20
21    // KEY_MODE_MASK is a constant used as a bitmask to extract
22    // only the "key mode" part from the iterator's flags.
23    // This helps determine how the key() method will return its value.
24    $currentKeyMode = $iterator->getFlags() & GlobIterator::KEY_MODE_MASK;
25    echo "Extracted key mode using KEY_MODE_MASK: " . $currentKeyMode . "\n";
26    echo "GlobIterator::KEY_AS_PATHNAME value: " . GlobIterator::KEY_AS_PATHNAME . "\n";
27    echo "Is current key mode KEY_AS_PATHNAME? " . ($currentKeyMode === GlobIterator::KEY_AS_PATHNAME ? 'Yes' : 'No') . "\n";
28
29    // Iterate and display the keys using the default mode (usually full path).
30    foreach ($iterator as $name => $fileInfo) {
31        echo "Default key(): " . $iterator->key() . "\n";
32    }
33
34    // Scenario 2: Changing key() behavior to return only the filename.
35    echo "\n[Scenario 2: Set KEY_AS_FILENAME]\n";
36    // We set the flags to make the key() method return only the filename.
37    $iterator->setFlags(GlobIterator::KEY_AS_FILENAME);
38    echo "Raw flags after setting KEY_AS_FILENAME: " . $iterator->getFlags() . "\n";
39
40    // Use KEY_MODE_MASK to verify that the key mode has changed.
41    $currentKeyMode = $iterator->getFlags() & GlobIterator::KEY_MODE_MASK;
42    echo "Extracted key mode using KEY_MODE_MASK: " . $currentKeyMode . "\n";
43    echo "GlobIterator::KEY_AS_FILENAME value: " . GlobIterator::KEY_AS_FILENAME . "\n";
44    echo "Is current key mode KEY_AS_FILENAME? " . ($currentKeyMode === GlobIterator::KEY_AS_FILENAME ? 'Yes' : 'No') . "\n";
45
46    // Rewind the iterator to apply new flags and iterate again.
47    $iterator->rewind();
48    foreach ($iterator as $name => $fileInfo) {
49        echo "key() with KEY_AS_FILENAME: " . $iterator->key() . "\n";
50    }
51
52    // Scenario 3: Changing key() behavior back to return the full pathname.
53    echo "\n[Scenario 3: Set KEY_AS_PATHNAME]\n";
54    // We set the flags to make the key() method return the full pathname.
55    $iterator->setFlags(GlobIterator::KEY_AS_PATHNAME);
56    echo "Raw flags after setting KEY_AS_PATHNAME: " . $iterator->getFlags() . "\n";
57
58    // Use KEY_MODE_MASK to verify that the key mode has changed again.
59    $currentKeyMode = $iterator->getFlags() & GlobIterator::KEY_MODE_MASK;
60    echo "Extracted key mode using KEY_MODE_MASK: " . $currentKeyMode . "\n";
61    echo "Is current key mode KEY_AS_PATHNAME? " . ($currentKeyMode === GlobIterator::KEY_AS_PATHNAME ? 'Yes' : 'No') . "\n";
62
63    // Rewind the iterator to apply new flags and iterate again.
64    $iterator->rewind();
65    foreach ($iterator as $name => $fileInfo) {
66        echo "key() with KEY_AS_PATHNAME: " . $iterator->key() . "\n";
67    }
68
69} finally {
70    // Clean up the temporary directory and files created for the example.
71    array_map('unlink', glob($tempDir . DIRECTORY_SEPARATOR . '*'));
72    rmdir($tempDir);
73    echo "\nCleanup complete: Temporary directory and files removed.\n";
74}

GlobIteratorクラスは、指定されたパターンに一致するファイルやディレクトリを走査するイテレータです。その中で、key()メソッドはイテレータが現在指し示している要素の「キー」を返しますが、このキーがファイル名になるかフルパスになるかは、イテレータの内部設定（フラグ）によって変化します。

GlobIterator::KEY_MODE_MASK定数は、GlobIteratorのgetFlags()メソッドで取得できる整数値の中から、key()メソッドの挙動を決定する「キーのモード」に関する部分のみを抽出するためのビットマスクです。この定数自体は引数を取らず、常に整数値を返します。

サンプルコードでは、KEY_MODE_MASKを利用して、現在のGlobIteratorがどのようなキーモードで動作しているかを判別しています。デフォルトのモード（通常はGlobIterator::KEY_AS_PATHNAMEでファイルのフルパスを返します）を確認した後、setFlags()メソッドを用いてキーモードをGlobIterator::KEY_AS_FILENAMEに変更し、key()メソッドがファイル名のみを返すように設定しています。ここでもKEY_MODE_MASKを使って、キーモードが正しく変更されたことを検証しています。このように、この定数はkey()メソッドの動作を理解し、現在のキーの返却形式をプログラムで確認する際に役立ちます。