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

Copy
1<?php
2
3/**
4 * GlobIterator::getPath() メソッドと pathinfo() 関数の使用例を示す関数。
5 *
6 * システムエンジニアを目指す初心者向けに、特定のパターンに一致するファイルのリストを取得し、
7 * そのイテレータが処理している基点パスと、各ファイルのパス情報を表示します。
8 */
9function demonstrateGlobIteratorPathAndPathinfo(): void
10{
11    // テスト用の作業ディレクトリを作成します
12    $tempDir = __DIR__ . DIRECTORY_SEPARATOR . 'temp_glob_example';
13
14    // ディレクトリが存在しない場合は作成
15    if (!mkdir($tempDir) && !is_dir($tempDir)) {
16        echo "エラー: テストディレクトリ '{$tempDir}' を作成できませんでした。\n";
17        return;
18    }
19
20    // テスト用のファイルをいくつか作成します
21    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'report_2023.txt', '年間レポートデータ');
22    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'photo_001.jpg', '写真データ');
23    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'config.ini', '設定ファイル'); // このファイルはパターンにマッチしません
24
25    echo "--- GlobIterator::getPath() と pathinfo() のサンプル開始 --- \n\n";
26
27    try {
28        // GlobIterator のインスタンスを作成
29        // 指定されたパスパターンに一致するファイルやディレクトリを反復処理します。
30        // ここでは、'.txt' または '.jpg' 拡張子を持つファイルを対象とします。
31        // FilesystemIterator::KEY_AS_PATHNAME: キーをファイルパスに設定
32        // FilesystemIterator::CURRENT_AS_FILEINFO: 値を SplFileInfo オブジェクトに設定
33        $pattern = $tempDir . DIRECTORY_SEPARATOR . '*.{txt,jpg}';
34        $iterator = new GlobIterator($pattern, FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO);
35
36        // GlobIterator が反復処理している基点パスを取得します。
37        // このメソッドは、GlobIterator のコンストラクタに渡されたパスパターンの
38        // ディレクトリ部分を返します。
39        $basePath = $iterator->getPath();
40        echo "GlobIterator の基点パス: " . $basePath . "\n\n";
41
42        echo "パターン '{$pattern}' に一致するファイルとパス情報:\n";
43
44        if (!$iterator->valid()) {
45            echo "  条件に一致するファイルは見つかりませんでした。\n";
46        } else {
47            foreach ($iterator as $file) {
48                // SplFileInfo オブジェクトから現在のファイルやディレクトリのフルパスを取得
49                $filePath = $file->getPathname();
50
51                echo "  ファイルパス: " . $filePath . "\n";
52
53                // pathinfo() 関数を使用して、与えられたパスに関する詳細な情報を取得します。
54                // キーワード 'php getpathinfo' に関連する機能を示します。
55                $pathInfo = pathinfo($filePath);
56
57                echo "    ディレクトリ名 (dirname): " . ($pathInfo['dirname'] ?? 'N/A') . "\n";
58                echo "    ベース名 (basename): " . ($pathInfo['basename'] ?? 'N/A') . "\n";
59                echo "    ファイル名 (filename): " . ($pathInfo['filename'] ?? 'N/A') . "\n";
60                echo "    拡張子 (extension): " . ($pathInfo['extension'] ?? 'N/A') . "\n";
61                echo "\n";
62            }
63        }
64    } catch (Exception $e) {
65        echo "エラーが発生しました: " . $e->getMessage() . "\n";
66    } finally {
67        // テスト環境のクリーンアップ
68        // 作成したファイルを削除します
69        $filesInTempDir = glob($tempDir . DIRECTORY_SEPARATOR . '*');
70        if ($filesInTempDir !== false) {
71            foreach ($filesInTempDir as $file) {
72                if (is_file($file)) {
73                    unlink($file);
74                }
75            }
76        }
77        // テスト用ディレクトリを削除します
78        if (is_dir($tempDir)) {
79            rmdir($tempDir);
80        }
81        echo "--- クリーンアップ完了 --- \n";
82    }
83    echo "--- サンプル終了 --- \n";
84}
85
86// サンプルコードを実行します
87demonstrateGlobIteratorPathAndPathinfo();
88
89?>

このサンプルコードは、PHPでファイルシステムを操作する際に役立つGlobIterator::getPath()メソッドとpathinfo()関数の使い方をシステムエンジニアの初心者向けに解説しています。

GlobIteratorは、特定のパターンに一致するファイルやディレクトリを効率的に反復処理（ループで一つずつ取り出すこと）するためのクラスです。その中のgetPath()メソッドは引数なしで呼び出すことができ、GlobIteratorのインスタンス作成時に指定したパスパターンの中から、基点となるディレクトリパスを文字列として返します。これにより、どのディレクトリを基準にファイル検索が行われているかを確認できます。

一方、pathinfo()関数は、指定されたファイルパスの詳細な情報を取得するのに使います。この関数は、パスを「ディレクトリ名」「ベース名（ファイル名＋拡張子）」「ファイル名」「拡張子」といった要素に分解し、それらの情報を含む連想配列として返します。これにより、ファイルパスの各部分を個別に扱いやすくなります。

サンプルコードでは、まず一時的な作業ディレクトリとテスト用のファイルを作成します。次に、.txtまたは.jpg拡張子を持つファイルをGlobIteratorで検索し、getPath()を使って検索の基点パスを表示します。その後、見つかった各ファイルについてpathinfo()関数を適用し、そのファイルの詳細なパス情報（ディレクトリ名、ベース名、ファイル名、拡張子）を分解して表示しています。最後に、作成したテスト用のファイルとディレクトリを削除し、環境をクリーンアップしています。

Copy
1<?php
2
3// GlobIterator クラスは、指定されたパターンに一致するファイルシステムのエントリ（ファイルやディレクトリ）を
4// イテレート（順に処理）するためのイテレータを提供します。
5// getPath() メソッドは、このイテレータが対象としている「ベースディレクトリ」のパスを返します。
6
7// 現在のスクリプトが実行されているディレクトリをベースパスとして設定します。
8// このパスが GlobIterator のパターンの一部となり、getPath() の戻り値の元となります。
9$baseDirectory = __DIR__;
10
11// GlobIterator を初期化します。
12// ここでは、現在のスクリプトが置かれているディレクトリ ($baseDirectory) 内の
13// すべてのファイルとディレクトリを対象とするパターンを作成しています。
14// 例: /path/to/your/script/*
15$iterator = new GlobIterator($baseDirectory . '/*');
16
17// getPath() メソッドを呼び出し、GlobIterator が対象としているベースディレクトリのパスを取得します。
18// これは、イテレータのコンストラクタに渡されたパターンから抽出されるディレクトリ部分です。
19$path = $iterator->getPath();
20
21// 取得したベースパスを表示します。
22echo "GlobIterator が対象としているベースディレクトリのパス: " . $path . PHP_EOL;
23
24// 補足:
25// getPath() はイテレータ全体のベースパスを返しますが、
26// イテレータで個々のファイルやディレクトリを処理する際に使う getPathname() メソッドは、
27// そのファイルやディレクトリの完全なパスを返します。
28// 以下は参考情報として、getPathname() の出力を示しています（このサンプルコードの主要な目的ではありません）。
29// foreach ($iterator as $file) {
30//     echo "  - ファイル/ディレクトリのフルパス (getPathname()): " . $file->getPathname() . PHP_EOL;
31// }

PHP 8のGlobIterator::getPathメソッドは、ファイルシステム上のファイルやディレクトリを扱うGlobIteratorクラスに属します。GlobIteratorクラスは、指定されたパターンに合致するファイルやディレクトリを順に処理する（イテレートする）ための機能を提供します。

getPathメソッドは、このGlobIteratorがファイル検索の対象としている「ベースディレクトリ」のパスを文字列として取得する役割を持ちます。このメソッドは引数を一切必要とせず、常にstring型のパスを返します。

サンプルコードでは、まず現在のスクリプトが実行されているディレクトリをベースパスとしてGlobIteratorを初期化しています。例えば、スクリプトが/home/user/my_projectで実行されていれば、GlobIteratorは/home/user/my_project/*のようなパターンでファイルを探します。ここで$iterator->getPath()を呼び出すと、イテレータが検索の基準としている/home/user/my_projectというパスが正確に返され、表示されます。

なお、関連するメソッドとしてgetPathnameがあります。getPathがイテレータ全体のベースパスを返すのに対し、getPathnameはイテレート中に取得される個々のファイルやディレクトリの完全なパス（例: /home/user/my_project/index.php）を返します。これらのメソッドを適切に使い分けることで、ファイルシステムの操作が効率的に行えます。