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

Copy
1<?php
2
3// ----------------------------------------------------------------------------
4// サンプルコード実行のための準備: 一時的なテストディレクトリとファイルを作成します
5// ----------------------------------------------------------------------------
6$baseTestDir = __DIR__ . '/temp_test_dir_for_recursive';
7$subDir = $baseTestDir . '/sub_directory';
8
9// ディレクトリが存在しない場合は作成します
10if (!is_dir($subDir)) {
11    // true を指定すると親ディレクトリも作成されます
12    mkdir($subDir, 0777, true); 
13}
14
15// テストファイルを作成します
16file_put_contents($baseTestDir . '/file_a.txt', 'This is file A.');
17file_put_contents($subDir . '/file_b.txt', 'This is file B.');
18file_put_contents($subDir . '/file_c.txt', 'This is file C.');
19
20echo "--- ディレクトリ走査の開始 ---\n";
21
22try {
23    // RecursiveDirectoryIterator を使用して、指定されたディレクトリを走査します。
24    // RecursiveDirectoryIterator::SKIP_DOTS フラグは、'.' (現在のディレクトリ) と '..' (親ディレクトリ) をスキップします。
25    $directoryIterator = new RecursiveDirectoryIterator($baseTestDir, RecursiveDirectoryIterator::SKIP_DOTS);
26    
27    // RecursiveIteratorIterator を使用して、RecursiveDirectoryIterator を再帰的に走査します。
28    // RecursiveIteratorIterator::SELF_FIRST は、ディレクトリ自体を先に、その後にその内容を返すことを意味します。
29    $recursiveIterator = new RecursiveIteratorIterator($directoryIterator, RecursiveIteratorIterator::SELF_FIRST);
30
31    // ディレクトリ内の各ファイルやディレクトリをループ処理します。
32    foreach ($recursiveIterator as $fileInfo) {
33        // $fileInfo は SplFileInfo クラスのインスタンスです。
34        
35        // getPath(): 現在の項目 (ファイルまたはディレクトリ) が存在するディレクトリのパスを返します。
36        // 例: '/path/to/temp_test_dir_for_recursive' または '/path/to/temp_test_dir_for_recursive/sub_directory'
37        echo "ディレクトリパス (getPath):      " . $fileInfo->getPath() . "\n";
38
39        // getFilename(): 現在の項目自身のファイル名またはディレクトリ名を返します。
40        // 例: 'file_a.txt' または 'sub_directory'
41        echo "ファイル/ディレクトリ名 (getFilename): " . $fileInfo->getFilename() . "\n";
42        
43        // getPathname(): 現在の項目のフルパス (ディレクトリパスとファイル/ディレクトリ名) を結合した文字列を返します。
44        // これはキーワード 'getpathname' に関連する情報です。
45        // 例: '/path/to/temp_test_dir_for_recursive/file_a.txt'
46        // または '/path/to/temp_test_dir_for_recursive/sub_directory'
47        echo "フルパス (getPathname): " . $fileInfo->getPathname() . "\n";
48        
49        echo "-----------------------------------------\n";
50    }
51
52} catch (UnexpectedValueException $e) {
53    // ディレクトリが見つからないなどのエラーが発生した場合の処理
54    echo "エラーが発生しました: " . $e->getMessage() . "\n";
55} finally {
56    echo "--- ディレクトリ走査の終了 ---\n";
57
58    // ----------------------------------------------------------------------------
59    // サンプルコード実行後のクリーンアップ: 作成した一時的なディレクトリとファイルを削除します
60    // ----------------------------------------------------------------------------
61    /**
62     * 指定されたディレクトリとその内容を再帰的に削除するヘルパー関数。
63     * @param string $dir ディレクトリのパス
64     */
65    function rrmdir(string $dir): void
66    {
67        if (!is_dir($dir)) {
68            return;
69        }
70        $objects = scandir($dir);
71        if ($objects === false) {
72            // ディレクトリが読み取れない場合は処理を中断
73            return; 
74        }
75        foreach ($objects as $object) {
76            if ($object === "." || $object === "..") {
77                continue;
78            }
79            $path = $dir . "/" . $object;
80            // シンボリックリンクを削除しないようにするためのチェック
81            if (is_dir($path) && !is_link($path)) { 
82                rrmdir($path);
83            } else {
84                unlink($path);
85            }
86        }
87        rmdir($dir);
88    }
89    
90    // 作成した一時ディレクトリとファイルを削除
91    rrmdir($baseTestDir);
92    echo "一時ディレクトリ '" . $baseTestDir . "' がクリーンアップされました。\n";
93}

PHPのRecursiveDirectoryIteratorクラスと組み合わせて利用されるSplFileInfoオブジェクトには、ファイルやディレクトリのパス情報を取得するgetPath()メソッドがあります。このメソッドは、引数を必要とせず、現在処理しているファイルまたはディレクトリが存在する親ディレクトリのパスを文字列（string）として返します。

サンプルコードでは、RecursiveDirectoryIteratorとRecursiveIteratorIteratorを用いて、指定されたディレクトリとその中のサブディレクトリを再帰的に走査しています。ループ内で取得される各項目（ファイルやディレクトリ）の情報はSplFileInfoオブジェクト（$fileInfo）として扱われます。ここで$fileInfo->getPath()を呼び出すことで、そのファイルやディレクトリが格納されている「親ディレクトリのパス」だけを簡単に取得できます。

たとえば、/path/to/temp_test_dir_for_recursive/file_a.txtというファイルの場合、getPath()は/path/to/temp_test_dir_for_recursiveを返します。もし/path/to/temp_test_dir_for_recursive/sub_directory/file_b.txtのようなパスであれば、getPath()は/path/to/temp_test_dir_for_recursive/sub_directoryを返します。

このメソッドは、ファイルやディレクトリ自身の名前を返すgetFilename()メソッドとは異なり、その項目が位置するディレクトリを示します。また、キーワードにも関連するgetPathname()メソッドは、getPath()とgetFilename()を結合した完全なフルパスを返します。これらのメソッドを適切に使い分けることで、ファイルシステムからの情報取得を柔軟に行い、プログラムでのファイル操作を効率的に進めることができます。

Copy
1<?php
2
3/**
4 * RecursiveDirectoryIterator::getPath() メソッドと、
5 * 関連するパス情報取得のための pathinfo() 関数の利用例を示します。
6 *
7 * この関数は、一時的なディレクトリ構造を作成し、
8 * RecursiveDirectoryIterator を使用して各ファイル/ディレクトリを走査し、
9 * それぞれのパス情報を表示します。
10 */
11function demonstrateRecursiveDirectoryIteratorGetPath(): void
12{
13    // 実行時に一時的なディレクトリを作成し、サンプルファイルとサブディレクトリを配置します。
14    // スクリプト終了時にクリーンアップされます。
15    $tempDir = __DIR__ . DIRECTORY_SEPARATOR . 'temp_recursive_dir_test';
16
17    // ディレクトリが存在しない場合は作成
18    if (!is_dir($tempDir)) {
19        mkdir($tempDir, 0777, true);
20    }
21    // サンプルファイルを作成
22    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file1.txt', 'これはファイル1の内容です。');
23    // サブディレクトリを作成
24    $subDir = $tempDir . DIRECTORY_SEPARATOR . 'subdir';
25    if (!is_dir($subDir)) {
26        mkdir($subDir, 0777);
27    }
28    // サブディレクトリ内にサンプルファイルを作成
29    file_put_contents($subDir . DIRECTORY_SEPARATOR . 'file2.log', 'これはファイル2の内容です。');
30
31    echo "--- ディレクトリツリー走査とパス情報 --- \n";
32
33    try {
34        // RecursiveDirectoryIterator を使用して指定されたディレクトリを走査します。
35        // RecursiveDirectoryIterator::SKIP_DOTS は "." と ".." を無視します。
36        $directoryIterator = new RecursiveDirectoryIterator($tempDir, RecursiveDirectoryIterator::SKIP_DOTS);
37
38        // RecursiveIteratorIterator は、RecursiveDirectoryIterator と組み合わせて
39        // ディレクトリツリー全体（サブディレクトリも含む）を再帰的に走査するために使用します。
40        // RecursiveIteratorIterator::SELF_FIRST は、ディレクトリ自体を先に処理し、その後に内容を処理します。
41        $recursiveIterator = new RecursiveIteratorIterator(
42            $directoryIterator,
43            RecursiveIteratorIterator::SELF_FIRST
44        );
45
46        foreach ($recursiveIterator as $item) {
47            // 各 $item は SplFileInfo オブジェクトのインスタンスです。
48
49            // getPath() メソッドは、現在の要素（ファイルまたはディレクトリ）が
50            // 含まれている親ディレクトリのパスを返します。
51            $parentDirPath = $item->getPath();
52
53            // getPathname() メソッドは、現在の要素（ファイルまたはディレクトリ）の
54            // 完全なパス（フルパス）を返します。
55            $fullPath = $item->getPathname();
56
57            echo "\n--- " . ($item->isDir() ? "ディレクトリ" : "ファイル") . ": " . $item->getBasename() . " ---\n";
58            echo "  現在の要素の親ディレクトリのパス (getPath()): " . $parentDirPath . "\n";
59            echo "  現在の要素のフルパス (getPathname()): " . $fullPath . "\n";
60            echo "  現在の要素の名前 (getFilename() / getBasename()): " . $item->getBasename() . "\n";
61
62            // pathinfo() 関数は、パス文字列からディレクトリ名、ベース名、ファイル名、拡張子などを取得します。
63            // これは「php getpathinfo」キーワードに関連する情報です。
64
65            echo "  --- pathinfo() を使ったフルパスの情報 ---\n";
66            $pathInfoFromFullPath = pathinfo($fullPath);
67            echo "    ディレクトリ名 (dirname): " . ($pathInfoFromFullPath['dirname'] ?? 'N/A') . "\n";
68            echo "    ベース名 (basename): " . ($pathInfoFromFullPath['basename'] ?? 'N/A') . "\n";
69            echo "    ファイル名 (filename): " . ($pathInfoFromFullPath['filename'] ?? 'N/A') . "\n";
70            echo "    拡張子 (extension): " . ($pathInfoFromFullPath['extension'] ?? 'N/A') . "\n";
71
72            // getPath() で取得した親ディレクトリのパスも pathinfo() で解析してみます。
73            echo "  --- pathinfo() を使った親ディレクトリパス (getPath()) の情報 ---\n";
74            $pathInfoFromParentDir = pathinfo($parentDirPath);
75            echo "    ディレクトリ名 (dirname): " . ($pathInfoFromParentDir['dirname'] ?? 'N/A') . "\n";
76            echo "    ベース名 (basename): " . ($pathInfoFromParentDir['basename'] ?? 'N/A') . "\n";
77            echo "    ファイル名 (filename, ディレクトリ名): " . ($pathInfoFromParentDir['filename'] ?? 'N/A') . "\n";
78            echo "    拡張子 (extension): " . ($pathInfoFromParentDir['extension'] ?? 'N/A') . "\n"; // ディレクトリには通常拡張子はありません
79        }
80    } catch (UnexpectedValueException $e) {
81        echo "エラー: ディレクトリが見つからないか、アクセスできません。" . $e->getMessage() . "\n";
82    } finally {
83        // 後処理: 作成した一時ディレクトリとその内容を削除します。
84        echo "\n--- 後処理 --- \n";
85        if (is_dir($tempDir)) {
86            // ディレクトリを再帰的に削除するために、CHILD_FIRST でイテレータを作成します。
87            // これにより、ファイルが先に削除され、その後に空のディレクトリが削除されます。
88            $files = new RecursiveIteratorIterator(
89                new RecursiveDirectoryIterator($tempDir, RecursiveDirectoryIterator::SKIP_DOTS),
90                RecursiveIteratorIterator::CHILD_FIRST
91            );
92            foreach ($files as $fileinfo) {
93                if ($fileinfo->isDir()) {
94                    rmdir($fileinfo->getRealPath());
95                } else {
96                    unlink($fileinfo->getRealPath());
97                }
98            }
99            rmdir($tempDir); // 最上位の一時ディレクトリを削除
100            echo "一時ディレクトリ '" . $tempDir . "' とその内容を削除しました。\n";
101        }
102    }
103}
104
105// 関数を実行してデモンストレーションを開始します。
106demonstrateRecursiveDirectoryIteratorGetPath();
107
108?>

PHP 8のRecursiveDirectoryIteratorクラスに属するgetPath()メソッドは、ディレクトリツリーを再帰的に走査する際に、現在注目しているファイルやディレクトリの「親ディレクトリのパス」を文字列として返します。このメソッドは引数を必要としません。

サンプルコードでは、一時的なディレクトリ構造を作成し、RecursiveDirectoryIteratorとRecursiveIteratorIteratorを使ってその中身を一つずつ調べます。各要素に対してgetPath()を呼び出すことで、その要素がどのディレクトリ内に存在するかを知ることができます。これに対し、getPathname()メソッドは要素自身の完全なパス（フルパス）を返します。

また、キーワード「php getpathinfo」に関連して、PHPの標準関数であるpathinfo()も紹介しています。この関数は、与えられたパス文字列から、ディレクトリ名、ベース名（ファイル名＋拡張子）、ファイル名、そして拡張子といった各部分の情報を連想配列として取得できる便利な機能です。サンプルコードでは、getPath()やgetPathname()で得られたパスをpathinfo()に渡し、さらに詳細なパス情報を分解して表示しています。これにより、ファイルやディレクトリのパスに関する様々な情報を効率的に扱う方法が示されています。

Copy
1<?php
2
3// このスクリプトが動作するために一時的なディレクトリとファイルを作成します。
4$baseDir = __DIR__ . '/recursive_iterator_test_' . uniqid(); // ユニークなディレクトリ名を作成
5mkdir($baseDir);
6mkdir($baseDir . '/subdir1');
7mkdir($baseDir . '/subdir1/subdir2');
8file_put_contents($baseDir . '/file_a.txt', 'This is file A.');
9file_put_contents($baseDir . '/subdir1/file_b.txt', 'This is file B.');
10file_put_contents($baseDir . '/subdir1/subdir2/file_c.txt', 'This is file C.');
11
12echo "--- テスト用のディレクトリ構造 ---\n";
13echo "ベースディレクトリ: " . realpath($baseDir) . "\n\n";
14
15try {
16    // RecursiveDirectoryIterator のインスタンスを作成します。
17    // SKIP_DOTS フラグは、'.' と '..' のエントリをスキップするために使用します。
18    $directoryIterator = new RecursiveDirectoryIterator(
19        $baseDir,
20        RecursiveDirectoryIterator::SKIP_DOTS
21    );
22
23    // RecursiveIteratorIterator を使用して、サブディレクトリも再帰的に走査します。
24    $recursiveIterator = new RecursiveIteratorIterator($directoryIterator);
25
26    echo "--- ディレクトリ走査結果 ---\n";
27    foreach ($recursiveIterator as $fileInfo) {
28        // getPath() メソッドは、現在のイテレータ要素が属するディレクトリのパスを返します。
29        // ファイル名やディレクトリ名は含みません。
30        echo "ディレクトリパス (getPath):    " . $fileInfo->getPath() . "\n";
31
32        // getPathname() メソッドは、現在のイテレータ要素自身の完全なパス（ファイル名やディレクトリ名を含む）を返します。
33        echo "完全パス (getPathname):    " . $fileInfo->getPathname() . "\n";
34        
35        // getFilename() メソッドは、ファイル名またはディレクトリ名のみを返します。
36        echo "ファイル/ディレクトリ名: " . $fileInfo->getFilename() . "\n";
37        echo "--------------------------------------------------\n";
38    }
39} catch (UnexpectedValueException $e) {
40    // ディレクトリが存在しないなどのエラーが発生した場合にキャッチします。
41    echo "エラー: " . $e->getMessage() . "\n";
42} finally {
43    // 後処理として、作成した一時的なディレクトリとファイルを削除します。
44    echo "\n--- クリーンアップ ---\n";
45    if (file_exists($baseDir)) {
46        $files = new RecursiveIteratorIterator(
47            new RecursiveDirectoryIterator($baseDir, RecursiveDirectoryIterator::SKIP_DOTS),
48            RecursiveIteratorIterator::CHILD_FIRST // 子要素から削除するためにCHILD_FIRSTを使用
49        );
50
51        foreach ($files as $fileinfo) {
52            $todo = ($fileinfo->isDir() ? 'rmdir' : 'unlink');
53            $todo($fileinfo->getRealPath()); // ファイルまたはディレクトリを削除
54        }
55        rmdir($baseDir); // ベースディレクトリを削除
56        echo "一時ディレクトリを削除しました: " . $baseDir . "\n";
57    }
58}

PHPのRecursiveDirectoryIteratorクラスに属するgetPath()メソッドは、ディレクトリを再帰的に走査する際に、現在処理しているファイルやディレクトリが存在する親ディレクトリのパスを文字列として取得するために使用します。このメソッドは引数なしで呼び出し、常に現在のイテレータ要素の直上にあたるディレクトリの完全なパスを返します。

サンプルコードでは、RecursiveIteratorIteratorによって得られるファイル情報オブジェクト（$fileInfo）に対して$fileInfo->getPath()が使われています。例えば、/tmp/test_dir/subdir1/file_b.txtのようなファイルが走査されている場合、getPath()はfile_b.txtそのものではなく、その親ディレクトリである/tmp/test_dir/subdir1というパスを返します。

このメソッドは、getPathname()やgetFilename()と区別して理解することが重要です。getPathname()はファイル名やディレクトリ名を含む要素自身の完全なパスを返しますが、getPath()は要素が「どのディレクトリに属しているか」という親ディレクトリのパスのみを提供します。また、getFilename()はファイル名やディレクトリ名そのものだけを返します。getPath()は、処理中のファイルやディレクトリの親の場所を知りたい場合に、正確で簡潔な情報を提供します。