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

Copy
1<?php
2
3/**
4 * GlobIterator::getSize() メソッドの使用例を示します。
5 *
6 * この関数は、指定されたパターンに一致するファイル（またはディレクトリ）の総数を
7 * GlobIterator を使用して取得し、その結果を表示します。
8 *
9 * @return void
10 */
11function demonstrateGlobIteratorGetSize(): void
12{
13    // 現在のスクリプトがあるディレクトリ内のすべての PHP ファイルを対象とするパターン
14    // __DIR__ は現在のファイルのディレクトリパスを示します。
15    // 例: C:\xampp\htdocs\my_project/*.php
16    $pattern = __DIR__ . '/*.php';
17
18    echo "検索パターン: '{$pattern}'\n\n";
19
20    try {
21        // GlobIterator をインスタンス化します。
22        // 指定されたパターンに一致するファイルシステムのパスを反復処理します。
23        $iterator = new GlobIterator($pattern);
24
25        // getSize() メソッドは、イテレータによって見つかったエントリの総数を返します。
26        // これは、パターンに一致するファイルの総数に相当します。
27        $fileCount = $iterator->getSize();
28
29        echo "パターンに一致するファイルの総数: {$fileCount} 件\n";
30
31        // オプション: 見つかったファイルをリスト表示し、何がカウントされたかを具体的に示します。
32        if ($fileCount > 0) {
33            echo "\n--- 見つかったファイル ---\n";
34            foreach ($iterator as $fileInfo) {
35                // SplFileInfo オブジェクトからファイル名を取得します。
36                echo "- " . $fileInfo->getFilename() . "\n";
37            }
38            echo "---------------------------\n";
39        } else {
40            echo "\nパターンに一致するファイルは見つかりませんでした。\n";
41        }
42
43    } catch (UnexpectedValueException $e) {
44        // パターンが無効な場合などに発生する可能性があるエラーを処理します。
45        echo "エラーが発生しました: " . $e->getMessage() . "\n";
46    }
47}
48
49// 関数を実行して、GlobIterator::getSize() の動作を確認します。
50demonstrateGlobIteratorGetSize();
51
52?>

PHP 8のGlobIteratorクラスは、ファイルシステム内で特定のパターンに合致するファイルやディレクトリを効率的に検索し、その結果を反復処理する機能を提供します。このクラスが持つgetSize()メソッドは、引数を一切必要とせず、検索パターンに一致したファイルやディレクトリの総数を整数値（int）として返します。

提示されたサンプルコードでは、__DIR__ . '/*.php'というパターンを用いて、現在のスクリプトと同じディレクトリにあるすべてのPHPファイルを検索対象としています。このパターンでGlobIteratorのインスタンスを生成した後、$iterator->getSize()を呼び出すことで、パターンに一致したPHPファイルの合計数が$fileCountに格納され、画面に表示されます。ファイルが見つからない場合は0が返されます。このメソッドは、特定の種類のファイルがいくつ存在するかを確認したい場合や、ファイル操作を行う前に数を把握したい場合に非常に有用です。エラー処理も組み込まれており、実用的なコードの書き方を学ぶことができます。