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

Copy
1<?php
2
3/**
4 * DirectoryIterator::getPath() メソッドの使用例を示します。
5 *
6 * この関数は、一時的に作成されたディレクトリ内の各要素（ファイルやサブディレクトリ）について、
7 * その親ディレクトリのパス、ファイル名、および完全なパス名を表示します。
8 * DirectoryIterator::getPath() が要素の親ディレクトリのパス部分のみを返すことを明確にします。
9 */
10function demonstrateDirectoryIteratorGetPath(): void
11{
12    // 一時ディレクトリを作成し、サンプルファイルとサブディレクトリを配置します。
13    // このディレクトリはスクリプトの実行後に削除されます。
14    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_dir_example_' . uniqid();
15    if (!mkdir($tempDir) && !is_dir($tempDir)) {
16        echo "エラー: 一時ディレクトリの作成に失敗しました。\n";
17        return;
18    }
19    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'document.txt', 'This is a sample document.');
20    mkdir($tempDir . DIRECTORY_SEPARATOR . 'photos');
21    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'photos' . DIRECTORY_SEPARATOR . 'image.jpg', 'Dummy content');
22
23    echo "--- DirectoryIterator::getPath() の使用例 ---\n";
24    echo "対象ディレクトリ: " . $tempDir . "\n";
25    echo "--------------------------------------------------\n";
26
27    try {
28        $iterator = new DirectoryIterator($tempDir);
29
30        foreach ($iterator as $fileinfo) {
31            // '.' (カレントディレクトリ) と '..' (親ディレクトリ) はスキップします。
32            if ($fileinfo->isDot()) {
33                continue;
34            }
35
36            echo "要素名: " . $fileinfo->getFilename() . "\n";
37            // getPath(): 現在の要素が格納されている親ディレクトリのパスを返します。
38            echo "  getPath()     : " . $fileinfo->getPath() . "\n";
39            // getFilename(): 現在の要素のファイル名またはディレクトリ名を返します。
40            echo "  getFilename() : " . $fileinfo->getFilename() . "\n";
41            // getPathname(): 現在の要素の完全なパス名 (getPath() + getFilename() に相当) を返します。
42            echo "  getPathname() : " . $fileinfo->getPathname() . "\n";
43            echo "--------------------------------------------------\n";
44        }
45    } catch (UnexpectedValueException $e) {
46        echo "エラー: 指定されたディレクトリを読み込めませんでした。 " . $e->getMessage() . "\n";
47    } finally {
48        // 使用した一時ディレクトリとファイルをクリーンアップします。
49        cleanupDirectory($tempDir);
50        echo "一時ディレクトリをクリーンアップしました: " . $tempDir . "\n";
51    }
52}
53
54/**
55 * 指定されたディレクトリとその内容を再帰的に削除します。
56 * テスト用のディレクトリとファイルを自動で削除するために使用されます。
57 *
58 * @param string $dirPath 削除するディレクトリのパス。
59 * @return bool 削除に成功した場合は true、それ以外は false。
60 */
61function cleanupDirectory(string $dirPath): bool
62{
63    if (!is_dir($dirPath)) {
64        return false;
65    }
66
67    // ディレクトリ内のすべてのファイルとサブディレクトリをスキャンします。
68    $items = array_diff(scandir($dirPath), ['.', '..']);
69    foreach ($items as $item) {
70        $path = $dirPath . DIRECTORY_SEPARATOR . $item;
71        if (is_dir($path)) {
72            // サブディレクトリの場合、再帰的にこの関数を呼び出して削除します。
73            cleanupDirectory($path);
74        } else {
75            // ファイルの場合、直接削除します。
76            unlink($path);
77        }
78    }
79    // ディレクトリが空になったら、そのディレクトリ自体を削除します。
80    return rmdir($dirPath);
81}
82
83// このスクリプトが直接実行された場合にデモンストレーション関数を呼び出します。
84if (php_sapi_name() === 'cli') {
85    demonstrateDirectoryIteratorGetPath();
86}

DirectoryIterator::getPath()は、PHP 8で利用できるDirectoryIteratorクラスに属するメソッドです。このメソッドは引数を一切取らず、現在のイテレータが指し示すファイルまたはディレクトリが格納されている親ディレクトリのパスを文字列として返します。

サンプルコードでは、作成された一時ディレクトリ内の各ファイルやサブディレクトリを順番に処理しています。ここでgetPath()メソッドを使用すると、ループ中に確認している「document.txt」や「photos」といった要素が存在する親ディレクトリのパス、例えば「/tmp/php_dir_example_XXXXXX」のような部分のみを取得できます。

このメソッドは、要素自身の名前を返すgetFilename()メソッドや、親ディレクトリのパスと要素名を結合した完全なパス名（getPath()とgetFilename()を合わせたもの）を返すgetPathname()メソッドとは異なる情報を提供します。getPath()は、ファイルシステムを操作する際に、特定の要素が「どこに」あるのかを効率的に知りたい場合に非常に有用です。これらのメソッドを適切に使い分けることで、ファイルのパス情報を柔軟に扱えるようになります。