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

<?php

/**
 * array_rand() の基本的な使用方法を示すサンプルコード。
 * 配列からランダムな要素のキーを一つ、または複数取得します。
 */
function demonstrateArrayRand(): void
{
    // サンプル配列を定義
    $fruits = [
        'apple',
        'banana',
        'cherry',
        'date',
        'elderberry',
    ];

    echo "元の配列:\n";
    print_r($fruits);
    echo "\n";

    // array_rand() を使ってランダムなキーを1つ取得する
    // デフォルトでは num が 1 なので、戻り値は文字列（キー）
    $randomKeySingle = array_rand($fruits);
    echo "ランダムに選ばれたキー (1つ): " . $randomKeySingle . "\n";
    echo "対応する値: " . $fruits[$randomKeySingle] . "\n\n";

    // array_rand() を使ってランダムなキーを複数取得する
    // num を指定すると、戻り値はキーの配列になる
    $randomKeysMultiple = array_rand($fruits, 3);
    echo "ランダムに選ばれたキー (3つ):\n";
    print_r($randomKeysMultiple);

    echo "対応する値 (3つ):\n";
    foreach ($randomKeysMultiple as $key) {
        echo "- キー: " . $key . ", 値: " . $fruits[$key] . "\n";
    }
}

// 関数の実行
demonstrateArrayRand();

?>

PHPのarray_rand関数は、指定した配列の中からランダムに選択された要素の「キー」を取得するために使用します。この関数は、配列の要素そのものではなく、その位置を示すキーを返します。

最初の引数には、ランダムにキーを選びたい対象の配列を指定します。必須の引数です。 二番目の引数である$numには、取得したいキーの数を整数で指定します。この引数は省略可能で、その場合はデフォルトで1つのキーが選択されます。

戻り値は、$numの値によって異なります。 もし$numが1の場合、単一のランダムなキーが文字列または整数として直接返されます。サンプルコードの最初の例では、$fruits配列から1つのキーが選ばれ、そのキーを使って対応するフルーツ名を表示しているのがわかります。 一方、$numが1より大きい場合、選択された複数のキーが格納された新しい配列として返されます。サンプルコードの2番目の例では、$fruits配列から3つのランダムなキーが配列として返され、それぞれのキーと対応するフルーツ名が順に表示されています。

このように、array_rand関数を使うことで、配列内の情報をランダムに選び出し、柔軟にプログラムで利用することが可能になります。返されたキーを利用して、元の配列から対応する値を取得する仕組みが重要です。

<?php

/**
 * array_rand関数を使って連想配列からランダムなキーを取得する例。
 * この関数は、配列からランダムに選ばれたキーを1つ、または複数のキーを配列として返します。
 * 主に、複数の選択肢の中からランダムに要素を選びたい場合などに使用されます。
 */
function demonstrateArrayRandForAssociativeArray(): void
{
    // 連想配列の例: ユーザー名とその役割
    $users = [
        'Alice'   => 'Administrator',
        'Bob'     => 'Editor',
        'Charlie' => 'Viewer',
        'David'   => 'Moderator',
        'Eve'     => 'Administrator',
    ];

    echo "--- 元の連想配列 ---\n";
    foreach ($users as $name => $role) {
        echo "- ユーザー名: {$name}, 役割: {$role}\n";
    }
    echo "\n";

    // 1つのランダムなキー（ユーザー名）を取得する例
    // array_rand() の第2引数を省略すると、デフォルトで1つのキーが選択されます。
    // 戻り値は選択されたキー（この場合は文字列）になります。
    $randomUserName = array_rand($users);
    echo "--- 1つのランダムなキーを取得 ---\n";
    echo "ランダムに選ばれたユーザー名: {$randomUserName}\n";
    echo "そのユーザーの役割: {$users[$randomUserName]}\n";
    echo "\n";

    // 複数のランダムなキー（ユーザー名）を取得する例
    // array_rand() の第2引数に、取得したいキーの数を指定します。
    // 戻り値は選択されたキーの配列になります。
    $numberOfUsersToSelect = 2;
    $randomUserNames = array_rand($users, $numberOfUsersToSelect);
    echo "--- {$numberOfUsersToSelect}つのランダムなキーを取得 ---\n";
    echo "ランダムに選ばれたユーザー名たち:\n";
    foreach ($randomUserNames as $name) {
        echo "- ユーザー名: {$name}, 役割: {$users[$name]}\n";
    }
    echo "\n";
}

// 関数を実行して動作を確認します。
demonstrateArrayRandForAssociativeArray();

PHPのarray_rand関数は、指定した配列からランダムにキー（要素を特定するための識別子）を選択する際に使用されます。この関数は、連想配列から特定のユーザー名や商品IDなどをランダムに選び出したい場合に特に便利です。

第一引数には、キーをランダムに取得したい対象の配列を指定します。これは連想配列でも通常の数値インデックス配列でも構いません。第二引数には、取得したいキーの数を整数で指定します。この引数を省略した場合、デフォルトで1つのキーが選択されます。

戻り値は、第二引数の指定によって異なります。もし1つのキーだけを取得する場合（第二引数を省略するか1を指定した場合）、ランダムに選ばれた単一のキーが文字列または整数の型で返されます。一方、複数のキーを取得する数（2以上）を指定した場合は、選ばれた複数のキーが格納された配列が戻り値となります。

提供されたサンプルコードでは、まずユーザー名とその役割を示す連想配列$usersを用意しています。次に、array_rand($users)として第二引数を省略し、ランダムなユーザー名を一つ取得する方法を示しています。これにより、選択されたユーザー名とその役割を表示しています。続いて、array_rand($users, 2)のように第二引数に「2」を指定し、二つのランダムなユーザー名を配列として取得し、それぞれのユーザー名と役割を表示する例が示されています。このように、用途に応じて単一または複数のキーを効率的に取得できるのがarray_rand関数の特徴です。