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

Copy
1<?php
2
3/**
4 * 指定されたパス（ファイルまたはディレクトリ）が書き込み可能かどうかをチェックし、結果を表示します。
5 *
6 * SplFileInfo::isWritable メソッドは、ファイルやディレクトリが存在し、
7 * かつPHPが実行されているユーザーに書き込み権限がある場合に true を返します。
8 * それ以外の場合（パスが存在しない、または権限がない場合）は false を返します。
9 *
10 * @param string $path チェックするファイルまたはディレクトリのパス
11 * @return void
12 */
13function checkPathWriteability(string $path): void
14{
15    echo "パス '{$path}' の書き込み可能性をチェック中...\n";
16
17    // SplFileInfo オブジェクトを作成します。
18    // パスが存在しなくても、このオブジェクトは作成できます。
19    $fileInfo = new SplFileInfo($path);
20
21    // isWritable メソッドを使用して、指定されたパスが書き込み可能かを確認します。
22    if ($fileInfo->isWritable()) {
23        echo "  結果: '{$path}' は書き込み可能です。\n";
24    } else {
25        echo "  結果: '{$path}' は書き込み不可能です。\n";
26        echo "  (ヒント: このパスが存在しないか、PHPを実行しているユーザーに書き込み権限がありません。)\n";
27    }
28    echo "\n";
29}
30
31// --- サンプル実行 ---
32
33// 1. 存在する、書き込み可能なファイルのチェック例
34// 一時的なファイルを準備し、その書き込み可能性をチェックします。
35$writableTestFile = __DIR__ . '/temp_php_writable_test.txt';
36
37// ファイル作成を試みる（成功すれば書き込み可能と仮定）
38if (file_put_contents($writableTestFile, 'This is a test content.') !== false) {
39    checkPathWriteability($writableTestFile);
40    // テスト後、作成したファイルを削除します。
41    unlink($writableTestFile);
42} else {
43    echo "エラー: テストファイル '{$writableTestFile}' の作成に失敗しました。\n";
44    echo "  (PHPを実行しているユーザーにこのディレクトリへの書き込み権限があるか確認してください。)\n\n";
45}
46
47// 2. 存在しないファイルのチェック例
48$nonExistentFile = __DIR__ . '/non_existent_php_file.txt';
49checkPathWriteability($nonExistentFile);
50
51// 3. 存在する、書き込み可能なディレクトリのチェック例
52$writableTestDir = __DIR__ . '/temp_php_writable_dir';
53
54// ディレクトリ作成を試みる（成功すれば書き込み可能と仮定）
55if (!is_dir($writableTestDir)) {
56    mkdir($writableTestDir);
57}
58
59if (is_dir($writableTestDir)) {
60    checkPathWriteability($writableTestDir);
61    // テスト後、作成したディレクトリを削除します。
62    rmdir($writableTestDir);
63} else {
64    echo "エラー: テストディレクトリ '{$writableTestDir}' の作成に失敗しました。\n";
65    echo "  (PHPを実行しているユーザーにこのディレクトリへの書き込み権限があるか確認してください。)\n\n";
66}

PHPのSplFileInfo::isWritableメソッドは、ファイルシステム上の特定のファイルやディレクトリが、PHPを実行しているユーザーにとって書き込み可能であるかどうかを簡潔にチェックするために使用されます。このメソッドはSplFileInfoクラスのオブジェクトから呼び出され、引数は一切必要ありません。戻り値としては真偽値（trueまたはfalse）を返します。

具体的には、指定されたパスのファイルやディレクトリが実際に存在し、かつPHPが動作しているユーザーアカウントにそのパスへの書き込み権限がある場合にtrueが返されます。一方、指定されたパスが存在しない場合や、PHP実行ユーザーに書き込み権限がない場合にはfalseが返されます。

サンプルコードでは、まずSplFileInfoオブジェクトを作成し、そのオブジェクトに対してisWritableメソッドを実行して結果を表示しています。一時的なファイルやディレクトリを作成して書き込み可能性を確認する例や、存在しないファイルが書き込み不可能であると判断される例が示されています。これにより、ファイルやディレクトリへアクセスする前に、安全に書き込み権限の有無を確認し、適切なエラー処理を行うための判断材料として活用できます。

Copy
1<?php
2
3/**
4 * SplFileInfo::isWritable メソッドの動作を示すサンプル関数。
5 *
6 * この関数は、一時ファイルを作成し、その書き込み権限を変更しながら
7 * isWritable() メソッドの挙動をデモンストレーションします。
8 * 最後に一時ファイルをクリーンアップします。
9 */
10function demonstrateIsWritable(): void
11{
12    // 一時ファイルのパスを定義します。
13    // __DIR__ を使うことで、スクリプトと同じディレクトリにファイルが作成されます。
14    $tempFilePath = __DIR__ . DIRECTORY_SEPARATOR . 'test_file_writable.txt';
15
16    // --- シナリオ1: 書き込み可能なファイルの場合 ---
17    echo "--- シナリオ1: 書き込み可能なファイルの場合 ---\n";
18
19    // 1. テストファイルを新規作成（または上書き）し、内容を書き込みます。
20    // この時点で、ファイルは通常、PHPプロセスから書き込み可能になります。
21    if (file_put_contents($tempFilePath, "これはテストデータです。\n") === false) {
22        echo "エラー: テストファイルの作成に失敗しました。ディレクトリの権限を確認してください。\n";
23        // エラー時はこれ以上のデモンストレーションを行わない
24        return;
25    }
26    // 2. ファイルのパーミッションを明示的に設定し、PHPが書き込み可能な状態にします。
27    //    0664 は所有者とグループに読み書き権限、その他に読み取り権限を与えます。
28    chmod($tempFilePath, 0664);
29
30    // 3. SplFileInfo オブジェクトを作成します。
31    $fileInfoWritable = new SplFileInfo($tempFilePath);
32
33    // 4. isWritable() メソッドを使って、ファイルが書き込み可能かどうかをチェックします。
34    if ($fileInfoWritable->isWritable()) {
35        echo "ファイル '{$tempFilePath}' は書き込み可能です。\n";
36    } else {
37        echo "ファイル '{$tempFilePath}' は書き込み不可能です。権限を確認してください。\n";
38    }
39
40    // --- シナリオ2: 書き込み不可能なファイルの場合 ---
41    echo "\n--- シナリオ2: 書き込み不可能なファイルの場合 ---\n";
42
43    // 1. 作成したファイルのパーミッションを書き込み不可（読み取り専用）に変更します。
44    //    0444 は所有者、グループ、その他すべてに読み取り権限のみ与えます。
45    chmod($tempFilePath, 0444);
46
47    // 2. 再度 SplFileInfo オブジェクトを作成（または既存のオブジェクトを再利用）し、isWritable() をチェックします。
48    //    isWritable はファイルの現在の状態をチェックするため、パーミッション変更後に再度チェックします。
49    $fileInfoNotWritable = new SplFileInfo($tempFilePath);
50    if ($fileInfoNotWritable->isWritable()) {
51        echo "ファイル '{$tempFilePath}' は書き込み可能です。\n";
52    } else {
53        echo "ファイル '{$tempFilePath}' は書き込み不可能です。\n";
54        echo "このファイルは読み取り専用に設定されているため、書き込み不可と判断されます。\n";
55    }
56
57    // --- シナリオ3: 存在しないファイルの場合 ---
58    echo "\n--- シナリオ3: 存在しないファイルの場合 ---\n";
59
60    // 1. 存在しないファイルのパスを定義します。
61    $nonExistentFilePath = __DIR__ . DIRECTORY_SEPARATOR . 'non_existent_file.txt';
62
63    // 2. SplFileInfo オブジェクトを作成します。
64    $fileInfoNonExistent = new SplFileInfo($nonExistentFilePath);
65
66    // 3. isWritable() メソッドを使って、ファイルが書き込み可能かどうかをチェックします。
67    //    存在しないファイルに対しては、通常 false を返します。
68    if ($fileInfoNonExistent->isWritable()) {
69        echo "ファイル '{$nonExistentFilePath}' は書き込み可能です。\n";
70    } else {
71        echo "ファイル '{$nonExistentFilePath}' は書き込み不可能です。\n";
72        echo "このファイルは存在しないため、書き込み不可と判断されます。\n";
73    }
74
75    // --- 後処理: テストファイルのクリーンアップ ---
76    // 最後に、作成した一時ファイルを削除して環境を元に戻します。
77    if (file_exists($tempFilePath)) {
78        unlink($tempFilePath);
79        echo "\nテストファイル '{$tempFilePath}' を削除しました。\n";
80    }
81}
82
83// 関数を実行してサンプルコードの動作を確認します。
84demonstrateIsWritable();

SplFileInfo::isWritableは、PHP 8で利用できるファイル情報操作クラスSplFileInfoのメソッドで、指定されたファイルやディレクトリがPHPの実行ユーザーから書き込み可能であるかを確認します。このメソッドは引数を取らず、戻り値は真偽値（bool）です。ファイルが書き込み可能であればtrueを、そうでなければfalseを返します。

具体的には、ファイルが存在し、かつPHPがそのファイルにデータを書き込む権限を持っている場合にtrueを返します。例えば、パーミッションが0664のように設定されたファイルは、通常書き込み可能と判断されます。

一方で、ファイルが存在しても、パーミッションが読み取り専用（例: 0444）に設定されている場合や、そもそも存在しないファイルに対してはfalseを返します。これは、書き込み対象が存在しないため、書き込みができないと判断されるためです。

このメソッドは、ファイルへのデータ保存やログの書き出しなどを行う前に、安全に書き込み操作が可能かどうかを事前に確認したい場合に非常に有用です。これにより、ファイルの書き込みに関するエラーを未然に防ぎ、アプリケーションの安定性を高めることができます。