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

Copy
1<?php
2
3/**
4 * glob() 関数で GLOB_NOSORT 定数を使用した場合の動作を示すサンプルコードです。
5 *
6 * GLOB_NOSORT は glob() 関数に渡すフラグの一つで、
7 * 結果のパスがソートされないことを意味します。
8 * 通常 glob() は結果をアルファベット順にソートしますが、
9 * このフラグを使うとファイルシステムが返した順序でパスが返されます。
10 * この順序はファイルシステムやOSによって異なる場合があります。
11 */
12function demonstrateGlobNosort(): void
13{
14    // テスト用のディレクトリを作成
15    $testDir = __DIR__ . DIRECTORY_SEPARATOR . 'temp_glob_test_' . uniqid();
16    if (!is_dir($testDir)) {
17        mkdir($testDir);
18    }
19
20    // テスト用のファイルをいくつか作成（意図的にソートされていない順序で）
21    $filesToCreate = ['c_file.txt', 'a_file.txt', 'b_file.txt'];
22    foreach ($filesToCreate as $file) {
23        file_put_contents($testDir . DIRECTORY_SEPARATOR . $file, "Content for $file");
24    }
25
26    echo "--- テストファイルの準備 ---\n";
27    echo "以下のファイルを作成しました: " . implode(', ', $filesToCreate) . " (ディレクトリ: $testDir)\n\n";
28
29    $pattern = $testDir . DIRECTORY_SEPARATOR . '*.txt';
30
31    // 1. GLOB_NOSORT なしの場合（デフォルトのソート動作）
32    echo "--- GLOB_NOSORT なしの場合 ---\n";
33    echo "通常、glob() は結果をアルファベット順にソートします。\n";
34    $filesSorted = glob($pattern);
35    echo "結果:\n";
36    print_r($filesSorted);
37    echo "\n";
38
39    // 2. GLOB_NOSORT ありの場合（ソートなし）
40    echo "--- GLOB_NOSORT ありの場合 ---\n";
41    echo "GLOB_NOSORT を指定すると、結果はソートされずに返されます。\n";
42    // 返される順序はファイルシステムによって異なる可能性があります。
43    $filesUnsorted = glob($pattern, GLOB_NOSORT);
44    echo "結果:\n";
45    print_r($filesUnsorted);
46    echo "\n";
47
48    // テストファイルのクリーンアップ
49    echo "--- テストファイルのクリーンアップ ---\n";
50    foreach ($filesToCreate as $file) {
51        unlink($testDir . DIRECTORY_SEPARATOR . $file);
52    }
53    rmdir($testDir);
54    echo "作成した一時ファイルとディレクトリを削除しました。\n";
55}
56
57// 関数を実行して動作を確認します。
58demonstrateGlobNosort();

PHPのGLOB_NOSORTは、glob()関数で使用する特別な定数です。glob()関数は、指定したパターンに一致するファイルやディレクトリのパスを検索し、そのリストを配列として返します。通常、glob()関数は検索結果のパスをアルファベット順にソートして返しますが、GLOB_NOSORTを第二引数に指定することで、このソート処理を行わないようにできます。GLOB_NOSORT自体は引数を取らず、内部的には整数値（int）として扱われるフラグです。この定数を使用すると、ファイルシステムがパスを返す順番でそのまま結果が得られますが、その順序はファイルシステムやOSによって異なるため、特定の結果順序を保証するものではありません。サンプルコードでは、一時的なファイルを複数作成し、GLOB_NOSORTを指定しない場合（デフォルトでソートされる）と指定した場合（ソートされない）のglob()関数の動作を比較しています。これにより、ソートされたリストとソートされないリストの違いを明確に確認できます。

Copy
1<?php
2
3/**
4 * PHPのglob()関数におけるGLOB_NOSORT定数の使用例を示します。
5 * GLOB_NOSORTを使用しない場合（デフォルト）と使用した場合の、
6 * 結果のパス名のソート順の違いを比較します。
7 */
8function demonstrateGlobNosort(): void
9{
10    // 一時ディレクトリを作成し、テストファイルを用意します。
11    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_glob_test_' . uniqid();
12    if (!mkdir($tempDir) && !is_dir($tempDir)) {
13        echo "エラー: 一時ディレクトリの作成に失敗しました。\n";
14        return;
15    }
16
17    // テストファイルを作成します。ファイル名がアルファベット順ではない順序で作成することで、
18    // ソートの効果を分かりやすくします。
19    $filesToCreate = ['file_b.txt', 'file_a.txt', 'file_c.txt'];
20    foreach ($filesToCreate as $fileName) {
21        $filePath = $tempDir . DIRECTORY_SEPARATOR . $fileName;
22        if (file_put_contents($filePath, "ファイル内容: {$fileName}") === false) {
23            echo "エラー: ファイル {$fileName} の作成に失敗しました。\n";
24            // エラー時は作成済みのファイルを削除し、ディレクトリも削除します。
25            foreach ($filesToCreate as $createdFile) {
26                $createdPath = $tempDir . DIRECTORY_SEPARATOR . $createdFile;
27                if (file_exists($createdPath)) {
28                    unlink($createdPath);
29                }
30            }
31            rmdir($tempDir);
32            return;
33        }
34    }
35
36    $pattern = $tempDir . DIRECTORY_SEPARATOR . 'file_*.txt';
37
38    echo "--- glob() で GLOB_NOSORT を指定しない場合 (デフォルトでソートされます) ---\n";
39    // GLOB_NOSORTを指定しない場合、結果のパス名はアルファベット順にソートされます。
40    $sortedFiles = glob($pattern);
41    if ($sortedFiles === false) {
42        echo "glob() の実行に失敗しました。\n";
43    } else {
44        foreach ($sortedFiles as $file) {
45            echo basename($file) . "\n";
46        }
47    }
48    echo "\n";
49
50    echo "--- glob() で GLOB_NOSORT を指定した場合 (ソートされません) ---\n";
51    // GLOB_NOSORTを指定すると、結果のパス名はソートされず、
52    // ファイルシステムが返す順序で取得されます。
53    $unsortedFiles = glob($pattern, GLOB_NOSORT);
54    if ($unsortedFiles === false) {
55        echo "glob() の実行に失敗しました。\n";
56    } else {
57        foreach ($unsortedFiles as $file) {
58            echo basename($file) . "\n";
59        }
60    }
61    echo "\n";
62
63    // 後処理: 作成したファイルとディレクトリを削除します。
64    foreach ($filesToCreate as $fileName) {
65        $filePath = $tempDir . DIRECTORY_SEPARATOR . $fileName;
66        if (file_exists($filePath)) {
67            unlink($filePath);
68        }
69    }
70    if (is_dir($tempDir)) {
71        rmdir($tempDir);
72    }
73}
74
75// 関数の実行
76demonstrateGlobNosort();

PHPのGLOB_NOSORT定数は、glob()関数がファイルやディレクトリのパスを検索した結果のソート順序を制御するためのオプションです。この定数は整数型の値を持つため、glob()関数の第二引数に指定して使用します。

通常、glob()関数は指定されたパターンに一致するパス名を見つけると、それらをアルファベット順にソートして配列として返します。しかし、GLOB_NOSORT定数を指定した場合、glob()関数は検索結果をソートせず、ファイルシステムがパス名を検出したそのままの順序で返します。これにより、不要なソート処理を省略できるため、パフォーマンスが向上する可能性や、ファイルシステムの物理的な順序を重視する場合に役立ちます。

サンプルコードでは、まず一時ディレクトリに複数のテストファイルを意図的にアルファベット順ではない順序で作成しています。その後、glob()関数をGLOB_NOSORTを指定しない場合（デフォルトの挙動）と、GLOB_NOSORTを指定した場合の二通りで実行し、それぞれの結果を比較しています。GLOB_NOSORTを指定しない場合はファイル名がソートされて表示されるのに対し、GLOB_NOSORTを指定した場合はソートされずに、ファイルシステムが返すであろう順序で表示されることが確認でき、この定数の挙動が明確に示されています。