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

Copy
1<?php
2
3/**
4 * 指定されたディレクトリとその内容を再帰的に削除します。
5 *
6 * @param string $dir 削除するディレクトリのパス
7 * @return bool 成功した場合は true、失敗した場合は false
8 */
9function rmdir_recursive(string $dir): bool
10{
11    if (!is_dir($dir)) {
12        return false;
13    }
14
15    $items = new FilesystemIterator($dir, FilesystemIterator::SKIP_DOTS);
16
17    foreach ($items as $item) {
18        if ($item->isDir()) {
19            rmdir_recursive($item->getPathname());
20        } else {
21            unlink($item->getPathname());
22        }
23    }
24
25    return rmdir($dir);
26}
27
28/**
29 * FilesystemIterator::getType() の動作確認用に、一時的なファイルシステム環境をセットアップします。
30 * この関数は一時ディレクトリ、ファイル、サブディレクトリ、および可能な場合はシンボリックリンクを作成します。
31 *
32 * @param string $baseDir ベースとなる一時ディレクトリのパス
33 * @return void
34 * @throws RuntimeException ディレクトリ作成に失敗した場合
35 */
36function setupTestEnvironment(string $baseDir): void
37{
38    if (!mkdir($baseDir) && !is_dir($baseDir)) {
39        throw new RuntimeException(sprintf('Directory "%s" was not created', $baseDir));
40    }
41
42    // テスト用の通常ファイルを作成
43    file_put_contents($baseDir . '/test_file.txt', 'This is a test file.');
44    
45    // テスト用のサブディレクトリを作成
46    mkdir($baseDir . '/sub_dir');
47    file_put_contents($baseDir . '/sub_dir/another_file.txt', 'Another file inside sub_dir.');
48
49    // シンボリックリンクの作成を試みます。
50    // Windows環境では管理者権限が必要な場合や、開発者モードが有効でないと失敗することがあります。
51    // 失敗しても処理は続行しますが、その旨をログに記録します。
52    if (function_exists('symlink')) {
53        try {
54            symlink($baseDir . '/test_file.txt', $baseDir . '/test_link.txt');
55        } catch (Throwable $e) {
56            error_log("Warning: Could not create symbolic link (might require admin privileges or specific OS config): " . $e->getMessage());
57        }
58    } else {
59        error_log("Warning: symlink() function is not available on this system.");
60    }
61}
62
63// スクリプトの実行開始
64// 一時ディレクトリのパスを生成 (OSのテンポラリディレクトリ + ユニークな名前)
65$tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_fs_iter_test_' . uniqid();
66
67try {
68    // テスト環境をセットアップ
69    setupTestEnvironment($tempDir);
70
71    echo "--- Listing file system entry types in: " . $tempDir . " ---" . PHP_EOL;
72
73    // FilesystemIterator を使用してディレクトリを走査します。
74    // FilesystemIterator::SKIP_DOTS: "." と ".." のエントリをスキップします。
75    // FilesystemIterator::CURRENT_AS_FILEINFO: 各要素を SplFileInfo オブジェクトとして返します。
76    // これにより、$fileInfo->getFilename() などのメソッドが利用可能になります。
77    $iterator = new FilesystemIterator(
78        $tempDir,
79        FilesystemIterator::SKIP_DOTS | FilesystemIterator::CURRENT_AS_FILEINFO
80    );
81
82    // ディレクトリ内の各エントリをループ処理
83    foreach ($iterator as $fileInfo) {
84        // FilesystemIterator::getType() メソッドを呼び出し、
85        // 現在のファイルシステムエントリの型（種類）を取得します。
86        // 戻り値は 'file', 'dir', 'link', 'unknown' などの文字列です。
87        echo sprintf(
88            "Name: %s, Type: %s%s",
89            $fileInfo->getFilename(), // ファイルまたはディレクトリの名前を取得
90            $iterator->getType(),     // FilesystemIterator::getType() の結果を表示
91            PHP_EOL
92        );
93    }
94
95} catch (Exception $e) {
96    // ファイルシステム操作中に例外が発生した場合は、エラーメッセージを表示します。
97    error_log("An error occurred during file system iteration: " . $e->getMessage());
98} finally {
99    // 処理の完了後（成功・失敗に関わらず）、作成した一時ディレクトリとその内容を削除します。
100    if (is_dir($tempDir)) {
101        rmdir_recursive($tempDir);
102        echo "--- Cleaned up temporary directory: " . $tempDir . " ---" . PHP_EOL;
103    }
104}

PHPのFilesystemIterator::getType()メソッドは、ファイルシステム内の項目（ファイルやディレクトリなど）の種類を判別するために使われるものです。このメソッドはFilesystemIteratorクラスに属しており、引数は不要で、現在反復処理中の項目がどのような種類であるかを文字列で返します。戻り値は、例えば通常のファイルであれば「file」、ディレクトリであれば「dir」、シンボリックリンクであれば「link」など、項目の種類を示す具体的な文字列です。

提供されたサンプルコードでは、まず一時的なディレクトリとファイル、サブディレクトリ、そして可能な場合はシンボリックリンクを作成し、テスト環境を構築しています。その後、FilesystemIteratorを使用してその一時ディレクトリ内の各項目を順に処理します。ループ内で$iterator->getType()を呼び出すことで、各項目がファイルなのか、ディレクトリなのか、シンボリックリンクなのかといった種類を判別し、その結果を画面に表示しています。このメソッドを使うことで、プログラムはファイルシステムを走査しながら、項目の種類に応じて適切な処理を実行できるようになります。処理の終了時には、作成した一時ディレクトリとその内容がすべて削除され、環境がクリーンアップされます。