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

Copy
1<?php
2
3/**
4 * GlobIterator を継承し、PHP 8 のコンストラクタプロモーションを利用して
5 * 検索パターンとフラグをプロパティとして保持するカスタムイテレータ。
6 */
7class MyPatternFileFinder extends GlobIterator
8{
9    /**
10     * コンストラクタプロモーションを使用して、`$pattern` と `$flags` を
11     * プライベートプロパティとして宣言し、同時に初期化します。
12     * その後、これらの値は親クラス (GlobIterator) のコンストラクタに渡されます。
13     *
14     * @param string $pattern 検索するファイルパスのパターン (例: /path/to/*.txt)
15     * @param int $flags FilesystemIterator のフラグの組み合わせ (例: FilesystemIterator::SKIP_DOTS)
16     */
17    public function __construct(
18        private string $pattern,
19        private int $flags = FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::SKIP_DOTS
20    ) {
21        // 親クラスである GlobIterator のコンストラクタを呼び出し、
22        // 指定されたパターンとフラグでイテレータを初期化します。
23        parent::__construct($this->pattern, $this->flags);
24    }
25
26    /**
27     * このイテレータが内部で使用している検索パターンを返します。
28     * コンストラクタプロモーションによって宣言されたプロパティにアクセスしています。
29     *
30     * @return string 検索パターン
31     */
32    public function getSearchPattern(): string
33    {
34        return $this->pattern;
35    }
36
37    /**
38     * このクラスの利用例と、テストファイルのセットアップ・クリーンアップを行うメソッド。
39     * 単体で動作可能なコードとして、全てのロジックをこのクラス内に含めています。
40     *
41     * @param string $testDir テストファイルを一時的に作成するディレクトリパス
42     */
43    public static function demonstrateUsage(string $testDir): void
44    {
45        // --------------------------------------------------
46        // テストファイルの準備
47        // --------------------------------------------------
48        if (!is_dir($testDir)) {
49            mkdir($testDir, 0777, true);
50        }
51        file_put_contents($testDir . '/document1.txt', 'This is document 1.');
52        file_put_contents($testDir . '/log_file.log', 'Log entry: something happened.');
53        file_put_contents($testDir . '/image.jpg', 'Binary image data.');
54
55        try {
56            echo "--- GlobIterator::__construct と PHP 8 コンストラクタプロモーションの例 ---\n\n";
57
58            // --------------------------------------------------
59            // .txt ファイルを検索するイテレータの作成と利用
60            // --------------------------------------------------
61            echo "■ .txt ファイルを検索:\n";
62            // MyPatternFileFinder をインスタンス化。
63            // コンストラクタプロモーションにより、$pattern プロパティが自動的に設定されます。
64            $txtFinder = new MyPatternFileFinder($testDir . '/*.txt');
65
66            echo "  検索パターン: " . $txtFinder->getSearchPattern() . "\n";
67            echo "  見つかったファイル:\n";
68
69            if ($txtFinder->count() > 0) {
70                foreach ($txtFinder as $fileInfo) {
71                    echo "    - " . $fileInfo->getFilename() . " (フルパス: " . $fileInfo->getPathname() . ")\n";
72                }
73            } else {
74                echo "    - .txt ファイルは見つかりませんでした。\n";
75            }
76
77            echo "\n";
78
79            // --------------------------------------------------
80            // .log ファイルを検索するイテレータの作成と利用
81            // --------------------------------------------------
82            echo "■ .log ファイルを検索:\n";
83            $logFinder = new MyPatternFileFinder($testDir . '/*.log');
84
85            echo "  検索パターン: " . $logFinder->getSearchPattern() . "\n";
86            echo "  見つかったファイル:\n";
87            if ($logFinder->count() > 0) {
88                foreach ($logFinder as $fileInfo) {
89                    echo "    - " . $fileInfo->getFilename() . " (フルパス: " . $fileInfo->getPathname() . ")\n";
90                }
91            } else {
92                echo "    - .log ファイルは見つかりませんでした。\n";
93            }
94
95        } finally {
96            // --------------------------------------------------
97            // テストファイルのクリーンアップ
98            // --------------------------------------------------
99            if (is_dir($testDir)) {
100                // ディレクトリ内の全てのファイルを削除
101                foreach (glob($testDir . '/*') as $file) {
102                    if (is_file($file)) {
103                        unlink($file);
104                    }
105                }
106                // 空になったディレクトリを削除
107                rmdir($testDir);
108            }
109        }
110    }
111}
112
113// --------------------------------------------------
114// スクリプトのエントリーポイント
115// --------------------------------------------------
116// MyPatternFileFinder クラスの demonstrateUsage メソッドを呼び出し、
117// 全ての処理を実行します。
118MyPatternFileFinder::demonstrateUsage(__DIR__ . '/temp_glob_test');
119
120?>

PHPのGlobIteratorクラスは、ファイルシステム上で特定のパターンに一致するファイルやディレクトリを効率的に検索し、それらを順に処理するためのイテレータを提供します。このクラスのコンストラクタである__constructメソッドは、GlobIteratorオブジェクトを初期化する際に使用されます。

引数として、string $patternには検索したいファイルパスのパターン（例: /path/to/*.txtのようなワイルドカードを含む文字列）を指定します。オプションのint $flagsには、FilesystemIteratorクラスで定義された定数を組み合わせて、検索結果の形式や挙動を細かく設定できます。このメソッド自体はオブジェクトを初期化するだけで、戻り値はありません。

サンプルコードでは、GlobIteratorを継承したMyPatternFileFinderクラスが、PHP 8で導入された「コンストラクタプロモーション」という機能を利用しています。これは、コンストラクタの引数を直接クラスのプロパティとして宣言し、同時に初期化できる便利な記法です。これにより、コードの記述量を減らし、より簡潔にプロパティを定義できます。MyPatternFileFinderは、このプロモーションで受け取った$patternと$flagsを内部プロパティとして保持しつつ、それらを親クラスであるGlobIteratorのコンストラクタに渡し、指定されたパターンに基づいてファイルを検索するイテレータとして動作します。

Copy
1<?php
2
3use FilesystemIterator;
4use GlobIterator; // GlobIterator クラスのインポート
5
6/**
7 * GlobIterator を内部で利用し、PHP 8 の Constructor Property Promotion を示すクラス。
8 * 
9 * システムエンジニアを目指す初心者の方へ:
10 * このクラスは、指定されたパターンに一致するファイルを検索するために GlobIterator を利用します。
11 * PHP 8 で導入された「Constructor Property Promotion」という機能を使って、
12 * コンストラクタの引数として渡された GlobIterator のインスタンスを、
13 * そのままクラスのプライベートプロパティとして宣言・初期化しています。
14 * これにより、冗長なプロパティ宣言と代入のコードを削減し、より簡潔に記述できます。
15 */
16class FileSearcher
17{
18    // PHP 8 の Constructor Property Promotion を利用。
19    // コンストラクタ引数 $iterator を受け取り、同時に private プロパティ $iterator として宣言・初期化。
20    public function __construct(
21        private GlobIterator $iterator // GlobIterator のインスタンスを受け取る
22    ) {}
23
24    /**
25     * 見つかったファイルをリストアップするメソッド。
26     * 内部で保持している GlobIterator を使ってファイルを反復処理します。
27     */
28    public function listFiles(): void
29    {
30        // イテレータが有効な要素を持っているか確認
31        if (!$this->iterator->valid()) {
32            echo "指定されたパターンに一致するファイルは見つかりませんでした。\n";
33            return;
34        }
35
36        echo "見つかったファイル:\n";
37        // GlobIterator は SplFileInfo のインスタンスを返すので、ファイル名などの情報にアクセスできます
38        foreach ($this->iterator as $file) {
39            echo "- " . $file->getFilename() . " (フルパス: " . $file->getPathname() . ")\n";
40        }
41    }
42}
43
44// --- サンプルコードの実行部分 ---
45
46// 検索対象のディレクトリと一時ファイルを作成
47$tempDir = __DIR__ . '/temp_search_example';
48if (!is_dir($tempDir)) {
49    mkdir($tempDir, 0777, true); // ディレクトリが存在しない場合は作成
50}
51file_put_contents($tempDir . '/document_a.txt', 'Content for A');
52file_put_contents($tempDir . '/image_b.jpg', 'Binary content B');
53file_put_contents($tempDir . '/document_c.txt', 'Content for C');
54file_put_contents($tempDir . '/.hidden_file.txt', 'This should be skipped'); // ドットファイル
55
56// GlobIterator のパターンを定義
57// temp_search_example ディレクトリ内の '.txt' 拡張子のファイルを検索
58$pattern = $tempDir . '/*.txt';
59
60// GlobIterator のフラグを定義
61// FilesystemIterator::CURRENT_AS_FILEINFO: 各要素を SplFileInfo オブジェクトとして扱う
62// FilesystemIterator::SKIP_DOTS: . と .. および .で始まるファイルをスキップする
63$flags = FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::SKIP_DOTS;
64
65// GlobIterator のインスタンスを生成
66// ここで GlobIterator::__construct が呼び出され、検索パターンとフラグが設定されます。
67$globIteratorInstance = new GlobIterator($pattern, $flags);
68
69// FileSearcher クラスのインスタンスを生成
70// このとき、GlobIterator のインスタンスが Constructor Property Promotion によって $searcher オブジェクトの
71// private プロパティ $iterator に自動的にセットされます。
72$searcher = new FileSearcher($globIteratorInstance);
73
74// ファイルをリストアップするメソッドを呼び出す
75$searcher->listFiles();
76
77// --- 後処理 (作成した一時ファイルとディレクトリを削除) ---
78array_map('unlink', glob($tempDir . '/*')); // ディレクトリ内のファイルを削除
79rmdir($tempDir); // ディレクトリ自体を削除
80
81?>

PHPのGlobIteratorクラスのコンストラクタ（__construct）は、指定されたパターンに合致するファイルやディレクトリを効率的に検索するためのイテレータを初期化します。引数$patternには*.txtのようなワイルドカードを含む検索パスを指定し、$flagsはFilesystemIterator::CURRENT_AS_FILEINFOで結果をファイル情報として取得したり、FilesystemIterator::SKIP_DOTSで.や..をスキップしたりと、検索の挙動を制御するオプションを指定します。コンストラクタはインスタンスを生成するため、明示的な戻り値はありません。

サンプルコードでは、PHP 8の「Constructor Property Promotion」が活用されています。これは、コンストラクタの引数宣言時に可視性を指定することで、その引数を自動的にクラスのプロパティとして宣言・初期化し、コードを簡潔にする機能です。FileSearcherクラスは、この機能を使ってGlobIteratorのインスタンスをプライベートプロパティとして受け取っています。その後、listFilesメソッド内でこのイテレータを利用し、一時ディレクトリに作成された.txtファイルを検索して、ファイル名とフルパスを表示しています。この例は、GlobIteratorとConstructor Property Promotionの効果的な連携を示しています。