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

Copy
1<?php
2
3// このスクリプトは、PHPの FilesystemIterator クラスの isWritable() メソッドの使い方を示します。
4// isWritable() は、イテレータが指す現在のファイルやディレクトリが、
5// スクリプトを実行しているユーザーによって書き込み可能かどうかをチェックします。
6
7// 1. テスト用の作業ディレクトリをシステムの一時ディレクトリ内に作成します。
8//    uniqid() はユニークな名前を生成し、ディレクトリ名の衝突を防ぎます。
9$tempDir = sys_get_temp_dir() . '/php_iswritable_example_' . uniqid();
10// mkdir() の第2引数 0755 は、ディレクトリのパーミッション（権限）を指定します。
11// これは所有者が読み書き実行、グループとその他のユーザーが読み書き実行できることを意味します。
12if (!mkdir($tempDir, 0755, true)) {
13    die("エラー: 一時ディレクトリの作成に失敗しました: " . $tempDir);
14}
15
16// 2. 作成した一時ディレクトリ内にテストファイルを作成します。
17$testFilePath = $tempDir . '/sample.txt';
18// file_put_contents() でファイルを作成し、内容を書き込みます。
19// この操作により、通常、ファイルは書き込み可能な状態で作成されます。
20if (file_put_contents($testFilePath, 'これはテストファイルです。') === false) {
21    // ファイル作成に失敗した場合、作成したディレクトリを削除して終了します。
22    rmdir($tempDir);
23    die("エラー: テストファイルの作成に失敗しました: " . $testFilePath);
24}
25
26echo "--- FilesystemIterator::isWritable() の使用例 ---" . PHP_EOL;
27echo "テスト対象ディレクトリ: " . $tempDir . PHP_EOL;
28echo "テスト対象ファイル: " . $testFilePath . PHP_EOL;
29echo "---------------------------------------------------" . PHP_EOL;
30
31try {
32    // 3. FilesystemIterator のインスタンスを作成し、テストディレクトリを指定します。
33    //    FilesystemIterator::SKIP_DOTS フラグは、特殊なディレクトリ「.」と「..」を
34    //    イテレーション（繰り返し処理）の対象から除外するために使用します。
35    $iterator = new FilesystemIterator($tempDir, FilesystemIterator::SKIP_DOTS);
36
37    echo "ディレクトリ内の要素の書き込み可能性:" . PHP_EOL;
38
39    // 4. ディレクトリ内の各要素（ファイルやサブディレクトリ）をループ処理します。
40    foreach ($iterator as $fileInfo) {
41        // FilesystemIterator::isWritable() メソッドを呼び出し、
42        // 現在の要素が書き込み可能かどうかをチェックします。
43        // このメソッドは真偽値 (true/false) を返します。
44        $isWritable = $fileInfo->isWritable();
45
46        // 結果を整形して出力します。
47        echo sprintf(
48            "  - '%s' (タイプ: %s): %s",
49            $fileInfo->getFilename(),  // 要素の名前（例: sample.txt）
50            $fileInfo->getType(),      // 要素のタイプ（'file' または 'dir'）
51            $isWritable ? "書き込み可能" : "書き込み不可" // 書き込み可能性
52        );
53        echo PHP_EOL;
54    }
55
56} catch (UnexpectedValueException $e) {
57    // 指定されたパスが存在しないか、ディレクトリではない、またはアクセス権がない場合などに
58    // UnexpectedValueException が発生する可能性があります。
59    echo "エラー: ディレクトリの読み込み中に問題が発生しました。" . PHP_EOL;
60    echo "  詳細メッセージ: " . $e->getMessage() . PHP_EOL;
61} finally {
62    // 5. 後処理: 作成した一時ファイルとディレクトリを削除し、環境をクリーンアップします。
63    //    まずファイルを削除します。
64    if (file_exists($testFilePath)) {
65        unlink($testFilePath);
66    }
67    //    次に、空になったディレクトリを削除します。rmdir() は空のディレクトリしか削除できません。
68    if (is_dir($tempDir)) {
69        rmdir($tempDir);
70    }
71    echo "---------------------------------------------------" . PHP_EOL;
72    echo "一時ファイルとディレクトリを削除し、クリーンアップしました。" . PHP_EOL;
73}
74
75?>

PHP 8 の FilesystemIterator::isWritable() メソッドは、ファイルシステムを効率的に反復処理する FilesystemIterator クラスの一部として提供される機能です。このメソッドは、イテレータが現在指しているファイルやディレクトリに対して、PHPスクリプトを実行しているユーザーが書き込み権限を持っているかどうかを判定するために使用されます。

このメソッドは引数を必要とせず、呼び出すだけで機能します。戻り値は bool 型で、対象のファイルやディレクトリが書き込み可能であれば true を、書き込み不可であれば false を返します。これにより、ファイル操作を行う前に書き込み権限の有無を事前に確認し、エラーを防ぐ堅牢なアプリケーションを構築できます。

サンプルコードでは、一時ディレクトリとファイルを実際に作成し、FilesystemIterator でディレクトリ内の要素を一つずつ巡回しながら、それぞれの要素に対して isWritable() メソッドを呼び出しています。その結果を「書き込み可能」または「書き込み不可」として出力することで、本メソッドの具体的な挙動と、ファイルシステム内の様々な要素に対する権限確認のプロセスが明確に示されています。ファイルやディレクトリへのアクセス権限に基づいた処理を実装する際に役立ちます。

Copy
1<?php
2
3/**
4 * 指定されたディレクトリ内の各ファイルおよびサブディレクトリの書き込み可能状態をチェックします。
5 *
6 * FilesystemIterator を使用してディレクトリを反復処理し、
7 * 各項目が書き込み可能かどうかを SplFileInfo::isWritable() メソッドで判定します。
8 *
9 * @param string $directoryPath チェックするディレクトリのパス
10 * @return void
11 */
12function checkFilesystemWritability(string $directoryPath): void
13{
14    echo "Checking writability for items in: {$directoryPath}\n";
15
16    // ディレクトリが存在しない、または読み取りできない場合はエラーメッセージを表示して終了
17    if (!is_dir($directoryPath) || !is_readable($directoryPath)) {
18        echo "Error: Directory '{$directoryPath}' does not exist or is not readable.\n";
19        return;
20    }
21
22    try {
23        // FilesystemIterator を初期化します。
24        // SKIP_DOTS: '.' と '..' のエントリをスキップします。
25        // CURRENT_AS_FILEINFO: 反復時に SplFileInfo オブジェクトを返します。
26        $iterator = new FilesystemIterator(
27            $directoryPath,
28            FilesystemIterator::SKIP_DOTS | FilesystemIterator::CURRENT_AS_FILEINFO
29        );
30
31        foreach ($iterator as $fileInfo) {
32            $itemName = $fileInfo->getFilename(); // 現在の項目（ファイルまたはディレクトリ）の名前を取得
33
34            // SplFileInfo::isWritable() メソッドで書き込み可能かどうかを判定します。
35            if ($fileInfo->isWritable()) {
36                echo "  - '{$itemName}' is writable.\n";
37            } else {
38                // キーワード「php is not writable」に関連する出力
39                echo "  - '{$itemName}' is NOT writable. (php is not writable)\n";
40            }
41        }
42    } catch (UnexpectedValueException $e) {
43        // ディレクトリパスが無効な場合などに発生する可能性のある例外を捕捉します。
44        echo "Error accessing directory '{$directoryPath}': " . $e->getMessage() . "\n";
45    }
46}
47
48// --- サンプルコードの実行部分 ---
49
50// テスト用のディレクトリとファイルを作成するためのパスを準備します。
51// システムの一時ディレクトリを使用し、ユニークな名前を付けます。
52$testDirectory = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_writable_test_' . uniqid();
53
54// テスト用ディレクトリの作成
55if (!mkdir($testDirectory)) {
56    echo "Failed to create test directory: {$testDirectory}\n";
57    exit(1); // ディレクトリ作成失敗時は終了
58}
59echo "Created test directory: {$testDirectory}\n";
60
61// 1. 書き込み可能なファイルを作成
62$writableFile = $testDirectory . DIRECTORY_SEPARATOR . 'writable_file.txt';
63file_put_contents($writableFile, 'This file should be writable.');
64
65// 2. 意図的に書き込み不可なファイルを作成
66$unwritableFile = $testDirectory . DIRECTORY_SEPARATOR . 'unwritable_file.txt';
67file_put_contents($unwritableFile, 'This file should NOT be writable.');
68
69// Unix系システムでファイルパーミッションを0444 (読み取り専用) に設定します。
70// 注意: Windows環境ではこのパーミッション設定は期待通りに動作しない場合があります。
71// PHP実行ユーザーがファイルの所有者でない場合、この設定では読み取りもできない可能性があります。
72chmod($unwritableFile, 0444);
73echo "Created unwritable file: {$unwritableFile} with permissions 0444.\n";
74
75// 作成したテストディレクトリ内の項目について、書き込み可能状態をチェックします。
76checkFilesystemWritability($testDirectory);
77
78// --- 後処理: テスト用のディレクトリとファイルをクリーンアップします ---
79
80// ディレクトリ内のファイルを削除
81$iteratorForCleanup = new FilesystemIterator($testDirectory, FilesystemIterator::SKIP_DOTS);
82foreach ($iteratorForCleanup as $file) {
83    unlink($file->getPathname()); // ファイルを削除
84}
85// ディレクトリを削除
86rmdir($testDirectory);
87echo "Cleaned up test directory: {$testDirectory}\n";
88
89?>

PHP 8のFilesystemIterator::isWritable()メソッドは、ファイルシステム上の特定の項目（ファイルまたはディレクトリ）が、現在PHPを実行しているプロセスによって書き込み可能であるかどうかを判定するために使用されます。このメソッドは引数を必要とせず、書き込み可能であればtrueを、そうでなければfalseを真偽値として返します。

提供されたサンプルコードでは、FilesystemIteratorを用いて指定されたディレクトリ内のすべてのファイルやサブディレクトリを順に調べます。それぞれの項目に対してisWritable()メソッドを呼び出し、その結果に基づいて書き込み権限の有無をメッセージで出力しています。例えば、書き込み権限がないファイルに対しては「'ファイル名' is NOT writable. (php is not writable)」と表示され、PHPがその項目に書き込みを行うことができない状態であることを明確に示します。

この機能は、アプリケーションがファイルへのデータ保存やログ出力、ディレクトリ内のファイル作成などを行う前に、必要な書き込み権限が適切に設定されているかを確認する際に非常に役立ちます。これにより、権限不足によるエラーを事前に検出し、堅牢なシステムを構築することができます。