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

Copy
1<?php
2
3/**
4 * GlobIterator を使用して、指定されたパスに一致するファイルやディレクトリのパーミッションを取得し表示します。
5 *
6 * 【重要】
7 * このコードは、提供されたリファレンス情報「GlobIterator::getPerms」に直接対応するものではありません。
8 * PHPの標準ライブラリにおいて、`GlobIterator` クラスには `getPerms` という名前のメソッドは存在しません。
9 *
10 * しかし、`GlobIterator` が反復処理で返す `SplFileInfo` オブジェクトには、
11 * ファイルのパーミッションを取得するための `getPerms()` メソッドが存在します。
12 * このサンプルコードは、`GlobIterator` のコンテキストでファイルのパーミッションを
13 * 取得する具体的な方法を示します。
14 *
15 * また、提供されたリファレンス情報では「戻り値: 戻り値なし」とありますが、
16 * 実際には `SplFileInfo::getPerms()` メソッドは整数値を返します。
17 * 本サンプルコードでは、その取得したパーミッションを表示します。
18 *
19 * @param string $pathPattern パーミッションを取得したいファイルやディレクトリのglobパターン (例: './*', './temp/*')
20 * @return void
21 */
22function displayFilePermissionsUsingGlobIterator(string $pathPattern): void
23{
24    // GlobIterator を使用して指定されたパターンに一致するファイルとディレクトリを反復処理します。
25    // GLOB_BRACE, GLOB_MARK など、必要に応じてフラグを追加できますが、ここではシンプルな使用例です。
26    try {
27        $iterator = new GlobIterator($pathPattern);
28    } catch (UnexpectedValueException $e) {
29        // パターンが無効な場合などに例外が発生する可能性があります。
30        echo "エラー: 指定されたパスパターンが無効です。 " . $e->getMessage() . "\n";
31        return;
32    }
33
34    if (!$iterator->valid()) {
35        echo "指定されたパターン '{$pathPattern}' に一致するファイルやディレクトリは見つかりませんでした。\n";
36        return;
37    }
38
39    echo "--- ファイル/ディレクトリのパーミッション一覧 ({$pathPattern}) ---\n";
40
41    foreach ($iterator as $fileInfo) {
42        // 各要素は SplFileInfo オブジェクトです。
43        // SplFileInfo::getPerms() メソッドでパーミッションを取得します。
44        // このメソッドは整数値を返します（例: Unix系OSの0755）。
45        $permissions = $fileInfo->getPerms();
46
47        // パーミッションの数値（例: 493 は 0755 に相当）を八進数形式の文字列に変換します。
48        // `0%o` フォーマット指定子を使用すると、先頭に '0' が付加された八進数表現が得られます。
49        $octalPermissions = sprintf('0%o', $permissions);
50
51        echo sprintf(
52            "ファイル名: %-25s | タイプ: %-10s | パーミッション (八進数): %s\n",
53            $fileInfo->getFilename(), // パスの最後の部分（ファイル名またはディレクトリ名）
54            $fileInfo->isDir() ? 'ディレクトリ' : ($fileInfo->isFile() ? 'ファイル' : 'その他'),
55            $octalPermissions
56        );
57    }
58    echo "--------------------------------------------------\n";
59}
60
61// --------------------------------------------------------------------------
62// サンプルコードの実行とクリーンアップ
63// --------------------------------------------------------------------------
64
65// テスト用のディレクトリとファイルを作成します。
66$testBaseDir = __DIR__ . '/_test_glob_perms';
67$testSubDir = $testBaseDir . '/sub_dir';
68
69// ディレクトリが存在しない場合は作成
70if (!is_dir($testBaseDir)) {
71    mkdir($testBaseDir);
72}
73if (!is_dir($testSubDir)) {
74    mkdir($testSubDir);
75}
76
77// テストファイルを作成し、パーミッションを設定します。
78// Windows環境ではパーミッションの完全な制御が難しい場合があります。
79$file1Path = $testBaseDir . '/file_one.txt';
80file_put_contents($file1Path, 'これはテストファイル1です。');
81chmod($file1Path, 0644); // r-w-r--r-- (octal 644)
82
83$file2Path = $testSubDir . '/file_two.log';
84file_put_contents($file2Path, 'これはテストファイル2です。');
85chmod($file2Path, 0600); // rwx------ (octal 600)
86
87// ディレクトリのパーミッションも設定 (mkdirでデフォルトが設定されるが、明示的に)
88chmod($testBaseDir, 0755); // rwxr-xr-x (octal 755)
89chmod($testSubDir, 0700); // rwx------ (octal 700)
90
91// 現在のスクリプトがあるディレクトリのテストディレクトリ内のアイテムを検索
92$pattern1 = $testBaseDir . '/*';
93displayFilePermissionsUsingGlobIterator($pattern1);
94
95echo "\n";
96
97// サブディレクトリ内のアイテムも検索
98$pattern2 = $testBaseDir . '/*/*';
99displayFilePermissionsUsingGlobIterator($pattern2);
100
101// 存在しないパターンを指定した場合の例
102echo "\n";
103displayFilePermissionsUsingGlobIterator($testBaseDir . '/non_existent_path/*');
104
105// --------------------------------------------------------------------------
106// 後処理: 作成したテスト用のディレクトリとファイルを削除します
107// 実際の本番コードでは不要ですが、サンプルコードのクリーンアップとして重要です。
108// --------------------------------------------------------------------------
109if (file_exists($file1Path)) {
110    unlink($file1Path);
111}
112if (file_exists($file2Path)) {
113    unlink($file2Path);
114}
115// 空のサブディレクトリから削除
116if (is_dir($testSubDir)) {
117    rmdir($testSubDir);
118}
119// ベースディレクトリを削除
120if (is_dir($testBaseDir)) {
121    rmdir($testBaseDir);
122}
123
124?>

このサンプルコードは、PHPでファイルやディレクトリのパーミッション（権限）を取得し表示する方法を、システムエンジニアを目指す初心者向けに解説します。

提供されたリファレンス情報ではGlobIteratorクラスのgetPermsメソッドが示されていますが、実際のPHPの標準ライブラリにおいて、GlobIteratorクラス自体にはその名前のメソッドは存在しません。代わりに、GlobIteratorがファイルシステムを走査して返す各要素であるSplFileInfoオブジェクトには、ファイルのパーミッションを取得するgetPerms()メソッドが存在します。このメソッドは引数なしで呼び出され、パーミッションを整数値として返します。リファレンス情報で「戻り値なし」と記載されている点も、実際のSplFileInfo::getPerms()の挙動とは異なります。

サンプルコードでは、まずGlobIteratorを用いて指定されたパターンに合致するファイルやディレクトリを検索します。その後、見つかった各ファイルやディレクトリ（SplFileInfoオブジェクト）に対してgetPerms()メソッドを呼び出し、取得したパーミッションの整数値を八進数形式に変換して、ファイル名や種類と共に分かりやすく表示しています。これにより、システム内のファイルやディレクトリのアクセス権限を手軽に確認・管理する基礎知識を習得できます。

Copy
1<?php
2
3/**
4 * URLクエリパラメータから特定のパラメータの値を取得します。
5 * パラメータが存在しない場合は、指定されたデフォルト値を返します。
6 *
7 * @param string $paramName 取得したいパラメータの名前（例: 'id', 'name'）。
8 * @param mixed $defaultValue パラメータが見つからなかった場合に返すデフォルト値。
9 * @return mixed パラメータの値、またはデフォルト値。返される値は自動的にエスケープされません。
10 */
11function getUrlParam(string $paramName, mixed $defaultValue = null): mixed
12{
13    // $_GET スーパーグローバル変数からパラメータの値を取得します。
14    // null合体演算子 (??) を使用することで、パラメータが存在しない場合に
15    // 自動的に $defaultValue が使用されるようになります。
16    return $_GET[$paramName] ?? $defaultValue;
17}
18
19// --- サンプル使用例 ---
20
21// このスクリプトをWebサーバー上で実行し、以下のURLでアクセスすることを想定します。
22// 例1: http://localhost/index.php?username=Alice&age=30
23// 例2: http://localhost/index.php?product=Laptop
24// 例3: http://localhost/index.php (パラメータなし)
25
26// 'username' パラメータを取得。存在しない場合は 'ゲスト' をデフォルト値とする。
27$username = getUrlParam('username', 'ゲスト');
28
29// 'age' パラメータを取得。存在しない場合は 0 をデフォルト値とする。
30$age = getUrlParam('age', 0);
31
32// 'product' パラメータを取得。存在しない場合は 'なし' をデフォルト値とする。
33$product = getUrlParam('product', 'なし');
34
35// 'city' パラメータを取得。URLに存在しないため、デフォルト値の null が返される。
36$city = getUrlParam('city');
37
38// 取得した値を表示します。
39// Webページに表示する場合は、セキュリティのために htmlspecialchars() でエスケープすることが推奨されます。
40echo "ユーザー名: " . htmlspecialchars($username) . "\n";
41echo "年齢: " . htmlspecialchars((string) $age) . "\n"; // ageが数値の場合でも文字列に変換して表示
42echo "製品: " . htmlspecialchars($product) . "\n";
43
44// cityはデフォルト値が設定されていないため、nullになる可能性があります。
45if ($city !== null) {
46    echo "都市: " . htmlspecialchars($city) . "\n";
47} else {
48    echo "都市: 未指定\n";
49}
50
51?>

このサンプルコードは、PHPでWebページのURLに含まれるクエリパラメータの値を安全に取得するための getUrlParam 関数を説明しています。URLの ? 以降に続く「キー=値」の形式で渡される情報から、指定したキー（パラメータ名）に対応する値を取得する仕組みです。

getUrlParam 関数は、第一引数に取得したいパラメータの名前（例: 'id'や'name'）を、第二引数にそのパラメータが見つからなかった場合に返すデフォルト値を指定します。関数内部では、PHPのスーパーグローバル変数 $_GET を使ってURLパラメータにアクセスし、PHP 8で利用可能な ?? (null合体演算子) を活用することで、パラメータが見つからない場合に自動的にデフォルト値が使われるようにしています。戻り値は、取得したパラメータの値、または指定されたデフォルト値となります。

例えば、http://example.com/?username=Alice のようなURLでアクセスした場合、getUrlParam('username', 'ゲスト') を呼び出すと 'Alice' が取得されます。もしURLに 'username' パラメータが存在しなければ、第二引数のデフォルト値 'ゲスト' が返されます。

取得した値をWebページに表示する際には、セキュリティ上の理由から htmlspecialchars() 関数を使ってエスケープ処理を行うことが強く推奨されます。これにより、悪意のあるスクリプトの挿入を防ぎ、安全なページ表示を保てます。

なお、今回提供されたリファレンス情報にある GlobIterator クラスの getPerms メソッドは、ファイルシステムオブジェクトのパーミッション（権限）を取得するためのものであり、本サンプルコードで扱っているURLクエリパラメータの取得とは直接関係ありません。