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

Copy
1<?php
2
3/**
4 * SplFileObject::isFile() メソッドのサンプルコード
5 *
6 * この関数は、SplFileObject クラスの isFile() メソッドの使用例を示します。
7 * isFile() メソッドは、現在の SplFileObject インスタンスがファイルシステム上の通常のファイルを指しているかどうかを返します。
8 * (PHPのグローバル関数 is_file() とは異なり、開かれたストリームの種類をチェックします。)
9 */
10function demonstrateSplFileObjectIsFile(): void
11{
12    $tempFileName = 'temp_file_for_splfileobject.txt';
13
14    // 1. 通常のファイルを開いた場合
15    try {
16        // テスト用のファイルを作成
17        file_put_contents($tempFileName, 'This is a test file content.');
18        echo "ファイル '{$tempFileName}' を作成しました。\n";
19
20        // SplFileObject でファイルを開く (読み込みモード)
21        $fileObject = new SplFileObject($tempFileName, 'r');
22        echo "SplFileObject で '{$tempFileName}' を開きました。\n";
23
24        // isFile() メソッドの結果を表示
25        if ($fileObject->isFile()) {
26            echo "isFile() は true を返しました (通常のファイルを指しています)。\n";
27        } else {
28            echo "isFile() は false を返しました (通常のファイルを指していません)。\n";
29        }
30    } catch (RuntimeException $e) {
31        echo "エラーが発生しました: " . $e->getMessage() . "\n";
32    } finally {
33        // テスト用ファイルを削除してクリーンアップ
34        if (file_exists($tempFileName)) {
35            unlink($tempFileName);
36            echo "ファイル '{$tempFileName}' を削除しました。\n";
37        }
38    }
39
40    echo "\n";
41
42    // 2. 特殊なストリーム (例: 標準入力) を開いた場合
43    try {
44        echo "SplFileObject で 'php://stdin' (標準入力) を開きます。\n";
45        // 標準入力はファイルシステム上の通常のファイルではないため、isFile() は false を返します。
46        $stdinObject = new SplFileObject('php://stdin', 'r');
47
48        // isFile() メソッドの結果を表示
49        if ($stdinObject->isFile()) {
50            echo "isFile() は true を返しました (通常のファイルを指しています)。\n";
51        } else {
52            echo "isFile() は false を返しました (通常のファイルを指していません)。\n";
53        }
54    } catch (RuntimeException $e) {
55        echo "エラーが発生しました: " . $e->getMessage() . "\n";
56    }
57
58    // 補足: SplFileObject は、存在しないファイルを読み込みモードで開こうとすると RuntimeException をスローします。
59    // 例: new SplFileObject('non_existent.txt', 'r'); // この行は例外を発生させます。
60    // そのため、isFile() を呼び出す前に、SplFileObject が有効なストリームを指している必要があります。
61}
62
63// サンプルコードを実行
64demonstrateSplFileObjectIsFile();
65

SplFileObject::isFile()メソッドは、PHPでファイルやストリームをオブジェクト指向で扱うためのSplFileObjectクラスに属します。このメソッドは引数を一切取らず、現在のSplFileObjectインスタンスが、ファイルシステム上の「通常のファイル」を指しているかどうかを真偽値（trueまたはfalse）で返します。

具体的には、テキストファイルや画像ファイルなどの一般的なファイルを開いたSplFileObjectインスタンスに対して呼び出すとtrueを返します。一方で、標準入力（php://stdin）のような特殊なストリームや、ディレクトリを指している場合にはfalseを返します。この挙動は、ファイルパスの存在をチェックするPHPのグローバル関数is_file()とは異なり、既に開かれているストリームの種類を直接判定する点が特徴です。

このメソッドを活用することで、SplFileObjectが実際に通常のファイルとして扱える対象を指しているかをプログラム内で正確に判断し、適切な処理を行うことができます。

Copy
1<?php
2
3/**
4 * SplFileObject::isFile() メソッドの動作をデモンストレーションします。
5 * このメソッドは、ファイルが存在し、かつそれが通常のファイル（ディレクトリや
6 * シンボリックリンクなどではない）である場合に true を返します。
7 */
8function demonstrateSplFileObjectIsFile(): void
9{
10    // テスト用のファイルパスとディレクトリパスを定義
11    $existingFilePath = 'example_file_for_spl.txt';
12    $nonExistentFilePath = 'non_existent_file_for_spl.txt';
13    $directoryPath = 'example_dir_for_spl';
14
15    // テスト用のファイルとディレクトリを作成します。
16    // スクリプト実行後、これらのファイルとディレクトリは削除されます。
17    file_put_contents($existingFilePath, 'This is a test file content.');
18    if (!is_dir($directoryPath)) {
19        mkdir($directoryPath);
20    }
21
22    echo "--- SplFileObject::isFile() メソッドのデモンストレーション ---" . PHP_EOL . PHP_EOL;
23
24    // 1. 存在する正規のファイルに対するテスト
25    echo "1. 存在する正規のファイル ('{$existingFilePath}') の場合:" . PHP_EOL;
26    try {
27        // 存在するファイルを読み込みモード ('r') で開きます。
28        $fileObject = new SplFileObject($existingFilePath, 'r');
29        if ($fileObject->isFile()) {
30            echo "   結果: '{$existingFilePath}' は正規のファイルです。" . PHP_EOL;
31        } else {
32            echo "   結果: '{$existingFilePath}' は正規のファイルではありません。" . PHP_EOL;
33        }
34    } catch (RuntimeException $e) {
35        echo "   エラー: " . $e->getMessage() . PHP_EOL;
36    }
37    echo PHP_EOL;
38
39    // 2. 存在しないファイルに対するテスト
40    echo "2. 存在しないファイル ('{$nonExistentFilePath}') の場合:" . PHP_EOL;
41    try {
42        // 存在しないファイルを読み込みモード ('r') で開こうとします。
43        // ファイルが存在しないため、isFile() は false を返します。
44        $fileObject = new SplFileObject($nonExistentFilePath, 'r');
45        if ($fileObject->isFile()) {
46            echo "   結果: '{$nonExistentFilePath}' は正規のファイルです。" . PHP_EOL;
47        } else {
48            echo "   結果: '{$nonExistentFilePath}' は正規のファイルではありません (期待通り)。" . PHP_EOL;
49        }
50    } catch (RuntimeException $e) {
51        // ファイルシステムへのアクセス権の問題などがない限り、このケースでエラーは通常発生しません。
52        echo "   エラー: " . $e->getMessage() . PHP_EOL;
53    }
54    echo PHP_EOL;
55
56    // 3. ディレクトリに対するテスト
57    echo "3. ディレクトリ ('{$directoryPath}') の場合:" . PHP_EOL;
58    try {
59        // ディレクトリを読み込みモード ('r') で開こうとします。
60        // ディレクトリは正規のファイルではないため、isFile() は false を返します。
61        $fileObject = new SplFileObject($directoryPath, 'r');
62        if ($fileObject->isFile()) {
63            echo "   結果: '{$directoryPath}' は正規のファイルです。" . PHP_EOL;
64        } else {
65            echo "   結果: '{$directoryPath}' は正規のファイルではありません (期待通り)。" . PHP_EOL;
66        }
67    } catch (RuntimeException $e) {
68        // ファイルシステムへのアクセス権の問題などがない限り、このケースでエラーは通常発生しません。
69        echo "   エラー: " . $e->getMessage() . PHP_EOL;
70    }
71    echo PHP_EOL;
72
73    // --- クリーンアップ ---
74    // テスト用に作成したファイルとディレクトリを削除します。
75    if (file_exists($existingFilePath)) {
76        unlink($existingFilePath);
77    }
78    if (is_dir($directoryPath)) {
79        rmdir($directoryPath);
80    }
81    echo "--- テスト用のファイルとディレクトリを削除し、クリーンアップ完了 ---" . PHP_EOL;
82}
83
84// デモンストレーション関数を実行
85demonstrateSplFileObjectIsFile();
86

PHPのSplFileObject::isFile()メソッドは、ファイル操作をオブジェクト指向で行うSplFileObjectクラスに属しています。このメソッドは引数を取らず、そのオブジェクトが表すパスが「実際に存在し、かつ通常のファイルであるか」を判断し、結果を真偽値（bool）で返します。通常のファイルとは、テキストファイルや画像ファイルなどを指し、ディレクトリやシンボリックリンクは含まれません。

サンプルコードでは、このisFile()メソッドの挙動を三つのケースで示しています。一つ目は、実際に存在するテキストファイルを開いた場合です。この場合、isFile()はtrueを返し、「正規のファイルである」と判断します。二つ目は、存在しないファイルを開いた場合です。ファイルが存在しないため、isFile()はfalseを返します。三つ目は、ディレクトリを開いた場合です。ディレクトリは通常のファイルではないため、isFile()はfalseを返します。

このように、SplFileObject::isFile()メソッドは、ファイル操作を行う際に、対象が期待通りの通常のファイルであるかを正確に確認するために利用されます。