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

<?php

/**
 * array_multisort() の使用例
 * 複数の配列を、指定したキーとソート順に基づいて同時にソートします。
 *
 * この例では、人々の名前と年齢を表す2つの配列があります。
 * これらをまず年齢の昇順でソートし、もし年齢が同じであれば名前の昇順でソートします。
 * array_multisort は、渡された配列を「参照渡し」で受け取り、直接内容を変更します。
 */

// ソート対象の配列を準備します
$names = ['Taro', 'Jiro', 'Hanako', 'Saburo', 'Emi'];
$ages = [30, 25, 30, 28, 25];

echo "--- ソート前 ---\n";
echo "名前: " . implode(', ', $names) . "\n";
echo "年齢: " . implode(', ', $ages) . "\n\n";

// array_multisort を使用して、複数配列をソートします。
//
// 最初の引数 ($ages) がプライマリソートキーとなります。
//   - SORT_ASC: 昇順 (小さい順)
//   - SORT_NUMERIC: 数値として比較
// 次の引数 ($names) がセカンダリソートキーとなります。
//   - プライマリソートキー ($ages) の値が同じ場合にのみ適用されます。
//   - SORT_ASC: 昇順 (小さい順)
//   - SORT_STRING: 文字列として比較
$success = array_multisort(
    $ages,       // プライマリソートキーとなる配列
    SORT_ASC,    // プライマリキーを昇順にソート
    SORT_NUMERIC,// プライマリキーを数値として比較

    $names,      // セカンダリソートキーとなる配列
    SORT_ASC,    // セカンダリキーを昇順にソート
    SORT_STRING  // セカンダリキーを文字列として比較
);

echo "--- ソート後 (年齢昇順、次いで名前昇順) ---\n";
if ($success) {
    echo "ソート成功！\n";
    echo "名前: " . implode(', ', $names) . "\n";
    echo "年齢: " . implode(', ', $ages) . "\n";
} else {
    echo "ソート失敗。\n";
}

?>

PHPのarray_multisort関数は、複数の配列を同時にソートする際に使用します。関連するデータを別々の配列で管理している場合でも、それらの配列を同期させながらまとめて並べ替えることが可能です。例えば、人々の名前と年齢が別々の配列に入っていても、年齢順に並べ替えつつ、年齢が同じ場合は名前順にするといった複雑なソートが実現できます。

この関数に渡される配列は「参照渡し」という形で扱われます。これは、関数内で配列が直接変更されることを意味し、ソート後の結果が元の配列にそのまま反映されます。引数としては、まずソートしたい配列を一つ渡し、その後にその配列に対するソート順（昇順のSORT_ASCや降順のSORT_DESCなど）と、比較方法（数値として比較するSORT_NUMERICや文字列として比較するSORT_STRINGなど）をセットで指定します。これを複数回繰り返すことで、優先順位の高いプライマリソートキーと、次に優先されるセカンダリソートキーを設定することができます。

サンプルコードでは、まず$ages配列を年齢の昇順、数値としてソートするプライマリキーとして指定しています。次に、$agesの値が同じ場合に適用されるセカンダリキーとして$names配列を名前の昇順、文字列としてソートするように設定しています。

戻り値はbool型で、ソート処理が成功した場合はtrue、何らかの理由で失敗した場合はfalseを返します。これにより、ソートが正しく行われたかを確認できます。

<?php

/**
 * 複数のキーに基づいて連想配列の配列をソートする関数
 *
 * @param array $data ソート対象の連想配列の配列
 * @return array ソートされた連想配列の配列
 */
function sortAssociativeArrayByMultipleKeys(array $data): array
{
    // ソートキーとなるカラムの値を抽出
    // 例えば、氏名で昇順、次にスコアで降順にソートしたい場合
    $names = array_column($data, 'name');
    $scores = array_column($data, 'score');

    // array_multisortを使用して、複数のキーで配列をソート
    // 最初の引数から順にソートの優先順位となる
    // ソートの方向 (SORT_ASC: 昇順, SORT_DESC: 降順) とタイプ (SORT_REGULAR, SORT_NUMERIC, SORT_STRING) を指定
    // 最後にソート対象の元の配列 ($data) を渡すことで、その順序が変更される
    array_multisort(
        $names,  SORT_ASC,   SORT_STRING, // nameカラムを文字列として昇順ソート
        $scores, SORT_DESC,  SORT_NUMERIC, // scoreカラムを数値として降順ソート
        $data                            // 元の連想配列の配列をこれらのソート順で並び替える
    );

    return $data;
}

// サンプルデータ
$employees = [
    ['id' => 1, 'name' => 'Alice',   'score' => 85],
    ['id' => 2, 'name' => 'Bob',     'score' => 90],
    ['id' => 3, 'name' => 'Charlie', 'score' => 75],
    ['id' => 4, 'name' => 'Alice',   'score' => 95], // Aliceは2人目
    ['id' => 5, 'name' => 'Bob',     'score' => 80], // Bobは2人目
];

echo "ソート前のデータ:\n";
print_r($employees);

// 関数を呼び出してソートを実行
$sortedEmployees = sortAssociativeArrayByMultipleKeys($employees);

echo "\nソート後のデータ (名前昇順、スコア降順):\n";
print_r($sortedEmployees);

?>

PHPのarray_multisort関数は、複数の条件（キー）に基づいて配列をソートするために使用します。特に、連想配列の配列を特定のキーの値で複雑に並べ替えたい場合に非常に役立つ関数です。

この関数は、ソート対象となる複数の配列と、それぞれの配列に対するソート順（SORT_ASCで昇順、SORT_DESCで降順）、ソートタイプ（SORT_STRINGで文字列、SORT_NUMERICで数値など）を引数として受け取ります。引数の順番がそのままソートの優先順位となります。最後の引数には、これらの指定された条件に基づいて実際に並べ替えたい元の配列を渡します。この元の配列は参照渡しされるため、関数内で直接順序が変更されます。戻り値は、ソートが成功した場合はtrue、失敗した場合はfalseを返します。

サンプルコードでは、従業員データの連想配列の配列をソートする例を示しています。まずarray_columnを使って、'name'と'score'カラムの値をそれぞれ独立した配列として抽出しています。その後、array_multisortにこれらの抽出した配列とソート条件、そして元の従業員データ配列を渡しています。具体的には、$namesを文字列として昇順（SORT_ASC, SORT_STRING）でソートし、次に$scoresを数値として降順（SORT_DESC, SORT_NUMERIC）でソートすることで、元の従業員データが「名前の昇順」で、さらに同名の人がいる場合は「スコアの降順」で並べ替えられます。