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

Copy
1<?php
2
3/**
4 * ArrayObject::uasort メソッドの使用例。
5 * ユーザー定義の比較関数に基づいて ArrayObject の値をソートし、キーと値の関連付けを維持します。
6 * システムエンジニアを目指す初心者向けに、年齢で学生をソートする例を示します。
7 */
8
9// 1. ArrayObject のインスタンスを生成し、初期データを設定します。
10// ここでは学生の名前と年齢をキーと値のペアとして持たせます。
11$students = new ArrayObject([
12    'Alice' => 25,
13    'Bob' => 22,
14    'Charlie' => 28,
15    'David' => 22,
16    'Eve' => 26,
17]);
18
19echo "--- ソート前の学生データ ---" . PHP_EOL;
20foreach ($students as $name => $age) {
21    echo "名前: {$name}, 年齢: {$age}" . PHP_EOL;
22}
23echo PHP_EOL;
24
25// 2. 比較関数を定義します。
26// この関数は ArrayObject の2つの値（ここでは年齢）を受け取り、それらを比較します。
27// - 最初の引数が2番目の引数より小さい場合、負の数を返します。
28// - 最初の引数が2番目の引数と等しい場合、ゼロを返します。
29// - 最初の引数が2番目の引数より大きい場合、正の数を返します。
30// この例では、年齢が若い順（昇順）にソートするように定義します。
31$compareAges = function (int $age1, int $age2): int {
32    if ($age1 === $age2) {
33        return 0; // 年齢が同じ場合は順序を変更しない
34    }
35    return ($age1 < $age2) ? -1 : 1; // age1がage2より若ければ-1、老いていれば1
36};
37
38// 3. ArrayObject::uasort メソッドを呼び出し、定義した比較関数を渡します。
39// このメソッドは ArrayObject の内容をソートし、結果として bool を返します（ソートが成功したかどうか）。
40$sortResult = $students->uasort($compareAges);
41
42echo "--- 年齢でソート後の学生データ (昇順) ---" . PHP_EOL;
43foreach ($students as $name => $age) {
44    echo "名前: {$name}, 年齢: {$age}" . PHP_EOL;
45}
46echo PHP_EOL;
47
48// ソートの結果を確認します。
49if ($sortResult) {
50    echo "ソートは成功しました。" . PHP_EOL;
51} else {
52    echo "ソートは失敗しました。" . PHP_EOL;
53}

PHP 8のArrayObject::uasortメソッドは、ユーザーが定義した比較関数に基づいてArrayObject内の要素をソートする際に、元のキーと値の関連付けを維持する特徴を持つメソッドです。

このメソッドは引数にcallable $callbackとして、比較処理を行う関数を指定します。この比較関数は、ソート対象の2つの要素を引数として受け取り、それらの大小関係を示す整数を返す必要があります。具体的には、最初の要素が2番目の要素より小さい場合は負の値を、等しい場合はゼロを、大きい場合は正の値を返します。サンプルコードでは、学生の年齢を比較し、若い順（昇順）に並べ替えるための関数を定義しています。

メソッドの戻り値はbool型で、ソート処理が成功した場合はtrue、失敗した場合はfalseを返します。このサンプルコードでは、まず学生の名前と年齢をペアとして持つArrayObjectを作成し、その後、定義した年齢比較関数をuasortメソッドに渡してソートを実行しています。これにより、例えば「Bobが22歳」といったキーと値の組み合わせは保持されたまま、学生データ全体が年齢順に並び替えられる様子を確認できます。最後に、ソートが成功したかどうかの結果も出力されます。

Copy
1<?php
2
3/**
4 * ArrayObject::uasort を使用して多次元配列を特定のキーでソートするサンプルコード。
5 * uasort はキーと値の関連付けを維持したまま、ユーザー定義の比較関数でソートを行います。
6 */
7class MultiDimensionalArraySorter
8{
9    /**
10     * 多次元配列を含む ArrayObject を受け取り、指定されたキーでソートします。
11     *
12     * @param ArrayObject<int, array<string, mixed>> $data ArrayObjectでラップされた多次元配列
13     * @param string $sortKey ソートに使用する内部配列のキー
14     * @return bool ソートが成功した場合は true、失敗した場合は false を返します。
15     */
16    public static function sortDataBy($data, string $sortKey): bool
17    {
18        echo "--- ソート前のデータ ---" . PHP_EOL;
19        self::printData($data);
20
21        // uasort メソッドを呼び出し、カスタム比較関数を渡します。
22        // この比較関数は、多次元配列の各要素 (内部の連想配列) を $sortKey の値で比較します。
23        $success = $data->uasort(function (array $a, array $b) use ($sortKey): int {
24            // 指定された $sortKey が存在しない場合は、エラーを避けるために適切なデフォルト値を設定するか、
25            // エラーをスローすることもできます。ここでは存在すると仮定します。
26            $valueA = $a[$sortKey] ?? null;
27            $valueB = $b[$sortKey] ?? null;
28
29            // 比較ロジック:
30            // -1 を返すと $a は $b より前に来ます (昇順)
31            // 0 を返すと $a と $b の順序は変わりません
32            // 1 を返すと $a は $b より後に来ます
33            if ($valueA === $valueB) {
34                return 0;
35            }
36            return ($valueA < $valueB) ? -1 : 1;
37        });
38
39        if ($success) {
40            echo PHP_EOL . "--- '" . $sortKey . "' でソート後のデータ ---" . PHP_EOL;
41            self::printData($data);
42        } else {
43            echo PHP_EOL . "ソートに失敗しました。" . PHP_EOL;
44        }
45
46        return $success;
47    }
48
49    /**
50     * ArrayObject 内のデータを整形して出力します。
51     *
52     * @param ArrayObject<int, array<string, mixed>> $data 出力する ArrayObject
53     */
54    private static function printData(ArrayObject $data): void
55    {
56        if ($data->count() === 0) {
57            echo "データがありません。" . PHP_EOL;
58            return;
59        }
60
61        foreach ($data as $key => $item) {
62            echo "  キー[" . $key . "]: ";
63            // 内部の配列を分かりやすく出力
64            $itemStrings = [];
65            foreach ($item as $itemKey => $itemValue) {
66                $itemStrings[] = $itemKey . ": " . $itemValue;
67            }
68            echo implode(", ", $itemStrings) . PHP_EOL;
69        }
70    }
71}
72
73// ------------------- 使用例 -------------------
74
75// 多次元配列をArrayObjectでラップします。
76// uasortは ArrayObject のメソッドとして呼び出すため、ArrayObject のインスタンスが必要です。
77$users = new ArrayObject([
78    'userA' => ['name' => 'Alice', 'age' => 30, 'city' => 'New York'],
79    'userB' => ['name' => 'Bob', 'age' => 25, 'city' => 'Los Angeles'],
80    'userC' => ['name' => 'Charlie', 'age' => 35, 'city' => 'Chicago'],
81    'userD' => ['name' => 'David', 'age' => 25, 'city' => 'Houston'], // Bobと同じageを持つ
82]);
83
84// 'age' キーに基づいてユーザーデータをソートします。
85// ArrayObject::uasort を使用すると、元のキー ('userA', 'userB' など) を維持したまま要素がソートされます。
86MultiDimensionalArraySorter::sortDataBy($users, 'age');
87
88echo PHP_EOL . "--- ソート後の元の ArrayObject (キーも確認) ---" . PHP_EOL;
89// ソート後の ArrayObject のキーが維持されていることを確認
90foreach ($users as $key => $item) {
91    echo "元のキー: " . $key . ", 名前: " . $item['name'] . ", 年齢: " . $item['age'] . PHP_EOL;
92}
93
94// 別のデータセットとキーで試す例
95$products = new ArrayObject([
96    0 => ['id' => 101, 'name' => 'Laptop', 'price' => 1200],
97    1 => ['id' => 102, 'name' => 'Mouse', 'price' => 25],
98    2 => ['id' => 103, 'name' => 'Keyboard', 'price' => 75],
99]);
100
101echo PHP_EOL . "--- 製品データをソート ---" . PHP_EOL;
102MultiDimensionalArraySorter::sortDataBy($products, 'price');

ArrayObject::uasortは、PHPのArrayObjectクラスに属するメソッドで、配列の要素をユーザーが定義した比較関数に基づいてソートします。このメソッドの大きな特徴は、ソート後も元の配列のキーと値の関連付けを維持する点です。

引数にはcallable $callbackとして比較関数を渡します。この比較関数はソート対象の2つの要素を受け取り、それらの相対的な順序を示す整数値（-1、0、1）を返します。具体的には、-1を返すと最初の要素が2番目の要素より前に、1を返すと後に、0を返すと順序が変わらないことを意味します。これにより、多次元配列の中から特定のキーの値を取り出してソートするなど、複雑なソートロジックを柔軟に実装できます。

メソッドの戻り値はbool型で、ソートが成功した場合はtrue、失敗した場合はfalseを返します。サンプルコードでは、多次元配列をラップしたArrayObjectに対し、ユーザーの年齢や製品の価格といった内部のキーを指定して昇順にソートする例を示しています。このように、データ構造を保ちつつ、アプリケーションの要件に応じた並べ替えが容易に行えるため、柔軟なデータ操作を実現する際に役立ちます。