【PHP8.x】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を実行するプロセスには権限が与えられていないといった状況が起こり得るためです。ファイルを操作する際は、事前にこの関数で書き込み権限を確認することが推奨されます。