【PHP8.x】asort関数の使い方

Copy
1<?php
2
3/**
4 * 指定された配列を値で昇順にソートし、その後、配列の要素順を反転させます。
5 * キーと値の関連付けは維持されます。
6 * 結果として、値が降順に並んだ配列が得られますが、これは asort の結果を反転させたものです。
7 *
8 * @param array<string|int, mixed> &$array ソートおよび要素順反転を行う対象の配列。参照渡しされます。
9 * @return bool ソート操作が成功した場合は true、失敗した場合は false。
10 */
11function sortArrayByValueAscendingThenReverse(array &$array): bool
12{
13    // asort() は配列の値を昇順にソートし、キーとの関連付けを維持します。
14    // この操作が成功したかどうかを $success に格納します。
15    $success = asort($array);
16
17    // ソートが成功した場合、配列の要素順を反転させます。
18    // array_reverse() の第二引数に true を指定することで、元のキーが保持されます。
19    // これにより、asort で昇順にソートされた結果が、値が降順に並んだような状態になります。
20    if ($success) {
21        $array = array_reverse($array, true);
22    }
23
24    return $success;
25}

PHPのasort関数は、配列の要素を「値」に基づいて昇順（小さい方から大きい方へ）にソートする機能を持っています。この際、元のキーと値の関連付けは維持されます。引数&$arrayにはソート対象の配列を渡し、直接その配列が変更されます。戻り値はbool型で、ソート操作が成功した場合はtrue、失敗した場合はfalseを返します。

提示されたサンプルコードのsortArrayByValueAscendingThenReverse関数は、このasort関数とarray_reverse関数を組み合わせています。まずasortを使って配列の値を昇順にソートします。ソートが成功した場合、次にarray_reverse関数で配列の要素順を反転させます。array_reverseの第二引数にtrueを指定することで、ソートによって維持されたキーをさらに反転後も保持します。

この一連の処理により、asortで昇順にソートされた結果がarray_reverseによって逆順になるため、結果的には「値が降順に並んだような」配列が得られます。これは、asortで昇順にソートし、その結果を反転させることで降順に並べた状態を実現する典型的な方法です。

Copy
1<?php
2
3/**
4 * Demonstrates how to sort an associative array by its values
5 * in a case-insensitive manner using asort().
6 *
7 * This function is suitable for system engineers new to PHP,
8 * showing how to use sort flags for specific comparison behaviors.
9 */
10function sortArrayCaseInsensitiveExample(): void
11{
12    // An associative array where keys are IDs and values are strings.
13    // Notice the mixed casing in the fruit names.
14    $fruits = [
15        'item_001' => 'Banana',
16        'item_002' => 'apple',
17        'item_003' => 'Orange',
18        'item_004' => 'grape',
19        'item_005' => 'Apple', // This value is "Apple" (capital A)
20        'item_006' => 'Cherry',
21    ];
22
23    echo "--- Original Array ---\n";
24    print_r($fruits);
25
26    // Sort the array by its values, case-insensitively,
27    // while maintaining the original key-value associations.
28    //
29    // - SORT_STRING: Specifies that items should be compared as strings.
30    // - SORT_FLAG_CASE: Modifies SORT_STRING (or SORT_NATURAL) to perform
31    //                   a case-insensitive comparison.
32    $success = asort($fruits, SORT_STRING | SORT_FLAG_CASE);
33
34    if ($success) {
35        echo "\n--- Sorted Array (Case-Insensitive by Value) ---\n";
36        print_r($fruits);
37    } else {
38        echo "\nFailed to sort the array. The array might be empty or an error occurred.\n";
39    }
40}
41
42// Execute the example function.
43sortArrayCaseInsensitiveExample();

PHPのasort関数は、連想配列をその「値」に基づいて昇順でソートし、キーと値の関連付けを維持する関数です。提供されたサンプルコードは、このasort関数を使用して、配列の値を大文字・小文字を区別せず（ケースインセンシティブに）ソートする方法を示しています。

サンプルコードでは、まず複数の果物の名前を含む連想配列$fruitsが定義されています。この配列をソートするために、asort($fruits, SORT_STRING | SORT_FLAG_CASE)が呼び出されています。第一引数の$arrayにはソート対象の配列が参照渡しで渡されるため、ソート後には元の配列$fruitsの内容が直接変更されます。第二引数の$flagsはソートの挙動を制御するオプションです。ここではSORT_STRINGとSORT_FLAG_CASEが|（ビット論理和）で組み合わされています。SORT_STRINGは値を文字列として比較することを指定し、SORT_FLAG_CASEは大文字・小文字を区別しない比較を行うようにSORT_STRINGを補完します。これにより、「Apple」と「apple」が同じ順序で扱われます。

asort関数の戻り値はbool型で、ソートが成功した場合はtrue、失敗した場合はfalseを返します。サンプルコードでは、この戻り値を確認し、成功時にはソート結果を出力し、失敗時にはその旨を表示しています。このように、asort関数と適切なフラグを組み合わせることで、多様なソート要件に対応できます。