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

Copy
1<?php
2
3/**
4 * is_writable関数を使ってファイルが書き込み可能かどうかを確認するサンプルコードです。
5 *
6 * システムエンジニアを目指す初心者向けに、ファイルが書き込み可能でない場合と
7 * 書き込み可能である場合の両方のシナリオを示します。
8 */
9
10// 1. 一時ファイルパスを生成
11// sys_get_temp_dir() はシステムの一時ディレクトリのパスを返します。
12// DIRECTORY_SEPARATOR はOSに応じたディレクトリ区切り文字 ('/' または '\') です。
13$testFilePath = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'test_file_writable_check.txt';
14
15// 2. テスト用ファイルを作成し、初期コンテンツを書き込む
16// file_put_contents() はファイルにデータを書き込みます。
17// 書き込みに失敗した場合は die() で処理を停止します。
18if (file_put_contents($testFilePath, "This is a test file content.") === false) {
19    die("エラー: テストファイルの作成に失敗しました: " . $testFilePath . PHP_EOL);
20}
21
22echo "テストファイル: " . $testFilePath . " が作成されました。" . PHP_EOL;
23
24// 3. ファイルを意図的に書き込み不可にするシナリオ
25// chmod() はファイルのパーミッションを変更します。
26// 0444 は、ファイル所有者、グループ、その他のユーザーに対して「読み取り専用」
27// パーミッションを設定することを意味します。
28if (chmod($testFilePath, 0444) === false) {
29    echo "警告: chmodでパーミッションを0444に変更できませんでした。" . PHP_EOL;
30}
31
32echo PHP_EOL . "--- 書き込み不可のシナリオ ---" . PHP_EOL;
33
34// is_writable() 関数でファイルが書き込み可能かチェック
35if (!is_writable($testFilePath)) {
36    // ファイルが書き込み可能でない場合の処理
37    echo "✓ 成功: ファイルは書き込み不可です。期待通りの動作です。" . PHP_EOL;
38    echo "  (例: このファイルへのデータ書き込みは拒否されます)" . PHP_EOL;
39    // 通常、ここでエラーログへの記録、ユーザーへの通知、代替処理の実行などが行われます。
40} else {
41    // ファイルが書き込み可能な場合の処理 (このパスは通常通らないはず)
42    echo "✗ 失敗: ファイルは書き込み可能です。パーミッションが正しく設定されていない可能性があります。" . PHP_EOL;
43}
44
45// 4. ファイルを書き込み可能に戻すシナリオ
46// 0644 は、ファイル所有者に「読み書き」、グループとその他のユーザーに「読み取り専用」
47// パーミッションを設定することを意味します。
48if (chmod($testFilePath, 0644) === false) {
49    echo "警告: chmodでパーミッションを0644に変更できませんでした。" . PHP_EOL;
50}
51
52echo PHP_EOL . "--- 書き込み可能のシナリオ ---" . PHP_EOL;
53
54// is_writable() 関数で再度チェック
55if (is_writable($testFilePath)) {
56    // ファイルが書き込み可能な場合の処理
57    echo "✓ 成功: ファイルは書き込み可能です。期待通りの動作です。" . PHP_EOL;
58    // ファイルへの追加書き込みを試みる
59    if (file_put_contents($testFilePath, "\nAppended new line at " . date('Y-m-d H:i:s'), FILE_APPEND) !== false) {
60        echo "  ファイルに新しい内容が正常に書き込まれました。" . PHP_EOL;
61    } else {
62        echo "  エラー: ファイルへの書き込みに失敗しました。" . PHP_EOL;
63    }
64} else {
65    // ファイルが書き込み可能でない場合の処理 (このパスは通常通らないはず)
66    echo "✗ 失敗: ファイルは書き込み不可です。パーミッションが正しく設定されていない可能性があります。" . PHP_EOL;
67}
68
69// 5. テスト終了後、作成した一時ファイルを削除
70// unlink() はファイルを削除します。
71if (unlink($testFilePath)) {
72    echo PHP_EOL . "テストファイル: " . $testFilePath . " が削除されました。" . PHP_EOL;
73} else {
74    echo PHP_EOL . "エラー: テストファイル " . $testFilePath . " の削除に失敗しました。" . PHP_EOL;
75}
76

PHPのis_writable関数は、指定したファイルパスが現在のスクリプトにとって書き込み可能であるかどうかを確認するために使用されます。この関数は、引数として検証したいファイルのパスをstring型で受け取ります。そして、ファイルが書き込み可能であればtrue（真）を、書き込み不可であればfalse（偽）をbool型で返します。

システム開発において、ファイルへのデータの保存やログの書き込みを行う前に、そのファイルやディレクトリに書き込み権限があるかを確認することは非常に重要です。例えば、ファイルにデータを書き込もうとした際に「php expression is not writable」のようなエラーが発生するのを防ぐために、事前にこの関数でチェックすることができます。

サンプルコードでは、まず一時ファイルを作成し、chmod関数で意図的にパーミッションを書き込み不可（読み取り専用の0444）に変更してis_writable関数を適用しています。この場合、ファイルが書き込み不可として正しく判定され、falseが返されることが確認できます。次に、パーミッションを書き込み可能（読み書き可能な0644）に戻し、再度is_writable関数でチェックすると、ファイルが書き込み可能と判定され、trueが返って実際にファイルへ追記できることを示しています。このように、is_writable関数を利用することで、安全かつ堅牢なファイル操作処理を実装できます。

Copy
1<?php
2
3/**
4 * 指定されたパス（ファイルまたはディレクトリ）が書き込み可能かどうかをチェックします。
5 *
6 * この関数は、PHPの組み込み関数 `is_writable()` を使用し、
7 * 特にシステムエンジニア初心者がファイルシステム権限を理解するのに役立つよう設計されています。
8 *
9 * @param string $path チェックするファイルまたはディレクトリのパス。
10 * @return bool パスが書き込み可能であれば true、そうでなければ false を返します。
11 */
12function checkPathWritability(string $path): bool
13{
14    // is_writable() は、パスが存在しない場合でも、
15    // そのパスにファイルやディレクトリを作成できるかどうかのチェックも行えます。
16    // しかし、ここでは主に既存のディレクトリの権限チェックを目的とします。
17    return is_writable($path);
18}
19
20// --- 初心者向けサンプルコード ---
21
22// 1. チェック対象となるディレクトリのパスを定義します。
23// __DIR__ を使用することで、このスクリプトがあるディレクトリからの相対パスとなります。
24// このディレクトリは、デモンストレーションのために存在しない場合は作成を試みます。
25$targetDirectory = __DIR__ . '/test_uploads';
26
27// --- 重要: ディレクトリが存在することを確認、または作成します ---
28if (!is_dir($targetDirectory)) {
29    echo "ディレクトリ '{$targetDirectory}' が存在しません。作成を試みます..." . PHP_EOL;
30    // ディレクトリを作成します。0755 は一般的なWebサーバーでのディレクトリ権限です。
31    // 3番目の引数 'true' は、親ディレクトリが存在しない場合に再帰的に作成します。
32    if (mkdir($targetDirectory, 0755, true)) {
33        echo "ディレクトリが正常に作成されました。" . PHP_EOL;
34    } else {
35        echo "ディレクトリ '{$targetDirectory}' の作成に失敗しました。" . PHP_EOL;
36        echo "親ディレクトリの権限を確認するか、手動で作成してください。" . PHP_EOL;
37        // 作成に失敗した場合でも、is_writable() 自体は実行できますが、結果は false になるでしょう。
38    }
39}
40
41echo PHP_EOL; // 見やすくするために改行を追加
42
43// 2. 作成した、または既存のディレクトリの書き込み権限をチェックします。
44if (checkPathWritability($targetDirectory)) {
45    echo "結果: ディレクトリ '{$targetDirectory}' は書き込み可能です。" . PHP_EOL;
46    echo "これは、PHPプロセスがこのディレクトリ内にファイルを作成および変更する権限を持つことを意味します。" . PHP_EOL;
47} else {
48    echo "結果: ディレクトリ '{$targetDirectory}' は書き込み可能ではありません。" . PHP_EOL;
49    echo "ファイルシステム権限を調整する必要があるかもしれません (例: Linuxで 'chmod 0777 {$targetDirectory}' を使用しますが、0777は注意して使用してください)。" . PHP_EOL;
50}
51
52echo PHP_EOL; // 見やすくするために改行を追加
53
54// --- 別の例: システムの一時ディレクトリをチェック ---
55// これは、システム全体の書き込み可能性をテストするのによく使用されます。
56$systemTempDir = sys_get_temp_dir();
57
58echo "システムの一時ディレクトリ: '{$systemTempDir}' をチェック中..." . PHP_EOL;
59if (checkPathWritability($systemTempDir)) {
60    echo "結果: システムの一時ディレクトリ '{$systemTempDir}' は書き込み可能です。" . PHP_EOL;
61} else {
62    echo "結果: システムの一時ディレクトリ '{$systemTempDir}' は書き込み可能ではありません。" . PHP_EOL;
63    echo "これは、重大なシステム設定の問題を示している可能性があります。" . PHP_EOL;
64}
65
66// 注意: サンプルコードの自己完結性を保つため、作成したディレクトリの自動削除は行いません。
67// 手動で 'test_uploads' ディレクトリを削除してください。
68
69?>

PHPのis_writable関数は、指定されたファイルまたはディレクトリに対して、PHPのプロセスがデータの書き込み操作を行えるかどうかを判定する際に使用します。

この関数は、引数として書き込み可能性をチェックしたいstring $filename（ファイルやディレクトリのパス）を一つ受け取ります。そして、PHPプロセスがそのパスに対してファイルやディレクトリの作成・変更・削除などの書き込み操作を行える場合にtrueを、そうでない場合にfalseをbool型の戻り値として返します。

サンプルコードでは、まず__DIR__ . '/test_uploads'というパスにディレクトリを作成し、そのディレクトリが書き込み可能であるかをis_writable関数を用いて確認しています。これは、例えばユーザーがファイルをアップロードする際、その保存先ディレクトリにPHPが書き込む権限があるかを確認する一般的なシナリオを想定しています。もし書き込みが不可能であれば、通常はファイルシステム上の権限（パーミッション）設定を見直す必要があります。

さらに、sys_get_temp_dir()で取得できるシステムの一時ディレクトリについても同様に書き込み可能かチェックする例が示されています。これは、アプリケーションが一時ファイルを生成する際の基本的な動作環境の確認に役立ちます。is_writable関数は、ファイルシステム権限に関する問題を診断し、適切に対応するために非常に重要な機能です。

Copy
1<?php
2
3/**
4 * PHPのis_writable関数がfalseを返すケースを示すサンプルコード。
5 * ファイルが存在しない場合、is_writableはfalseを返します。
6 *
7 * @return void
8 */
9function demonstrateIsWritableReturnsFalse(): void
10{
11    // 実際に存在しないファイルのパスを定義します。
12    // is_writable関数は、ファイルが存在しない場合、書き込み可能ではないと判断します。
13    $nonExistentFilePath = 'this_file_does_not_exist_for_test.txt';
14
15    // is_writable関数を呼び出し、結果をチェックします。
16    // このファイルは存在しないため、is_writableはfalseを返します。
17    if (is_writable($nonExistentFilePath)) {
18        // このブロックは通常、実行されません。
19        echo "ファイル '{$nonExistentFilePath}' は書き込み可能です。\n";
20    } else {
21        // ファイルが存在しないため、is_writableはfalseを返し、このブロックが実行されます。
22        echo "ファイル '{$nonExistentFilePath}' は書き込み不可能です。\n";
23        echo "（理由: ファイルが存在しないか、または書き込みパーミッションがありません。）\n";
24    }
25}
26
27// サンプル関数を実行します。
28demonstrateIsWritableReturnsFalse();
29
30?>

PHPのis_writable関数は、指定したファイルやディレクトリが書き込み可能であるかどうかを判定するために使用します。この関数には、$filenameという引数で検査したいファイルまたはディレクトリのパスを文字列として渡します。戻り値は真偽値（bool）で、書き込み可能であればtrueを、そうでなければfalseを返します。

サンプルコードは、is_writable関数がfalseを返す具体的なケースとして、ファイルが存在しない場合を示しています。コード内で定義されているthis_file_does_not_exist_for_test.txtは、実際にシステム上に存在しないファイルパスです。is_writable関数は、指定されたパスにファイルが存在しない場合、書き込みが不可能であると判断します。

そのため、is_writable($nonExistentFilePath)を実行すると、戻り値としてfalseが返されます。これにより、if文の条件式が偽となり、elseブロック内の「ファイル 'this_file_does_not_exist_for_test.txt' は書き込み不可能です。（理由: ファイルが存在しないか、または書き込みパーミッションがありません。）」というメッセージが表示されます。このように、is_writable関数は、ファイルが存在しない場合や、存在しても書き込み権限がない場合にfalseを返し、ファイル操作時のエラー回避に役立ちます。

Copy
1<?php
2
3/**
4 * ファイルまたはディレクトリの書き込み権限をチェックし、結果を出力するサンプル関数です。
5 *
6 * is_writable() 関数は、指定されたパスにPHPスクリプトが書き込み可能かどうかを調べます。
7 * 書き込み可能であれば true を、そうでなければ false を返します。
8 *
9 * @param string $filename チェックするファイルまたはディレクトリのパス。
10 */
11function demonstrateIsWritable(string $filename): void
12{
13    echo "ファイル/ディレクトリ: '{$filename}' の書き込み権限をチェックします。" . PHP_EOL;
14
15    // is_writable() は、ファイルが存在し、かつ書き込み可能である場合に true を返します。
16    // ファイルが存在しない場合も false を返します。
17    if (is_writable($filename)) {
18        echo "=> '{$filename}' は書き込み可能です。" . PHP_EOL;
19    } else {
20        echo "=> '{$filename}' は書き込み不可能です。" . PHP_EOL;
21        echo "   - 可能性のある原因:" . PHP_EOL;
22        echo "     1. 指定されたファイルまたはディレクトリが存在しない。" . PHP_EOL;
23        echo "     2. PHPを実行しているユーザーが、ファイルまたはディレクトリへの書き込み権限を持っていない。" . PHP_EOL;
24        echo "     3. ファイルが別のプロセスによってロックされている可能性がある。" . PHP_EOL;
25        echo "   - 注意: 特にWindows環境では、ファイルシステムやセキュリティ設定、" . PHP_EOL;
26        echo "     UAC (ユーザーアカウント制御) の影響により、書き込み権限が制限され、" . PHP_EOL;
27        echo "     is_writable() が false を返すケースが多く見られます。" . PHP_EOL;
28    }
29    echo PHP_EOL;
30}
31
32// -------------------------------------------------------------------
33// サンプル実行
34// -------------------------------------------------------------------
35
36// 一時ディレクトリのパスを取得
37$tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR;
38
39// 1. 一時ファイルを作成し、書き込み可能かチェックする例
40// (通常は書き込み可能であると想定される)
41$writableTestFile = $tempDir . 'writable_test_' . uniqid() . '.txt';
42if (file_put_contents($writableTestFile, 'test data for writable check')) {
43    demonstrateIsWritable($writableTestFile); // 結果: 通常は書き込み可能 (true)
44    unlink($writableTestFile); // テスト後、ファイルを削除
45} else {
46    echo "エラー: テストファイル '{$writableTestFile}' の作成に失敗しました。" . PHP_EOL . PHP_EOL;
47}
48
49// 2. 存在しないファイルパスをチェックする例
50// (is_writable() はファイルが存在しない場合 false を返します)
51$nonExistentFile = $tempDir . 'non_existent_file_' . uniqid() . '.txt';
52demonstrateIsWritable($nonExistentFile); // 結果: 書き込み不可能 (false)
53
54// 3. 読み取り専用ファイルを作成し、書き込み可能かチェックする例
55// (権限不足により false を返すケース)
56$readOnlyTestFile = $tempDir . 'readonly_test_' . uniqid() . '.txt';
57if (file_put_contents($readOnlyTestFile, 'test data for read-only check')) {
58    // ファイルのパーミッションを読み取り専用に設定 (Unix系の場合: r--r--r--)
59    // Windows環境ではchmodの挙動が異なる場合がありますが、is_writableは動作します。
60    if (chmod($readOnlyTestFile, 0444)) {
61        demonstrateIsWritable($readOnlyTestFile); // 結果: 通常は書き込み不可能 (false)
62    } else {
63        echo "警告: '{$readOnlyTestFile}' を読み取り専用に設定できませんでした。このシステムではchmodが期待通りに動作しない可能性があります。" . PHP_EOL . PHP_EOL;
64        demonstrateIsWritable($readOnlyTestFile); // 権限変更失敗時のフォールバック
65    }
66    unlink($readOnlyTestFile); // テスト後、ファイルを削除
67} else {
68    echo "エラー: テストファイル '{$readOnlyTestFile}' の作成に失敗しました。" . PHP_EOL . PHP_EOL;
69}
70
71?>

is_writable関数は、指定されたファイルやディレクトリにPHPスクリプトがデータを書き込めるかどうかを判定する際に使用します。引数としてチェックしたいファイルまたはディレクトリのパスを文字列（$filename）で渡します。

この関数は、指定されたパスが書き込み可能であれば真（true）を、書き込み不可能であれば偽（false）をブール値として返します。falseが返される主なケースとしては、指定したファイルやディレクトリが存在しない場合や、PHPが実行されているユーザーアカウントに書き込み権限がない場合などが考えられます。また、ファイルが別のプロセスによってロックされている可能性もあります。

特にWindows環境では、ファイルシステムの設定、セキュリティポリシー、UAC（ユーザーアカウント制御）などの影響により、is_writableがfalseを返すことが多くあります。これは、一見すると書き込み権限があるように見えても、PHPを実行するプロセスには権限が与えられていないといった状況が起こり得るためです。ファイルを操作する際は、事前にこの関数で書き込み権限を確認することが推奨されます。