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

Copy
1<?php
2
3/**
4 * SplFileObject::getExtension() メソッドの使用例を示します。
5 * このメソッドは、ファイル名から拡張子を抽出します。
6 */
7
8// 1. サンプル用のファイルを作成します。
9// SplFileObject は既存のファイルを操作するため、一時ファイルが必要です。
10$fileName = 'sample_document.txt';
11if (file_put_contents($fileName, 'これはテストファイルの内容です。') === false) {
12    echo "エラー: ファイル '{$fileName}' の作成に失敗しました。\n";
13    exit(1);
14}
15
16echo "ファイル '{$fileName}' を作成しました。\n";
17
18try {
19    // 2. SplFileObject のインスタンスを作成します。
20    // 'r' モードは読み込み専用を意味します。
21    $fileObject = new SplFileObject($fileName, 'r');
22
23    // 3. getExtension() メソッドを呼び出して拡張子を取得します。
24    $extension = $fileObject->getExtension();
25
26    // 4. 取得した拡張子を表示します。
27    echo "ファイル名: " . $fileObject->getFilename() . "\n";
28    echo "拡張子: " . $extension . "\n";
29
30    // 拡張子のないファイルの場合の例も試してみます。
31    $noExtensionFileName = 'no_extension_file';
32    file_put_contents($noExtensionFileName, '拡張子のないファイルです。');
33    $noExtensionFileObject = new SplFileObject($noExtensionFileName, 'r');
34    $noExtension = $noExtensionFileObject->getExtension();
35    echo "ファイル名 (拡張子なし): " . $noExtensionFileObject->getFilename() . "\n";
36    echo "拡張子 (拡張子なし): '" . $noExtension . "' (空文字列)\n";
37
38} catch (RuntimeException $e) {
39    // ファイルが存在しない、またはアクセス権がない場合などに例外が発生します。
40    echo "ファイル操作中にエラーが発生しました: " . $e->getMessage() . "\n";
41} finally {
42    // 5. サンプル用に作成したファイルを削除し、クリーンアップします。
43    if (file_exists($fileName)) {
44        unlink($fileName);
45        echo "一時ファイル '{$fileName}' を削除しました。\n";
46    }
47    if (file_exists($noExtensionFileName)) {
48        unlink($noExtensionFileName);
49        echo "一時ファイル '{$noExtensionFileName}' を削除しました。\n";
50    }
51}

PHPのSplFileObject::getExtension()メソッドは、ファイル名から拡張子を効率的に取得するために使用されます。このメソッドは、SplFileObjectクラスのインスタンスに対して呼び出され、引数を必要としません。呼び出すと、ファイル名の拡張子部分を文字列として返します。例えば、「report.pdf」というファイル名からは「pdf」という文字列が取得できます。もしファイル名に拡張子がない場合（例えば「document」というファイル名）、戻り値は空の文字列となります。

提示されたサンプルコードでは、まず「sample_document.txt」という一時ファイルを作成し、そのファイルをSplFileObjectのオブジェクトとして開いています。そして、そのオブジェクトに対してgetExtension()メソッドを呼び出すことで「txt」という拡張子を取得し、画面に表示しています。さらに、拡張子を持たない「no_extension_file」という一時ファイルも作成し、同様にgetExtension()メソッドを呼び出して、空の文字列が返されることを示しています。ファイルが見つからないなどのエラーが発生した場合には、try-catchブロックで適切に処理され、最終的に作成した一時ファイルはfinallyブロックで確実に削除され、クリーンアップが行われます。このメソッドは、ファイル名から拡張子を安全かつ簡単に抽出したい場合に非常に便利です。