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

<?php

/**
 * uksort() の使用例を示します。
 * ユーザー定義の比較関数を使用して、配列のキーでソートします。
 */
function demonstrateUksort(): void
{
    // ソートする連想配列を定義します。
    // キーはフルーツの名前、値は色です。
    $fruits = [
        "banana" => "yellow",
        "apple" => "red",
        "kiwi" => "green",
        "orange" => "orange",
        "grape" => "purple",
        "pear" => "green",
    ];

    echo "--- ソート前の配列 ---\n";
    print_r($fruits);

    // キーの長さを基準に比較するコールバック関数を定義します。
    // uksort() に渡されるこの関数は、2つのキーを受け取り、それらの順序を決定するために整数を返します。
    // - 0 を返すと、2つのキーは等しいとみなされます。
    // - 0 未満の値を返すと、$keyA は $keyB の前に来ます。
    // - 0 より大きい値を返すと、$keyA は $keyB の後に来ます。
    $compareKeysByLength = function (string $keyA, string $keyB): int {
        $lenA = strlen($keyA);
        $lenB = strlen($keyB);

        // キーの長さで比較します。
        // 同じ長さの場合は、文字列としてアルファベット順に比較します。
        if ($lenA === $lenB) {
            return $keyA <=> $keyB; // PHP 7以降の「宇宙船演算子」を使用して、コンパクトに比較
        }

        return $lenA <=> $lenB; // 長さで比較
    };

    // uksort() 関数を呼び出して、定義したコールバック関数で配列のキーをソートします。
    // uksort() は配列自体を変更し、成功した場合は true、失敗した場合は false を返します。
    $isSorted = uksort($fruits, $compareKeysByLength);

    echo "\n--- ソート後の配列 (キーの長さで昇順、同じ長さならアルファベット順) ---\n";
    if ($isSorted) {
        print_r($fruits);
    } else {
        echo "配列のソートに失敗しました。\n";
    }

    // 別の比較関数でのソート例：キーを逆順（降順）でソート
    $compareKeysReverseAlphabetical = function (string $keyA, string $keyB): int {
        // デフォルトの文字列比較の逆順で比較します。
        return $keyB <=> $keyA;
    };

    // 配列を元の状態に戻してから、再度ソートします。
    $fruits = [
        "banana" => "yellow",
        "apple" => "red",
        "kiwi" => "green",
        "orange" => "orange",
        "grape" => "purple",
        "pear" => "green",
    ];

    $isSortedReverse = uksort($fruits, $compareKeysReverseAlphabetical);

    echo "\n--- ソート後の配列 (キーをアルファベット逆順) ---\n";
    if ($isSortedReverse) {
        print_r($fruits);
    } else {
        echo "配列のソートに失敗しました。\n";
    }
}

// 関数の実行
demonstrateUksort();

?>

PHPのuksort関数は、ユーザーが定義した比較関数を使用して、配列のキーを基準にソートを行う機能を提供します。

この関数は最初の引数として、ソート対象となる連想配列を参照渡しで受け取ります。そのため、関数が実行されると元の配列自体が直接変更されます。2番目の引数には、キーの順序を決定するための比較ロジックを実装したコールバック関数を指定します。このコールバック関数は2つのキーを受け取り、それらの相対的な順序を示す整数を返します。具体的には、最初のキーが2番目のキーより小さい場合は負の数、等しい場合は0、大きい場合は正の数を返さなければなりません。

uksort関数自体の戻り値はブール型で、ソートが成功した場合はtrueを、失敗した場合はfalseを返します。

提供されたサンプルコードでは、まずフルーツの連想配列を定義し、キーの長さを基準にソートする例を示しています。同じ長さのキーの場合はアルファベット順に比較するロジックがコールバック関数内に記述されています。次に、元の配列をリセットした後、キーをアルファベット逆順でソートする別の例も示しており、コールバック関数を切り替えることで多様なソート条件に対応できることがわかります。このようにuksortを用いることで、標準のソート関数では実現できない複雑な条件でキーを並べ替えることが可能になります。