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

Copy
1<?php
2
3/**
4 * GLOB_NOESCAPE定数の使用例を示します。
5 *
6 * glob() 関数において、GLOB_NOESCAPE フラグはバックスラッシュ (\) を
7 * エスケープ文字として扱わないようにします。
8 * これにより、パターン内のバックスラッシュはリテラル文字として解釈され、
9 * その後に続くワイルドカード文字 (例: *) がエスケープされなくなります。
10 *
11 * この関数は、一時的なファイルを作成し、GLOB_NOESCAPE の有無による
12 * glob() の挙動の違いを比較します。
13 */
14function demonstrateGlobNoescape(): void
15{
16    // 一時ディレクトリとファイル名の設定
17    // ファイル名にワイルドカード文字 '*' を含ませて、エスケープの挙動を確認します。
18    $testDir = __DIR__ . '/temp_glob_test_' . uniqid();
19    $specialFileName = 'special*file.txt'; 
20    $filePath = $testDir . '/' . $specialFileName;
21
22    echo "--- GLOB_NOESCAPE 定数の使用例 ---" . PHP_EOL . PHP_EOL;
23
24    // 1. 一時ディレクトリとファイルを準備
25    if (!mkdir($testDir) && !is_dir($testDir)) {
26        echo "エラー: ディレクトリ '{$testDir}' の作成に失敗しました。" . PHP_EOL;
27        return;
28    }
29    if (file_put_contents($filePath, "This is a test file.") === false) {
30        echo "エラー: ファイル '{$filePath}' の作成に失敗しました。" . PHP_EOL;
31        rmdir($testDir); // ディレクトリもクリーンアップ
32        return;
33    }
34    echo "一時ディレクトリ '{$testDir}' を作成しました。" . PHP_EOL;
35    echo "ファイル '{$filePath}' を作成しました。(ファイル名に '*' が含まれます)" . PHP_EOL . PHP_EOL;
36
37    // 検索パターン: 'special\*'
38    // このパターンでは、バックスラッシュ '\' は本来、その後の '*' をエスケープする意図があります。
39    $pattern = $testDir . '/special\*.txt';
40    echo "検索パターン: '{$pattern}'" . PHP_EOL . PHP_EOL;
41
42    // 2. GLOB_NOESCAPE なしの場合の挙動
43    echo "--- GLOB_NOESCAPE なしの場合 ---" . PHP_EOL;
44    echo "バックスラッシュ ('\\') は次のワイルドカード ('*') をエスケープ文字として扱います。" . PHP_EOL;
45    echo "そのため、リテラルの '*' を含むファイル名 '{$specialFileName}' を検索します。" . PHP_EOL;
46    $resultsWithoutNoescape = glob($pattern);
47    if ($resultsWithoutNoescape !== false && count($resultsWithoutNoescape) > 0) {
48        echo "検索結果:" . PHP_EOL;
49        foreach ($resultsWithoutNoescape as $file) {
50            echo "- " . basename($file) . PHP_EOL;
51        }
52    } else {
53        echo "ファイルは見つかりませんでした。(エラーが発生したか、期待外の結果です)" . PHP_EOL;
54    }
55    echo PHP_EOL;
56
57    // 3. GLOB_NOESCAPE ありの場合の挙動
58    echo "--- GLOB_NOESCAPE ありの場合 ---" . PHP_EOL;
59    echo "GLOB_NOESCAPE が指定されているため、バックスラッシュ ('\\') はエスケープ文字として機能しません。" . PHP_EOL;
60    echo "バックスラッシュとアスタリスクはどちらもリテラル文字として扱われ、" . PHP_EOL;
61    echo "正確に 'special\\*.txt' という名前のファイルを検索します。" . PHP_EOL;
62    $resultsWithNoescape = glob($pattern, GLOB_NOESCAPE);
63    if ($resultsWithNoescape !== false && count($resultsWithNoescape) > 0) {
64        echo "検索結果:" . PHP_EOL;
65        foreach ($resultsWithNoescape as $file) {
66            echo "- " . basename($file) . PHP_EOL;
67        }
68    } else {
69        echo "ファイルは見つかりませんでした。(これは期待通りの結果です。'special\\*.txt'というファイルは存在しないため)" . PHP_EOL;
70    }
71    echo PHP_EOL;
72
73    // 4. クリーンアップ
74    // 作成したファイルを削除
75    if (file_exists($filePath)) {
76        unlink($filePath);
77    }
78    // 作成したディレクトリを削除
79    if (is_dir($testDir)) {
80        rmdir($testDir);
81    }
82    echo "一時ファイルとディレクトリをクリーンアップしました。" . PHP_EOL;
83}
84
85// 関数の実行
86demonstrateGlobNoescape();

PHP 8のGLOB_NOESCAPE定数は、glob()関数と組み合わせて使用されるフラグの一つです。この定数は引数を取らず、整数（int）値を返します。glob()関数は、特定のパターンに一致するファイルやディレクトリのパスを検索しますが、そのパターン内でワイルドカード文字（例: *）をリテラルとして扱いたい場合、通常はバックスラッシュ（\）でエスケープします。

GLOB_NOESCAPE定数をglob()関数の第二引数に指定すると、このバックスラッシュによるエスケープ機能が無効になります。これにより、パターン内のバックスラッシュはエスケープ文字ではなく、単なるリテラル文字として解釈されるようになります。

サンプルコードでは、ファイル名にワイルドカード文字のアスタリスク（*）が含まれるファイルを一時的に作成し、検索パターンに「\と*」を組み合わせた場合の挙動を比較しています。GLOB_NOESCAPEを指定しない場合、バックスラッシュは続くアスタリスクをエスケープし、リテラルのアスタリスクを含むファイル名を検索します。一方、GLOB_NOESCAPEを指定すると、バックスラッシュはエスケープ文字として機能せず、パターン内のバックスラッシュとアスタリスクがどちらもリテラル文字として扱われるため、厳密に「special\*.txt」という名前のファイルだけを検索するようになり、期待される検索結果が変わることが示されています。

Copy
1<?php
2
3/**
4 * Demonstrates the use of GLOB_NOESCAPE and GLOB_NOSORT flags with the glob() function.
5 *
6 * GLOB_NOESCAPE: Backslashes do not quote metacharacters. This means a backslash
7 *                followed by a metacharacter (like *, ?, [) is treated as
8 *                a literal backslash followed by the metacharacter itself.
9 *                It effectively disables the backslash as an escape character for metacharacters.
10 * GLOB_NOSORT:   Return files as they appear in the directory (unsorted).
11 *                By default, glob() sorts the results alphabetically.
12 */
13function demonstrateGlobFlags(): void
14{
15    // 1. Setup: Create a temporary directory and some test files.
16    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid('glob_demo_');
17    if (!mkdir($tempDir) && !is_dir($tempDir)) {
18        echo "Error: Could not create temporary directory: " . $tempDir . "\n";
19        return;
20    }
21
22    // Define file names and their full paths
23    $fileAName = 'fileA.txt';
24    $fileBName = 'fileB.txt';
25    $fileCName = 'fileC.txt';
26    $fileLiteralAsteriskName = 'file*.txt'; // This file name contains a literal asterisk
27
28    $filePathA = $tempDir . DIRECTORY_SEPARATOR . $fileAName;
29    $filePathB = $tempDir . DIRECTORY_SEPARATOR . $fileBName;
30    $filePathC = $tempDir . DIRECTORY_SEPARATOR . $fileCName;
31    $filePathLiteralAsterisk = $tempDir . DIRECTORY_SEPARATOR . $fileLiteralAsteriskName;
32
33    // Create test files
34    file_put_contents($filePathA, 'content');
35    file_put_contents($filePathB, 'content');
36    file_put_contents($filePathC, 'content');
37    file_put_contents($filePathLiteralAsterisk, 'content');
38
39    echo "--- Demonstrating GLOB_NOESCAPE ---\n";
40
41    // Scenario 1: Search for 'file*.txt' (wildcard match)
42    // The '*' acts as a wildcard, matching any sequence of characters.
43    // This will find 'fileA.txt', 'fileB.txt', 'fileC.txt', and 'file*.txt'.
44    echo "Using glob('" . $tempDir . DIRECTORY_SEPARATOR . "file*.txt') (default wildcard):\n";
45    $resultsWildcard = glob($tempDir . DIRECTORY_SEPARATOR . 'file*.txt');
46    print_r($resultsWildcard);
47    echo "Expected: All files starting with 'file' and ending with '.txt', including '" . $filePathLiteralAsterisk . "'. (Alphabetically sorted by default)\n\n";
48
49    // Scenario 2: Search for 'file\*.txt' (escaped asterisk, default behavior)
50    // The backslash '\' escapes the asterisk '*', so it matches the literal file "file*.txt".
51    // This pattern specifically looks for a file whose name is exactly "file*.txt".
52    echo "Using glob('" . $tempDir . DIRECTORY_SEPARATOR . "file\\*.txt') (default, backslash escapes metacharacter):\n";
53    $resultsEscaped = glob($tempDir . DIRECTORY_SEPARATOR . 'file\\*.txt');
54    print_r($resultsEscaped);
55    echo "Expected: Only '" . $filePathLiteralAsterisk . "'.\n\n";
56
57    // Scenario 3: Search for 'file\*.txt' with GLOB_NOESCAPE
58    // With GLOB_NOESCAPE, backslashes do NOT escape metacharacters.
59    // So 'file\*' is interpreted as a literal 'file' followed by a literal backslash '\' and then a literal asterisk '*'.
60    // It will NOT find 'file*.txt' because the pattern itself contains a literal '\' that is not present in the 'file*.txt' filename.
61    echo "Using glob('" . $tempDir . DIRECTORY_SEPARATOR . "file\\*.txt', GLOB_NOESCAPE) (backslashes do NOT escape):\n";
62    $resultsNoEscape = glob($tempDir . DIRECTORY_SEPARATOR . 'file\\*.txt', GLOB_NOESCAPE);
63    print_r($resultsNoEscape); // Expected: empty array
64    echo "Expected: empty array, as 'file\\*.txt' is treated as a literal sequence including the backslash, which doesn't exist in our file names.\n\n";
65
66    echo "--- Demonstrating GLOB_NOSORT ---\n";
67
68    // Scenario 4: Search for 'file?.txt' (default sorted)
69    // The '?' acts as a wildcard for a single character.
70    // This matches 'fileA.txt', 'fileB.txt', 'fileC.txt'. Results are sorted alphabetically by default.
71    echo "Using glob('" . $tempDir . DIRECTORY_SEPARATOR . "file?.txt') (default sorted):\n";
72    $resultsSorted = glob($tempDir . DIRECTORY_SEPARATOR . 'file?.txt');
73    print_r($resultsSorted);
74    echo "Expected: ['" . $filePathA . "', '" . $filePathB . "', '" . $filePathC . "'] in alphabetical order.\n\n";
75
76    // Scenario 5: Search for 'file?.txt' with GLOB_NOSORT
77    // The GLOB_NOSORT flag prevents glob() from sorting the results alphabetically.
78    // The order might vary based on the underlying filesystem's directory reading order.
79    echo "Using glob('" . $tempDir . DIRECTORY_SEPARATOR . "file?.txt', GLOB_NOSORT) (unsorted):\n";
80    $resultsUnsorted = glob($tempDir . DIRECTORY_SEPARATOR . 'file?.txt', GLOB_NOSORT);
81    print_r($resultsUnsorted);
82    echo "Expected: Results whose order is not guaranteed to be alphabetical (e.g., ['" . $filePathB . "', '" . $filePathA . "', '" . $filePathC . "']).\n\n";
83    
84    // 2. Cleanup: Remove temporary files and the created directory.
85    $files = glob($tempDir . DIRECTORY_SEPARATOR . '*');
86    foreach ($files as $file) {
87        if (is_file($file)) {
88            unlink($file);
89        }
90    }
91    rmdir($tempDir);
92    echo "Temporary directory and files cleaned up.\n";
93}
94
95// Execute the demonstration function
96demonstrateGlobFlags();
97

PHPのglob()関数は、指定されたパターンに一致するファイルやディレクトリのパスを検索し、それらのパスの配列を返す機能を持っています。このglob()関数の挙動を制御するために使用されるのが、GLOB_NOESCAPEとGLOB_NOSORTという定数です。これらはどちらも整数型の定数であり、引数は持ちません。

GLOB_NOESCAPEは、ファイルパスのパターン中でバックスラッシュ（\）が特別な意味を持つメタキャラクター（*、?、[など）をエスケープする機能を無効にするために使用されます。通常、\は後続のメタキャラクターを「文字そのもの」として扱わせますが、GLOB_NOESCAPEが指定されると、\は単なる文字として解釈され、その後のメタキャラクターは通常通りワイルドカードとして機能します。これにより、特定の文字を含むファイル名を正確にマッチさせたい場合に役立ちます。

GLOB_NOSORTは、glob()関数が見つけたファイルパスの結果をソートしないように指示する定数です。デフォルトでは、glob()関数は検索結果のファイルパスをアルファベット順に並び替えて返します。しかし、GLOB_NOSORTを指定することで、ソート処理を行わずにファイルシステムが返す順序で結果がそのまま返されます。これにより、ソートによる処理時間を省くことができ、パフォーマンスが向上する可能性があります。

サンプルコードでは、一時的なファイルを作成し、glob()関数の第2引数にこれらの定数を渡すことで、ファイル検索の挙動がどのように変化するかを具体的に示しています。GLOB_NOESCAPEがパターン内のエスケープの解釈に、GLOB_NOSORTが結果の並び順にそれぞれ影響を与えることが確認できます。