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

Copy
1<?php
2
3/**
4 * 現在のスクリプトがあるディレクトリを走査し、
5 * 各ファイルのエントリからパス情報を取得して表示します。
6 * DirectoryIterator::getPathInfo() メソッドの使用例を示します。
7 */
8
9// 現在のスクリプトがあるディレクトリのパスを取得
10$directoryPath = __DIR__;
11
12try {
13    // DirectoryIterator のインスタンスを作成
14    // これにより、指定されたディレクトリの内容を反復処理できます。
15    $iterator = new DirectoryIterator($directoryPath);
16
17    echo "--- ディレクトリ内のファイルパス情報 ---" . "\n";
18    echo "対象ディレクトリ: " . $directoryPath . "\n\n";
19
20    // ディレクトリ内の各エントリ（ファイルやサブディレクトリ）をループ処理
21    foreach ($iterator as $fileInfo) {
22        // 特殊なエントリである '.' (現在のディレクトリ) と '..' (親ディレクトリ) はスキップ
23        if ($fileInfo->isDot()) {
24            continue;
25        }
26
27        // DirectoryIterator::getPathInfo() メソッドを呼び出し、SplFileInfo オブジェクトを取得します。
28        // このメソッドは、元の SplFileInfo オブジェクト（または、
29        // オプション引数 $class で指定されたクラスのインスタンス）を返します。
30        // ここではデフォルトの SplFileInfo オブジェクトを使用します。
31        $splFileInfo = $fileInfo->getPathInfo();
32
33        echo "ファイル名 (getFilename): " . $fileInfo->getFilename() . "\n";
34        echo "  - 親ディレクトリのパス (getPath): " . $splFileInfo->getPath() . "\n";
35        echo "  - ベース名 (拡張子なし) (getBasename): " . $splFileInfo->getBasename("." . $splFileInfo->getExtension()) . "\n";
36        echo "  - 拡張子 (getExtension): " . $splFileInfo->getExtension() . "\n";
37        echo "  - フルパス (getPathname): " . $splFileInfo->getPathname() . "\n";
38        echo "----------------------------------------\n";
39    }
40
41} catch (Exception $e) {
42    // ディレクトリが存在しないなど、エラーが発生した場合の処理
43    echo "エラーが発生しました: " . $e->getMessage() . "\n";
44}
45
46?>

PHP 8のDirectoryIterator::getPathInfo()メソッドは、ディレクトリ内の各ファイルやサブディレクトリのエントリから、そのパスに関する詳細な情報を取得するために使用されます。このメソッドはDirectoryIteratorクラスに属し、ファイルシステムを走査する際に非常に役立ちます。

引数$classはオプションで、戻り値として特定のクラスのSplFileInfoオブジェクトを返すように指定できます。省略された場合は、デフォルトでSplFileInfoクラスのインスタンスが返されます。戻り値であるSplFileInfoオブジェクトには、ファイルのフルパス、親ディレクトリのパス、ファイル名、拡張子といった様々な情報が含まれています。

サンプルコードでは、まず現在のスクリプトがあるディレクトリをDirectoryIteratorで走査しています。foreachループを使ってディレクトリ内の各エントリを順に処理し、特殊なエントリである「.」と「..」はスキップしています。各エントリのDirectoryIteratorオブジェクトに対し、getPathInfo()メソッドを呼び出すことで、そのエントリに対応するSplFileInfoオブジェクトを取得しています。この取得したSplFileInfoオブジェクトから、getPath()で親ディレクトリのパス、getBasename()で拡張子を除いたファイル名、getExtension()で拡張子、getPathname()でフルパスなどを抽出し、画面に表示しています。これにより、ファイルパスの各要素を簡単に扱うことが可能になります。エラーが発生した場合は、try-catchブロックでその内容を表示します。

Copy
1<?php
2
3// このスクリプトが実行されているディレクトリのパスを指定します。
4// '__DIR__' は、現在のスクリプトファイルが存在するディレクトリの絶対パスを示すPHPの定数です。
5$targetDirectory = __DIR__;
6
7echo "--- ディレクトリ '$targetDirectory' 内のファイルとディレクトリのパス名 ---" . PHP_EOL;
8
9try {
10    // DirectoryIterator クラスを使用して、指定されたディレクトリの内容を反復処理（ループで一つずつ取り出す）します。
11    // これは、ファイルシステム内のファイルやサブディレクトリを効率的に探索するためのPHPの組み込み機能です。
12    $directoryIterator = new DirectoryIterator($targetDirectory);
13
14    // ディレクトリ内の各ファイルやサブディレクトリをループで処理します。
15    foreach ($directoryIterator as $fileObject) {
16        // '.' と '..' は特殊なエントリで、それぞれ現在のディレクトリと親ディレクトリを表します。
17        // これらは実際のファイルやディレクトリではないため、処理をスキップします。
18        if ($fileObject->isDot()) {
19            continue;
20        }
21
22        // DirectoryIterator の getPathInfo() メソッドを呼び出します。
23        // このメソッドは、現在の項目（ファイルまたはディレクトリ）に関するより詳細な情報を含む
24        // SplFileInfo オブジェクトを返します。
25        // 引数 `$class` は省略されており、デフォルトの SplFileInfo オブジェクトが返されます。
26        // 必要に応じて SplFileInfo を継承したカスタムクラスを指定することも可能ですが、
27        // 通常はデフォルトで十分です。
28        $splFileInfo = $fileObject->getPathInfo();
29
30        // SplFileInfo オブジェクトの getPathname() メソッドを呼び出し、
31        // その項目（ファイルまたはディレクトリ）の完全なパス名（ディレクトリ名とファイル名を含む）を取得します。
32        // これは「php getpathname」というキーワードに直接関連する情報です。
33        echo "パス名: " . $splFileInfo->getPathname() . PHP_EOL;
34    }
35
36} catch (UnexpectedValueException $e) {
37    // ディレクトリが見つからない場合や、アクセス権がない場合などに発生する可能性のあるエラーを捕捉します。
38    echo "エラー: 指定されたディレクトリが見つからないか、アクセスできません。" . PHP_EOL;
39    echo "詳細: " . $e->getMessage() . PHP_EOL;
40} catch (Exception $e) {
41    // 上記以外の予期せぬエラーがPHPの実行中に発生した場合に捕捉します。
42    echo "予期せぬエラーが発生しました。" . PHP_EOL;
43    echo "詳細: " . $e->getMessage() . PHP_EOL;
44}
45
46?>

このPHPサンプルコードは、DirectoryIterator クラスと getPathInfo() メソッドを使用して、指定したディレクトリ内のファイルやサブディレクトリのパス名を取得する方法を示しています。

スクリプトはまず、現在のディレクトリを対象として DirectoryIterator を初期化し、その内容を一つずつ反復処理します。ループ内で各ファイルまたはディレクトリを表すオブジェクトに対し、DirectoryIterator::getPathInfo() メソッドを呼び出します。このメソッドは、対象のファイルやディレクトリに関する詳細な情報を持つ SplFileInfo オブジェクトを戻り値として返します。引数 $class はオプションであり、通常は省略されますが、SplFileInfo を継承したカスタムクラスを指定することも可能です。

取得した SplFileInfo オブジェクトは、ファイル名、ディレクトリ名、更新日時など、様々なファイルシステム情報を保持しています。このオブジェクトの getPathname() メソッドを利用することで、ファイルやディレクトリの完全なパス名（ディレクトリ名とファイル名を含む）を簡潔に取得できます。これは「php getpathname」というキーワードに関連する主要な機能です。

このサンプルは、ディレクトリの内容を安全に探索し、各エントリのパス情報を取得する基本的な手順と、エラー発生時の例外処理も含まれており、堅牢なファイルシステム操作の参考になります。