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

Copy
1<?php
2
3/**
4 * 指定されたディレクトリ構造を再帰的にスキャンし、
5 * 各ファイルとその親ディレクトリ（ファイルが属するカレントディレクトリ）のパスを表示します。
6 *
7 * このサンプルは、ParentIterator を使って、ファイル（子要素）を反復処理しながら、
8 * その親であるディレクトリの情報にアクセスする方法を示します。
9 */
10function displayFilesWithCurrentDirectory(string $rootPath): void
11{
12    // --- 1. サンプル用のディレクトリとファイルを作成 ---
13    // 実行前に、一時的なディレクトリ構造を準備します。
14    $dirs = [
15        $rootPath,
16        $rootPath . '/documents',
17        $rootPath . '/images/thumbnails',
18    ];
19    $files = [
20        $rootPath . '/index.php',
21        $rootPath . '/documents/report.docx',
22        $rootPath . '/images/photo.jpg',
23        $rootPath . '/images/thumbnails/photo_thumb.jpg',
24    ];
25
26    foreach ($dirs as $dir) {
27        if (!is_dir($dir)) {
28            mkdir($dir, 0777, true);
29        }
30    }
31    foreach ($files as $file) {
32        touch($file);
33    }
34
35    // --- 2. イテレータの準備 ---
36    try {
37        // 指定されたパスを再帰的に走査するイテレータを作成します。
38        $directoryIterator = new RecursiveDirectoryIterator(
39            $rootPath,
40            FilesystemIterator::SKIP_DOTS
41        );
42
43        // 再帰イテレータをフラットに扱えるようにし、ファイルのみを対象とします。
44        $flatIterator = new RecursiveIteratorIterator(
45            $directoryIterator,
46            RecursiveIteratorIterator::LEAVES_ONLY
47        );
48
49        // イテレータを ParentIterator でラップし、親要素へのアクセスを可能にします。
50        $parentIterator = new ParentIterator($flatIterator);
51
52        echo "Scanning directory: " . realpath($rootPath) . PHP_EOL;
53        echo "------------------------------------------------------------" . PHP_EOL;
54
55        // --- 3. ParentIterator を使った処理 ---
56        foreach ($parentIterator as $fileInfo) {
57            // ParentIterator::current() は内部イテレータの現在の要素を返します。
58            // foreach ループでは、この戻り値が $fileInfo 変数に自動的に代入されます。
59            // ここでの $fileInfo は、現在のファイルを表す SplFileInfo オブジェクトです。
60            $currentFile = $parentIterator->current();
61
62            // getParent() メソッドで、現在のファイルの親、つまりファイルが属するディレクトリを取得します。
63            $parentDirectory = $parentIterator->getParent();
64
65            // ファイル名と、そのファイルが存在する「カレントディレクトリ」のパスを表示します。
66            printf(
67                "File: %-20s | Current Directory: %s\n",
68                $currentFile->getFilename(),
69                $parentDirectory->getPathname()
70            );
71        }
72        echo "------------------------------------------------------------" . PHP_EOL;
73
74    } finally {
75        // --- 4. 後片付け ---
76        // 処理の最後に、作成したサンプル用のディレクトリとファイルをすべて削除します。
77        foreach (array_reverse($files) as $file) {
78            if (file_exists($file)) unlink($file);
79        }
80        foreach (array_reverse($dirs) as $dir) {
81            if (is_dir($dir)) rmdir($dir);
82        }
83        echo "Cleanup complete." . PHP_EOL;
84    }
85}
86
87// スクリプトを実行するディレクトリに 'temp_directory_structure' を作成して実行します。
88$sampleDirectory = __DIR__ . '/temp_directory_structure';
89displayFilesWithCurrentDirectory($sampleDirectory);
90

ParentIterator::current()メソッドは、イテレータが現在指し示している要素を取得します。このメソッドに引数はなく、戻り値として現在位置の要素そのものを返します。

foreachループでParentIteratorのようなイテレータを処理する場合、各繰り返しで変数（このサンプルでは $fileInfo）に格納される値は、内部的にこのcurrent()メソッドが返した値と同じです。サンプルコードでは、ディレクトリ内のファイルを再帰的に走査しているため、$parentIterator->current()を呼び出すと、その時点で処理対象となっているファイルの情報を表すSplFileInfoオブジェクトが返されます。

このメソッドは、ParentIteratorのgetParent()メソッドと対比すると役割がより明確になります。current()が現在処理中のファイル（子要素）を取得するのに対し、getParent()はそのファイルが属する親ディレクトリの情報を取得します。このサンプルでは、current()で得たファイル名と、getParent()で得たそのファイルのカレントディレクトリのパスを組み合わせることで、親子関係を分かりやすく表示しています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 現在の月を数値で取得します。
7 *
8 * この関数は、PHPの組み込み関数 `date()` を使用して、
9 * サーバーの現在時刻に基づいた月を 1 から 12 までの整数で返します。
10 *
11 * @return int 現在の月 (例: 1月なら1, 12月なら12)
12 */
13function getCurrentMonth(): int
14{
15    // date() 関数にフォーマット文字 'n' を渡すと、
16    // 先頭にゼロを付けない形式の月 (1-12) を文字列として取得できます。
17    // (int) で整数型にキャストして返します。
18    return (int)date('n');
19}
20
21// 関数を呼び出して現在の月を取得します。
22$month = getCurrentMonth();
23
24// 取得した月を出力します。
25echo "今月は {$month} 月です。" . PHP_EOL;
26
27?>

このPHPサンプルコードは、現在の月を数値で取得し、その結果を画面に表示するプログラムです。

最初に getCurrentMonth という名前の関数を定義しています。この関数は、呼び出し時に外部から値を受け取る必要がないため、引数はありません。関数内部では、PHPの組み込み関数である date() を使用しています。date() 関数にフォーマット文字 'n' を渡すことで、サーバーの現在時刻に基づいた月を1から12までの数値で取得します。date() が返す値は文字列型のため、(int) を使って整数型に変換し、この数値を関数の結果（戻り値）として返します。

次に、定義した getCurrentMonth() 関数を呼び出し、その戻り値である現在の月の数値を $month という変数に代入しています。

最後に echo を使い、「今月は {$month} 月です。」という文章を画面に出力します。{$month} の部分には、変数に保存されている実際の月の数値が展開されて表示されます。このコードは、特定の処理を再利用可能な関数としてまとめる基本的な方法を示しています。