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

Copy
1<?php
2
3/**
4 * SplFileInfo::isFile() メソッドの使用例を示します。
5 *
6 * この関数は、指定されたパスが通常のファイルであるかどうかを判定します。
7 * システムエンジニアを目指す初心者の方にも分かりやすいように、
8 * ファイル、ディレクトリ、存在しないパスのそれぞれのケースを検証します。
9 */
10function demonstrateSplFileInfoIsFile(): void
11{
12    // 1. テスト用のファイルパスとディレクトリパスを定義
13    $filePath = 'sample_document.txt';
14    $directoryPath = 'sample_project_folder';
15    $nonExistentPath = 'non_existent_file.log';
16
17    // 2. テスト用のファイルとディレクトリを準備
18    // 既に存在する場合は上書きを避け、存在しない場合のみ作成します。
19    if (!file_exists($filePath)) {
20        file_put_contents($filePath, 'これはテスト用のファイルの内容です。');
21        echo "テストファイル '{$filePath}' を作成しました。" . PHP_EOL;
22    }
23    if (!is_dir($directoryPath)) {
24        mkdir($directoryPath);
25        echo "テストディレクトリ '{$directoryPath}' を作成しました。" . PHP_EOL;
26    }
27    echo PHP_EOL;
28
29    echo "--- SplFileInfo::isFile() メソッドの実行結果 ---" . PHP_EOL;
30
31    // ケース1: 存在する「ファイル」に対する確認
32    $fileInfo = new SplFileInfo($filePath);
33    echo "パス: '{$filePath}'" . PHP_EOL;
34    if ($fileInfo->isFile()) {
35        echo "  → 結果: '{$filePath}' は**ファイルです**。" . PHP_EOL;
36    } else {
37        echo "  → 結果: '{$filePath}' はファイルではありません。" . PHP_EOL;
38    }
39    echo PHP_EOL;
40
41    // ケース2: 存在する「ディレクトリ」に対する確認
42    $dirInfo = new SplFileInfo($directoryPath);
43    echo "パス: '{$directoryPath}'" . PHP_EOL;
44    if ($dirInfo->isFile()) {
45        echo "  → 結果: '{$directoryPath}' は**ファイルです**。" . PHP_EOL;
46    } else {
47        echo "  → 結果: '{$directoryPath}' はファイルではありません。" . PHP_EOL;
48    }
49    echo PHP_EOL;
50
51    // ケース3: 「存在しないパス」に対する確認
52    $nonExistentInfo = new SplFileInfo($nonExistentPath);
53    echo "パス: '{$nonExistentPath}'" . PHP_EOL;
54    if ($nonExistentInfo->isFile()) {
55        echo "  → 結果: '{$nonExistentPath}' は**ファイルです**。" . PHP_EOL;
56    } else {
57        echo "  → 結果: '{$nonExistentPath}' はファイルではありません。" . PHP_EOL;
58    }
59    echo PHP_EOL;
60
61    echo "--- 処理終了 ---" . PHP_EOL;
62
63    // 3. 後処理: 作成したテストファイルとディレクトリを削除
64    if (file_exists($filePath)) {
65        unlink($filePath);
66        echo "テストファイル '{$filePath}' を削除しました。" . PHP_EOL;
67    }
68    if (is_dir($directoryPath)) {
69        rmdir($directoryPath);
70        echo "テストディレクトリ '{$directoryPath}' を削除しました。" . PHP_EOL;
71    }
72}
73
74// 上記のデモンストレーション関数を実行
75demonstrateSplFileInfoIsFile();

SplFileInfo::isFile()メソッドは、PHPでファイルシステム上の特定のパスが「通常のファイル」であるかどうかを判定するために使用します。このメソッドはSplFileInfoクラスのインスタンスに対して呼び出され、引数は不要です。戻り値は真偽値（bool）であり、指定されたパスが通常のファイルであればtrueを、そうでなければfalseを返します。

サンプルコードでは、まずSplFileInfoクラスのインスタンスを生成し、そのインスタンスに対してisFile()メソッドを実行しています。具体的には、以下の3つのケースで挙動を検証しています。

1. 存在するファイル: sample_document.txtというパスに対してisFile()を実行すると、そのパスが通常のファイルを指しているためtrueが返されます。
2. 存在するディレクトリ: sample_project_folderというディレクトリのパスに対してisFile()を実行すると、ディレクトリは通常のファイルではないためfalseが返されます。
3. 存在しないパス: non_existent_file.logという存在しないパスに対してisFile()を実行すると、ファイルが存在しないためfalseが返されます。

このメソッドは、ファイルの内容を読み書きする前に、対象が適切なファイルであることを確認する際などに非常に有用です。

Copy
1<?php
2
3/**
4 * 指定されたパスが通常のファイルであるかをチェックし、結果を出力します。
5 * SplFileInfo::isFile() メソッドは、パスが存在し、かつそれが通常のファイルである場合に true を返します。
6 * ディレクトリやシンボリックリンク、存在しないパスの場合は false を返します。
7 *
8 * @param string $filePath チェックするファイルのパス
9 */
10function checkFileExistenceAndType(string $filePath): void
11{
12    // SplFileInfo オブジェクトを作成します。
13    // この時点では、ファイルが存在するかどうかはチェックされません。
14    $fileInfo = new SplFileInfo($filePath);
15
16    // isFile() メソッドを呼び出して、パスが通常のファイルであるかを判断します。
17    if ($fileInfo->isFile()) {
18        echo "パス '{$filePath}' は通常のファイルです。\n";
19    } else {
20        // ファイルが存在しないか、ディレクトリなどの場合は false が返されます。
21        echo "パス '{$filePath}' は通常のファイルではありません（存在しないか、ディレクトリなど）。\n";
22    }
23}
24
25// --- サンプルコードの実行 ---
26
27// 1. 存在する通常のファイルをテストする
28$existingFileName = 'sample_file_for_test.txt';
29// テスト用にファイルを作成します。
30file_put_contents($existingFileName, "このファイルはテスト用です。\n");
31checkFileExistenceAndType($existingFileName);
32
33echo "\n"; // 出力を見やすくするための改行
34
35// 2. 存在しないファイルをテストする
36$nonExistentFileName = 'non_existent_file.txt';
37checkFileExistenceAndType($nonExistentFileName);
38
39echo "\n";
40
41// 3. ディレクトリをテストする
42// __DIR__ は現在のスクリプトが格納されているディレクトリのパスを返します。
43$directoryPath = __DIR__;
44checkFileExistenceAndType($directoryPath);
45
46// テストで作成したファイルをクリーンアップします。
47if (file_exists($existingFileName)) {
48    unlink($existingFileName);
49}
50
51?>

PHPのSplFileInfo::isFile()メソッドは、ファイルシステム上の特定のパスが「通常のファイル」であるかどうかを判別するために使用されます。このメソッドを利用するには、まず対象のファイルパスを指定してSplFileInfoオブジェクトを作成し、そのオブジェクトに対してisFile()メソッドを呼び出します。引数は必要ありません。

このメソッドの戻り値は真偽値（bool）です。もしパスが存在し、かつそれが通常のデータファイル（テキストファイルや画像ファイル、実行ファイルなど）であればtrueを返します。しかし、もしパスが存在しない場合や、対象がファイルではなくディレクトリ（フォルダ）であったり、シンボリックリンクであったりする場合にはfalseを返します。

サンプルコードでは、checkFileExistenceAndType関数を使ってその挙動が示されています。例えば、実際に存在するファイルパスを渡すと「通常のファイルです」と表示され、存在しないパスやディレクトリのパスを渡すと「通常のファイルではありません」と表示されることで、isFile()がファイルの種類を厳密に判別していることがわかります。この機能は、ファイル操作を行う際に、対象が期待する種類のファイルであるかを確認する上で非常に役立ちます。