【PHP8.x】is_file()関数の使い方

Copy
1<?php
2
3/**
4 * 指定されたパスが通常のファイルであるかどうかをチェックし、結果を出力します。
5 *
6 * is_file() 関数は、指定されたパスが存在し、それが通常のファイルである場合にのみ true を返します。
7 * ディレクトリ、シンボリックリンク、または存在しないパスに対しては false を返します。
8 *
9 * @param string $filePath チェックするファイルのパス。
10 * @return void
11 */
12function checkFileStatus(string $filePath): void
13{
14    echo "パス '{$filePath}' の状態を確認します。\n";
15
16    if (is_file($filePath)) {
17        echo "  結果: このパスは、存在する通常のファイルです。\n";
18    } else {
19        echo "  結果: このパスは、存在しないか、または通常のファイルではありません (例: ディレクトリ、シンボリックリンク)。\n";
20    }
21    echo "----------------------------------------\n";
22}
23
24// -----------------------------------------------------
25// サンプルコードの実行例
26// -----------------------------------------------------
27
28// 1. このスクリプト自身をチェック（存在する通常のファイル）
29//    __FILE__ は現在のPHPスクリプトのフルパスを表す定数です。
30checkFileStatus(__FILE__);
31
32// 2. 存在しないファイルをチェック
33checkFileStatus('non_existent_file.txt');
34
35// 3. ディレクトリをチェック（is_file() はディレクトリに対して false を返します）
36//    __DIR__ は現在のPHPスクリプトがあるディレクトリのフルパスを表す定数です。
37checkFileStatus(__DIR__);
38
39// 4. 一時的にファイルを作成し、それをチェックした後に削除する例
40//    (より実践的な例として、ファイル作成・削除の関数を利用)
41$tempFileName = 'temp_example_file.txt';
42file_put_contents($tempFileName, 'これはテストファイルです。');
43echo "一時ファイル '{$tempFileName}' を作成しました。\n";
44checkFileStatus($tempFileName);
45
46// 使用済みのテストファイルを削除
47unlink($tempFileName);
48echo "一時ファイル '{$tempFileName}' を削除しました。\n";
49echo "----------------------------------------\n";
50
51// 削除後のファイルを再度チェック（存在しないため false になります）
52checkFileStatus($tempFileName);
53
54?>

PHPのis_file()関数は、指定されたパスが通常のファイルであるかどうかを調べるために使用します。

引数には、調べたいファイルへのパスを文字列として渡します。この関数は、指定したパスが存在し、かつそれがディレクトリなどではない「通常のファイル」である場合にのみ、戻り値としてtrue（真）を返します。パスが存在しない場合や、ディレクトリやシンボリックリンクであった場合はfalse（偽）を返します。

このサンプルコードは、checkFileStatusという独自の関数を定義し、様々な条件のパスに対してis_file()を実行して結果を表示しています。まず、現在実行中のスクリプト自身のパス(__FILE__)を調べることで、存在するファイルにはtrueが返されることを示します。次に、存在しないファイル名や、ディレクトリのパス(__DIR__)を渡すと、これらは通常のファイルではないためfalseが返されることを確認できます。さらに、一時的にファイルを作成してチェックするとtrueとなり、そのファイルを削除した後に再度チェックするとfalseに変わる流れを通して、関数の正確な挙動を具体的に示しています。

このように、ファイル操作を行う前に、対象が意図した通り通常のファイルであるかを確認する際に便利な関数です。

Copy
1<?php
2
3/**
4 * 指定されたファイルが実在し、かつ内容が空であるかを判断します。
5 *
6 * この関数は、`is_file()` を使用してパスが有効なファイルであることを確認し、
7 * その後 `filesize()` を使用してファイルのサイズが0バイトであるかをチェックします。
8 *
9 * @param string $filePath チェックするファイルのパス。
10 * @return bool ファイルが存在し、内容が空（0バイト）であれば true、それ以外は false を返します。
11 */
12function isFileContentEmpty(string $filePath): bool
13{
14    // 1. まず、指定されたパスが通常ファイルとして存在するかをチェックします。
15    //    is_file() は、ファイルが存在し、ディレクトリやシンボリックリンクではなく
16    //    「通常のファイル」である場合に true を返します。
17    if (!is_file($filePath)) {
18        return false; // ファイルが存在しない、または通常のファイルではない
19    }
20
21    // 2. ファイルが存在することが確認できたら、そのファイルのサイズを取得します。
22    //    filesize() は、ファイルのサイズをバイト単位で返します。
23    //    もしファイルサイズの取得に失敗した場合（例: 権限不足）、false を返します。
24    $fileSize = filesize($filePath);
25
26    // 3. ファイルサイズの取得に失敗した場合、ファイルが空であるかを判断できないため、
27    //    安全のために false を返します。
28    if ($fileSize === false) {
29        return false;
30    }
31
32    // 4. ファイルサイズが0バイトであれば、そのファイルは空であると判断します。
33    return $fileSize === 0;
34}
35
36// --- 使用例 ---
37
38// テスト用のファイル名を設定
39$testFilename = 'sample_file_for_check.txt';
40
41echo "--- ファイルの状態チェック ---" . PHP_EOL;
42
43// ケース1: 存在しないファイル
44echo "1. 'non_existent.txt' のチェック: ";
45if (isFileContentEmpty('non_existent.txt')) {
46    echo "空のファイルです。" . PHP_EOL;
47} else {
48    echo "空のファイルではありません。" . PHP_EOL; // 期待される出力
49}
50
51// ケース2: 空のファイルを作成し、チェック
52file_put_contents($testFilename, ''); // 空のファイルを作成
53echo "2. '" . $testFilename . "' (空) のチェック: ";
54if (isFileContentEmpty($testFilename)) {
55    echo "空のファイルです。" . PHP_EOL; // 期待される出力
56} else {
57    echo "空のファイルではありません。" . PHP_EOL;
58}
59
60// ケース3: 内容のあるファイルを作成し、チェック
61file_put_contents($testFilename, 'Hello, PHP engineers!'); // 内容のあるファイルを作成
62echo "3. '" . $testFilename . "' (内容あり) のチェック: ";
63if (isFileContentEmpty($testFilename)) {
64    echo "空のファイルです。" . PHP_EOL;
65} else {
66    echo "空のファイルではありません。" . PHP_EOL; // 期待される出力
67}
68
69// 使用したテストファイルを削除してクリーンアップ
70if (file_exists($testFilename)) {
71    unlink($testFilename);
72}
73
74?>

このPHPのサンプルコードは、指定されたファイルが存在し、その内容が空（0バイト）であるかを判断する方法を初心者の方にも分かりやすく示しています。

中心となるis_file関数は、引数$filenameで指定されたパスが実際に存在する「通常のファイル」であるかをチェックし、その結果を真偽値（bool）で返します。例えば、ディレクトリや存在しないパスに対してはfalseを返し、通常のファイルであればtrueを返します。

サンプルコードで定義されているisFileContentEmpty関数は、このis_file関数とfilesize関数を組み合わせて、より詳細なファイルの空判定を行っています。この関数は、引数$filePathで指定されたファイルパスが有効な通常のファイルであり、かつそのファイルのサイズが0バイトである場合にのみtrueを返します。ファイルが存在しない場合や、サイズが0バイトでない場合にはfalseを戻り値として返します。

コードの実行部では、存在しないファイル、内容が空のファイル、そして内容が書き込まれたファイルという三つの異なる状況でisFileContentEmpty関数を呼び出しています。これにより、ファイルの実際の状態に応じて、関数が「空のファイルです」または「空のファイルではありません」と正確に判断する様子を確認できます。これはファイルの状態を安全に確認する上で重要なテクニックです。

Copy
1<?php
2
3/**
4 * is_file() と file_exists() の違いを比較するサンプルコードです。
5 *
6 * is_file(string $filename): bool
7 *   指定されたパスが通常のファイルであるかどうかを調べます。
8 *   ディレクトリに対しては false を返します。
9 *   シンボリックリンクの場合、そのリンク先が通常のファイルであれば true を返します。
10 *
11 * file_exists(string $filename): bool
12 *   指定されたパスが存在するかどうかを調べます。
13 *   ファイル、ディレクトリ、シンボリックリンクのいずれでも存在すれば true を返します。
14 *   存在しないパスに対しては false を返します。
15 */
16
17// テスト用のファイルとディレクトリのパスを定義します。
18// 実行ごとに異なる一時ディレクトリを使用するため、uniqid() でユニークな名前を生成します。
19$basePath = __DIR__ . DIRECTORY_SEPARATOR . 'test_data_' . uniqid();
20$testFilePath = $basePath . DIRECTORY_SEPARATOR . 'test_file.txt';
21$testDirPath = $basePath . DIRECTORY_SEPARATOR . 'test_dir';
22$nonExistentPath = $basePath . DIRECTORY_SEPARATOR . 'non_existent.txt';
23$fileSymlinkPath = $basePath . DIRECTORY_SEPARATOR . 'file_symlink.txt';
24$dirSymlinkPath = $basePath . DIRECTORY_SEPARATOR . 'dir_symlink';
25
26/**
27 * テスト環境をセットアップします。
28 * テスト用のファイル、ディレクトリ、およびシンボリックリンクを作成します。
29 *
30 * @param string $basePath テストデータを作成するベースディレクトリのパス。
31 * @param string $testFilePath テスト用ファイルのフルパス。
32 * @param string $testDirPath テスト用ディレクトリのフルパス。
33 * @param string $fileSymlinkPath ファイルへのシンボリックリンクのフルパス。
34 * @param string $dirSymlinkPath ディレクトリへのシンボリックリンクのフルパス。
35 */
36function setupTestEnvironment(
37    string $basePath,
38    string $testFilePath,
39    string $testDirPath,
40    string $fileSymlinkPath,
41    string $dirSymlinkPath
42): void {
43    // ベースディレクトリを作成
44    if (!mkdir($basePath, 0777, true) && !is_dir($basePath)) {
45        echo "エラー: ベースディレクトリ '$basePath' の作成に失敗しました。\n";
46        exit(1);
47    }
48
49    // 通常のファイルを作成
50    file_put_contents($testFilePath, 'This is a test file content.');
51
52    // ディレクトリを作成
53    mkdir($testDirPath);
54
55    // ファイルへのシンボリックリンクを作成
56    // Windows環境では管理者権限が必要な場合があります。
57    if (file_exists($testFilePath)) {
58        if (!@symlink($testFilePath, $fileSymlinkPath)) {
59            echo "警告: ファイルへのシンボリックリンク '$fileSymlinkPath' の作成に失敗しました。\n" .
60                 "      (Windows環境では管理者権限が必要な場合があります)\n";
61        }
62    }
63
64    // ディレクトリへのシンボリックリンクを作成
65    // Windows環境では管理者権限が必要な場合があります。
66    if (file_exists($testDirPath)) {
67        if (!@symlink($testDirPath, $dirSymlinkPath)) {
68            echo "警告: ディレクトリへのシンボリックリンク '$dirSymlinkPath' の作成に失敗しました。\n" .
69                 "      (Windows環境では管理者権限が必要な場合があります)\n";
70        }
71    }
72    echo "テスト環境をセットアップしました。\n\n";
73}
74
75/**
76 * テスト環境をクリーンアップします。
77 * 作成したファイル、ディレクトリ、シンボリックリンクを削除します。
78 *
79 * @param string $basePath テストデータを作成したベースディレクトリのパス。
80 * @param string $testFilePath テスト用ファイルのフルパス。
81 * @param string $testDirPath テスト用ディレクトリのフルパス。
82 * @param string $fileSymlinkPath ファイルへのシンボリックリンクのフルパス。
83 * @param string $dirSymlinkPath ディレクトリへのシンボリックリンクのフルパス。
84 */
85function cleanupTestEnvironment(
86    string $basePath,
87    string $testFilePath,
88    string $testDirPath,
89    string $fileSymlinkPath,
90    string $dirSymlinkPath
91): void {
92    // シンボリックリンクを削除
93    if (is_link($fileSymlinkPath)) {
94        unlink($fileSymlinkPath);
95    }
96    if (is_link($dirSymlinkPath)) {
97        unlink($dirSymlinkPath);
98    }
99
100    // ファイルを削除
101    if (file_exists($testFilePath)) {
102        unlink($testFilePath);
103    }
104
105    // ディレクトリを削除
106    // rmdir() は空のディレクトリしか削除できません。
107    if (is_dir($testDirPath)) {
108        rmdir($testDirPath);
109    }
110
111    // ベースディレクトリを削除 (これも空である必要があります)
112    if (is_dir($basePath)) {
113        rmdir($basePath);
114    }
115    echo "\nテスト環境をクリーンアップしました。\n";
116}
117
118/**
119 * 指定されたパスに対して is_file() と file_exists() の結果を表示し、比較します。
120 *
121 * @param string $path テスト対象のパス。
122 * @param string $description パスの説明。
123 */
124function compareFileFunctions(string $path, string $description): void
125{
126    echo "--------------------------------------------------\n";
127    echo "パス: \"" . basename($path) . "\"\n";
128    echo "説明: $description\n";
129    // is_file() はファイルかどうかを判定
130    echo sprintf("  is_file('%s'):    %s\n", basename($path), is_file($path) ? 'TRUE' : 'FALSE');
131    // file_exists() は存在するかどうかを判定 (ファイル、ディレクトリ、リンク問わず)
132    echo sprintf("  file_exists('%s'): %s\n", basename($path), file_exists($path) ? 'TRUE' : 'FALSE');
133    echo "\n";
134}
135
136// メインの実行ロジック
137// try...finally を使用して、スクリプトが途中で中断しても必ずクリーンアップが実行されるようにします。
138try {
139    // 1. テスト環境をセットアップ
140    setupTestEnvironment($basePath, $testFilePath, $testDirPath, $fileSymlinkPath, $dirSymlinkPath);
141
142    // 2. 各パスに対して is_file() と file_exists() の結果を比較表示
143    compareFileFunctions($testFilePath, '存在する通常のファイル');
144    compareFileFunctions($testDirPath, '存在するディレクトリ');
145    compareFileFunctions($nonExistentPath, '存在しないファイルまたはディレクトリ');
146    compareFileFunctions($fileSymlinkPath, 'ファイルへのシンボリックリンク');
147    compareFileFunctions($dirSymlinkPath, 'ディレクトリへのシンボリックリンク');
148
149} finally {
150    // 3. テスト環境をクリーンアップ
151    cleanupTestEnvironment($basePath, $testFilePath, $testDirPath, $fileSymlinkPath, $dirSymlinkPath);
152}
153
154?>

PHPのis_file()関数とfile_exists()関数は、指定されたパスに関する情報を取得する際に利用されますが、それぞれの目的と挙動には明確な違いがあります。

is_file(string $filename)関数は、引数に指定された$filenameパスが「通常のファイル」であるかどうかを調べ、その結果をbool値（trueまたはfalse）で返します。この関数は、ディレクトリに対してはfalseを返し、ファイルへのシンボリックリンクの場合は、そのリンク先が通常のファイルであればtrueを返します。

一方、file_exists(string $filename)関数は、引数に指定された$filenameパスが「存在するかどうか」のみを調べ、結果をbool値で返します。この関数は、パスが通常のファイル、ディレクトリ、シンボリックリンクのいずれであっても存在すればtrueを返します。パスが全く存在しない場合にのみfalseを返します。

これらの違いから、is_file()はパスが本当に「ファイル」として操作できるかを確認したい場合に適しており、file_exists()はパスに何らかの項目（ファイル、ディレクトリ、リンク）が存在するかどうかを大まかに確認したい場合に適しています。サンプルコードでは、ディレクトリに対してis_file()がfalse、file_exists()がtrueを返すことで、両者の挙動の違いが具体的に示されています。

Copy
1<?php
2
3/**
4 * PHPのis_file関数を利用した、ファイルアップロード処理のサンプルです。
5 * システムエンジニアを目指す初心者向けに、正確かつ簡潔なコードを提供します。
6 * この関数は、ファイルアップロードフォームと、その処理ロジックの両方を扱います。
7 *
8 * @return string ユーザーに表示するHTMLメッセージを返します。
9 */
10function handleFileUploadAndForm(): string
11{
12    // ユーザーへのメッセージを格納する変数
13    $message = '';
14
15    // フォームがPOSTメソッドで送信され、かつファイルがアップロードされたかをチェック
16    if ($_SERVER['REQUEST_METHOD'] === 'POST' && isset($_FILES['uploaded_file'])) {
17        $file = $_FILES['uploaded_file'];
18
19        // アップロードエラーがないか確認 (UPLOAD_ERR_OKはエラーなしを意味する)
20        if ($file['error'] === UPLOAD_ERR_OK) {
21            $tmpFilePath = $file['tmp_name']; // アップロードされた一時ファイルのパス
22            $fileName = basename($file['name']); // オリジナルファイル名からパス情報を除去
23
24            // is_file関数を使用して、一時ファイルが実際に存在し、通常のファイルであるかを確認します。
25            // これは、サーバーに一時ファイルが作成されたかどうかの基本的なチェックです。
26            if (is_file($tmpFilePath)) {
27                $uploadDir = __DIR__ . '/uploads/'; // ファイルの保存先ディレクトリ
28
29                // アップロードディレクトリが存在しない場合は作成
30                if (!is_dir($uploadDir)) {
31                    mkdir($uploadDir, 0755, true); // ディレクトリを再帰的に作成
32                }
33
34                $destination = $uploadDir . $fileName; // 最終的な保存パス
35
36                // アップロードされた一時ファイルを、指定の場所へ安全に移動します。
37                if (move_uploaded_file($tmpFilePath, $destination)) {
38                    $message = "ファイル '<strong>" . htmlspecialchars($fileName) . "</strong>' が正常にアップロードされました。<br>";
39                    $message .= "保存先: " . htmlspecialchars($destination) . "<br>";
40                } else {
41                    $message = "ファイルの移動に失敗しました。<br>";
42                }
43            } else {
44                $message = "エラー: アップロードされた一時ファイルが見つかりません。<br>";
45            }
46        } else {
47            // アップロードエラーコードに応じたメッセージを表示
48            $message = "ファイルアップロードエラーが発生しました。エラーコード: " . $file['error'] . "<br>";
49            switch ($file['error']) {
50                case UPLOAD_ERR_INI_SIZE:
51                    $message .= "ファイルサイズがphp.iniの設定を超過しています。<br>";
52                    break;
53                case UPLOAD_ERR_FORM_SIZE:
54                    $message .= "ファイルサイズがフォームの上限を超過しています。<br>";
55                    break;
56                case UPLOAD_ERR_PARTIAL:
57                    $message .= "ファイルが一部しかアップロードされませんでした。<br>";
58                    break;
59                case UPLOAD_ERR_NO_FILE:
60                    $message .= "ファイルが選択されませんでした。<br>";
61                    break;
62                case UPLOAD_ERR_NO_TMP_DIR:
63                    $message .= "一時ディレクトリがありません。<br>";
64                    break;
65                case UPLOAD_ERR_CANT_WRITE:
66                    $message .= "ディスクへの書き込みに失敗しました。<br>";
67                    break;
68                case UPLOAD_ERR_EXTENSION:
69                    $message .= "PHP拡張機能がアップロードを停止しました。<br>";
70                    break;
71            }
72        }
73    } else {
74        // 初回アクセス時、またはフォームが送信されなかった場合
75        $message = "ファイルをアップロードするには、フォームからファイルを選択し、「アップロード」ボタンをクリックしてください。<br>";
76    }
77
78    return $message;
79}
80
81// 関数を実行し、結果のメッセージを取得
82$outputMessage = handleFileUploadAndForm();
83
84?>
85<!DOCTYPE html>
86<html lang="ja">
87<head>
88    <meta charset="UTF-8">
89    <meta name="viewport" content="width=device-width, initial-scale=1.0">
90    <title>PHP ファイルアップロードの例</title>
91</head>
92<body>
93    <h1>PHPファイルアップロードと is_file() の利用</h1>
94
95    <div>
96        <?php echo $outputMessage; ?>
97    </div>
98
99    <form action="" method="post" enctype="multipart/form-data">
100        <!-- MAX_FILE_SIZE はオプションで、ブラウザ側での上限設定です。 -->
101        <!-- セキュリティのためにサーバー側でのファイルサイズチェックも必ず行ってください。 -->
102        <input type="hidden" name="MAX_FILE_SIZE" value="5000000" /> <!-- 例: 5MB -->
103        <label for="uploaded_file">アップロードするファイルを選択:</label>
104        <input type="file" name="uploaded_file" id="uploaded_file">
105        <br><br>
106        <input type="submit" value="アップロード">
107    </form>
108</body>
109</html>

PHPのis_file関数は、指定されたパスが実際に存在し、かつ通常のファイル（ディレクトリやシンボリックリンクではない）であるかどうかを真偽値で判定する関数です。引数にはチェックしたいファイルのパスを文字列で指定し、存在し通常のファイルであればtrue、そうでなければfalseを返します。

このサンプルコードは、ウェブフォームを通じてユーザーがファイルをアップロードする一連の処理を示しています。まず、フォームがPOSTメソッドで送信され、ファイルが選択されたことを確認します。次に、アップロード中にエラーが発生していないかを詳細にチェックし、一時的にサーバーに保存されたファイルのパスを取得します。

ここでis_file関数が重要な役割を果たします。is_file($tmpFilePath)と記述することで、アップロードされた一時ファイルが実際にサーバー上に存在し、通常のファイルとして認識されているかを検証します。この確認は、後続のファイル移動処理を安全に進めるための基本的なステップです。

検証が成功すれば、一時ファイルを指定された保存先ディレクトリへmove_uploaded_file関数を用いて安全に移動させます。万が一、一時ファイルが見つからなかったり、移動に失敗したりした場合は、適切なエラーメッセージを表示し、問題をユーザーに伝えます。この一連の処理を通じて、is_file関数がファイルアップロード処理の信頼性を高める上でどのように利用されるかを学ぶことができます。