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

Copy
1<?php
2
3/**
4 * ArrayIterator::uksort() メソッドのサンプルコード
5 *
6 * このスクリプトは、ArrayIterator オブジェクトに格納された連想配列のキーを、
7 * ユーザー定義の比較関数（コールバック）を使ってソートする方法を示します。
8 *
9 * ArrayIterator::uksort() は、キーの比較のみを行い、値には影響しません。
10 */
11
12// 1. ソート対象となる連想配列を準備します。
13$data = [
14    'banana' => 100,
15    'apple'  => 150,
16    'orange' => 120,
17    'grape'  => 200,
18];
19
20// 2. ArrayIterator オブジェクトを作成します。
21$iterator = new ArrayIterator($data);
22
23echo "--- ソート前 ---\n";
24foreach ($iterator as $key => $value) {
25    echo "Key: '{$key}', Value: {$value}\n";
26}
27
28// 3. キーを比較するためのコールバック関数を定義します。
29//    この関数は2つのキーを受け取り、比較結果を整数で返します。
30//    - 負の値を返すと $keyA が $keyB より小さいとみなされます。
31//    - ゼロを返すと等しいとみなされます。
32//    - 正の値を返すと $keyA が $keyB より大きいとみなされます。
33//
34//    ここでは、キーを辞書順の逆順（ZからA）にソートする例です。
35$compareFunction = function (string $keyA, string $keyB): int {
36    // strcasecmp は大文字小文字を区別せず文字列を比較します。
37    // 逆順にするため、$keyB と $keyA の順番を入れ替えます。
38    return strcasecmp($keyB, $keyA);
39};
40
41// 4. ArrayIterator::uksort() メソッドを呼び出してソートを実行します。
42//    このメソッドは成功した場合 true、失敗した場合 false を返します。
43$sortedSuccessfully = $iterator->uksort($compareFunction);
44
45echo "\n--- ソート後 (キーを辞書順の逆順) ---\n";
46if ($sortedSuccessfully) {
47    foreach ($iterator as $key => $value) {
48        echo "Key: '{$key}', Value: {$value}\n";
49    }
50} else {
51    echo "キーのソートに失敗しました。\n";
52}

ArrayIterator::uksort()メソッドは、ArrayIteratorオブジェクトに格納された連想配列のキーを、ユーザーが定義した比較ルールに基づいてソートするために使用されます。

このメソッドはcallable $callbackという引数を一つ取ります。このコールバック関数はソート対象となる2つのキーを受け取り、それらの比較結果を整数値で返さなければなりません。具体的には、最初のキーが2番目のキーより小さい場合は負の整数、等しい場合はゼロ、大きい場合は正の整数を返します。この戻り値によって、uksort()はキーの並び順を決定します。

メソッドの戻り値はbool型です。ソート処理が成功した場合はtrueを、何らかの理由で失敗した場合はfalseを返します。

サンプルコードでは、まずキーと値を持つ連想配列を作成し、それをArrayIteratorオブジェクトに渡しています。ソートのルールとして、キーを辞書順の逆順に並べ替える比較関数を定義し、その関数をuksort()メソッドに渡してソートを実行しています。ソートが成功すると、ArrayIteratorオブジェクト内のデータは定義した比較関数に基づいてキーが並べ替えられた状態になり、対応する値も移動します。これにより、開発者は自由な条件で連想配列のキーをソートできます。