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

Copy
1<?php
2
3/**
4 * DirectoryIterator::isWritable メソッドの使用例を示します。
5 * 指定されたディレクトリ内のファイルやディレクトリが書き込み可能であるかを確認します。
6 *
7 * @return void
8 */
9function demonstrateDirectoryIteratorIsWritable(): void
10{
11    // チェック対象のディレクトリパス。ここではカレントディレクトリ('.')を使用します。
12    $directoryPath = '.'; 
13
14    try {
15        // DirectoryIterator オブジェクトを作成します。
16        // これにより、指定されたディレクトリの内容を反復処理できます。
17        $iterator = new DirectoryIterator($directoryPath);
18
19        echo "--- ディレクトリ '{$directoryPath}' 内の要素の書き込み権限チェック ---\n";
20
21        // ディレクトリ内の各要素をループ処理します。
22        foreach ($iterator as $fileinfo) {
23            // "." (カレントディレクトリ) および ".." (親ディレクトリ) はスキップします。
24            if ($fileinfo->isDot()) {
25                continue;
26            }
27
28            // 要素の名前を取得します。
29            $filename = $fileinfo->getFilename();
30
31            // isWritable() メソッドを呼び出し、要素が書き込み可能かを確認します。
32            // 戻り値は bool (true または false) です。
33            $isWritable = $fileinfo->isWritable();
34
35            // 要素の種類を判断します。
36            $type = 'その他';
37            if ($fileinfo->isFile()) {
38                $type = 'ファイル';
39            } elseif ($fileinfo->isDir()) {
40                $type = 'ディレクトリ';
41            }
42
43            // 結果を整形して出力します。
44            echo sprintf(
45                "%-25s [%s] は書き込み可能: %s\n",
46                $filename,
47                $type,
48                $isWritable ? 'はい' : 'いいえ'
49            );
50        }
51
52        echo "-------------------------------------------------------\n";
53
54    } catch (UnexpectedValueException $e) {
55        // DirectoryIterator のコンストラクタは、指定されたパスが無効な場合に
56        // UnexpectedValueException をスローすることがあります。
57        echo "エラー: ディレクトリ '{$directoryPath}' にアクセスできません。\n";
58        echo "詳細: " . $e->getMessage() . "\n";
59    }
60}
61
62// 関数を実行して、結果を出力します。
63demonstrateDirectoryIteratorIsWritable();
64

PHPのDirectoryIterator::isWritableメソッドは、ファイルシステム上の特定の要素（ファイルまたはディレクトリ）が、現在のPHPスクリプトを実行しているユーザーによって書き込み可能であるかを確認するために利用されます。このメソッドはDirectoryIteratorクラスのオブジェクトに対して呼び出され、そのオブジェクトが指し示す要素の書き込み権限をチェックします。

isWritableメソッドは引数を必要とせず、呼び出すと結果を真偽値（bool）で返します。具体的には、書き込みが可能であればtrue（真）、書き込みができない場合はfalse（偽）を返します。これにより、ファイルへのデータの書き込みやディレクトリへの新しいファイルの作成など、書き込み操作を行う前にその可否をプログラムで判断できます。

サンプルコードでは、DirectoryIteratorを使用してカレントディレクトリ内の各要素を順に走査しています。ループ内で$fileinfo->isWritable()を呼び出すことで、個々のファイルやサブディレクトリが書き込み可能であるかを確認し、その結果を「はい」または「いいえ」で出力しています。これは、プログラムが安全にファイル操作を行うための事前チェックとして非常に有効な手段となります。

Copy
1<?php
2
3/**
4 * 指定されたディレクトリ内のファイルとサブディレクトリの書き込み可能性をチェックします。
5 * DirectoryIterator::isWritable() メソッドは、イテレータが現在指している項目（ファイルやディレクトリ）が
6 * スクリプトを実行しているユーザーにとって書き込み可能であるかを判定します。
7 *
8 * @param string $path チェック対象のディレクトリパス
9 */
10function checkDirectoryWritableStatus(string $path): void
11{
12    try {
13        // DirectoryIterator のインスタンスを作成
14        // 指定されたパスが存在しない、またはアクセス権がない場合はここで例外が発生します。
15        $iterator = new DirectoryIterator($path);
16        echo "ディレクトリ '{$path}' 内の項目書き込み可能性チェック:\n";
17        echo "--------------------------------------------------\n";
18
19        // ディレクトリ内の各項目（ファイル、サブディレクトリ）をイテレート
20        foreach ($iterator as $fileinfo) {
21            // '.' (カレントディレクトリ) と '..' (親ディレクトリ) はスキップ
22            if ($fileinfo->isDot()) {
23                continue;
24            }
25
26            $name = $fileinfo->getFilename(); // 項目の名前を取得
27            $type = ''; // 項目の種類を示す文字列
28
29            // 項目の種類を判定
30            if ($fileinfo->isFile()) {
31                $type = 'ファイル';
32            } elseif ($fileinfo->isDir()) {
33                $type = 'ディレクトリ';
34            } else {
35                $type = 'その他'; // シンボリックリンクなど
36            }
37
38            // isWritable() メソッドを使用して書き込み可能か判定
39            $writableStatus = $fileinfo->isWritable() ? '書き込み可能' : '書き込み不可';
40
41            // 結果を出力
42            echo " - {$type}: '{$name}' は {$writableStatus} です。\n";
43        }
44        echo "--------------------------------------------------\n";
45
46    } catch (UnexpectedValueException $e) {
47        // ディレクトリが見つからない、または開けない場合の例外処理
48        echo "エラー: ディレクトリ '{$path}' を開けませんでした。 ({$e->getMessage()})\n";
49        echo "考えられる原因: ディレクトリが存在しないか、アクセス権限がありません。\n";
50    }
51}
52
53// -----------------------------------------------------------------------------
54// サンプルコードの実行部分
55// -----------------------------------------------------------------------------
56
57// 一時ディレクトリを作成し、テスト用のファイルやディレクトリを準備します。
58$tempDir = __DIR__ . '/temp_writable_test';
59if (!file_exists($tempDir)) {
60    mkdir($tempDir, 0755, true); // ディレクトリが存在しない場合は作成 (0755は一般的なパーミッション)
61    echo "一時ディレクトリ '{$tempDir}' を作成しました。\n";
62}
63
64// 1. 書き込み可能なファイルを作成
65// デフォルトでPHPスクリプトの実行ユーザーには書き込み権限があるため、isWritable()はtrueを返します。
66$writableFile = $tempDir . '/writable_file.txt';
67file_put_contents($writableFile, 'これは書き込み可能なファイルです。');
68echo "書き込み可能ファイル '{$writableFile}' を作成しました。\n";
69
70// 2. 意図的に書き込み不可のファイルを作成（UNIX系OSでのみ動作を保証）
71// このファイルはPHPスクリプトの実行ユーザーに対しても書き込み不可に設定されます。
72// Windows環境ではchmodの挙動が異なる場合があるため、結果が異なる可能性があります。
73$unwritableFile = $tempDir . '/unwritable_file.txt';
74file_put_contents($unwritableFile, 'これは書き込み不可のファイルとして設定されます。');
75chmod($unwritableFile, 0444); // ファイルのパーミッションを読み取り専用 (r--r--r--) に設定
76echo "書き込み不可ファイル '{$unwritableFile}' を作成し、パーミッションを0444に設定しました。\n";
77
78// 3. サブディレクトリを作成
79// 通常、サブディレクトリもPHPスクリプトの実行ユーザーにとって書き込み可能です。
80$subDir = $tempDir . '/sub_directory';
81if (!file_exists($subDir)) {
82    mkdir($subDir, 0755);
83    echo "サブディレクトリ '{$subDir}' を作成しました。\n";
84}
85
86// サンプル関数を実行して、作成したディレクトリとファイルの書き込み可能性をチェック
87echo "\n--- テストディレクトリの項目をチェック ---\n";
88checkDirectoryWritableStatus($tempDir);
89
90// 存在しないディレクトリをチェックするケース
91echo "\n--- 存在しないディレクトリをチェック ---\n";
92checkDirectoryWritableStatus(__DIR__ . '/non_existent_directory');
93
94// -----------------------------------------------------------------------------
95// クリーンアップ処理
96// -----------------------------------------------------------------------------
97echo "\n--- クリーンアップ中 ---\n";
98if (file_exists($writableFile)) {
99    unlink($writableFile); // 書き込み可能なファイルを削除
100}
101if (file_exists($unwritableFile)) {
102    // 読み取り専用に設定されたファイルも、所有者であればunlink()で削除可能です。
103    unlink($unwritableFile); // 書き込み不可ファイルを削除
104}
105if (file_exists($subDir)) {
106    rmdir($subDir); // サブディレクトリを削除
107}
108if (file_exists($tempDir)) {
109    rmdir($tempDir); // 一時ディレクトリを削除
110}
111echo "クリーンアップ完了。\n";
112
113?>

PHPのDirectoryIterator::isWritable()メソッドは、ファイルシステム上の特定の項目（ファイルやディレクトリ）が、現在PHPスクリプトを実行しているユーザーによって書き込み可能であるかを判定する際に利用されます。このメソッドは引数を取らず、戻り値として真偽値（bool）を返します。書き込み可能であればtrueを、そうでなければfalseを返します。

提供されたサンプルコードでは、まずcheckDirectoryWritableStatus関数が定義されており、指定されたディレクトリパスを受け取ります。この関数はDirectoryIteratorクラスを使ってディレクトリ内の各項目を走査し、ファイル、サブディレクトリ、およびその他の項目ごとにisWritable()メソッドを呼び出して書き込み可能性をチェックしています。

コードの実行部分では、一時ディレクトリを作成し、書き込み可能なファイル、パーミッションを0444（読み取り専用）に設定した書き込み不可ファイル、そしてサブディレクトリを準備しています。これらの項目に対してcheckDirectoryWritableStatus関数を実行することで、isWritable()メソッドがファイルの種類やパーミッション設定に応じてどのようにtrueやfalseを返すかを確認できます。特に、chmod 0444で設定されたファイルが「書き込み不可」と判定される点が重要なポイントです。また、存在しないディレクトリパスを渡した場合にはUnexpectedValueExceptionが発生し、適切なエラーメッセージが表示される例外処理も含まれています。このメソッドは、ファイル操作を行う前に権限チェックを行うことで、プログラムの堅牢性を高めるのに役立ちます。