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

Copy
1<?php
2
3/**
4 * 指定されたファイルが実行可能であるかを確認する関数。
5 *
6 * この関数は、まずファイルが存在するかどうかを確認し、
7 * その後、SplFileInfoクラスのisExecutableメソッドを使用して実行可能性を判断します。
8 *
9 * @param string $filePath 確認するファイルのパス。
10 * @return void
11 */
12function checkFileExecutability(string $filePath): void
13{
14    // キーワード「php is_exist」に関連付け、ファイルが存在するかを最初に確認します。
15    if (!file_exists($filePath)) {
16        echo "ファイル '{$filePath}' は存在しません。" . PHP_EOL;
17        return;
18    }
19
20    try {
21        // SplFileInfo オブジェクトを作成します。
22        // このクラスはファイルシステムに関する情報を提供します。
23        $fileInfo = new SplFileInfo($filePath);
24
25        // isExecutable() メソッドを使用して、ファイルが実行可能であるかを確認します。
26        // 戻り値は bool (true または false) です。
27        if ($fileInfo->isExecutable()) {
28            echo "ファイル '{$filePath}' は実行可能です。" . PHP_EOL;
29        } else {
30            echo "ファイル '{$filePath}' は実行可能ではありません。" . PHP_EOL;
31        }
32    } catch (RuntimeException $e) {
33        // SplFileInfoのコンストラクタは、ファイルが見つからない場合にRuntimeExceptionを
34        // スローする可能性があるため、try-catchブロックで処理します。
35        // (file_existsで確認済みのため、このブロックに入る可能性は低いですが、堅牢性のために。)
36        echo "ファイル '{$filePath}' の情報取得中にエラーが発生しました: " . $e->getMessage() . PHP_EOL;
37    }
38}
39
40// --- サンプルコードの実行例 ---
41
42// テスト用の実行可能ファイルを一時的に作成します。
43$executableFileName = 'my_script.sh';
44file_put_contents($executableFileName, '#!/bin/bash' . PHP_EOL . 'echo "Hello from executable script!"');
45// 作成したファイルを実行可能にするパーミッションを設定します。
46// Unix系システムでは、0755は所有者に読み書き実行、グループとその他に読み書き実行の権限を与えます。
47chmod($executableFileName, 0755);
48
49// テスト用の実行不可能ファイルを一時的に作成します。
50$nonExecutableFileName = 'my_document.txt';
51file_put_contents($nonExecutableFileName, 'This is a test document.');
52// 作成したファイルを実行不可能にするパーミッションを設定します。
53// 0644は所有者に読み書き、グループとその他に読み取りの権限を与え、実行権限はありません。
54chmod($nonExecutableFileName, 0644);
55
56// 実行可能ファイルに対してテストします。
57checkFileExecutability($executableFileName);
58
59// 実行不可能ファイルに対してテストします。
60checkFileExecutability($nonExecutableFileName);
61
62// 存在しないファイルに対してテストします。
63checkFileExecutability('non_existent_file.php');
64
65// テスト用ファイルの後処理を行います。
66unlink($executableFileName);
67unlink($nonExecutableFileName);
68
69?>

PHPのSplFileInfo::isExecutableメソッドは、指定されたファイルがシステム上で実行可能であるかを確認するために使用されます。このメソッドは引数を必要とせず、ファイルの実行権限が設定されている場合にtrueを、そうでない場合にfalseを真偽値として返します。

サンプルコードでは、まずfile_exists()関数（キーワード「php is_exist」に関連します）を用いて、対象のファイルが実際に存在するかどうかを確認しています。ファイルが存在しない場合は、それ以上の処理をせずに終了することで、無駄な処理やエラーを防いでいます。

ファイルが存在する場合、SplFileInfoクラスのオブジェクトを作成します。このクラスは、ファイル名、サイズ、更新日時など、ファイルシステムに関する様々な情報にアクセスするための機能を提供します。作成した$fileInfoオブジェクトに対してisExecutable()メソッドを呼び出すことで、そのファイルが実行可能であるかを判断し、結果に応じて「実行可能です」または「実行可能ではありません」と出力します。

たとえば、シェルスクリプトファイルにchmod 0755などのコマンドで実行権限が与えられていればtrueが返され、通常のテキストファイルのように実行権限がない（chmod 0644など）場合はfalseが返されます。この機能は、プログラムが外部スクリプトの実行を試みる前に、そのファイルが実行可能であるかを事前にチェックし、予期せぬエラーを防ぐために非常に役立ちます。

Copy
1<?php
2
3/**
4 * SplFileInfo::isExecutable メソッドの使用例を示します。
5 *
6 * この関数は一時ファイルを作成し、その実行可能パーミッションを段階的に変更しながら、
7 * SplFileInfo::isExecutable メソッドの動作を確認します。
8 *
9 * @param string $prefix 一時ファイル名のプレフィックス
10 */
11function demonstrateSplFileInfoIsExecutable(string $prefix = 'php_exec_test'): void
12{
13    // 一時ファイルを作成します。このファイルに対して実行可能性をテストします。
14    $tempFile = tempnam(sys_get_temp_dir(), $prefix);
15    if ($tempFile === false) {
16        echo "エラー: 一時ファイルの作成に失敗しました。\n";
17        return;
18    }
19
20    echo "テストファイル: " . $tempFile . "\n\n";
21
22    // SplFileInfo オブジェクトを作成します。
23    // このオブジェクトは、指定されたファイルに関する情報（パス、パーミッションなど）を提供します。
24    $fileInfo = new SplFileInfo($tempFile);
25
26    // --- ステップ1: 初期状態（通常は実行パーミッションなし）で実行可能性をチェック ---
27    echo "1. 初期状態（実行パーミッションなし）:\n";
28    // isExecutable() メソッドを呼び出し、ファイルが実行可能かどうかを判断します。
29    // 戻り値は bool (true または false) です。
30    $isExecutableInitial = $fileInfo->isExecutable();
31    if ($isExecutableInitial) {
32        echo "   -> このファイルは実行可能です。\n";
33    } else {
34        echo "   -> このファイルは実行可能ではありません。\n";
35    }
36    echo "   戻り値: " . var_export($isExecutableInitial, true) . "\n\n";
37
38    // --- ステップ2: ファイルに実行パーミッションを付与して実行可能性をチェック ---
39    // chmod() 関数を使用してファイルのパーミッションを変更します。
40    // Unix系OSの場合、'0755' は所有者に読み書き実行、グループとその他に読み書き実行のパーミッションを付与します。
41    // Windowsの場合、chmod() は限定的な効果しか持たないか、実行可能性に直接影響しないことがあります。
42    // Windowsではファイルの実行可能性は、通常、拡張子（.exe, .batなど）や関連付けによって判断されます。
43    if (chmod($tempFile, 0755)) {
44        echo "2. 実行パーミッション (0755) を付与しました。\n";
45        // SplFileInfo オブジェクトは、ファイルのステータス変更を自動的に検出するため、
46        // 通常はオブジェクトを再生成する必要はありません。
47        $isExecutableWithPerm = $fileInfo->isExecutable();
48        if ($isExecutableWithPerm) {
49            echo "   -> このファイルは実行可能です。\n";
50        } else {
51            echo "   -> このファイルは実行可能ではありません。\n";
52        }
53        echo "   戻り値: " . var_export($isExecutableWithPerm, true) . "\n\n";
54
55        // --- ステップ3: ファイルから実行パーミッションを削除して実行可能性をチェック ---
56        if (chmod($tempFile, 0644)) {
57            echo "3. 実行パーミッション (0644) を削除しました。\n";
58            $isExecutableWithoutPerm = $fileInfo->isExecutable();
59            if ($isExecutableWithoutPerm) {
60                echo "   -> このファイルは実行可能です。\n";
61            } else {
62                echo "   -> このファイルは実行可能ではありません。\n";
63            }
64            echo "   戻り値: " . var_export($isExecutableWithoutPerm, true) . "\n\n";
65        } else {
66            echo "エラー: 実行パーミッションの削除に失敗しました。Windowsなどではこの操作が常に成功するとは限りません。\n\n";
67        }
68    } else {
69        echo "エラー: 実行パーミッションの付与に失敗しました。Windowsなどではこの操作が常に成功するとは限りません。\n\n";
70    }
71
72    // --- 後処理: 作成した一時ファイルを削除 ---
73    if (unlink($tempFile)) {
74        echo "一時ファイル " . $tempFile . " を削除しました。\n";
75    } else {
76        echo "エラー: 一時ファイル " . $tempFile . " の削除に失敗しました。\n";
77    }
78}
79
80// 関数の実行
81demonstrateSplFileInfoIsExecutable();
82
83?>

PHP 8のSplFileInfoクラスが提供するisExecutableメソッドは、指定されたファイルがシステム上で実行可能であるかどうかを判定し、その結果をtrueまたはfalseの真偽値で返します。このメソッドは引数を取りません。

サンプルコードでは、まず一時ファイルを作成し、そのファイルの情報を扱うSplFileInfoオブジェクトを生成しています。次に、isExecutableメソッドを呼び出して初期状態での実行可能性を確認します。その後、chmod関数を使ってファイルのパーミッションを実行可能（例えば0755）に設定し、再度isExecutableを呼び出すことで、戻り値がtrueに変わることを示します。さらに、実行パーミッションを削除（例えば0644）すると、再びfalseが返される様子が確認できます。これは、特にUNIX系OSにおいて、ファイルのパーミッションが実行可能性の判断に大きく影響することを示しています。Windows環境では、実行可能ファイルの判断基準やchmodの挙動が異なる場合があるため、注意が必要です。このメソッドは、ファイルが実行可能かプログラムで確認したい場合に便利で、最後に作成した一時ファイルは削除されます。