【PHP8.x】filegroup()関数の使い方

Copy
1<?php
2
3// --- サンプル実行のための準備 ---
4// 一時的なテキストファイルをいくつか作成します。
5// これらのファイルに対して、後でファイルグループIDを取得します。
6$tempFile1 = 'example_file_a.txt';
7$tempFile2 = 'example_file_b.txt';
8$tempFile3 = 'example_log.log'; // このファイルは 'example_file_*.txt' パターンにマッチしません
9
10file_put_contents($tempFile1, 'これはテストファイルAです。');
11file_put_contents($tempFile2, 'これはテストファイルBです。');
12file_put_contents($tempFile3, 'これはログファイルです。');
13
14echo "--- ファイルグループIDの取得 ---" . PHP_EOL;
15
16// `glob`関数を使用して、特定のパターンに一致するファイルリストを取得します。
17// ここでは 'example_file_*.txt' というパターンに一致するすべてのファイルを探します。
18$files = glob('example_file_*.txt');
19
20if (empty($files)) {
21    echo "指定されたパターンに一致するファイルが見つかりませんでした。" . PHP_EOL;
22} else {
23    echo "以下のファイルについてグループIDを取得します:" . PHP_EOL;
24    foreach ($files as $filename) {
25        // `filegroup`関数を使用して、指定されたファイルのグループIDを取得します。
26        // 成功した場合はグループID (整数)、失敗した場合は false を返します。
27        $groupId = filegroup($filename);
28
29        if ($groupId !== false) {
30            echo "  ファイル: '{$filename}' -> グループID: {$groupId}" . PHP_EOL;
31            // 必要であれば、`posix_getgrgid()`関数（POSIX拡張が必要）を使って
32            // グループIDからグループ名を取得することもできます。
33            // 例: $groupInfo = posix_getgrgid($groupId);
34            //     if ($groupInfo) { echo " (グループ名: " . $groupInfo['name'] . ")"; }
35        } else {
36            // `filegroup`が false を返した場合、エラーが発生しています。
37            // (例: ファイルが存在しない、アクセス権がないなど)
38            echo "  ファイル: '{$filename}' のグループIDを取得できませんでした。エラーが発生しました。" . PHP_EOL;
39        }
40    }
41}
42
43echo "--- 後処理 ---" . PHP_EOL;
44// サンプル実行のために作成した一時ファイルを削除します。
45// `glob`にマッチしなかったファイルもここで削除します。
46unlink($tempFile1);
47unlink($tempFile2);
48unlink($tempFile3); 
49
50echo "処理が完了しました。作成された一時ファイルは削除されました。" . PHP_EOL;
51
52?>

PHPのfilegroup関数は、指定されたファイルのグループID（整数）を取得する機能を提供します。このグループIDは、ファイルがどのユーザーグループに属しているかを示す番号で、ファイルシステム上でのアクセス権限管理などに利用される重要な情報です。関数はファイルのパスを引数に受け取り、グループIDの取得に成功した場合は整数値を、ファイルが存在しない場合やアクセス権限がないなどで失敗した場合はfalseを戻り値として返します。サンプルコードでは、まず一時ファイルを作成し、次にglob関数を用いて特定のパターン（'example_file_*.txt'）に一致するファイル名の一覧を取得しています。その後、取得した各ファイルに対してfilegroup関数を適用し、それぞれのグループIDを表示しています。このようにして、特定のファイルがどのグループに属しているかを確認することができます。最後に、作成した一時ファイルを削除して処理を終えています。

Copy
1<?php
2
3/**
4 * PHPのfilegroup関数およびfileowner関数の使用例を示すスクリプト。
5 *
6 * このスクリプトは一時ファイルを作成し、そのファイルの所有者IDとグループIDを取得して表示します。
7 * 取得したIDは、それぞれ対応する所有者名とグループ名に変換して表示することで、
8 * システムエンジニアを目指す初心者にも理解しやすいようにします。
9 *
10 * 注意: posix_getpwuid および posix_getgrgid 関数は、Unix系システムでのみ利用可能です。
11 * Windows環境では利用できないため、IDの数値のみが表示されます。
12 */
13function demonstrateFileOwnership(): void
14{
15    // 一時ファイル名を設定
16    $tempFilename = 'temp_ownership_test_file.txt';
17
18    // 一時ファイルを作成し、内容を書き込む
19    // ファイル作成に失敗した場合はエラーを表示して終了
20    if (file_put_contents($tempFilename, "This is a test file for filegroup and fileowner functions.") === false) {
21        echo "エラー: 一時ファイルの作成に失敗しました。ファイルが書き込み可能か確認してください。\n";
22        return;
23    }
24
25    echo "一時ファイル '{$tempFilename}' を作成しました。\n\n";
26
27    // --- ファイルの所有者IDを取得 (fileowner関数) ---
28    // 指定されたファイルの所有者のUID（ユーザーID）を返します。
29    // 成功した場合はint、失敗した場合はfalseを返します。
30    $ownerId = fileowner($tempFilename);
31
32    if ($ownerId === false) {
33        echo "エラー: ファイル '{$tempFilename}' の所有者IDを取得できませんでした。\n";
34    } else {
35        echo "ファイル '{$tempFilename}' の所有者ID: {$ownerId}\n";
36
37        // posix_getpwuid関数が利用可能であれば、所有者IDを所有者名に変換して表示
38        if (function_exists('posix_getpwuid')) {
39            $ownerInfo = posix_getpwuid($ownerId);
40            if ($ownerInfo !== false && isset($ownerInfo['name'])) {
41                echo "ファイル '{$tempFilename}' の所有者名: {$ownerInfo['name']}\n";
42            } else {
43                echo "注意: 所有者ID '{$ownerId}' に対応する所有者名を取得できませんでした。\n";
44            }
45        } else {
46            echo "注意: posix_getpwuid関数は利用できません。(Unix系システムでのみ利用可能です)\n";
47        }
48    }
49
50    echo "\n"; // 区切りのための改行
51
52    // --- ファイルのグループIDを取得 (filegroup関数) ---
53    // 指定されたファイルのグループのGID（グループID）を返します。
54    // 成功した場合はint、失敗した場合はfalseを返します。
55    $groupId = filegroup($tempFilename);
56
57    if ($groupId === false) {
58        echo "エラー: ファイル '{$tempFilename}' のグループIDを取得できませんでした。\n";
59    } else {
60        echo "ファイル '{$tempFilename}' のグループID: {$groupId}\n";
61
62        // posix_getgrgid関数が利用可能であれば、グループIDをグループ名に変換して表示
63        if (function_exists('posix_getgrgid')) {
64            $groupInfo = posix_getgrgid($groupId);
65            if ($groupInfo !== false && isset($groupInfo['name'])) {
66                echo "ファイル '{$tempFilename}' のグループ名: {$groupInfo['name']}\n";
67            } else {
68                echo "注意: グループID '{$groupId}' に対応するグループ名を取得できませんでした。\n";
69            }
70        } else {
71            echo "注意: posix_getgrgid関数は利用できません。(Unix系システムでのみ利用可能です)\n";
72        }
73    }
74
75    echo "\n"; // 区切りのための改行
76
77    // 作成した一時ファイルを削除
78    if (unlink($tempFilename)) {
79        echo "一時ファイル '{$tempFilename}' を削除しました。\n";
80    } else {
81        echo "エラー: 一時ファイル '{$tempFilename}' の削除に失敗しました。\n";
82    }
83}
84
85// 関数の実行
86demonstrateFileOwnership();
87
88?>

このPHPサンプルコードは、ファイルの所有者IDとグループIDを取得するfileowner関数およびfilegroup関数の基本的な使い方を示しています。まず、プログラムは一時ファイルを作成し、そのファイルに対してこれらの関数を適用します。

fileowner関数は、指定されたファイルの所有者のユーザーID（UID）を取得するために使用されます。引数には対象のファイルパスを文字列（string $filename）で渡します。成功すると所有者のUIDを整数（int）で返し、失敗した場合はfalseを返します。サンプルでは、取得したUIDをさらにposix_getpwuid関数（Unix系システムでのみ利用可能）で所有者名に変換して表示しています。

次にfilegroup関数は、指定されたファイルのグループID（GID）を取得します。こちらも引数にはファイルパスを文字列（string $filename）で指定し、成功するとグループのGIDを整数（int）で、失敗した場合はfalseを返します。サンプルコードでは、取得したGIDをposix_getgrgid関数（Unix系システムでのみ利用可能）でグループ名に変換し、出力しています。

これらの関数は、ファイルシステム上でのアクセス権限やセキュリティ設定を理解する上で重要です。サンプルコードは一時ファイルの作成、情報の取得、そしてファイルの削除までの一連の流れを含んでおり、エラー発生時の処理も示しています。これにより、PHPを用いたファイル管理の基本的な操作と、システムにおけるファイルの所有権に関する理解を深めることができます。