【PHP8.x】pathinfo関数の使い方

Copy
1<?php
2
3/**
4 * ファイルパスから拡張子を抽出するシンプルな関数。
5 *
6 * pathinfo() 関数はファイルパスに関する情報を取得するために使用され、
7 * PATHINFO_EXTENSION フラグを指定すると、ファイルの拡張子のみを文字列として返します。
8 * 拡張子がない場合は空の文字列が返されます。
9 *
10 * @param string $filePath 拡張子を抽出したいファイルパス。
11 * @return string 抽出された拡張子。拡張子がない場合は空の文字列。
12 */
13function getFileExtension(string $filePath): string
14{
15    // pathinfo() 関数と PATHINFO_EXTENSION フラグを使って拡張子を取得
16    $extension = pathinfo($filePath, PATHINFO_EXTENSION);
17    return $extension;
18}
19
20// --- 使用例 ---
21
22// 拡張子のあるファイルパス
23$sampleFilePathWithExtension = '/var/www/html/index.php';
24$extension1 = getFileExtension($sampleFilePathWithExtension);
25
26echo "ファイルパス: " . $sampleFilePathWithExtension . "\n";
27echo "抽出された拡張子: " . $extension1 . "\n\n";
28
29// 拡張子がないファイルパス
30$sampleFilePathWithoutExtension = '/path/to/my/document';
31$extension2 = getFileExtension($sampleFilePathWithoutExtension);
32
33echo "ファイルパス: " . $sampleFilePathWithoutExtension . "\n";
34echo "抽出された拡張子: " . $extension2 . " (拡張子がないため空文字列)\n\n";
35
36// 複数のドットがあるファイルパス
37$sampleFilePathMultipleDots = 'archive.tar.gz';
38$extension3 = getFileExtension($sampleFilePathMultipleDots);
39
40echo "ファイルパス: " . $sampleFilePathMultipleDots . "\n";
41echo "抽出された拡張子: " . $extension3 . "\n";
42
43?>

このPHPのサンプルコードでは、pathinfo関数を利用してファイルパスから拡張子を効率的に抽出する方法を解説しています。pathinfo関数は、ファイルパスの情報を分析し、ファイル名、ディレクトリ名、拡張子などを取得するために用いられます。

このコードの中心となるgetFileExtension関数は、ファイルパスを表す文字列$filePathを引数として受け取ります。関数内部では、pathinfo($filePath, PATHINFO_EXTENSION)を呼び出しており、第二引数にPATHINFO_EXTENSIONという定数を指定することで、ファイルパスから拡張子のみを文字列として抽出するよう指示しています。この関数は抽出された拡張子を文字列で返しますが、もし指定されたファイルパスに拡張子がない場合は空の文字列を返します。

使用例を見ると、/var/www/html/index.phpからは「php」が、拡張子を持たない/path/to/my/documentからは空の文字列が抽出されることがわかります。また、archive.tar.gzのように複数のドットを含むファイル名であっても、最後のドット以降の「gz」が正しく拡張子として取得されることを示しています。このようにpathinfo関数は、ファイルパスから特定の情報を簡潔に取得する際に非常に便利な機能です。

Copy
1<?php
2
3// 日本語を含むファイルパスの例
4$path = '/var/www/html/プロジェクト/データファイル.txt';
5
6echo "元のパス: " . $path . PHP_EOL . PHP_EOL;
7
8// pathinfo関数をデフォルト（PATHINFO_ALL）で呼び出すと、
9// パス情報が連想配列として返されます。
10// 日本語のパスも正しく処理されます。
11$pathInfo = pathinfo($path);
12
13echo "--- pathinfo() の結果 (PATHINFO_ALL) ---" . PHP_EOL;
14print_r($pathInfo);
15
16echo "取得された情報:" . PHP_EOL;
17echo "  ディレクトリ名 (dirname): " . $pathInfo['dirname'] . PHP_EOL;
18echo "  ファイル名（拡張子含む） (basename): " . $pathInfo['basename'] . PHP_EOL;
19echo "  拡張子 (extension): " . $pathInfo['extension'] . PHP_EOL;
20echo "  拡張子なしファイル名 (filename): " . $pathInfo['filename'] . PHP_EOL;
21echo PHP_EOL;
22
23// 特定の情報を取得したい場合は、第2引数にフラグを指定します。
24// この場合、戻り値は文字列になります。
25echo "--- 特定の情報を取得する例 ---" . PHP_EOL;
26
27$dirname = pathinfo($path, PATHINFO_DIRNAME);
28echo "PATHINFO_DIRNAME (ディレクトリ名): " . $dirname . PHP_EOL;
29
30$basename = pathinfo($path, PATHINFO_BASENAME);
31echo "PATHINFO_BASENAME (ファイル名): " . $basename . PHP_EOL;
32
33$extension = pathinfo($path, PATHINFO_EXTENSION);
34echo "PATHINFO_EXTENSION (拡張子): " . $extension . PHP_EOL;
35
36$filename = pathinfo($path, PATHINFO_FILENAME);
37echo "PATHINFO_FILENAME (拡張子なしファイル名): " . $filename . PHP_EOL;
38
39?>

PHPのpathinfo関数は、ファイルパスをディレクトリ名、ファイル名、拡張子などの個別の情報に分解するために使用します。この関数はPHP 8でも動作し、日本語を含むパスも正しく処理できます。

第一引数には解析したいファイルパスを文字列で指定し、第二引数には取得したい情報の種類を定数で指定します。第二引数を省略するかPATHINFO_ALLを指定すると、戻り値は連想配列となり、「dirname」「basename」「extension」「filename」の各キーで全てのパス情報が返されます。一方、特定の情報だけを取得したい場合は、PATHINFO_DIRNAME（ディレクトリ名）、PATHINFO_BASENAME（ファイル名）、PATHINFO_EXTENSION（拡張子）、PATHINFO_FILENAME（拡張子なしファイル名）などの定数を指定し、その場合は指定された情報が文字列として直接返されます。

サンプルコードでは、まず日本語を含むパスを用意し、pathinfo関数をデフォルトで呼び出しています。結果は連想配列として表示され、各キーに対応する情報が日本語も含めて正しく取得されていることがわかります。次に、それぞれのフラグを使って特定の情報を個別に取得する例を示しています。このように、pathinfo関数を利用することで、ファイルパスから必要な要素を簡単に抽出し、プログラムで活用できるようになります。