【PHP8.x】FNM_PERIOD定数の使い方

Copy
1<?php
2
3/**
4 * 指定されたディレクトリ内でファイル名パターンに一致するファイルを検索します。
5 * FNM_PERIOD フラグを使用することで、先頭にピリオドを持つファイル（ドットファイル、例: .htaccess）の
6 * マッチング挙動を制御できます。
7 *
8 * この関数自体は大量のメモリを消費しません。しかし、もし検索結果として得られた
9 * 多数のファイルの内容をループ内でメモリにロードするような処理が続く場合、
10 * PHP-FPM の `memory_limit` 設定に抵触し、スクリプトが途中で停止する可能性があります。
11 * システムエンジニアとして、ファイル処理を行う際は `memory_limit` に注意が必要です。
12 *
13 * @param string $directoryPath 検索対象のディレクトリパス。
14 * @param string $pattern 一致させるファイル名パターン（例: '*.php', '.*'）。
15 * @return array パターンに一致したファイル名のリスト。ディレクトリ読み込みに失敗した場合は空の配列。
16 */
17function findFilesConsideringPeriod(string $directoryPath, string $pattern): array
18{
19    $matchingFiles = [];
20
21    // scandir() は指定されたディレクトリ内のすべてのファイルとディレクトリをリストアップします。
22    $filesInDir = scandir($directoryPath);
23
24    if ($filesInDir === false) {
25        // ディレクトリが存在しないか、読み取り権限がない場合のエラー処理
26        // エラーログに出力し、空の配列を返します。
27        error_log("Error: Could not read directory '{$directoryPath}'.");
28        return [];
29    }
30
31    foreach ($filesInDir as $file) {
32        // fnmatch() と FNM_PERIOD フラグを使用してファイル名をパターンと比較します。
33        // FNM_PERIOD の効果:
34        // 例えばパターンが '*' の場合、通常のファイル名 (e.g., 'script.php') はマッチしますが、
35        // 先頭にピリオドを持つファイル名 (e.g., '.env') はデフォルトではマッチしません。
36        // ドットファイルもマッチさせたい場合は、パターンを '.*' とする必要があります。
37        if (fnmatch($pattern, $file, FNM_PERIOD)) {
38            $matchingFiles[] = $file;
39
40            // 注意: ここでマッチした各ファイルのコンテンツをメモリに読み込むような処理（例: file_get_contents()）を
41            // 大量のファイルに対して行うと、PHP-FPM の `memory_limit` 設定を超過し、
42            // スクリプトが "Allowed memory size of X bytes exhausted" エラーで終了する可能性があります。
43            // システムのメモリリソースを考慮し、処理設計や設定（php.iniのmemory_limit）を行う必要があります。
44            // 例: $fileContent = file_get_contents("{$directoryPath}/{$file}"); // これを実際に実行するとメモリ消費が増える
45        }
46    }
47
48    return $matchingFiles;
49}

このPHPのサンプルコードは、指定されたディレクトリ内でファイル名パターンに一致するファイルを検索するfindFilesConsideringPeriod関数を示しています。PHP 8で利用可能なFNM_PERIOD定数は、fnmatch()関数で使用されるフラグの一つで、ファイル名の先頭にあるピリオド（.）のマッチング挙動を制御します。この定数を指定することで、通常のパターン*は.htaccessのようなドットファイルにマッチせず、ドットファイルを対象とするには.*のようにパターンを明示する必要があります。

findFilesConsideringPeriod関数は、第一引数に検索対象の$directoryPath、第二引数に一致させる$pattern（例: '*.php', '.*'）を受け取ります。そして、パターンに一致したファイル名のリストを配列として返します。ディレクトリの読み込みに失敗した場合は空の配列が返されます。

システムエンジニアとして注意すべき点は、この関数自体はメモリを大量に消費しませんが、検索結果として得られた多数のファイルの内容をループ内で読み込む処理（例えばfile_get_contents()）が続く場合です。そのような処理を行うと、PHP-FPMのmemory_limit設定を超過する可能性があります。memory_limitを超過すると、スクリプトは「Allowed memory size of X bytes exhausted」エラーで停止します。大規模なファイル処理を行う際には、システムのメモリリソースを考慮した設計と、PHPの設定（php.iniのmemory_limit）に十分注意してください。

Copy
1<?php
2
3/**
4 * PHP-FPM環境でファイルパスのパターンマッチングを行う例。
5 *
6 * FNM_PERIOD 定数は、fnmatch() 関数で使用され、パターン内のワイルドカード（* や ?）が
7 * ファイル名の先頭のピリオドにマッチするのを防ぎます。
8 * これにより、システムエンジニアがログファイルや設定ファイルを処理する際、
9 * '.htaccess' や '.env' のような隠しファイル（ドットファイル）を意図せず含めたり除外したりする際に
10 * 細かい制御が可能になります。
11 *
12 * この例では、PHP-FPMが生成するログファイルや設定ファイルに見立てたリストに対して、
13 * FNM_PERIODの使用有無によるマッチング結果の違いを示します。
14 */
15function processPhpFpmRelatedFiles(): void
16{
17    // PHP-FPM環境やウェブサーバーディレクトリに存在しうるファイルパスのリストをシミュレート
18    $filesInDirectory = [
19        'php-fpm.log',       // PHP-FPMの標準ログファイル
20        'access.log',        // Webサーバーのアクセスログ (PHP-FPMのリクエストに関連する場合がある)
21        'error.log',         // Webサーバーのエラーログ
22        '.user.ini',         // PHPのユーザー設定ファイル (隠しドットファイル)
23        '.htaccess',         // Webサーバーの設定ファイル (隠しドットファイル)
24        'app.php',           // PHPアプリケーションファイル
25        '.env',              // 環境変数ファイル (隠しドットファイル)
26        'php-fpm.conf',      // PHP-FPMの設定ファイル
27        '.php-fpm.tmp',      // 一時的なPHP-FPM関連ファイル (隠しドットファイル)
28    ];
29
30    echo "--- 隠しドットファイルを除外し、'*.log' パターンにマッチするファイルを探す (FNM_PERIOD 使用) ---\n";
31    foreach ($filesInDirectory as $file) {
32        // パターンは '.log' で終わる全てのファイルにマッチしますが、
33        // FNM_PERIOD が有効なため、ファイル名の先頭が '.' の場合はマッチしません。
34        // 例: '.php-fpm.tmp' はマッチしません。
35        if (fnmatch('*.log', $file, FNM_PERIOD)) {
36            echo "  [MATCHED] (FNM_PERIOD) " . $file . "\n";
37        } else {
38            echo "  [SKIPPED] (FNM_PERIOD) " . $file . "\n";
39        }
40    }
41
42    echo "\n--- 隠しドットファイルを含め、'*.log' パターンにマッチするファイルを探す (FNM_PERIOD 不使用) ---\n";
43    foreach ($filesInDirectory as $file) {
44        // FNM_PERIOD が無効なため、ワイルドカード '*' は先頭の '.' にもマッチします。
45        // 例: '.php-fpm.tmp' がマッチする可能性があります。
46        if (fnmatch('*.log', $file)) {
47            echo "  [MATCHED] (No FNM_PERIOD) " . $file . "\n";
48        } else {
49            echo "  [SKIPPED] (No FNM_PERIOD) " . $file . "\n";
50        }
51    }
52}
53
54// 関数を実行し、FNM_PERIOD定数の動作を示す
55processPhpFpmRelatedFiles();

PHP 8におけるFNM_PERIOD定数は、ファイルパスのパターンマッチングを行うfnmatch()関数で使用されるフラグの一つです。この定数を利用することで、パターン内のワイルドカード（*や?など）がファイル名の先頭にあるピリオド（.）にマッチするのを防ぎます。これにより、.htaccessや.envのような隠しファイル（ドットファイル）をパターンマッチングの対象から意図的に除外したり、含めたりといった細かい制御が可能になります。

例えば、PHP-FPMのログファイルや設定ファイルを処理する際、「*.log」といったパターンでログファイルを検索するケースを考えます。FNM_PERIODを指定すると、ファイル名が「.」で始まる「.php-fpm.tmp」のような隠しファイルは「*.log」というパターンにマッチしなくなります。一方、FNM_PERIODを指定しない場合、これらの隠しファイルもパターンにマッチする可能性があります。

サンプルコードでは、PHP-FPM関連のファイルに見立てたリストに対し、FNM_PERIODを使用した場合としない場合で、*.logパターンでのマッチング結果の違いを具体的に示しています。定数であるため引数はなく、それ自体が機能の挙動を制御する値を持つため戻り値もありません。隠しドットファイルの扱いに柔軟性を持たせる際に役立つ重要な定数です。