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

Copy
1<?php
2
3/**
4 * 指定されたパス内のディレクトリを降順で取得する関数。
5 *
6 * PHP の scandir() 関数と SCANDIR_SORT_DESCENDING 定数を使用し、
7 * 結果を is_dir() でフィルタリングしてディレクトリのみを返します。
8 * システムエンジニアを目指す初心者の方にも分かりやすいように、
9 * エラーハンドリングとコメントを含んでいます。
10 *
11 * @param string $path 検索対象のディレクトリパス
12 * @return array ディレクトリ名の配列。エラー発生時やディレクトリが見つからない場合は空の配列を返します。
13 */
14function getDirectoriesSortedDescending(string $path): array
15{
16    // 指定されたパスがディレクトリではない、または読み取り権限がない場合はエラーメッセージを表示し、空の配列を返します。
17    if (!is_dir($path) || !is_readable($path)) {
18        echo "エラー: 指定されたパス '{$path}' はディレクトリではないか、または読み取りできません。\n";
19        return [];
20    }
21
22    // scandir() 関数を使用して、指定されたディレクトリ内のすべてのファイルとディレクトリの一覧を取得します。
23    // SCANDIR_SORT_DESCENDING 定数を第2引数に指定することで、結果が降順 (Z-A) にソートされます。
24    // 例: 'dir_c', 'dir_b', 'dir_a' の順
25    $items = scandir($path, SCANDIR_SORT_DESCENDING);
26
27    // scandir() が失敗した場合 (例: 存在しないディレクトリを指定した場合)、エラーメッセージを表示し、空の配列を返します。
28    if ($items === false) {
29        echo "エラー: ディレクトリ '{$path}' の内容を読み取れませんでした。\n";
30        return [];
31    }
32
33    $directories = []; // ディレクトリ名を格納する配列を初期化
34    foreach ($items as $item) {
35        // 特殊なディレクトリである '.' (カレントディレクトリ) と '..' (親ディレクトリ) は結果から除外します。
36        if ($item === '.' || $item === '..') {
37            continue;
38        }
39
40        // 完全なパスを構築します。これにより、is_dir() が正しく機能します。
41        $fullPath = rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . $item;
42
43        // is_dir() 関数を使用して、現在の項目がディレクトリであるかを確認します。
44        if (is_dir($fullPath)) {
45            $directories[] = $item; // ディレクトリであれば、その名前を配列に追加します。
46        }
47    }
48
49    return $directories; // フィルタリングされ、降順にソートされたディレクトリ名の配列を返します。
50}
51
52// --------------------------------------------------------------------------
53// サンプルコードの実行例
54// --------------------------------------------------------------------------
55
56// このスクリプトと同じディレクトリ内に、テスト用のサブディレクトリを作成します。
57$testDirPath = __DIR__ . DIRECTORY_SEPARATOR . 'sample_dirs_sorted_desc';
58if (!is_dir($testDirPath)) {
59    // ディレクトリが存在しない場合、作成します。0777は推奨されませんが、サンプルとして使用します。
60    // 3番目の引数 'true' は、親ディレクトリが存在しない場合に再帰的に作成することを意味します。
61    mkdir($testDirPath, 0777, true);
62    // テスト用のサブディレクトリをいくつか作成します。
63    mkdir($testDirPath . DIRECTORY_SEPARATOR . 'dir_c');
64    mkdir($testDirPath . DIRECTORY_SEPARATOR . 'dir_a');
65    mkdir($testDirPath . DIRECTORY_SEPARATOR . 'dir_b');
66    // ファイルも作成し、ディレクトリのみが取得されることを確認します。
67    file_put_contents($testDirPath . DIRECTORY_SEPARATOR . 'file_x.txt', 'これはテストファイルです。');
68    echo "テストディレクトリとサブディレクトリを作成しました: {$testDirPath}\n";
69} else {
70    echo "テストディレクトリは既に存在します: {$testDirPath}\n";
71}
72
73echo "\n--- 降順にソートされたディレクトリ一覧 ---\n";
74
75// 作成したテストディレクトリに対して getDirectoriesSortedDescending 関数を実行します。
76$foundDirectories = getDirectoriesSortedDescending($testDirPath);
77
78if (empty($foundDirectories)) {
79    echo "指定されたパス '{$testDirPath}' にディレクトリは見つかりませんでした。\n";
80} else {
81    // 取得されたディレクトリ名を一つずつ表示します。
82    foreach ($foundDirectories as $dirName) {
83        echo "- " . $dirName . "\n";
84    }
85}
86
87// 注意: このサンプルコードで作成されたテストディレクトリ（sample_dirs_sorted_desc）は、
88// スクリプト実行後も削除されません。必要に応じて手動で削除してください。
89
90?>

このPHPサンプルコードは、指定されたパス内のディレクトリを、アルファベット順の降順（ZからA）で取得する方法を説明しています。主な目的は、scandir() 関数と SCANDIR_SORT_DESCENDING 定数を組み合わせて使用し、その結果からディレクトリのみを効率的に抽出することです。

getDirectoriesSortedDescending 関数は、検索対象のディレクトリパスを $path という文字列型の引数として受け取ります。まず、指定されたパスが実際に存在するディレクトリであり、かつ読み取り可能であるかを確認します。問題がある場合は、エラーメッセージを表示して空の配列を返します。次に、scandir() 関数を呼び出し、第2引数に SCANDIR_SORT_DESCENDING 定数を指定します。この定数を使用することで、scandir() 関数はディレクトリやファイルのリストを降順でソートして返します。

取得したリストから .（カレントディレクトリ）と ..（親ディレクトリ）のような特殊なエントリを除外した後、各項目が実際にディレクトリであるかどうかを is_dir() 関数で確認します。ディレクトリであると判断された項目のみが、最終的な結果の配列に追加されます。この関数の戻り値は、フィルタリングされ、降順にソートされたディレクトリ名の配列です。エラーが発生した場合やディレクトリが見つからない場合は、空の配列が返されます。このコードは、堅牢性を高めるための基本的なエラーハンドリングも組み込まれています。

Copy
1<?php
2
3/**
4 * 指定されたディレクトリの内容をファイル名降順で表示する関数。
5 *
6 * SCANDIR_SORT_DESCENDING 定数を使用し、scandir() のソート順を制御します。
7 * これは、システムエンジニアを目指す初心者向けの PHP scandir 関数の使用例です。
8 */
9function listDirectoryContentsDescending(string $directoryPath): void
10{
11    // scandir() を使用してディレクトリの内容を読み込みます。
12    // SCANDIR_SORT_DESCENDING 定数を第2引数に指定することで、
13    // 結果の配列がファイル名に基づいてアルファベット降順でソートされます。
14    $files = scandir($directoryPath, SCANDIR_SORT_DESCENDING);
15
16    // scandir() が失敗した場合（例: ディレクトリが存在しない、アクセス権がないなど）
17    if ($files === false) {
18        echo "エラー: ディレクトリ '{$directoryPath}' の読み込みに失敗しました。\n";
19        return;
20    }
21
22    echo "ディレクトリ '{$directoryPath}' の内容 (降順):\n";
23    foreach ($files as $file) {
24        echo "- " . $file . "\n";
25    }
26}
27
28// 現在のスクリプトがあるディレクトリ（__DIR__）の内容を降順で表示します。
29// このディレクトリには、通常 '.'（現在のディレクトリ）と '..'（親ディレクトリ）のエントリが含まれます。
30listDirectoryContentsDescending(__DIR__);

PHPのscandir()関数は、指定されたディレクトリ内のファイルやサブディレクトリの一覧を取得するために使用されます。通常、この関数はディレクトリ内のエントリをアルファベット昇順で返しますが、ソート順を制御するためのオプションも提供されています。

SCANDIR_SORT_DESCENDINGは、PHP 8から利用できる定数で、scandir()関数の第2引数に指定することで、ファイルやサブディレクトリのリストをアルファベット順の「降順」でソートさせることができます。この定数自体に引数や戻り値はありません。

サンプルコードのlistDirectoryContentsDescending関数では、scandir($directoryPath, SCANDIR_SORT_DESCENDING)のようにこの定数を使用しています。これにより、関数は指定されたディレクトリのファイル名をZからAの順に並べ替えた配列を戻り値として取得します。もしscandir()がディレクトリの読み込みに失敗した場合（例えば、ディレクトリが存在しない、アクセス権がないなど）は、falseが戻り値として返され、エラーメッセージが表示されるように処理されています。

この例は、現在のスクリプトがあるディレクトリの内容を降順で表示するものであり、システムエンジニアを目指す初心者の方でも、PHPでディレクトリの内容を簡単に操作する方法を理解するのに役立ちます。