【PHP8.x】FilesystemIterator::CURRENT_MODE_MASK定数の使い方

Copy
1<?php
2
3/**
4 * FilesystemIterator::CURRENT_MODE_MASK 定数と、
5 * それが FilesystemIterator の current() メソッドの振る舞いにどう影響するかを示します。
6 *
7 * FilesystemIterator::CURRENT_MODE_MASK は整数型のビットマスクです。
8 * これは、FilesystemIterator の current() メソッドが返す値の種類
9 * (例: パス名、SplFileInfo オブジェクト、またはイテレータ自身) を
10 * 構成するフラグを識別するために使用されます。
11 */
12function demonstrateFilesystemIteratorCurrentModeMask(): void
13{
14    // デモンストレーション用の仮ディレクトリとファイルを作成します。
15    $tempDir = __DIR__ . '/fs_iterator_demo_' . uniqid();
16    if (!is_dir($tempDir)) {
17        mkdir($tempDir, 0777, true);
18    }
19    file_put_contents($tempDir . '/example1.txt', 'Content for file 1');
20    file_put_contents($tempDir . '/example2.log', 'Content for file 2');
21
22    echo "--- FilesystemIterator::CURRENT_MODE_MASK のデモンストレーション ---\n\n";
23
24    // CURRENT_MODE_MASK の値と目的を表示します。
25    echo "FilesystemIterator::CURRENT_MODE_MASK の値: " . FilesystemIterator::CURRENT_MODE_MASK . "\n";
26    echo "この定数は、設定されたフラグから '現在のモード' 部分を抽出するためのビットマスクです。\n\n";
27
28    // シナリオ 1: CURRENT_AS_PATHNAME フラグを使用
29    // このモードでは、current() メソッドは現在の項目のフルパスを文字列として返します。
30    $flagsPathname = FilesystemIterator::CURRENT_AS_PATHNAME | FilesystemIterator::SKIP_DOTS;
31    $extractedModePathname = $flagsPathname & FilesystemIterator::CURRENT_MODE_MASK;
32
33    echo "シナリオ 1: FilesystemIterator::CURRENT_AS_PATHNAME を使用\n";
34    echo "  設定されたフラグ: " . $flagsPathname . "\n";
35    echo "  マスクで抽出された '現在のモード': " . $extractedModePathname;
36    echo " (FilesystemIterator::CURRENT_AS_PATHNAME と一致: " . FilesystemIterator::CURRENT_AS_PATHNAME . ")\n";
37
38    $iteratorPathname = new FilesystemIterator($tempDir, $flagsPathname);
39    foreach ($iteratorPathname as $key => $value) {
40        // ここで、$value (current() から) はフルパスの文字列です。
41        echo "  キー: '$key', current() の戻り値: '$value' (型: " . gettype($value) . ")\n";
42    }
43    echo "\n";
44
45    // シナリオ 2: CURRENT_AS_FILEINFO フラグを使用 (デフォルトモード)
46    // このモードでは、current() メソッドは現在の項目を表す SplFileInfo オブジェクトを返します。
47    // このフラグを明示的に設定しない場合でも、これがデフォルトの振る舞いです。
48    $flagsFileinfo = FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::SKIP_DOTS;
49    $extractedModeFileinfo = $flagsFileinfo & FilesystemIterator::CURRENT_MODE_MASK;
50
51    echo "シナリオ 2: FilesystemIterator::CURRENT_AS_FILEINFO を使用 (デフォルト)\n";
52    echo "  設定されたフラグ: " . $flagsFileinfo . "\n";
53    echo "  マスクで抽出された '現在のモード': " . $extractedModeFileinfo;
54    echo " (FilesystemIterator::CURRENT_AS_FILEINFO と一致: " . FilesystemIterator::CURRENT_AS_FILEINFO . ")\n";
55
56    $iteratorFileinfo = new FilesystemIterator($tempDir, $flagsFileinfo);
57    foreach ($iteratorFileinfo as $key => $fileInfo) {
58        // ここで、$fileInfo (current() から) は SplFileInfo オブジェクトです。
59        echo "  キー: '$key', current() の戻り値: " . $fileInfo->getFilename() . " (型: " . get_class($fileInfo) . ")\n";
60    }
61    echo "\n";
62
63    // シナリオ 3: CURRENT_AS_SELF フラグを使用
64    // このモードでは、current() メソッドは FilesystemIterator オブジェクト自身を返します。
65    $flagsSelf = FilesystemIterator::CURRENT_AS_SELF | FilesystemIterator::SKIP_DOTS;
66    $extractedModeSelf = $flagsSelf & FilesystemIterator::CURRENT_MODE_MASK;
67
68    echo "シナリオ 3: FilesystemIterator::CURRENT_AS_SELF を使用\n";
69    echo "  設定されたフラグ: " . $flagsSelf . "\n";
70    echo "  マスクで抽出された '現在のモード': " . $extractedModeSelf;
71    echo " (FilesystemIterator::CURRENT_AS_SELF と一致: " . FilesystemIterator::CURRENT_AS_SELF . ")\n";
72
73    $iteratorSelf = new FilesystemIterator($tempDir, $flagsSelf);
74    foreach ($iteratorSelf as $key => $iteratorInstance) {
75        // ここで、$iteratorInstance (current() から) は FilesystemIterator オブジェクト自身です。
76        echo "  キー: '$key', current() の戻り値: " . $iteratorInstance->getFilename() . " (型: " . get_class($iteratorInstance) . ")\n";
77    }
78    echo "\n";
79
80    // 作成した仮ディレクトリとファイルをクリーンアップします。
81    unlink($tempDir . '/example1.txt');
82    unlink($tempDir . '/example2.log');
83    rmdir($tempDir);
84    echo "仮ディレクトリ '$tempDir' とその内容は削除されました。\n";
85}
86
87// デモンストレーションを実行します。
88demonstrateFilesystemIteratorCurrentModeMask();

「FilesystemIterator」は、PHPでディレクトリ内のファイルやフォルダを順に処理するためのクラスです。このクラスの「current()」メソッドは、現在の項目に関する情報を提供しますが、その情報の形式は「フラグ」によって指定できます。

「FilesystemIterator::CURRENT_MODE_MASK」は、FilesystemIteratorのクラス定数で、整数型のビットマスクです。これは、FilesystemIteratorのコンストラクタに渡されるフラグの中から、「current()」メソッドが返す値の「モード」（種類）を識別するために使われます。この定数に引数はなく、戻り値は整数です。

サンプルコードは、CURRENT_MODE_MASKの機能を示します。一時的なファイルを作成後、この定数が、設定されたフラグから現在のモード部分を抽出する目的で使用されることを説明しています。

具体的に、current()メソッドの戻り値のモードとして3つを例示します。

1. CURRENT_AS_PATHNAME: current()がファイルのフルパス（文字列）を返します。
2. CURRENT_AS_FILEINFO (デフォルト): current()がファイルの詳細情報を持つSplFileInfoオブジェクトを返します。
3. CURRENT_AS_SELF: current()がFilesystemIteratorオブジェクト自身を返します。

各シナリオでは、設定したフラグとCURRENT_MODE_MASKを論理AND演算子（&）で組み合わせることで、有効なモードを識別できることを示します。これにより、CURRENT_MODE_MASKがcurrent()メソッドの挙動を理解し制御する上で役立つことがわかります。

Copy
1<?php
2
3/**
4 * FilesystemIterator::CURRENT_MODE_MASK の使用例とファイル情報の取得
5 *
6 * この関数は、FilesystemIterator を使用してディレクトリの内容を走査し、
7 * 各ファイルの情報を表示します。
8 * FilesystemIterator::CURRENT_MODE_MASK 定数を使って、イテレータの
9 * '現在の要素の返却モード' がどのように設定されているかを確認する方法を示します。
10 * また、ファイルの最終更新日時（タイムスタンプ）を取得することで、
11 * キーワード 'current_timestamp' の「タイムスタンプ」という側面にも関連付けます。
12 */
13function demonstrateFilesystemIteratorModes(): void
14{
15    // 1. 一時ディレクトリとテストファイルを作成
16    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_fs_test_' . uniqid('fs_');
17    if (!mkdir($tempDir) && !is_dir($tempDir)) {
18        echo "一時ディレクトリの作成に失敗しました: {$tempDir}\n";
19        return;
20    }
21    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file1.txt', 'Content for file 1');
22    sleep(1); // ファイルのタイムスタンプに違いを出すため少し待機
23    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file2.txt', 'Content for file 2');
24
25    echo "--- FilesystemIterator::CURRENT_MODE_MASK の使用例 ---\n\n";
26
27    // 2. FilesystemIterator を初期化
28    //    - FilesystemIterator::CURRENT_AS_FILEINFO: 各要素を SplFileInfo オブジェクトとして返すように設定
29    //    - FilesystemIterator::SKIP_DOTS: . (カレントディレクトリ) と .. (親ディレクトリ) をスキップ
30    $flags = FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::SKIP_DOTS;
31    $iterator = new FilesystemIterator($tempDir, $flags);
32
33    echo "FilesystemIterator に設定されたフラグの合計値: " . $iterator->getFlags() . "\n";
34
35    // 3. FilesystemIterator::CURRENT_MODE_MASK を使用して、現在のエントリの返却モードを抽出
36    //    CURRENT_MODE_MASK は、設定されているフラグから
37    //    CURRENT_AS_PATHNAME, CURRENT_AS_FILEINFO, CURRENT_AS_SELF のいずれのモードが
38    //    有効になっているか (または何も設定されていないか) を判断するために使われるビットマスクです。
39    $currentEntryMode = $iterator->getFlags() & FilesystemIterator::CURRENT_MODE_MASK;
40
41    echo "FilesystemIterator::CURRENT_MODE_MASK を適用して抽出された現在のエントリ返却モード: " . $currentEntryMode . "\n";
42
43    // 抽出されたモードに基づいて、イテレータが何を返すように設定されているかを表示
44    // この例では FilesystemIterator::CURRENT_AS_FILEINFO (値: 16) を設定しているため、最初の条件に合致します。
45    if ($currentEntryMode === FilesystemIterator::CURRENT_AS_FILEINFO) {
46        echo " -> イテレータは SplFileInfo オブジェクトを返します。\n";
47    } elseif ($currentEntryMode === FilesystemIterator::CURRENT_AS_SELF) {
48        echo " -> イテレータは FilesystemIterator インスタンス自身を返します。\n";
49    } elseif ($currentEntryMode === FilesystemIterator::CURRENT_AS_PATHNAME) {
50        // FilesystemIterator::CURRENT_AS_PATHNAME の値は 0 なので、
51        // 他の CURRENT_AS_* フラグが設定されていない場合のデフォルト動作を示します。
52        echo " -> イテレータはパス名を返します (デフォルト動作)。\n";
53    } else {
54        echo " -> 不明な、またはデフォルト以外の現在のエントリ返却モードです。\n";
55    }
56
57    echo "\n--- ディレクトリ内のファイルを走査し、ファイル情報を表示 ---\n";
58    foreach ($iterator as $fileInfo) {
59        // FilesystemIterator::CURRENT_AS_FILEINFO を設定したため、$fileInfo は SplFileInfo オブジェクト
60        echo "ファイル名: " . $fileInfo->getFilename() . "\n";
61        echo "フルパス: " . $fileInfo->getPathname() . "\n";
62        // ファイルの最終更新日時（UNIXタイムスタンプ）を取得し、表示
63        // これは 'current_timestamp' というキーワードの「タイムスタンプ」部分に関連します。
64        echo "最終更新日時 (UNIXタイムスタンプ): " . $fileInfo->getMTime() . "\n";
65        echo "最終更新日時 (読みやすい形式): " . date('Y-m-d H:i:s', $fileInfo->getMTime()) . "\n";
66        echo "--------------------------\n";
67    }
68
69    // 4. クリーンアップ: 一時ファイルとディレクトリを削除
70    //    FILESYSTEMITERATOR_SKIP_DOTS はデフォルトで含まれているので、ここでは明示的に指定する必要はありませんが、
71    //    安全性のため指定しています。
72    foreach (new FilesystemIterator($tempDir, FilesystemIterator::SKIP_DOTS) as $file) {
73        unlink($file->getPathname());
74    }
75    rmdir($tempDir);
76    echo "\n一時ディレクトリ '{$tempDir}' とテストファイルをクリーンアップしました。\n";
77}
78
79// 関数を実行してデモンストレーションを開始
80demonstrateFilesystemIteratorModes();
81

FilesystemIterator::CURRENT_MODE_MASKは、PHP 8から提供されるFilesystemIteratorクラスの定数です。この定数は、FilesystemIteratorがディレクトリ内の要素を走査する際に、各要素をどのような形式で返すか（例えば、パス名、SplFileInfoオブジェクト、FilesystemIteratorインスタンス自体など）を識別するためのビットマスクとして機能します。この定数には引数はなく、常に整数値（int）を返します。

この定数は、FilesystemIteratorに設定された様々なフラグの中から、特に「現在の要素の返却モード」に関するフラグだけを抽出したい場合に便利です。サンプルコードでは、イテレータのgetFlags()メソッドで取得した全体のフラグ値に対し、CURRENT_MODE_MASKとのビットAND演算を行うことで、どの返却モードが有効になっているかを判断しています。これにより、イテレータがSplFileInfoオブジェクトを返すように設定されていることを確認し、そのオブジェクトからファイル名やパスを取得しています。

また、SplFileInfoオブジェクトからファイルの最終更新日時（UNIXタイムスタンプ）も取得しており、これはキーワード「current_timestamp」の「タイムスタンプ」という側面に直接関連します。このように、ファイルシステムを操作しながら、ファイルの重要な時間情報を効率的に扱えることが理解できます。