【PHP8.x】PATHINFO_FILENAME定数の使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定されたファイルパスからファイル名情報を抽出し、表示します。
7 *
8 * この関数は、`PATHINFO_FILENAME` 定数を使用して拡張子なしのファイル名を取得する方法と、
9 * 関連する拡張子付きのファイル名を取得する方法（`PATHINFO_BASENAME` を使用）を示します。
10 *
11 * @param string $filePath 処理するファイルパスの文字列。
12 * @return void 出力は標準出力に行われます。
13 */
14function extractAndDisplayFilenameInfo(string $filePath): void
15{
16    echo "対象パス: " . $filePath . "\n";
17
18    // PATHINFO_FILENAME:
19    // pathinfo() 関数の第2引数として使用し、ファイルパスから拡張子を含まないファイル名を抽出します。
20    // 例: "document.pdf" -> "document"
21    $filenameWithoutExtension = pathinfo($filePath, PATHINFO_FILENAME);
22    echo "ファイル名 (拡張子なし、PATHINFO_FILENAME): " . $filenameWithoutExtension . "\n";
23
24    // PATHINFO_BASENAME:
25    // キーワード「filename with extension」に関連して、拡張子を含むファイル名を抽出する方法も示します。
26    // これは pathinfo() 関数の第2引数に PATHINFO_BASENAME を指定して行います。
27    // 例: "document.pdf" -> "document.pdf"
28    $filenameWithExtension = pathinfo($filePath, PATHINFO_BASENAME);
29    echo "ファイル名 (拡張子あり、PATHINFO_BASENAME): " . $filenameWithExtension . "\n";
30
31    echo "----------------------------------------\n";
32}
33
34// --- サンプルコードの実行例 ---
35
36// 標準的なファイルパス
37extractAndDisplayFilenameInfo('/var/www/html/uploads/image.jpeg');
38
39// 拡張子が複数ある場合 (最後のドット以降が拡張子と見なされます)
40extractAndDisplayFilenameInfo('/path/to/archive.tar.gz');
41
42// 拡張子がないファイルの場合
43extractAndDisplayFilenameInfo('README');
44
45// Windows形式のパス (PHPはLinux/Windows両方のパス形式を扱えます)
46extractAndDisplayFilenameInfo('C:\Users\User\Documents\report.docx');
47
48?>

PHPのpathinfo()関数は、与えられたファイルパスから様々な構成要素（ディレクトリ名、ファイル名、拡張子など）を抽出するために利用されます。この関数は第一引数にファイルパス文字列、第二引数にどの情報を取得するかを指定する定数を取ります。

PATHINFO_FILENAMEは、pathinfo()関数の第二引数として使用するPHPの定数です。この定数を指定すると、ファイルパスから「拡張子を含まないファイル名」のみを抽出できます。例えば、「document.pdf」というファイルパスからは「document」という文字列が得られます。

サンプルコード内のextractAndDisplayFilenameInfo関数は、このPATHINFO_FILENAMEの具体的な利用方法を示しています。pathinfo($filePath, PATHINFO_FILENAME)と記述することで、指定されたファイルパスから拡張子なしのファイル名が正確に抽出され、$filenameWithoutExtension変数に格納される様子を確認できます。

また、キーワード「filename with extension」に関連して、サンプルコードでは拡張子を含むファイル名全体を取得する方法も示されています。これは、pathinfo()関数の第二引数にPATHINFO_BASENAME定数を指定することで実現できます。「document.pdf」であれば「document.pdf」全体を取得し、$filenameWithExtension変数に格納されます。

このコードは、ファイル名と拡張子を個別に扱いたい場合や、拡張子を含めた完全なファイル名が必要な場合など、ファイルパス情報の操作を行う際に役立つ実践的な例を提供しています。

Copy
1<?php
2
3/**
4 * pathinfo()関数とPATHINFO_FILENAME定数を使用して、
5 * ファイルパスから拡張子を除いたファイル名を取得するサンプルコードです。
6 *
7 * PATHINFO_FILENAME定数は、pathinfo()関数の第二引数として使用され、
8 * ファイル名から拡張子を取り除いた部分のみを抽出するよう指示するために利用されます。
9 *
10 * @param string $filePath 処理するファイルパス
11 * @return string 拡張子を除いたファイル名
12 */
13function getFilenameWithoutExtension(string $filePath): string
14{
15    // pathinfo()関数は、与えられたファイルパスに関する情報を取得します。
16    // 第二引数にPATHINFO_FILENAMEを指定することで、
17    // ファイル名（最後のドットとその後の文字列である拡張子を除く部分）のみが返されます。
18    return pathinfo($filePath, PATHINFO_FILENAME);
19}
20
21// --- サンプル実行 ---
22
23// 典型的なファイルパス
24$filePath1 = "/var/www/html/index.php";
25// ルートディレクトリからの相対パス
26$filePath2 = "images/picture.jpeg";
27// 拡張子がないファイル名
28$filePath3 = "README";
29// 複数のドットを含むファイル名（最後のドットのみが拡張子として扱われる）
30$filePath4 = "archive.tar.gz";
31
32echo "--- ファイルパスから拡張子を除いたファイル名を取得する例 ---" . PHP_EOL . PHP_EOL;
33
34echo "元のパス: '{$filePath1}'" . PHP_EOL;
35echo "結果: '" . getFilenameWithoutExtension($filePath1) . "'" . PHP_EOL . PHP_EOL;
36
37echo "元のパス: '{$filePath2}'" . PHP_EOL;
38echo "結果: '" . getFilenameWithoutExtension($filePath2) . "'" . PHP_EOL . PHP_EOL;
39
40echo "元のパス: '{$filePath3}'" . PHP_EOL;
41echo "結果: '" . getFilenameWithoutExtension($filePath3) . "'" . PHP_EOL . PHP_EOL;
42
43echo "元のパス: '{$filePath4}'" . PHP_EOL;
44echo "結果: '" . getFilenameWithoutExtension($filePath4) . "'" . PHP_EOL . PHP_EOL;
45
46?>

このPHPサンプルコードは、与えられたファイルパスから拡張子を除いたファイル名のみを効率的に取得する方法を紹介しています。主要な機能は、PHPの組み込み関数pathinfo()と、その挙動を制御する定数PATHINFO_FILENAMEの組み合わせによって実現されます。

pathinfo()関数は、ファイルパスを解析し、その構成要素に関する情報を取得するための関数です。この関数の第二引数にPATHINFO_FILENAME定数を指定すると、pathinfo()関数は、ファイル名の中から最後のドットとそれに続く拡張子の部分を除外した文字列を結果として返します。PATHINFO_FILENAME定数自体は、pathinfo()関数への指示として機能するため、引数や戻り値はありません。

サンプルコード内のgetFilenameWithoutExtension関数は、このpathinfo()関数とPATHINFO_FILENAME定数を活用しています。この関数は引数として処理するファイルパス（$filePath）を文字列で受け取り、拡張子を含まないファイル名部分のみを抽出した文字列を戻り値として返します。例えば、「/var/www/html/index.php」というパスからは「index」が、「archive.tar.gz」というパスからは「archive.tar」が取得されます。これにより、ファイル名から拡張子を簡単に分離し、プログラム内で柔軟に利用することが可能となります。