配列の順列を取得する

# Random\Randomizer::shuffleArray

(PHP 8 >= 8.2.0)

Random\Randomizer::shuffleArray — 配列の順列を取得する

### 説明

public function Random\Randomizer::shuffleArray(array `$array`): array

指定された `array` のあり得る順列から、 等確率に選ばれた順列を返します。

指定された `array` のあり得る順列それぞれが、返される確率は等しくなります。

### パラメータ

`array`

  値をシャッフルする配列

  指定された配列は変更されません。

### 戻り値

`array` の値の順列を返します。

指定された `array` のキーは保存されません。 つまり、返される配列はリスト (array_is_list()) になります。

### エラー / 例外

- `Random\Randomizer::$engine` に存在する Random\Engine::generate() メソッド がスローした、あらゆる Throwable がスローされます。

### 例

例1 Random\Randomizer::shuffleArray() の例

    <?php
    $r = new \Random\Randomizer();

    $fruits = [ 'red' => '🍎', 'green' => '🥝', 'yellow' => '🍌', 'pink' => '🍑', 'purple' => '🍇' ];

    // 配列をシャッフルします
    echo "Salad: ", implode(', ', $r->shuffleArray($fruits)), "\n";

    // 再度シャッフルします
    echo "Another Salad: ", implode(', ', $r->shuffleArray($fruits)), "\n";
    ?>

上の例の出力は、 たとえば以下のようになります。

    Salad: 🍎, 🥝, 🍇, 🍌, 🍑
    Another Salad: 🍑, 🍇, 🥝, 🍎, 🍌

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open