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

Copy
1<?php
2
3/**
4 * ArrayIterator::asort() メソッドの使用例を示します。
5 * asort() メソッドは、イテレータが保持する配列の要素を値で昇順にソートし、
6 * キーと値の関連性を維持します。
7 *
8 * @param int $flags ソートの挙動を変更するためのフラグ。デフォルトは SORT_REGULAR。
9 *                    例: SORT_NUMERIC, SORT_STRING, SORT_LOCALE_STRING, SORT_NATURAL, SORT_FLAG_CASE。
10 *                    詳細は PHP マニュアルの sort() 関数を参照してください。
11 * @return void
12 */
13function demonstrateArrayIteratorAsort(): void
14{
15    // ソートする連想配列を準備します。
16    $data = [
17        'apple' => 3,
18        'banana' => 1,
19        'cherry' => 2,
20        'date' => 4,
21    ];
22
23    // ArrayIterator オブジェクトを作成し、配列を渡します。
24    $iterator = new ArrayIterator($data);
25
26    echo "--- ソート前 ---" . PHP_EOL;
27    // ソート前の配列の内容を表示します。
28    // ArrayIterator を直接 foreach で反復することで、内部の配列要素にアクセスできます。
29    foreach ($iterator as $key => $value) {
30        echo sprintf("キー: %s, 値: %d%s", $key, $value, PHP_EOL);
31    }
32
33    // asort() メソッドを呼び出して、値を昇順にソートします。
34    // キーと値の関連性は維持されます。
35    // $iterator->asort(SORT_NUMERIC); のようにフラグを指定することも可能です。
36    $iterator->asort();
37
38    echo PHP_EOL . "--- asort() 適用後 (値で昇順ソート) ---" . PHP_EOL;
39    // ソート後の配列の内容を表示します。
40    foreach ($iterator as $key => $value) {
41        echo sprintf("キー: %s, 値: %d%s", $key, $value, PHP_EOL);
42    }
43}
44
45// 関数の実行
46demonstrateArrayIteratorAsort();
47

PHPのArrayIterator::asort()メソッドは、ArrayIteratorオブジェクトが内部に保持している配列の要素を、その「値」で昇順にソートする際に使用されます。このメソッドの大きな特徴は、ソート後も元の「キーと値の関連性」が維持される点です。

サンプルコードでは、まずキーと値のペアを持つ連想配列が用意され、これを元にArrayIteratorオブジェクトが作成されています。ソート前は、配列の追加順にキーと値が表示されます。

次に、$iterator->asort();を呼び出すと、内部の配列が値の小さい順（1, 2, 3, 4）にソートされます。このとき、元のキー（'banana', 'cherry', 'apple', 'date'）は、それぞれの値と結びついたまま順序が入れ替わります。ソート後の出力では、値が昇順になっていることと、各値に対応するキーが正しく表示されていることが確認できます。

引数$flagsはオプションで、ソートの挙動をカスタマイズするために使用します。例えば、SORT_NUMERICを指定すると数値を数値として正確に比較し、SORT_STRINGは文字列として比較します。この引数を省略した場合、デフォルトのSORT_REGULAR（通常の比較）が適用されます。このメソッドは配列を直接変更するため、特に戻り値はありません。