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

Copy
1<?php
2
3/**
4 * ファイルの存在を確認し、内容を読み込むサンプルスクリプト
5 *
6 * システムエンジニアを目指す初心者向けに、file_exists() と file() 関数の基本的な使い方を示します。
7 * file_exists() でファイルが存在するかを事前に確認し、安全に file() 関数を使用する流れが重要です。
8 */
9
10// テスト用のファイル名と内容を定義
11$testFilename = 'sample_data.txt';
12$testContent = "ライン1: PHP学習\nライン2: ファイル操作の基礎\nライン3: システムエンジニアへの道\n";
13
14// --- 1. ファイルが存在する場合の処理例 ---
15
16// テストファイルを作成します。
17// file_put_contents() は、指定されたファイルに文字列を書き込む関数です。
18if (file_put_contents($testFilename, $testContent) === false) {
19    echo "エラー: テストファイルの作成に失敗しました。\n";
20    exit(1); // 処理を終了
21}
22echo "テストファイル '{$testFilename}' を作成しました。\n";
23
24// file_exists() 関数で、ファイルが存在するかどうかを確認します。
25// 戻り値は bool (true または false) です。
26if (file_exists($testFilename)) {
27    echo "ファイル '{$testFilename}' は存在します。\n";
28
29    // file() 関数でファイルを読み込みます。
30    // 戻り値は、ファイルの各行を要素とする配列、または失敗した場合は false です。
31    // FILE_IGNORE_NEW_LINES フラグは、各行の末尾にある改行文字（\n）を削除します。
32    $lines = file($testFilename, FILE_IGNORE_NEW_LINES);
33
34    if ($lines !== false) {
35        echo "--- ファイルの内容 ---\n";
36        foreach ($lines as $lineNum => $line) {
37            echo "行 " . ($lineNum + 1) . ": " . $line . "\n";
38        }
39        echo "----------------------\n";
40    } else {
41        echo "エラー: ファイル '{$testFilename}' の読み込みに失敗しました。\n";
42    }
43} else {
44    // ここには到達しないはずですが、念のためエラーメッセージを表示
45    echo "エラー: ファイル '{$testFilename}' が見つかりませんでした。\n";
46}
47
48// --- 2. ファイルが存在しない場合の処理例 ---
49
50echo "\n--- ファイルが存在しない場合の確認 ---\n";
51
52// 作成したテストファイルを削除します。
53// unlink() は、ファイルを削除する関数です。
54if (unlink($testFilename)) {
55    echo "テストファイル '{$testFilename}' を削除しました。\n";
56} else {
57    echo "エラー: テストファイルの削除に失敗しました。\n";
58}
59
60// 削除されたファイルが存在するかを再度確認します。
61if (file_exists($testFilename)) {
62    // このブロックには到達しないはずです。
63    echo "エラー: ファイル '{$testFilename}' がまだ存在します。\n";
64} else {
65    echo "ファイル '{$testFilename}' は存在しません。\n";
66
67    // ファイルが存在しない状態で file() 関数を呼び出すと、false が返されます。
68    $lines = file($testFilename, FILE_IGNORE_NEW_LINES);
69
70    if ($lines === false) {
71        echo "ファイルが存在しないため、file() 関数は期待通り false を返しました。\n";
72    } else {
73        echo "エラー: ファイルが存在しないにもかかわらず、file() が false 以外を返しました。\n";
74    }
75}
76
77?>

PHPのfile()関数は、指定されたファイルの全内容を読み込み、その内容を行ごとに分割して配列として返す機能を提供します。主にテキストファイルの内容を一括で取得する際に利用され、第一引数に読み込むファイルのパスを文字列で指定します。オプションの第二引数$flagsには、例えばFILE_IGNORE_NEW_LINESを指定することで、読み込んだ各行の末尾にある改行文字を自動的に削除できます。ファイルの読み込みが成功すると、各行を要素とする文字列の配列が戻り値として返されますが、ファイルが見つからない場合や読み込み権限がないなどのエラーが発生した場合はfalseを返します。

システム開発においてファイルを扱う際は、安全性を確保することが極めて重要です。そのため、file()関数を呼び出す前に、file_exists()関数を使って対象のファイルが実際に存在するかどうかを確認する習慣をつけましょう。file_exists()関数は、ファイルが存在すればtrueを、存在しなければfalseを戻り値として返すため、ファイルの有無によって処理を分岐させ、不要なエラーを防ぐことができます。サンプルコードでは、まずテストファイルを作成し、file_exists()で存在を確認した後にfile()で読み込み、最終的にファイルを削除して存在しない場合のfile()の挙動も示しており、一連のファイル操作の基本的な流れと安全な利用方法を学ぶことができます。

Copy
1<?php
2
3// このスクリプトは、PHPの `file()` 関数を使ってファイルの内容を読み込む方法を示します。
4// `file()` 関数は、ファイル全体を配列として読み込みます。配列の各要素はファイルの1行に対応します。
5
6// 1. デモンストレーション用のダミーファイルを作成します。
7$filename = 'sample_data.txt';
8$fileContent = "こんにちは、PHP！\nこれはテストファイルです。\n3行目のデータ。";
9
10// ファイルの作成が成功したかを確認します。
11if (file_put_contents($filename, $fileContent) === false) {
12    // ファイル作成に失敗した場合、エラーメッセージを出力して終了します。
13    die("エラー: デモンストレーション用のファイル '{$filename}' を作成できませんでした。\n");
14}
15
16echo "デモンストレーション用にファイル '{$filename}' を作成しました。\n";
17echo "--- ファイル内容 ---\n{$fileContent}\n--------------------\n\n";
18
19// 2. `file()` 関数を使ってファイルの内容を読み込みます。
20// デフォルトの挙動 (flags = 0) では、各行の末尾の改行文字も配列の要素に含まれます。
21$linesArray = file($filename);
22
23// 3. 関数呼び出しが成功したかを確認します。
24if ($linesArray === false) {
25    // ファイルの読み込みに失敗した場合、エラーメッセージを出力します。
26    echo "エラー: ファイル '{$filename}' の読み込みに失敗しました。\n";
27} else {
28    // 成功した場合、読み込んだ内容を表示します。
29    echo "`file()` 関数を使ってファイル '{$filename}' を正常に読み込みました。\n";
30    echo "関数は " . count($linesArray) . " 個の要素を持つ配列を返しました。\n\n";
31    echo "配列の内容:\n";
32
33    // 配列の各要素（行）を順番に表示します。
34    foreach ($linesArray as $index => $line) {
35        // `rtrim()` を使うことで、表示の際に各行の末尾にある改行文字や余分な空白を除去し、
36        // コンソール出力を見やすくしています。ただし、元の配列要素には改行文字が含まれたままです。
37        echo "要素 [" . $index . "]: '" . rtrim($line) . "' (元の長さ: " . strlen($line) . " バイト)\n";
38    }
39
40    echo "\n補足: `file()` 関数はデフォルトで各行の改行文字を含みます。\n";
41    echo "      `FILE_IGNORE_NEW_LINES` や `FILE_SKIP_EMPTY_LINES` などのフラグを使用することで、\n";
42    echo "      改行文字を除去したり、空行をスキップしたりできます。\n";
43}
44
45// 4. デモンストレーション用に作成したファイルを削除してクリーンアップします。
46if (file_exists($filename)) {
47    unlink($filename);
48    echo "\nファイル '{$filename}' を削除しました。\n";
49}
50
51?>

PHPのfile()関数は、指定されたファイルの内容を、各行を配列の要素として読み込むための関数です。第一引数$filenameには、読み込みたいファイルのパスを文字列で指定します。成功した場合、ファイルの各行を要素とする配列が返されます。デフォルトでは、この配列の各要素には行末の改行文字も含まれます。

第二引数$flagsはオプションで、ファイルの読み込み方法を制御します。例えば、FILE_IGNORE_NEW_LINESフラグを指定すると各行の改行文字を除去したり、FILE_SKIP_EMPTY_LINESフラグで空行をスキップしたりできます。ファイルの読み込みに失敗した場合はfalseが返されます。

このサンプルコードでは、まずfile_put_contents()関数を使ってダミーのテキストファイルを作成し、その内容をfile()関数で読み込んでいます。読み込まれた内容は配列として取得され、foreachループを使って各行のデータとその長さを表示しています。表示の際にはrtrim()関数で改行文字を一時的に除去し、コンソールでの視認性を高めています。最後に、デモンストレーション用に作成したファイルを削除してクリーンアップを行っています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定されたファイルにコンテンツを書き込みます。
7 *
8 * file_put_contents関数は、ファイルに文字列データを書き込むための推奨される方法です。
9 * ファイルが存在しない場合は新しく作成され、存在する場合はデフォルトでその内容を上書きします。
10 * 成功した場合は書き込まれたバイト数を整数で返し、失敗した場合はfalseを返します。
11 *
12 * @param string $filename 書き込み対象のファイルパス。
13 * @param string $data ファイルに書き込む文字列データ。
14 * @param int $flags 追加の動作を指定するフラグ (例: FILE_APPENDで既存ファイルに追記、0で上書き)。
15 * @return void
16 */
17function writeToFile(string $filename, string $data, int $flags = 0): void
18{
19    // file_put_contents関数を使用してファイルにコンテンツを書き込む。
20    // 第1引数: ファイルパス ($filename)
21    // 第2引数: 書き込むデータ ($data)
22    // 第3引数 (省略可能): フラグ ($flags)。省略時は0となり、既存ファイルを上書きします。
23    $bytesWritten = file_put_contents($filename, $data, $flags);
24
25    // 書き込みの成否をチェック。
26    // 成功すると書き込まれたバイト数 (0以上の整数) を返し、失敗すると false を返します。
27    if ($bytesWritten !== false) {
28        echo "ファイル '{$filename}' に {$bytesWritten} バイト書き込みました。\n";
29        echo "ファイルの内容を確認するには、ターミナルで 'cat {$filename}' コマンドを実行してください。\n";
30    } else {
31        // 書き込みに失敗した場合のエラーメッセージ。
32        // 例: ディレクトリへの書き込み権限がない場合や、パスが無効な場合など。
33        echo "エラー: ファイル '{$filename}' への書き込みに失敗しました。\n";
34    }
35}
36
37// --- サンプル使用例 ---
38
39// 1. 新しいファイルを作成し、内容を書き込む (デフォルト動作: 上書き)
40$sampleFilename1 = 'my_first_document.txt';
41$sampleContent1 = "Hello, PHP file_put_contents!\n";
42$sampleContent1 .= "This is a test line for writing content to a file.\n";
43writeToFile($sampleFilename1, $sampleContent1);
44
45echo "\n"; // 出力を見やすくするための改行
46
47// 2. 既存のファイルに追記する例 (FILE_APPENDフラグを使用)
48// この場合、'my_first_document.txt' の既存の内容に新しい内容が追加されます。
49$sampleFilename2 = 'my_first_document.txt'; // 既存のファイルを指定
50$sampleContent2 = "--- Appended Content ---\n";
51$sampleContent2 .= "This line was added using the FILE_APPEND flag.\n";
52writeToFile($sampleFilename2, $sampleContent2, FILE_APPEND);
53
54echo "\n"; // 出力を見やすくするための改行
55
56// 3. 別のファイルに現在のタイムスタンプを書き込む例
57$logFilename = 'application.log';
58$logContent = date('Y-m-d H:i:s') . " - Application started successfully.\n";
59writeToFile($logFilename, $logContent, FILE_APPEND); // ログファイルは追記が一般的
60
61// 例: 後で作成したファイルを削除したい場合 (このサンプルコードには含まれませんが参考として)
62// unlink('my_first_document.txt');
63// unlink('application.log');
64

PHP 8で利用できるfile_put_contents関数は、指定されたファイルにデータを書き込むための便利な機能です。この関数は、ファイルが存在しない場合は新しく作成し、既存のファイルがある場合は、その内容をデフォルトで上書きします。

引数としては、最初に「$filename」で操作したいファイルのパスを文字列で指定します。次に「$data」としてファイルに書き込む文字列の内容を渡します。そして、省略可能な「$flags」には、FILE_APPENDのような追加の動作を制御する整数値を設定できます。例えば、FILE_APPENDフラグを指定すると、既存の内容を保持したまま末尾に追記されますが、このフラグを指定しない（または0を指定する）場合はファイル全体が上書きされます。

関数が正常に実行されると、ファイルに書き込まれたバイト数を示す整数値が戻り値として返されます。しかし、書き込みに失敗した場合はfalseが返されるため、サンプルコードのように戻り値をチェックして処理の成否を確認することが大切です。この関数は、ログの記録や設定ファイルの保存など、さまざまな場面でファイルの書き込み処理に活用されます。

Copy
1<?php
2
3/**
4 * ファイルを読み込み、その内容とサイズを表示するサンプル関数です。
5 * 
6 * システムエンジニアを目指す初心者の方にも分かりやすいように、
7 * PHPの組み込み関数 `file()` と `filesize()` の基本的な使い方を示します。
8 * `file()` 関数は、ファイルの内容を各行ごとに配列の要素として読み込みます。
9 * `filesize()` 関数は、ファイルのサイズをバイト単位で取得します。
10 */
11function demonstrateFileAndFilesize(): void
12{
13    // テスト用のファイル名を設定します。一時ファイルを使用します。
14    $filename = 'example_file.txt';
15
16    // ファイルに書き込む内容です。
17    $fileContent = "これは1行目のテキストです。\n";
18    $fileContent .= "これは2行目のテキストです。\n";
19    $fileContent .= "これは3行目のテキストです。\n";
20
21    // テストファイルを作成し、内容を書き込みます。
22    // file_put_contents() は、ファイルを書き込むためのシンプルな関数です。
23    if (file_put_contents($filename, $fileContent) === false) {
24        echo "エラー: ファイル '{$filename}' の作成に失敗しました。\n";
25        return;
26    }
27
28    echo "ファイル '{$filename}' を作成しました。\n";
29
30    // file() 関数を使ってファイルの内容を配列として読み込みます。
31    // 第2引数 $flags に FILE_IGNORE_NEW_LINES を指定すると、各行末の改行文字を削除します。
32    // 第2引数 $flags に FILE_SKIP_EMPTY_LINES を指定すると、空行をスキップします。
33    // これらのフラグはビットOR演算子 `|` で複数指定できます。
34    $lines = file($filename, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
35
36    if ($lines === false) {
37        echo "エラー: ファイル '{$filename}' の読み込みに失敗しました。\n";
38    } else {
39        echo "ファイルの内容 (file() 関数で読み込み): \n";
40        foreach ($lines as $lineNumber => $line) {
41            echo "  行 " . ($lineNumber + 1) . ": " . $line . "\n";
42        }
43    }
44
45    // filesize() 関数を使ってファイルのサイズをバイト単位で取得します。
46    // PHP 8では、filesize() が失敗した場合に false を返すことがあります。
47    $size = filesize($filename);
48
49    if ($size === false) {
50        echo "エラー: ファイル '{$filename}' のサイズ取得に失敗しました。\n";
51    } else {
52        echo "ファイル '{$filename}' のサイズ: {$size} バイト\n";
53    }
54
55    // 使用後、テストファイルを削除します。
56    // unlink() 関数はファイルを削除します。
57    if (unlink($filename)) {
58        echo "ファイル '{$filename}' を削除しました。\n";
59    } else {
60        echo "エラー: ファイル '{$filename}' の削除に失敗しました。\n";
61    }
62}
63
64// 関数を実行します。
65demonstrateFileAndFilesize();
66
67?>

PHPのfile()関数は、指定されたファイルを読み込み、その内容を各行ごとに配列の要素として返します。第1引数$filenameには読み込むファイルのパスを指定します。第2引数$flagsには、行末の改行文字を削除するFILE_IGNORE_NEW_LINESや空行をスキップするFILE_SKIP_EMPTY_LINESなど、読み込み動作を制御するオプションを複数指定できます。成功すると文字列の配列を返し、失敗した場合はfalseを返します。

一方、filesize()関数は、指定されたファイルのサイズをバイト単位で取得します。この関数も第1引数$filenameにファイルのパスを指定します。ファイルのサイズ取得に成功するとファイルサイズを示す整数値を返し、失敗した場合はfalseを返します。PHP 8では、これらの関数がエラー時にfalseを返す挙動に注意が必要です。

サンプルコードでは、まずテスト用のファイルを作成し、内容を書き込みます。次にfile()関数を使ってファイルを行ごとに読み込み、内容と行数を表示します。FILE_IGNORE_NEW_LINESとFILE_SKIP_EMPTY_LINESフラグの使用例も確認できます。最後にfilesize()関数でファイルのサイズをバイト単位で取得して表示し、テストファイルを削除しています。これらの関数は、ファイルの内容を読み込んだり、サイズを確認したりする基本的なファイル操作に役立ちます。