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

Copy
1<?php
2
3/**
4 * SplFileInfo::getPerms() メソッドの使用例
5 * ファイルのパーミッション（権限）を数値形式で取得する方法を示します。
6 * システムエンジニアにとって、ファイルのアクセス制御を理解する上で重要です。
7 */
8
9// 1. テスト用のファイルを作成します。
10// file_put_contents() は、指定されたファイルに文字列を書き込みます。
11$testFileName = 'example_file_for_perms.txt';
12file_put_contents($testFileName, 'このファイルはパーミッションテストのために作成されました。');
13
14// ファイルの作成に失敗した場合はエラーを表示し終了します。
15if (!file_exists($testFileName)) {
16    echo "エラー: テストファイル '{$testFileName}' の作成に失敗しました。\n";
17    exit(1);
18}
19
20// 2. SplFileInfo オブジェクトを生成します。
21// SplFileInfo クラスは、ファイルに関する様々な情報（名前、サイズ、パーミッションなど）
22// をオブジェクト指向的に取得するための機能を提供します。
23$fileInfo = new SplFileInfo($testFileName);
24
25// 3. getPerms() メソッドを使用してファイルのパーミッションを取得します。
26// このメソッドは引数なしで呼び出され、ファイルのパーミッションを整数値で返します。
27$permissions = $fileInfo->getPerms();
28
29// 4. 取得したパーミッション情報を表示します。
30echo "対象ファイル: " . $fileInfo->getFilename() . "\n";
31echo "ファイルパス: " . $fileInfo->getPathname() . "\n";
32
33// getPerms() で取得される数値は、通常8進数で表現されるファイルパーミッションの
34// 10進数表現です。多くの場合、8進数形式で表示すると理解しやすいため、
35// decoct() 関数を使って8進数に変換して表示します。
36echo "パーミッション (数値): " . $permissions . "\n";
37echo "パーミッション (8進数): " . decoct($permissions) . "\n";
38
39// 例:
40// - `0644` (8進数) は、所有者には読み書き権限、グループとその他には読み取り権限
41// - `0755` (8進数) は、所有者には読み書き実行権限、グループとその他には読み書き実行権限
42
43// 5. テスト用ファイルの後処理（クリーンアップ）を行います。
44// テスト後に作成したファイルを削除し、環境をクリーンに保ちます。
45if (unlink($testFileName)) {
46    echo "テストファイル '{$testFileName}' を削除しました。\n";
47} else {
48    echo "エラー: テストファイル '{$testFileName}' の削除に失敗しました。\n";
49}
50
51?>

PHP 8のSplFileInfo::getPerms()メソッドは、特定のファイルのパーミッション（権限）を数値形式で取得するために使用されます。このメソッドはSplFileInfoクラスに属しており、システムエンジニアにとってファイルのアクセス制御を理解し、適切に管理する上で非常に重要な機能を提供します。

getPerms()メソッドは引数を必要とせず、呼び出されるとファイルのパーミッションを表す整数値（int）を返します。この戻り値は、通常「0755」や「0644」といった8進数で表現されるパーミッションの10進数形式です。そのため、取得した数値をdecoct()関数などで8進数に変換して表示すると、所有者、グループ、その他のユーザーに対する読み書き実行権限の設定をより直感的に理解しやすくなります。

サンプルコードでは、まずテスト用のファイルを一時的に作成し、そのファイルパスを用いてSplFileInfoオブジェクトを生成しています。その後、生成されたSplFileInfoオブジェクトからgetPerms()メソッドを呼び出すことで、作成したファイルのパーミッション情報を取得し、その結果を10進数と8進数の両方で表示しています。このメソッドは、ファイルのセキュリティ状態を確認したり、プログラムからアクセス権限を判定したりする際に役立ちます。最後に、テストで作成したファイルは適切に削除され、環境がクリーンに保たれます。

Copy
1<?php
2
3/**
4 * 指定されたファイルのパーミッション（権限）を取得し、表示します。
5 *
6 * @param string $filePath パーミッションを取得したいファイルのパス。
7 */
8function displayFilePermissions(string $filePath): void
9{
10    // SplFileInfoオブジェクトを作成
11    // ファイルが存在しない場合は、RuntimeExceptionが発生する可能性があります。
12    try {
13        $fileInfo = new SplFileInfo($filePath);
14
15        // ファイルのパーミッションを取得
16        // 戻り値は整数値です。この整数値には、ファイルタイプ（例: 通常ファイル、ディレクトリ）の情報と
17        // パーミッション（読み取り、書き込み、実行権限）の両方が含まれています。
18        $permissionsInt = $fileInfo->getPerms();
19
20        // 一般的に、パーミッションは8進数形式（例: 0755）で表現されます。
21        // 下位9ビット（ユーザー、グループ、その他）を抽出するためにビットマスク0777を使用します。
22        $permissionsOctal = sprintf('%o', $permissionsInt & 0777);
23
24        echo "ファイルパス: " . $filePath . PHP_EOL;
25        echo "パーミッション (整数値): " . $permissionsInt . PHP_EOL;
26        echo "パーミッション (8進数): 0" . $permissionsOctal . PHP_EOL;
27
28    } catch (RuntimeException $e) {
29        echo "エラー: ファイル情報の取得に失敗しました。ファイルが存在しないか、アクセスできません。" . PHP_EOL;
30        echo "詳細: " . $e->getMessage() . PHP_EOL;
31    }
32}
33
34// --- サンプルコードの実行 ---
35
36// 1. このスクリプトファイル自身のパーミッションを取得する例
37// __FILE__ は現在のスクリプトファイルのフルパスを返します。
38echo "=== このスクリプトファイルのパーミッション ===\n";
39displayFilePermissions(__FILE__);
40
41// 2. 新しいテストファイルを作成し、そのパーミッションを取得・表示する例
42$testFileName = 'test_sample_file.txt';
43
44// テストファイルを作成し、内容を書き込む
45file_put_contents($testFileName, "これはテスト用のファイルです。\n");
46
47// Unix系システムではchmodでパーミッションを設定できますが、Windowsでは限定的な影響です。
48// ここでは、オーナーに読み書き、グループとその他に読み取り権限 (0644) を設定する例。
49if (PHP_OS_FAMILY !== 'Windows') {
50    chmod($testFileName, 0644);
51}
52
53echo PHP_EOL . "=== テストファイルのパーミッション ===\n";
54displayFilePermissions($testFileName);
55
56// テストファイルをクリーンアップ（削除）
57if (file_exists($testFileName)) {
58    unlink($testFileName);
59    echo PHP_EOL . "テストファイル '" . $testFileName . "' を削除しました。\n";
60}
61
62?>

PHPのSplFileInfoクラスは、ファイルやディレクトリに関する詳細な情報を扱うためのクラスです。その中のgetPermsメソッドは、指定されたファイルやディレクトリのパーミッション（権限）を取得するために使われます。

このgetPermsメソッドは引数を取らずに呼び出され、戻り値として整数値（int）を返します。この整数値には、ファイルが通常のファイルかディレクトリかといったタイプ情報と、読み取り・書き込み・実行権限がまとめて含まれています。特にファイルのパーミッション部分は、通常「0755」のような8進数形式で表現されることが多いため、取得した整数値からパーミッション部分を抽出し、sprintf('%o', $permissionsInt & 0777)のように8進数に変換して利用することが一般的です。

サンプルコードでは、SplFileInfoオブジェクトをファイルのパスを指定して作成し、getPermsメソッドを呼び出してパーミッションの整数値を取得しています。そして、その整数値を8進数形式に変換して表示する流れを示しています。スクリプトファイル自身のパーミッションや、新しく作成したテストファイルのパーミッションを取得する例が示されており、ファイルが存在しない場合のエラー処理も含まれています。このメソッドは、プログラムからファイルへのアクセス権限を確認・管理する際に非常に役立ちます。