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

Copy
1<?php
2
3// このスクリプトは、SplFileInfoクラスのgetPathメソッドの使用方法を示します。
4// getPathメソッドは、ファイルまたはディレクトリのパスからディレクトリ部分のみを返します。
5
6// 1. サンプルファイルを作成します。
7// システムの一時ディレクトリに一時ファイルを作成することで、どこでも実行できるようにします。
8$tempDir = sys_get_temp_dir();
9$fileName = 'sample_file_for_path.txt';
10$filePath = $tempDir . DIRECTORY_SEPARATOR . $fileName;
11
12// ファイルが存在しない場合は作成します
13if (!file_exists($filePath)) {
14    file_put_contents($filePath, "このファイルはSplFileInfo::getPathのサンプル用です。");
15    echo "サンプルファイル '{$filePath}' を作成しました。" . PHP_EOL;
16} else {
17    echo "サンプルファイル '{$filePath}' は既に存在します。" . PHP_EOL;
18}
19
20// 2. SplFileInfo オブジェクトを作成します。
21// SplFileInfoは、ファイルに関する様々な情報をオブジェクト指向で扱うためのクラスです。
22$fileInfo = new SplFileInfo($filePath);
23
24// 3. getPath メソッドを呼び出し、ファイルが存在するディレクトリのパスを取得します。
25// このメソッドは、ファイル名や拡張子を含まない、純粋なディレクトリのパスを返します。
26$directoryPath = $fileInfo->getPath();
27
28// 結果を出力して確認します。
29echo "----------------------------------------" . PHP_EOL;
30echo "元のファイルパス: " . $filePath . PHP_EOL;
31echo "SplFileInfo::getPath() で取得されたディレクトリパス: " . $directoryPath . PHP_EOL;
32echo "----------------------------------------" . PHP_EOL;
33
34// 4. 後処理として、作成したサンプルファイルを削除します。
35if (file_exists($filePath)) {
36    unlink($filePath);
37    echo "サンプルファイル '{$filePath}' を削除しました。" . PHP_EOL;
38}
39
40?>

このPHPのサンプルコードは、ファイルパスからディレクトリ部分だけを効率的に取得する方法を、システムエンジニアを目指す初心者の方にも分かりやすく説明しています。

SplFileInfoは、ファイルやディレクトリに関する様々な情報をオブジェクトとして扱うためのPHPの標準クラスです。このクラスにPHP 8で利用できるgetPathメソッドは、SplFileInfoオブジェクトが持つファイルパスから、ファイル名や拡張子を含まない、純粋なディレクトリのパス部分だけを文字列として返します。このメソッドは引数を一切必要としません。

サンプルコードでは、まず一時的なファイルを作成し、そのファイルパスを使ってSplFileInfoオブジェクトを生成しています。次に、getPathメソッドを呼び出すことで、作成したファイルが存在するディレクトリのパスを取得し、元のファイルパスと取得されたディレクトリパスを比較して出力しています。これにより、ファイル名とディレクトリの情報を明確に分離して扱いたい場合に、このメソッドが非常に役立つことが視覚的に理解できます。ファイルの情報を扱う際に、ディレクトリパスのみが必要な状況で、安全かつ効率的に情報を取り出すことが可能になります。スクリプトの最後には、作成した一時ファイルを適切に削除する後処理も含まれています。

Copy
1<?php
2
3/**
4 * SplFileInfo::getPath() の使用例を示します。
5 * このメソッドは、ファイル名部分を含まない、ファイルまたはディレクトリの親ディレクトリのパスを返します。
6 * 引数なしで呼び出され、文字列 (string) を返します。
7 *
8 * SplFileInfo オブジェクトは、実際のファイルが存在するかどうかに関わらず、
9 * パスの情報として扱うことができます。
10 */
11
12// サンプルパス1: 通常の絶対パス
13$filePath1 = '/usr/local/var/log/application.log';
14$fileInfo1 = new SplFileInfo($filePath1);
15echo "元のパス: " . $filePath1 . "\n";
16echo "getPath(): " . $fileInfo1->getPath() . "\n\n";
17// 出力例: /usr/local/var/log
18
19// サンプルパス2: 相対パス
20$filePath2 = 'temp_data/images/photo.jpg';
21$fileInfo2 = new SplFileInfo($filePath2);
22echo "元のパス: " . $filePath2 . "\n";
23echo "getPath(): " . $fileInfo2->getPath() . "\n\n";
24// 出力例: temp_data/images
25
26// サンプルパス3: ルートディレクトリ直下のファイル
27$filePath3 = '/server_status.txt';
28$fileInfo3 = new SplFileInfo($filePath3);
29echo "元のパス: " . $filePath3 . "\n";
30echo "getPath(): " . $fileInfo3->getPath() . "\n\n";
31// 出力例: /
32
33// サンプルパス4: カレントディレクトリ内のファイル（パスにディレクトリ区切り文字がない場合）
34$filePath4 = 'config.ini';
35$fileInfo4 = new SplFileInfo($filePath4);
36echo "元のパス: " . $filePath4 . "\n";
37echo "getPath(): " . $fileInfo4->getPath() . "\n\n";
38// 出力例: . (ドットはカレントディレクトリを意味します)
39
40// サンプルパス5: ディレクトリそのもののパス
41$directoryPath5 = '/var/www/html';
42$fileInfo5 = new SplFileInfo($directoryPath5);
43echo "元のパス: " . $directoryPath5 . "\n";
44echo "getPath(): " . $fileInfo5->getPath() . "\n\n";
45// 出力例: /var/www
46
47?>

PHPのSplFileInfo::getPath()メソッドは、ファイルやディレクトリのパス情報から、ファイル名部分を含まない「親ディレクトリ」のパスを取得するために使用されます。このメソッドは引数を必要とせず、結果としてパスを表す文字列を返します。SplFileInfoオブジェクトは、実際にそのファイルやディレクトリが存在するかどうかに関わらず、パス情報そのものをオブジェクトとして扱うことができる点が特徴です。

具体的には、絶対パス「/usr/local/var/log/application.log」からは「/usr/local/var/log」を、相対パス「temp_data/images/photo.jpg」からは「temp_data/images」を返します。ルートディレクトリ直下のファイル「/server_status.txt」の場合、「/」が返されます。また、「config.ini」のようにディレクトリ区切り文字を含まないファイル名に対しては、カレントディレクトリを意味する「.（ドット）」が戻り値となります。さらに、「/var/www/html」のようにディレクトリそのもののパスを指定した場合でも、その一つ上の階層である「/var/www」が結果として得られます。これにより、指定されたファイルやディレクトリがどの親ディレクトリに所属しているのかを簡単に判別することができます。