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

Copy
1<?php
2
3/**
4 * FNM_CASEFOLD 定数の動作を示すサンプルコードです。
5 *
6 * FNM_CASEFOLD は fnmatch() 関数で使用されるフラグで、
7 * パターンと文字列のマッチングにおいて大文字・小文字を区別しないようにします。
8 */
9function demonstrateFnmCasefoldUsage(): void
10{
11    $pattern = '*.TXT'; // 大文字の拡張子を持つパターン
12    $targetString = 'report.txt'; // 小文字の拡張子を持つ文字列
13
14    echo "比較対象: パターン='{$pattern}', 文字列='{$targetString}'\n";
15
16    // FNM_CASEFOLD フラグを使用しない場合
17    // 大文字・小文字を区別するため、拡張子の '.TXT' と '.txt' は一致しない。
18    $matchWithoutCasefold = fnmatch($pattern, $targetString);
19    echo "FNM_CASEFOLD なし (大文字・小文字を区別): " . ($matchWithoutCasefold ? 'マッチ' : '不一致') . "\n";
20
21    // FNM_CASEFOLD フラグを使用する場合
22    // 大文字・小文字を区別しないため、拡張子の '.TXT' と '.txt' は一致する。
23    $matchWithCasefold = fnmatch($pattern, $targetString, FNM_CASEFOLD);
24    echo "FNM_CASEFOLD あり (大文字・小文字を区別しない): " . ($matchWithCasefold ? 'マッチ' : '不一致') . "\n";
25
26    echo "\n--- 別の例 ---\n";
27
28    $pattern2 = 'TEMP_*'; // 大文字で始まるパターン
29    $targetString2 = 'temp_file.log'; // 小文字で始まる文字列
30
31    echo "比較対象: パターン='{$pattern2}', 文字列='{$targetString2}'\n";
32
33    // FNM_CASEFOLD フラグを使用しない場合
34    // 大文字・小文字を区別するため、'TEMP_' と 'temp_' は一致しない。
35    $matchWithoutCasefold2 = fnmatch($pattern2, $targetString2);
36    echo "FNM_CASEFOLD なし (大文字・小文字を区別): " . ($matchWithoutCasefold2 ? 'マッチ' : '不一致') . "\n";
37
38    // FNM_CASEFOLD フラグを使用する場合
39    // 大文字・小文字を区別しないため、'TEMP_' と 'temp_' は一致する。
40    $matchWithCasefold2 = fnmatch($pattern2, $targetString2, FNM_CASEFOLD);
41    echo "FNM_CASEFOLD あり (大文字・小文字を区別しない): " . ($matchWithCasefold2 ? 'マッチ' : '不一致') . "\n";
42}
43
44// 関数を実行して、FNM_CASEFOLD の動作を確認します。
45demonstrateFnmCasefoldUsage();

PHP 8の定数FNM_CASEFOLDは、ファイル名などのパターンマッチングを行うfnmatch()関数で使用される特別なフラグです。この定数は引数を取らず、整数（int）の値を返します。

FNM_CASEFOLDの主な役割は、パターンと文字列を比較する際に、大文字・小文字を区別しないようにすることです。

サンプルコードでは、この動作が具体的に示されています。例えば、'*.TXT'というパターンと'report.txt'という文字列をfnmatch()関数で比較するケースを考えます。FNM_CASEFOLDフラグを指定しない場合、拡張子の.TXTと.txtは異なるものとして扱われるため、結果は「不一致」となります。しかし、FNM_CASEFOLDフラグを渡して比較すると、大文字・小文字が無視されるため、両者は「マッチ」と判定されます。同様に、'TEMP_*'というパターンと'temp_file.log'という文字列の比較でも、FNM_CASEFOLDを使用することで、先頭の'TEMP_'と'temp_'が同一とみなされ「マッチ」となります。このように、FNM_CASEFOLDはパターンマッチングの柔軟性を高めるために利用される便利な定数です。

Copy
1<?php
2
3/**
4 * 指定されたディレクトリ内で、特定のパターンに一致するファイルを検索します。
5 * FNM_CASEFOLD フラグを使用し、大文字・小文字を区別せずにファイル名をマッチングします。
6 * これは、例えば設定ファイルや画像ファイルなど、特定の拡張子を持つファイルを
7 * 大文字・小文字を気にせずに見つけたい場合に役立ちます。
8 *
9 * @param string $directoryPath 検索対象のディレクトリパス。例: '/var/www/html/app/config'
10 * @param string $pattern       検索するファイル名のパターン。ワイルドカード (*) や (?) が使用可能。例: '*.php', 'config_*.yml'
11 * @return array<string> マッチしたファイルのフルパスの配列。見つからない場合は空の配列。
12 */
13function findCaseInsensitiveFiles(string $directoryPath, string $pattern): array
14{
15    // ディレクトリが存在しないか、読み取り権限がない場合は処理を中止し、空の配列を返す
16    if (!is_dir($directoryPath) || !is_readable($directoryPath)) {
17        error_log("Error: Directory not found or not readable: " . $directoryPath);
18        return [];
19    }
20
21    $foundFiles = [];
22    // ディレクトリ内のすべてのエントリ（ファイルとサブディレクトリ）の名前を取得
23    // エラーが発生した場合はfalseを返すため、確認が必要
24    $items = scandir($directoryPath);
25
26    if ($items === false) {
27        error_log("Error: Could not scan directory: " . $directoryPath);
28        return [];
29    }
30
31    foreach ($items as $item) {
32        // 現在のディレクトリを示す '.' と親ディレクトリを示す '..' はスキップ
33        if ($item === '.' || $item === '..') {
34            continue;
35        }
36
37        // ファイルのフルパスを作成
38        $filePath = $directoryPath . DIRECTORY_SEPARATOR . $item;
39
40        // エントリがファイルであり、かつパターンにマッチするかどうかをチェック
41        // FNM_CASEFOLD は、fnmatch() 関数に大文字・小文字を区別しないマッチングを行うよう指示します
42        // 例えば、パターンが "*.php" であれば "MyFile.php" と "myfile.PHP" の両方にマッチします。
43        if (is_file($filePath) && fnmatch($pattern, $item, FNM_CASEFOLD)) {
44            $foundFiles[] = $filePath;
45        }
46    }
47
48    return $foundFiles;
49}
50
51// --- サンプル使用例 ---
52// このスクリプトと同じディレクトリ内に 'test_files' フォルダを作成し、
53// その中に複数のファイルを置いてテストしてください。
54// 例: "MyConfig.php", "myconfig.PHP", "README.md", "config.txt"
55
56$testDir = __DIR__ . DIRECTORY_SEPARATOR . 'test_files';
57$searchPattern = '*.php'; // '.php' 拡張子を持つファイルを検索するパターン
58
59// テスト用にディレクトリとファイルを作成（スクリプト実行時の一時的なセットアップ）
60if (!is_dir($testDir)) {
61    mkdir($testDir);
62}
63file_put_contents($testDir . DIRECTORY_SEPARATOR . 'MyConfig.php', '<?php // MyConfig content');
64file_put_contents($testDir . DIRECTORY_SEPARATOR . 'myconfig.PHP', '<?php // myconfig content');
65file_put_contents($testDir . DIRECTORY_SEPARATOR . 'config.txt', 'This is a text file.');
66file_put_contents($testDir . DIRECTORY_SEPARATOR . 'README.md', '# README file');
67
68echo "--- ファイル検索開始 ---\n";
69echo "検索対象ディレクトリ: " . $testDir . "\n";
70echo "検索パターン: " . $searchPattern . " (大文字・小文字を区別しない)\n";
71
72// 関数を呼び出してファイルを検索
73$matchedFiles = findCaseInsensitiveFiles($testDir, $searchPattern);
74
75if (empty($matchedFiles)) {
76    echo "条件に一致するファイルは見つかりませんでした。\n";
77} else {
78    echo "見つかったファイル:\n";
79    foreach ($matchedFiles as $file) {
80        echo "- " . $file . "\n";
81    }
82}
83echo "--- ファイル検索終了 ---\n\n";
84
85// テスト用に作成したディレクトリとファイルをクリーンアップ（オプション）
86// 実際のアプリケーションではこの部分は不要です。
87array_map('unlink', glob($testDir . DIRECTORY_SEPARATOR . '*'));
88rmdir($testDir);
89?>

このPHPサンプルコードは、指定されたディレクトリ内で特定のパターンに一致するファイルを、大文字・小文字を区別せずに検索する方法を示しています。ここでは、PHP 8で利用可能なFNM_CASEFOLDという定数が中心的な役割を果たします。この定数はint型の値で、ファイル名のパターンマッチングを行うfnmatch()関数で使用され、大文字・小文字を区別しないマッチングを有効にします。

findCaseInsensitiveFiles関数は、検索対象のディレクトリパスを$directoryPath、検索するファイル名のパターンを$pattern（ワイルドカード*や?が使用可能）として受け取ります。内部ではscandir()でディレクトリ内のファイルを取得し、それぞれのファイルがis_file()でファイルであることを確認した後、fnmatch()関数でパターンに一致するかを判定します。この際、FNM_CASEFOLDをfnmatch()関数の第三引数に指定することで、例えば*.phpというパターンに対してMyConfig.phpやmyconfig.PHPのように、ファイル名の大文字・小文字を問わずに両方をマッチさせることが可能になります。関数は条件に一致するすべてのファイルのフルパスを文字列の配列として返します。ファイルが見つからない場合は空の配列が返されます。

この機能は、設定ファイルや画像ファイルなど、ファイル名の大文字・小文字が混在している環境で、柔軟かつ確実なファイル検索を実現したい場合に非常に役立ちます。実際の開発現場で、特定のファイルを効率的に見つける必要がある際に活用できます。