【PHP8.x】RecursiveArrayIterator::ksort()メソッドの使い方

Copy
1<?php
2
3/**
4 * RecursiveArrayIterator を使用して配列のキーを降順にソートするサンプル。
5 *
6 * RecursiveArrayIterator::ksort メソッドには降順ソートのためのフラグは提供されていません。
7 * そのため、キーワード「descending」の要求に応えるには、カスタム比較関数を使用する
8 * RecursiveArrayIterator::uksort メソッドを利用するのが適切です。
9 *
10 * この例では、イテレータが扱うトップレベルの配列のキーを降順にソートします。
11 * ネストされた配列のキーをソートするには、別途再帰的な処理が必要です。
12 */
13function demonstrateRecursiveArrayIteratorDescendingKeySort(): void
14{
15    // ソート対象となるサンプルデータ
16    $data = [
17        'apple' => 100,
18        'banana' => 50,
19        'cherry' => 200,
20        'date' => [ // ネストされた配列のキーはこのメソッドではソートされません
21            'd1' => 10,
22            'd3' => 30,
23            'd2' => 20,
24        ],
25        'elderberry' => 150,
26    ];
27
28    echo "--- ソート前のデータ ---\n";
29    print_r($data);
30
31    // RecursiveArrayIterator のインスタンスを作成
32    $iterator = new RecursiveArrayIterator($data);
33
34    // RecursiveArrayIterator::uksort を使用して、キーを降順にソートします。
35    // ksort メソッド自体には降順ソートのオプションがないため、
36    // uksort を使ってカスタム比較ロジックを提供します。
37    // strcmp($keyB, $keyA) とすることで、キーを文字列として降順に比較します。
38    $iterator->uksort(function (string $keyA, string $keyB): int {
39        return strcmp($keyB, $keyA);
40    });
41
42    // ソート結果を新しい配列として取得します。
43    // uksort はイテレータの内部状態をソートしますが、元の配列を直接変更しません。
44    // 変更されたイテレータから配列のコピーを取得するには getArrayCopy() を使用します。
45    $sortedData = $iterator->getArrayCopy();
46
47    echo "\n--- キーを降順にソートした後のデータ (トップレベルのみ) ---\n";
48    print_r($sortedData);
49
50    // 参考：RecursiveArrayIterator::ksort を使用した場合
51    // ksort メソッドはキーを昇順にソートし、降順のフラグは提供されません。
52    // $iterator->ksort(SORT_REGULAR);
53    // $ascendingSortedData = $iterator->getArrayCopy();
54    // echo "\n--- ksort で昇順ソートした後のデータ (参考) ---\n";
55    // print_r($ascendingSortedData);
56}
57
58// 関数を実行して、ソート結果を確認します。
59demonstrateRecursiveArrayIteratorDescendingKeySort();

RecursiveArrayIterator::ksortは、RecursiveArrayIteratorが内部に保持する配列のキーをソートするためのメソッドです。引数$flagsにはソートの比較方法を示す定数（例えば、SORT_REGULARで通常の比較）を指定でき、ソート処理が成功した場合はtrue、失敗した場合はfalseが戻り値として返されます。このksortメソッドは基本的にキーを昇順にソートし、降順ソートのための直接的なオプションは提供されていません。

そのため、サンプルコードではキーを降順にソートするという要求に応じるために、RecursiveArrayIterator::uksortメソッドを使用しています。uksortは、開発者が自由に定義した比較関数を使ってキーをソートできる柔軟なメソッドです。サンプルコードでは、ソート対象の配列をRecursiveArrayIteratorのインスタンスに渡し、そのインスタンスに対してuksortメソッドを呼び出しています。

比較関数としてfunction (string $keyA, string $keyB): int { return strcmp($keyB, $keyA); }を指定することで、文字列キーを逆順に比較し、結果として配列のキーを降順に並べ替えています。このソート処理は、イテレータが扱うトップレベルの配列のキーにのみ適用され、ネストされた配列のキーはソートの対象外となります。ソートされた結果は、getArrayCopy()メソッドを利用して、新しい配列として取得し確認することができます。

Copy
1<?php
2
3/**
4 * 多次元配列の各レベルをキーで再帰的にソートします。
5 * RecursiveArrayIterator::ksort() メソッドを利用しています。
6 *
7 * @param array|RecursiveArrayIterator $data ソート対象の多次元配列、または RecursiveArrayIterator インスタンス。
8 * @param int $flags ソートの挙動を指定するフラグ (例: SORT_REGULAR, SORT_NUMERIC, SORT_STRING)。
9 *                     詳細は PHP の ksort 関数ドキュメントを参照してください。
10 * @return array キーがソートされた多次元配列。
11 */
12function recursiveKsortMultiDimensionalArray(array|RecursiveArrayIterator $data, int $flags = SORT_REGULAR): array
13{
14    // 引数が配列であれば RecursiveArrayIterator でラップし、そうでなければ既存のイテレータを使用します。
15    $iterator = ($data instanceof RecursiveArrayIterator) ? $data : new RecursiveArrayIterator($data);
16
17    // 現在のイテレータが指す配列のキーをソートします。
18    // このメソッドは配列の内部状態を変更し、成功した場合に true を返します。
19    // 例外的なエラーケースを考慮しない場合、戻り値の確認は省略されることがあります。
20    $iterator->ksort($flags);
21
22    // ソートされた要素を格納する新しい配列を初期化します。
23    $sortedArray = [];
24
25    // イテレータを走査し、各要素を処理します。
26    foreach ($iterator as $key => $value) {
27        // もし現在の要素が子要素（つまり配列）を持っている場合
28        if ($iterator->hasChildren()) {
29            // 子イテレータを取得し、再帰的にこの関数を呼び出してソートします。
30            $sortedArray[$key] = recursiveKsortMultiDimensionalArray($iterator->getChildren(), $flags);
31        } else {
32            // 子要素がない場合はそのまま値を追加します。
33            $sortedArray[$key] = $value;
34        }
35    }
36
37    return $sortedArray;
38}
39
40// サンプルとなる多次元配列
41$originalArray = [
42    'fruit' => [
43        'banana' => 'yellow',
44        'apple' => 'red',
45        'grape' => 'purple'
46    ],
47    'vegetable' => [
48        'carrot' => 'orange',
49        'broccoli' => 'green',
50        'potato' => 'brown'
51    ],
52    'cereal' => 'oats',
53    'dairy' => [
54        'cheese' => 'white',
55        'milk' => 'white'
56    ]
57];
58
59echo "--- オリジナル配列 ---" . PHP_EOL;
60print_r($originalArray);
61
62// 多次元配列をキーで再帰的にソート (文字列として比較)
63$sortedArray = recursiveKsortMultiDimensionalArray($originalArray, SORT_STRING);
64
65echo PHP_EOL . "--- ソート後の配列 (RecursiveArrayIterator::ksort を使用) ---" . PHP_EOL;
66print_r($sortedArray);
67
68// 数値キーを持つ多次元配列の例
69$numericKeyArray = [
70    'data_b' => [
71        2 => 'second',
72        1 => 'first',
73        3 => 'third'
74    ],
75    'data_a' => [
76        5 => 'fifth',
77        4 => 'fourth'
78    ]
79];
80
81echo PHP_EOL . "--- 数値キーを持つオリジナル配列 ---" . PHP_EOL;
82print_r($numericKeyArray);
83
84// 数値キーを再帰的にソート (数値として比較)
85$sortedNumericArray = recursiveKsortMultiDimensionalArray($numericKeyArray, SORT_NUMERIC);
86
87echo PHP_EOL . "--- 数値キーをソート後の配列 ---" . PHP_EOL;
88print_r($sortedNumericArray);
89
90?>

PHP 8のRecursiveArrayIterator::ksortメソッドは、RecursiveArrayIteratorが管理する配列のキーをソートするために使用されます。このメソッドは、多次元配列の各レベルのキーを再帰的にソートする際に特に有用です。

引数int $flagsは、ソートの挙動を指定します。例えば、SORT_REGULARは通常通り、SORT_NUMERICは数値として、SORT_STRINGは文字列として比較してソートします。戻り値はboolで、ソートが成功した場合はtrueを返しますが、一般的には成功を前提とするため、戻り値の確認は省略されることもあります。

サンプルコードのrecursiveKsortMultiDimensionalArray関数は、このRecursiveArrayIterator::ksortを活用し、多次元配列全体をキーで再帰的にソートするものです。まず、与えられた配列をRecursiveArrayIteratorでラップし、$iterator->ksort($flags)を呼び出して現在のレベルのキーをソートします。その後、hasChildren()で子要素の有無を確認し、もし子配列があればgetChildren()で取得し、関数自身を再帰的に呼び出して同様にソート処理を行います。これにより、ネストされた配列のすべてのレベルでキーが適切にソートされます。例として、文字列キーや数値キーを持つ多次元配列が、指定されたフラグに応じて正しく並べ替えられる様子が示されています。