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

<?php

/**
 * PHPのshuffle関数が連想配列に適用された際の動作を示すサンプルコードです。
 * shuffle関数は配列の値をランダムな順序に並べ替えます。
 * しかし、連想配列に適用すると元のキーは失われ、値のみがシャッフルされた数値添字配列になります。
 */
function demonstrateShuffleWithAssociativeArray(): void
{
    // 元の連想配列を定義します。
    $originalArray = [
        'apple' => 100,
        'banana' => 150,
        'orange' => 120,
        'grape' => 200,
    ];

    echo "元の連想配列:\n";
    print_r($originalArray);

    // shuffle関数を適用します。
    // この関数は配列を直接変更（参照渡し）します。
    // 連想配列に適用すると、キーは破棄され、値だけがシャッフルされます。
    $success = shuffle($originalArray);

    echo "shuffle関数適用後の配列 (成功: " . ($success ? 'true' : 'false') . "):\n";
    print_r($originalArray);

    // [ポイント]
    // 上記の出力結果から、元の連想配列のキーは失われ、
    // 値のみがシャッフルされて新しい数値添字配列になったことが確認できます。
    // もしキーと値のペアを維持したままシャッフルしたい場合は、別の方法が必要です。
}

// サンプル関数の実行
demonstrateShuffleWithAssociativeArray();

?>

PHPのshuffle関数は、指定された配列の要素の順序をランダムに並べ替えるための関数です。引数として渡すarray &$arrayは、配列を直接変更する「参照渡し」であることを意味しており、関数実行後に元の配列の内容が更新されます。戻り値は常にtrueであり、シャッフル処理が成功したことを示します。

このサンプルコードは、shuffle関数を連想配列に適用した場合の具体的な動作を示しています。連想配列に対してshuffle関数を実行すると、元のキーはすべて失われます。その代わりに、配列の値のみがランダムな順序で並べ替えられ、自動的に0から始まる新しい数値添字が割り当てられた配列に再構築されます。

したがって、もし元の連想配列のキーと値のペアの関係を維持したまま要素の順序をランダムにしたい場合は、shuffle関数は適切な選択肢ではありません。その場合は、array_keysやarray_randなどを組み合わせるなど、キーと値の関連性を保持する別の方法を検討する必要があります。この挙動は、shuffle関数を利用する上で特に注意すべき重要な点です。

<?php

/**
 * PHPのshuffle()関数を使用して配列の要素をランダムに並べ替えるデモンストレーションを行います。
 *
 * shuffle()関数は、与えられた配列の要素をインプレースで（参照渡しによって元の配列を直接変更し）
 * ランダムな順序に並べ替えます。この関数は、統計的な偏りがないように設計されており、
 * 信頼性の高い乱数生成器を使用して要素の順序を決定します。
 * 成功した場合は常にtrueを返します。
 */
function demonstrateArrayShuffle(): void
{
    // シャッフルする配列を定義します。
    $cards = ['♠A', '♠K', '♠Q', '♠J', '♠10', '♡A', '♡K', '♡Q', '♡J', '♡10', '♢A', '♢K', '♢Q', '♢J', '♢10', '♣A', '♣K', '♣Q', '♣J', '♣10'];

    echo "シャッフル前のカード配列:\n";
    print_r($cards);

    // 配列の要素をランダムな順序に並べ替えます。
    // shuffle()関数は内部的に偏りのない乱数生成器を使用しており、
    // 特定の順序に偏ることがないように設計されています。
    // 戻り値は常にtrueですが、ここでは確認のために変数に格納しています。
    $success = shuffle($cards);

    echo "\nシャッフル後のカード配列 (shuffle()の戻り値: " . ($success ? 'true' : 'false') . "):\n";
    print_r($cards);

    // 複数回実行することで、毎回異なる順序でシャッフルされることを確認できます。
    echo "\nもう一度シャッフル後のカード配列:\n";
    shuffle($cards);
    print_r($cards);
}

// デモンストレーション関数を実行します。
demonstrateArrayShuffle();

?>

PHPのshuffle()関数は、配列の要素をランダムな順序に並べ替えるために使用されます。この関数は、引数として渡された配列の要素の順序を直接変更します。引数はarray &$arrayと定義されており、これは配列が「参照渡し」されることを意味します。そのため、関数内で配列が変更されると、その変更は元の配列にも反映されます。

shuffle()関数は、統計的な偏りがないように設計されており、信頼性の高い乱数生成器を使用して要素の順序を決定します。これにより、特定の要素の並び順に偏りが生じることなく、公正にシャッフルされることが保証されます。

関数の処理が成功した場合、shuffle()は常にtrueを返します。この戻り値は、シャッフル操作が問題なく完了したことを示します。サンプルコードでは、カードの配列がshuffle()関数によってどのように並べ替えられるかを示しています。シャッフル前とシャッフル後の配列を比較することで、要素がランダムに再配置され、毎回異なる順序になることが確認できます。システム開発において、データのランダム化が必要な場面で幅広く利用できる便利な関数です。