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

Copy
1<?php
2
3/**
4 * FilesystemIterator::getFilename() メソッドのデモンストレーションクラス
5 *
6 * このクラスは、FilesystemIterator を使用してディレクトリ内のファイル名やサブディレクトリ名を
7 * 取得する方法を、一時的なファイルシステム環境を設定・クリーンアップしながら示します。
8 * システムエンジニアを目指す初心者の方にも、ファイルシステム操作の基本とイテレータの活用を理解しやすいように構成されています。
9 */
10class FilesystemIteratorGetFilenameDemo
11{
12    private string $tempDir = ''; // 一時的に作成するディレクトリのパス
13
14    /**
15     * デモンストレーションを実行します。
16     * 一時ディレクトリの準備、FilesystemIteratorの使用、結果の表示、クリーンアップを行います。
17     */
18    public function run(): void
19    {
20        try {
21            // 1. テスト用のファイルシステム構造を準備
22            $this->setupTempFilesystem();
23            echo "対象ディレクトリ: " . $this->tempDir . "\n\n";
24
25            // 2. FilesystemIterator のインスタンスを作成
26            //    FilesystemIterator::SKIP_DOTS フラグは '.' と '..' （現在のディレクトリと親ディレクトリ）
27            //    といった特殊なエントリをスキップするために使用します。
28            $iterator = new FilesystemIterator($this->tempDir, FilesystemIterator::SKIP_DOTS);
29
30            echo "ディレクトリ内のエントリ名:\n";
31            // 3. ディレクトリ内の各エントリ（ファイルまたはサブディレクトリ）をループ処理
32            foreach ($iterator as $fileInfo) {
33                // FilesystemIterator::getFilename() を使用してエントリ名を取得
34                // このメソッドは、ファイルシステム上の「純粋な」名前（例: "document.txt"）を返します。
35                // フルパス情報（例: "/tmp/my_dir/document.txt"）は含まれません。
36                echo "- " . $fileInfo->getFilename() . "\n";
37            }
38
39        } catch (Exception $e) {
40            // エラーが発生した場合の処理
41            echo "エラーが発生しました: " . $e->getMessage() . "\n";
42        } finally {
43            // 4. クリーンアップ処理 (try-finally ブロックで確実に行われるようにする)
44            if ($this->tempDir && is_dir($this->tempDir)) {
45                echo "\n一時ディレクトリをクリーンアップ中: " . $this->tempDir . "\n";
46                $this->cleanupTempFilesystem();
47                echo "クリーンアップ完了。\n";
48            }
49        }
50    }
51
52    /**
53     * テスト用の一時ディレクトリとダミーファイルを準備します。
54     * このメソッド内でファイルシステム操作が行われます。
55     */
56    private function setupTempFilesystem(): void
57    {
58        $baseDir = sys_get_temp_dir(); // システムの一時ディレクトリを取得
59        // ユニークな名前で一時ディレクトリを作成
60        $this->tempDir = $baseDir . DIRECTORY_SEPARATOR . 'php_fs_iterator_demo_' . uniqid();
61        
62        // ディレクトリとダミーファイルを作成
63        mkdir($this->tempDir, 0777, true); // 0777は読み書き実行の全権限、trueは親ディレクトリも作成
64        file_put_contents($this->tempDir . DIRECTORY_SEPARATOR . 'document.txt', 'Sample text content.');
65        file_put_contents($this->tempDir . DIRECTORY_SEPARATOR . 'image.jpg', 'Binary data simulation.');
66        mkdir($this->tempDir . DIRECTORY_SEPARATOR . 'logs', 0777); // サブディレクトリも作成
67        file_put_contents($this->tempDir . DIRECTORY_SEPARATOR . 'logs' . DIRECTORY_SEPARATOR . 'access.log', 'Log entry data.');
68    }
69
70    /**
71     * 準備した一時ディレクトリとその中身を全てクリーンアップします。
72     * ディレクトリとその中のファイル/サブディレクトリを再帰的に削除します。
73     */
74    private function cleanupTempFilesystem(): void
75    {
76        // RecursiveIteratorIterator を使用してディレクトリ全体を再帰的に走査
77        $files = new RecursiveIteratorIterator(
78            new RecursiveDirectoryIterator($this->tempDir, RecursiveDirectoryIterator::SKIP_DOTS),
79            RecursiveIteratorIterator::CHILD_FIRST // 子要素から先に処理 (ファイル→サブディレクトリ→親ディレクトリの順)
80        );
81
82        foreach ($files as $fileinfo) {
83            if ($fileinfo->isDir()) {
84                rmdir($fileinfo->getRealPath()); // ディレクトリを削除
85            } else {
86                unlink($fileinfo->getRealPath()); // ファイルを削除
87            }
88        }
89        rmdir($this->tempDir); // ベースディレクトリを削除
90    }
91}
92
93// クラスのインスタンスを作成し、デモンストレーションを実行
94$demo = new FilesystemIteratorGetFilenameDemo();
95$demo->run();
96

PHP 8 で提供される FilesystemIterator::getFilename() メソッドは、ファイルシステム上のファイルやサブディレクトリの「名前」のみを取得するために利用されます。このメソッドは FilesystemIterator クラスに属しており、ディレクトリ内のエントリ（ファイルまたはサブディレクトリ）を一つずつ処理する際に、それぞれのエントリに対応するオブジェクトから呼び出されます。

引数は不要で、呼び出すだけで対象のエントリ名が文字列（string）として返されます。ここで返される名前は、ファイルやディレクトリのフルパスではなく、そのエントリ自体の純粋な名前です。例えば、/path/to/my_file.txt というパスのファイルに対してこのメソッドを使用した場合、戻り値は my_file.txt となります。サブディレクトリの場合も同様に、/path/to/my_dir であれば my_dir が返されます。

この機能は、ディレクトリ内のファイル一覧を表示する際や、特定の名前を持つファイルを検索・処理する際に、余分なパス情報を考慮せずにファイル名を直接扱いたい場合に大変役立ちます。システムエンジニアを目指す方にとって、ファイルシステムを効率的に操作し、管理するための基本的ながら重要なメソッドの一つです。

Copy
1<?php
2
3/**
4 * FilesystemIterator::getFilename() メソッドの動作をデモンストレーションします。
5 * 指定されたディレクトリ内の各項目（ファイルやサブディレクトリ）の完全パスとファイル名/ディレクトリ名を表示します。
6 *
7 * システムエンジニアを目指す初心者向けに、`getFilename` が何を返すのかを明確に示すことを目的としています。
8 */
9function demonstrateFilesystemIteratorGetFilename(): void
10{
11    // テスト用のディレクトリパスを定義します。
12    // スクリプトが実行されるディレクトリに一時的なディレクトリを作成します。
13    $testDirPath = __DIR__ . '/temp_fs_iterator_demo';
14
15    // 1. テスト環境の準備
16    // 一時的なディレクトリとファイルを作成し、デモンストレーション用の環境を整えます。
17    if (!is_dir($testDirPath)) {
18        mkdir($testDirPath);
19    }
20    file_put_contents($testDirPath . '/document.txt', 'これはテストファイルです。');
21    file_put_contents($testDirPath . '/image.jpg', 'ダミーコンテンツ');
22    mkdir($testDirPath . '/subdirectory');
23    file_put_contents($testDirPath . '/subdirectory/report.pdf', 'これはレポートです。');
24
25    echo "--- FilesystemIterator::getFilename() デモンストレーション ---\n";
26    echo "対象ディレクトリ: " . $testDirPath . "\n\n";
27
28    try {
29        // 2. FilesystemIterator のインスタンスを作成
30        // FilesystemIterator は、指定されたディレクトリの直下にある項目をイテレート（巡回）するために使用します。
31        // デフォルトでは、カレントディレクトリ(.)と親ディレクトリ(..)はスキップされません。
32        // ここでは、デフォルトの動作で進めます。
33        $iterator = new FilesystemIterator($testDirPath);
34
35        // 3. ループ処理と getFilename() の呼び出し
36        // ディレクトリ内の各項目（ファイルやサブディレクトリ）を一つずつ処理します。
37        foreach ($iterator as $fileInfo) {
38            // $fileInfo は SplFileInfo クラスのインスタンスです。
39            // FilesystemIterator は SplFileInfo オブジェクトを返します。
40
41            // getPathname() は、ファイルまたはディレクトリへの完全なパスを返します。
42            $fullPath = $fileInfo->getPathname();
43
44            // getFilename() は、パスからファイル名またはディレクトリ名のみを返します。
45            // 例: "/path/to/file.txt" から "file.txt" を返します。
46            // 例: "/path/to/directory/" から "directory" を返します。
47            $filename = $fileInfo->getFilename();
48
49            echo "完全パス: " . $fullPath . "\n";
50            echo "ファイル名/ディレクトリ名: " . $filename . "\n";
51            echo "-----------------------------------\n";
52        }
53    } catch (UnexpectedValueException $e) {
54        // FilesystemIteratorのコンストラクタが失敗した場合（例: 指定されたパスが存在しないかディレクトリではない場合）に捕捉します。
55        echo "エラーが発生しました: " . $e->getMessage() . "\n";
56    } finally {
57        // 4. テスト環境のクリーンアップ
58        // 作成した一時的なディレクトリとファイルを削除し、元の状態に戻します。
59        // この処理は、スクリプトが正常に終了してもエラーで終了しても実行されます。
60        if (is_dir($testDirPath)) {
61            // RecursiveDirectoryIterator を使ってサブディレクトリ内のファイルも削除します。
62            $ri = new RecursiveIteratorIterator(
63                new RecursiveDirectoryIterator($testDirPath, RecursiveDirectoryIterator::SKIP_DOTS),
64                RecursiveIteratorIterator::CHILD_FIRST
65            );
66            foreach ($ri as $item) {
67                if ($item->isDir()) {
68                    rmdir($item->getPathname());
69                } else {
70                    unlink($item->getPathname());
71                }
72            }
73            rmdir($testDirPath); // ルートディレクトリを削除
74            echo "\nテスト環境「" . $testDirPath . "」をクリーンアップしました。\n";
75        }
76    }
77}
78
79// デモンストレーション関数の実行
80demonstrateFilesystemIteratorGetFilename();
81
82?>

PHPのFilesystemIterator::getFilename()メソッドは、ファイルシステムを操作する際に、パスからファイル名やディレクトリ名だけを取得するために使用されます。このメソッドは、FilesystemIteratorが返すSplFileInfoクラスのインスタンスから呼び出されます。FilesystemIteratorは、指定されたディレクトリ内のファイルやサブディレクトリといった各項目を順番に処理するための機能を提供します。

getFilename()メソッドは引数を一切取りません。その役割は、ファイルまたはディレクトリの完全なパスから、その最後の部分である「名前」のみを文字列として返すことです。例えば、「/path/to/document.txt」という完全なパスからは「document.txt」を、また「/path/to/subdirectory/」というディレクトリのパスからは「subdirectory」を返します。

このサンプルコードでは、まず一時的なディレクトリと複数のテストファイル、サブディレクトリを作成し、デモンストレーション環境を整えています。次に、FilesystemIteratorを使ってその一時ディレクトリ内を巡回し、各項目についてgetPathname()メソッドで完全なパスを取得し、それと並行してgetFilename()メソッドで抽出されたファイル名やディレクトリ名を表示しています。これにより、完全なパスからファイルやディレクトリの名前部分だけがどのように正確に取得されるかを、システムエンジニアを目指す初心者の方にも分かりやすく示しています。ファイル操作において、パス全体ではなく名前部分だけが必要な場面で非常に役立つメソッドです。