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

Copy
1<?php
2
3// ArrayObjectのインスタンスを作成し、キーと値の初期データを設定します。
4// uksortはキーをソートするため、キーが識別しやすい連想配列を使用します。
5$data = [
6    'banana' => '黄色',
7    'apple' => '赤',
8    'grape' => '紫',
9    'orange' => '橙',
10];
11
12$arrayObj = new ArrayObject($data);
13
14echo "--- ソート前のデータ ---\n";
15print_r($arrayObj->getArrayCopy());
16
17// uksort()で使用する比較関数を定義します。
18// この関数はソート対象のキーを2つ受け取り、それらを比較した結果を整数で返します。
19// 戻り値のルール:
20//   - 0: キー1 と キー2 が等しい
21//   - 負の値: キー1 が キー2 より小さい
22//   - 正の値: キー1 が キー2 より大きい
23//
24// この例では、キーをアルファベット順の逆順（Z-A）にソートします。
25$comparisonFunction = function (string $key1, string $key2): int {
26    // strcmp関数は文字列を比較し、辞書順で $key2 が $key1 より大きい場合は正の数を返します。
27    // その結果を反転させることで、Z-A順にソートします。
28    return strcmp($key2, $key1);
29};
30
31// ArrayObject::uksort() メソッドを呼び出し、ユーザー定義の比較関数でキーをソートします。
32// このメソッドはソートに成功すると true を返しますが、通常は戻り値を確認する必要はありません。
33$arrayObj->uksort($comparisonFunction);
34
35echo "\n--- ソート後のデータ (キーを逆順ソート: Z-A) ---\n";
36print_r($arrayObj->getArrayCopy());
37
38// 別な比較関数でソートしてみる例（キーの長さでソート、短い順）
39$arrayObj->exchangeArray($data); // 元のデータに戻す
40
41echo "\n--- 再度ソート前のデータ ---\n";
42print_r($arrayObj->getArrayCopy());
43
44$comparisonFunctionByLength = function (string $key1, string $key2): int {
45    $length1 = strlen($key1);
46    $length2 = strlen($key2);
47
48    if ($length1 === $length2) {
49        return 0; // 長さが同じ場合は順序を変えない
50    }
51    return $length1 <=> $length2; // 宇宙船演算子で短い方を優先
52};
53
54$arrayObj->uksort($comparisonFunctionByLength);
55
56echo "\n--- ソート後のデータ (キーの長さで短い順) ---\n";
57print_r($arrayObj->getArrayCopy());
58
59?>

PHPのArrayObject::uksortメソッドは、ArrayObjectに格納された連想配列の「キー」を、ユーザー定義のルールでソートします。このメソッドは、引数callable $callbackとして比較関数を指定します。比較関数は2つのキーを受け取り、比較結果を整数で返します。戻り値は、最初のキーが小さい場合に負、等しい場合にゼロ、大きい場合に正の値となり、これに基づいてキーの順序が決定されます。

サンプルコードでは、キーをアルファベット順の逆順（Z-A）にソートする例や、キーの文字列の長さに応じて短い順にソートする例が示されています。このように、uksortを利用することで、標準のソート機能では対応できないような、柔軟かつ複雑なキーのソートロジックを実装できる点が特徴です。このメソッドはソートが成功するとtrueを返しますが、通常その戻り値を確認する必要はありません。