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

Copy
1<?php
2
3/**
4 * 指定されたディレクトリ内のファイルが実行可能かどうかをチェックし、その結果を表示します。
5 *
6 * この関数は DirectoryIterator クラスを使用してディレクトリ内の各エントリー（ファイルやサブディレクトリ）を走査し、
7 * isExecutable() メソッドを使って、それぞれが実行可能であるかを判定します。
8 *
9 * @param string $directoryPath チェックするディレクトリのパス
10 * @return void
11 */
12function checkDirectoryExecutableStatus(string $directoryPath): void
13{
14    // まず、指定されたパスが実際にディレクトリとして存在するかを確認します。
15    // これはキーワード「is_exist」の意図とも関連し、存在しないディレクトリを処理しようとするとエラーになります。
16    if (!is_dir($directoryPath)) {
17        echo "エラー: 指定されたディレクトリ '{$directoryPath}' が見つかりません。\n";
18        return;
19    }
20
21    echo "--- ディレクトリ '{$directoryPath}' 内の実行可能ファイルチェック ---\n";
22    try {
23        // DirectoryIterator オブジェクトを作成し、ディレクトリ内のエントリーを順に処理します。
24        // 各エントリーは DirectoryIterator オブジェクト（SplFileInfo を継承）として取得されます。
25        foreach (new DirectoryIterator($directoryPath) as $fileInfo) {
26            // "." や ".." といった特殊なディレクトリ（ドットファイル）は通常スキップします。
27            if ($fileInfo->isDot()) {
28                continue;
29            }
30
31            $fileName = $fileInfo->getFilename();
32
33            // isExecutable() メソッドを呼び出し、ファイルが実行可能であるかを確認します。
34            // 戻り値は bool (true または false) です。
35            $status = $fileInfo->isExecutable() ? '実行可能' : '実行不可';
36
37            echo "- {$fileName}: {$status}\n";
38        }
39    } catch (Exception $e) {
40        // DirectoryIterator の作成や処理中にエラーが発生した場合に捕捉します。
41        echo "エラー発生: " . $e->getMessage() . "\n";
42    }
43}
44
45// -----------------------------------------------------------------------------
46// サンプル実行のための準備
47// -----------------------------------------------------------------------------
48
49// 一時的なテストディレクトリを作成します。
50$testDir = __DIR__ . '/temp_exec_test';
51if (!is_dir($testDir)) {
52    mkdir($testDir);
53    echo "テストディレクトリ '{$testDir}' を作成しました。\n";
54}
55
56// 1. 実行可能なダミースクリプトを作成します。
57$executableFilePath = $testDir . '/my_script.sh';
58file_put_contents($executableFilePath, "#!/bin/bash\necho \"Hello from script!\"\n");
59
60// Unix/Linux系システムの場合、chmodで実行権限を付与する必要があります。
61// Windowsではファイルシステムでの実行権限の概念が異なり、isExecutable()の動作も異なります。
62if (PHP_OS_FAMILY === 'Windows') {
63    echo "警告: Windows環境ではisExecutable()の動作がUnix/Linux系と異なる場合があります。\n";
64    echo "      通常、.exeや.batなどの拡張子を持つファイルが実行可能と見なされます。\n";
65} else {
66    // 0755 は、所有者に読み書き実行権限、グループとその他に読み取りと実行権限を付与します。
67    chmod($executableFilePath, 0755);
68    echo "実行可能ファイル 'my_script.sh' を作成し、実行権限を付与しました。\n";
69}
70
71// 2. 実行不可なダミーテキストファイルを作成します。
72$nonExecutableFilePath = $testDir . '/my_document.txt';
73file_put_contents($nonExecutableFilePath, "This is a simple text file.");
74
75if (PHP_OS_FAMILY !== 'Windows') {
76    // 0644 は、所有者に読み書き権限、グループとその他に読み取り権限を付与します。
77    // 実行権限は付与しないため、isExecutable()は false を返します。
78    chmod($nonExecutableFilePath, 0644);
79    echo "実行不可ファイル 'my_document.txt' を作成し、実行権限を剥奪しました。\n";
80}
81
82// -----------------------------------------------------------------------------
83// 作成したテストディレクトリに対してチェック関数を実行
84// -----------------------------------------------------------------------------
85echo "\n"; // 見やすいように改行
86checkDirectoryExecutableStatus($testDir);
87
88// -----------------------------------------------------------------------------
89// クリーンアップ
90// -----------------------------------------------------------------------------
91echo "\n--- クリーンアップ ---\n";
92// 作成したファイルを削除します。
93if (file_exists($executableFilePath)) {
94    unlink($executableFilePath);
95    echo "ファイル 'my_script.sh' を削除しました。\n";
96}
97if (file_exists($nonExecutableFilePath)) {
98    unlink($nonExecutableFilePath);
99    echo "ファイル 'my_document.txt' を削除しました。\n";
100}
101// 作成したディレクトリを削除します。
102if (is_dir($testDir)) {
103    rmdir($testDir);
104    echo "テストディレクトリ '{$testDir}' を削除しました。\n";
105}
106
107?>

このPHPサンプルコードは、DirectoryIteratorクラスとisExecutable()メソッドを利用して、指定されたディレクトリ内の各ファイルが実行可能であるかどうかをチェックし、その結果を表示します。

まず、is_dir()関数を用いて、処理対象となるディレクトリが実際に存在するかを確認します。これは「is_exist」というキーワードの意図と関連し、存在しないパスを操作することによるエラーを防ぐために重要な手順です。

DirectoryIteratorクラスは、ディレクトリ内のファイルやサブディレクトリといった各エントリーを順番に走査するために使われます。それぞれのエントリーはオブジェクトとして取得され、そのオブジェクトに対してisExecutable()メソッドを呼び出します。このメソッドは引数を一切取らず、ファイルが実行可能であればtrueを、実行不可能であればfalseをブール値（bool）として返します。

コードは、ディレクトリ内の各ファイルについてisExecutable()の結果を判定し、「実行可能」か「実行不可」かを表示します。ファイルの実行可能性の判断は、オペレーティングシステムによって異なる場合があり、例えばUnix/Linuxではファイルの実行権限（chmodで設定）が重要であるのに対し、Windowsでは拡張子などが考慮されることがあります。サンプルでは、テスト用に実行可能なファイルと実行不可なファイルを作成し、それぞれの結果を確認後、作成したファイルを削除するクリーンアップ処理も行っています。これにより、PHPでファイルの実行権限をプログラム的に確認する方法を学ぶことができます。

Copy
1<?php
2
3/**
4 * DirectoryIterator::isExecutable() メソッドの使用例。
5 * 指定されたディレクトリ内の各ファイル/ディレクトリが実行可能かどうかを判定します。
6 *
7 * システムエンジニアを目指す初心者の方へ:
8 * このコードは、PHPがファイルシステムとどのように対話し、
9 * 特定のファイルの属性（この場合は実行可能性）をチェックできるかを示しています。
10 * Unix系システムでは、実行可能フラグがファイルに設定されているかどうかをチェックします。
11 * Windows系システムでは、'.exe', '.cmd', '.bat' などの拡張子を持つファイルが実行可能と見なされます。
12 */
13
14// このスクリプトが存在するディレクトリを対象とします。
15// 例として、現在のディレクトリ内のファイルが実行可能かチェックします。
16$directoryPath = __DIR__;
17
18echo "ディレクトリ '{$directoryPath}' 内のファイル/ディレクトリの実行可能性をチェックします。\n\n";
19
20try {
21    // DirectoryIterator は指定されたディレクトリの内容をイテレート（繰り返し処理）するためのクラスです。
22    // ディレクトリが存在しない場合やアクセス権がない場合、ここで例外が発生します。
23    $iterator = new DirectoryIterator($directoryPath);
24
25    // ディレクトリ内の各ファイルやサブディレクトリを順番に処理します。
26    foreach ($iterator as $fileinfo) {
27        // '.' (現在のディレクトリ) と '..' (親ディレクトリ) は情報としては不要な場合が多いのでスキップします。
28        if ($fileinfo->isDot()) {
29            continue;
30        }
31
32        // isExecutable() メソッドを使って、現在のファイルやディレクトリが実行可能かを判定します。
33        // 戻り値は bool (true または false) です。
34        $isExecutable = $fileinfo->isExecutable();
35
36        // 結果を整形して出力します。
37        // printf はフォーマットされた文字列を出力するための関数です。
38        printf(
39            "ファイル/ディレクトリ名: %s, 実行可能: %s\n",
40            $fileinfo->getFilename(),           // ファイル名またはディレクトリ名を取得
41            $isExecutable ? 'はい' : 'いいえ' // true なら 'はい'、false なら 'いいえ' と表示
42        );
43    }
44} catch (Exception $e) {
45    // ディレクトリが存在しない、アクセス権がないなどのエラーが発生した場合に、そのメッセージを出力します。
46    echo "エラーが発生しました: " . $e->getMessage() . "\n";
47}
48

PHPのDirectoryIterator::isExecutable()メソッドは、ファイルやディレクトリが実行可能であるかを判定する機能を提供します。このメソッドは引数を取らず、実行可能であればtrue、そうでなければfalseという真偽値（bool型）を返します。

このサンプルコードでは、現在スクリプトが存在するディレクトリを対象に、その中にある各ファイルやサブディレクトリが実行可能かどうかをチェックしています。DirectoryIteratorクラスを使用してディレクトリの内容を一つずつ読み込み、それぞれの項目に対してisExecutable()メソッドを呼び出しています。

具体的には、LinuxやmacOSのようなUnix系システムではファイルの実行権限（実行可能フラグ）が設定されているかを調べます。一方、Windows系システムでは、通常.exe、.cmd、.batといった特定の拡張子を持つファイルが実行可能と判断されます。

この機能は、PHPがファイルシステムとどのように連携し、ファイルの属性を確認できるかを示す良い例です。システムが特定のアクションを実行する前に、必要なファイルが適切な権限を持っているかを確認する際に役立ちます。エラーが発生した場合は、そのメッセージを表示するように例外処理も含まれています。