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

Copy
1<?php
2
3/**
4 * scandir() 関数におけるファイルソート順の定数使用例をデモンストレーションします。
5 * SCANDIR_SORT_ASCENDING と SCANDIR_SORT_DESCENDING を比較して表示します。
6 *
7 * システムエンジニアを目指す初心者向けに、一時ディレクトリとファイルを作成し、
8 * クリーンアップまで含んだ単体で動作可能なコードです。
9 */
10function demonstrateScandirSorting(): void
11{
12    // 一時的なテストディレクトリ名を作成します。uniqid() を使うことで、実行ごとにユニークな名前になります。
13    $testDir = 'scandir_test_dir_' . uniqid();
14
15    echo "--- scandir() 定数ソート順デモンストレーション ---\n\n";
16
17    // 1. テストディレクトリの作成
18    if (!mkdir($testDir, 0777, true)) {
19        echo "エラー: ディレクトリ '$testDir' の作成に失敗しました。\n";
20        return;
21    }
22    echo "テストディレクトリ '$testDir' を作成しました。\n";
23
24    // 2. テストファイルとサブディレクトリの作成
25    // ソート順が分かりやすいように、ファイル名を意図的にバラバラに配置します。
26    $itemsToCreate = ['file_b.txt', 'file_a.txt', 'subdir_1', 'file_c.txt', '.hidden_file'];
27    foreach ($itemsToCreate as $item) {
28        $itemPath = $testDir . '/' . $item;
29        if (strpos($item, 'subdir_') !== false) { // サブディレクトリの場合
30            if (!mkdir($itemPath)) {
31                echo "エラー: サブディレクトリ '$itemPath' の作成に失敗しました。\n";
32            }
33        } else { // ファイルの場合
34            if (file_put_contents($itemPath, "Content for $item.") === false) {
35                echo "エラー: ファイル '$itemPath' の作成に失敗しました。\n";
36            }
37        }
38    }
39    echo "テスト用のファイルとサブディレクトリをいくつか作成しました。\n\n";
40
41    // 3. SCANDIR_SORT_ASCENDING (昇順) でディレクトリをスキャン
42    echo "=== ディレクトリ内容を昇順で取得 (SCANDIR_SORT_ASCENDING) ===\n";
43    // SCANDIR_SORT_ASCENDING 定数 (値は 0) を使用すると、ファイルやディレクトリが名前の昇順 (A-Z) でソートされます。
44    // scandir() 関数は、結果に常に '.' (カレントディレクトリ) と '..' (親ディレクトリ) を含みます。
45    $ascendingOrder = scandir($testDir, SCANDIR_SORT_ASCENDING);
46    if ($ascendingOrder === false) {
47        echo "エラー: ディレクトリ '$testDir' の読み込みに失敗しました。\n";
48    } else {
49        print_r($ascendingOrder); // 配列の内容を見やすく表示
50    }
51    echo "\n";
52
53    // 4. SCANDIR_SORT_DESCENDING (降順) でディレクトリをスキャン
54    echo "=== ディレクトリ内容を降順で取得 (SCANDIR_SORT_DESCENDING) ===\n";
55    // キーワードにもある SCANDIR_SORT_DESCENDING 定数 (値は 1) を使用すると、
56    // ファイルやディレクトリが名前の降順 (Z-A) でソートされます。
57    $descendingOrder = scandir($testDir, SCANDIR_SORT_DESCENDING);
58    if ($descendingOrder === false) {
59        echo "エラー: ディレクトリ '$testDir' の読み込みに失敗しました。\n";
60    } else {
61        print_r($descendingOrder); // 配列の内容を見やすく表示
62    }
63    echo "\n";
64
65    // 5. クリーンアップ
66    echo "=== クリーンアップ ===\n";
67    // 作成したファイルとサブディレクトリを削除します。
68    // scandir() の結果から '.' と '..' を除外してループ処理を行います。
69    $itemsInDir = array_diff(scandir($testDir), ['.', '..']);
70    foreach ($itemsInDir as $item) {
71        $itemPath = $testDir . '/' . $item;
72        if (is_file($itemPath)) {
73            unlink($itemPath); // ファイルを削除
74        } elseif (is_dir($itemPath)) {
75            rmdir($itemPath); // 空のディレクトリを削除
76        }
77    }
78
79    // 最後にテストディレクトリ自体を削除します。
80    if (rmdir($testDir)) {
81        echo "テストディレクトリ '$testDir' とその内容を削除しました。\n";
82    } else {
83        echo "エラー: テストディレクトリ '$testDir' の削除に失敗しました。\n";
84    }
85
86    echo "\n--- デモンストレーション終了 ---\n";
87}
88
89// 関数を実行してデモンストレーションを開始します。
90demonstrateScandirSorting();

PHP 8で利用可能なSCANDIR_SORT_ASCENDINGは、scandir()関数がディレクトリ内のファイルをスキャンする際のソート順を指定するための定数です。この定数自体は引数を持たず、値を返しません。scandir()関数の第二引数にこの定数を指定することで、ファイル名やディレクトリ名がアルファベット順（AからZへ）に昇順でソートされた配列として結果が返されます。

提供されたサンプルコードでは、まず一時的なディレクトリと複数のテストファイルを作成します。その後、scandir()関数にSCANDIR_SORT_ASCENDING定数を渡してディレクトリ内容を昇順で取得し、その結果を表示します。さらに、関連キーワードであるSCANDIR_SORT_DESCENDING定数（降順ソート）も使用し、両者の違いを比較して示します。SCANDIR_SORT_DESCENDINGを用いると、ファイルやディレクトリはZからAへ降順でソートされます。コードは最後に、作成した一時ディレクトリとファイルを適切に削除するクリーンアップ処理も実行します。このデモンストレーションにより、scandir()関数におけるソート順指定の挙動を明確に理解することができます。

Copy
1<?php
2
3/**
4 * scandir() 関数と SCANDIR_SORT_ASCENDING 定数を使って、
5 * ディレクトリ内のエントリを昇順で取得するサンプルコードです。
6 *
7 * このコードは一時的なディレクトリとファイルを自動で作成し、
8 * その内容をスキャンして表示した後、すべてクリーンアップします。
9 */
10function demonstrateScandirSortAscending(): void
11{
12    $testDir = 'temp_scandir_example_' . uniqid(); // 一時ディレクトリ名を生成
13
14    // テスト用ディレクトリの作成
15    if (!mkdir($testDir)) {
16        echo "エラー: ディレクトリ '{$testDir}' の作成に失敗しました。" . PHP_EOL;
17        return;
18    }
19
20    // テストファイルを意図的に順不同で作成し、ソート効果を確認
21    file_put_contents("{$testDir}/c_file.txt", "Content C");
22    file_put_contents("{$testDir}/a_file.txt", "Content A");
23    file_put_contents("{$testDir}/b_file.txt", "Content B");
24
25    echo "--- scandir() と SCANDIR_SORT_ASCENDING の使用例 ---" . PHP_EOL;
26
27    // scandir() 関数でディレクトリの内容を取得します。
28    // 第2引数に SCANDIR_SORT_ASCENDING を指定すると、
29    // ディレクトリ内のエントリ（ファイルやサブディレクトリ）が名前のアルファベット順（昇順）でソートされます。
30    // 結果には '.' (カレントディレクトリ) と '..' (親ディレクトリ) も含まれます。
31    $sortedEntries = scandir($testDir, SCANDIR_SORT_ASCENDING);
32
33    if ($sortedEntries === false) {
34        echo "エラー: ディレクトリ '{$testDir}' のスキャンに失敗しました。" . PHP_EOL;
35        // スキャンに失敗した場合も、作成したディレクトリを削除を試みます。
36        rmdir($testDir); 
37        return;
38    }
39
40    echo "ソートされたファイルとディレクトリの一覧:" . PHP_EOL;
41    foreach ($sortedEntries as $entry) {
42        echo "- " . $entry . PHP_EOL;
43    }
44    echo PHP_EOL;
45
46    // クリーンアップ: 作成したファイルとディレクトリを削除します
47    unlink("{$testDir}/c_file.txt");
48    unlink("{$testDir}/a_file.txt");
49    unlink("{$testDir}/b_file.txt");
50    rmdir($testDir);
51    echo "一時ファイルとディレクトリを削除し、クリーンアップが完了しました。" . PHP_EOL;
52}
53
54// 関数を実行します
55demonstrateScandirSortAscending();

PHPのSCANDIR_SORT_ASCENDINGは、PHP 8で利用できる組み込みの定数です。この定数自体に引数や戻り値はありませんが、特定の関数と組み合わせて使用することで、その関数の挙動を制御する役割を果たします。

特にscandir()関数と組み合わせて使用する際に真価を発揮します。scandir()関数は、指定されたディレクトリ内のファイルやサブディレクトリといったエすべてのエントリを一覧で取得するための関数です。このscandir()関数の第2引数にSCANDIR_SORT_ASCENDING定数を指定すると、ディレクトリ内のエントリが名前のアルファベット順（昇順）にソートされた状態で取得されます。scandir()関数の戻り値は、成功した場合はソートされたエントリの文字列配列となり、失敗した場合はfalseを返します。

提示されたサンプルコードでは、一時的なディレクトリとファイルを意図的に順不同で作成し、そのディレクトリをscandir()関数とSCANDIR_SORT_ASCENDING定数を使ってスキャンしています。これにより、ファイルやディレクトリ名がアルファベット順に並べ替えられて表示されることを確認できます。結果には、カレントディレクトリを示す「.」と親ディレクトリを示す「..」も含まれます。最後に、作成された一時ファイルとディレクトリは自動でクリーンアップされます。