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

Copy
1<?php
2
3/**
4 * 指定されたディレクトリとそのサブディレクトリ内の各ファイル/ディレクトリの
5 * 書き込み可能性をチェックし、結果を表示する関数。
6 *
7 * RecursiveDirectoryIterator を用いたディレクトリ走査中に、各要素の書き込み権限を
8 * 確認する方法を示します。
9 *
10 * @param string $directoryPath チェック対象のディレクトリパス
11 */
12function checkDirectoryWritePermissions(string $directoryPath): void
13{
14    // ディレクトリが存在しない場合はエラーを表示して終了
15    if (!is_dir($directoryPath)) {
16        echo "エラー: 指定されたディレクトリ '{$directoryPath}' が見つかりません。\n";
17        return;
18    }
19
20    try {
21        // RecursiveDirectoryIterator を使用してディレクトリを再帰的に走査するためのイテレータを作成
22        // RecursiveDirectoryIterator::SKIP_DOTS は . (カレントディレクトリ) と .. (親ディレクトリ) をスキップします。
23        // RecursiveIteratorIterator は、RecursiveDirectoryIterator が返すイテレータを再帰的に処理します。
24        $iterator = new RecursiveIteratorIterator(
25            new RecursiveDirectoryIterator($directoryPath, RecursiveDirectoryIterator::SKIP_DOTS),
26            RecursiveIteratorIterator::SELF_FIRST // ディレクトリ自身も処理対象に含める
27        );
28
29        echo "ディレクトリ '{$directoryPath}' 内の書き込み権限チェック:\n\n";
30
31        /**
32         * RecursiveIteratorIterator の各要素は SplFileInfo オブジェクトです。
33         * この SplFileInfo オブジェクトが isWritable() メソッドを持ちます。
34         *
35         * 提供されたリファレンス情報では「RecursiveDirectoryIterator::isWritable」とありますが、
36         * PHPの実際の仕様ではRecursiveDirectoryIteratorがイテレーション中に返すSplFileInfoオブジェクトの
37         * isWritable() メソッドを指していると考えられます。
38         * このメソッドは、PHPの組み込み関数 is_writable() と同様に、OSレベルでの書き込み権限をチェックします。
39         */
40        foreach ($iterator as $item) {
41            // 現在の要素のパスを取得
42            $path = $item->getPathname();
43            // 現在の要素がディレクトリかファイルかを判断
44            $type = $item->isDir() ? 'ディレクトリ' : 'ファイル';
45
46            // SplFileInfo::isWritable メソッドを使用して書き込み可能かチェック
47            if ($item->isWritable()) {
48                echo "✅ {$type}: '{$path}' は書き込み可能です。\n";
49            } else {
50                echo "❌ {$type}: '{$path}' は書き込み不可能です。\n";
51            }
52        }
53    } catch (UnexpectedValueException $e) {
54        // ディレクトリが見つからない、または開けない場合などの例外を捕捉
55        echo "エラー: ディレクトリ '{$directoryPath}' を開けませんでした。メッセージ: " . $e->getMessage() . "\n";
56    }
57}
58
59// スクリプトが実行されている現在のディレクトリを対象として書き込み権限をチェックします。
60// 必要に応じて、'/' や '/var/www/html' など、別のパスを指定して実行することも可能です。
61checkDirectoryWritePermissions(__DIR__);

PHPのisWritable()メソッドは、ファイルやディレクトリがオペレーティングシステム上で書き込み可能かどうかを確認するために使用されます。このメソッドは、RecursiveDirectoryIteratorなどを用いてディレクトリを再帰的に走査する際に得られる、各ファイルやディレクトリの情報を持つSplFileInfoオブジェクトのメソッドとして利用されます。

引数は不要で、呼び出すと書き込み可能であればtrue（真）、書き込み不可能であればfalse（偽）の真偽値を返します。PHPの組み込み関数is_writable()と同様の機能を提供し、ファイルやディレクトリのアクセス権限を判定する際に役立ちます。

サンプルコードでは、RecursiveDirectoryIteratorとRecursiveIteratorIteratorを組み合わせて、指定されたディレクトリとそのサブディレクトリをすべて走走査しています。そして、走査中に見つかる各ファイルやサブディレクトリに対してisWritable()を適用し、その要素が書き込み可能かどうかを判定し、結果を分かりやすく表示しています。このように、システム内のファイルアクセス権限を効率的に把握できるため、システムエンジニアの業務で役立つでしょう。

Copy
1<?php
2
3/**
4 * RecursiveDirectoryIterator を使用して、指定されたディレクトリ内のファイルとディレクトリの
5 * 書き込み権限を再帰的にチェックするサンプルコードです。
6 *
7 * システムエンジニアを目指す初心者向けに、`isWritable()` メソッドの基本的な使い方を示します。
8 */
9
10// このスクリプトが動作するディレクトリを対象とします。
11// 実際の使用では、書き込み権限をチェックしたいディレクトリのパスを指定してください。
12$targetDirectory = __DIR__;
13
14// 指定されたパスが有効なディレクトリであるかを確認します。
15if (!is_dir($targetDirectory)) {
16    echo "エラー: 指定されたパス '{$targetDirectory}' は存在しないか、ディレクトリではありません。\n";
17    exit(1); // スクリプトを終了
18}
19
20echo "ディレクトリ '{$targetDirectory}' およびそのサブディレクトリ内のファイル/ディレクトリの\n";
21echo "書き込み権限をチェックします...\n\n";
22
23try {
24    // RecursiveDirectoryIterator は、指定されたディレクトリ内の項目を反復処理します。
25    // SKIP_DOTS フラグは、"." (現在のディレクトリ) と ".." (親ディレクトリ) をスキップします。
26    $directoryIterator = new RecursiveDirectoryIterator(
27        $targetDirectory,
28        RecursiveDirectoryIterator::SKIP_DOTS
29    );
30
31    // RecursiveIteratorIterator は、RecursiveDirectoryIterator をラップすることで、
32    // サブディレクトリも再帰的に走査できるようにします。
33    // SELF_FIRST は、現在のディレクトリ内の項目を先に、次にサブディレクトリ内の項目を処理する順序です。
34    $iterator = new RecursiveIteratorIterator(
35        $directoryIterator,
36        RecursiveIteratorIterator::SELF_FIRST
37    );
38
39    /**
40     * ループで各ファイルまたはディレクトリ (SplFileInfo オブジェクト) を処理します。
41     * @var SplFileInfo $fileInfo
42     */
43    foreach ($iterator as $fileInfo) {
44        // 現在の項目 (ファイルまたはディレクトリ) が書き込み可能かどうかをチェックします。
45        // isWritable() メソッドは、書き込み可能であれば true、そうでなければ false を返します。
46        if ($fileInfo->isWritable()) {
47            echo "✔ 書き込み可能: " . $fileInfo->getRealPath() . "\n";
48        } else {
49            // キーワード「php is not writable」に関連する、書き込み不可能な場合の出力です。
50            echo "❌ 書き込み不可: " . $fileInfo->getRealPath() . "\n";
51        }
52    }
53} catch (UnexpectedValueException $e) {
54    // ディレクトリが存在しない、または読み取り権限がない場合に発生する可能性があります。
55    echo "エラー: ディレクトリの読み取り中に問題が発生しました。権限を確認してください。({$e->getMessage()})\n";
56} catch (Exception $e) {
57    // その他の予期せぬエラーを捕捉します。
58    echo "予期せぬエラー: {$e->getMessage()}\n";
59}
60
61?>

このサンプルコードは、PHPのRecursiveDirectoryIteratorとRecursiveIteratorIteratorを組み合わせ、指定されたディレクトリとその中のサブディレクトリに含まれる全てのファイルやディレクトリについて、書き込み権限を再帰的に確認する方法を示しています。

コードではまず、対象とするディレクトリを決め、それが有効なディレクトリであることを確認します。次に、RecursiveDirectoryIteratorでディレクトリの内容を反復処理し、さらにRecursiveIteratorIteratorでサブディレクトリも含めて再帰的に走査できるように準備します。

ループの中で、各ファイルやディレクトリはSplFileInfoオブジェクトとして取得されます。このSplFileInfoオブジェクトのメソッドであるisWritable()は、そのファイルやディレクトリが現在のユーザーにとって書き込み可能かどうかをチェックします。このメソッドは引数を必要とせず、もし書き込み可能であればtrueを、書き込み不可能であればfalseをブール値として返します。サンプルコードでは、このisWritable()の戻り値に基づいて「✔ 書き込み可能」または「❌ 書き込み不可」というメッセージと、その項目への完全なパスを出力しています。「php is not writable」という状況は、このisWritable()がfalseを返した場合に該当します。この機能は、システムの設定やデプロイ時にファイル権限の問題を診断する際に役立ちます。