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

<?php

/**
 * array_fill_keys 関数を使用して、指定されたキー配列に同じ値を割り当て、
 * 特に「多次元」のキーワードを考慮して、割り当てる値を配列にする例です。
 * これにより、生成される配列は多次元構造を持ちます。
 *
 * @return void
 */
function createMultidimensionalArrayUsingFillKeys(): void
{
    // 配列のキーとして使用する文字列のリスト
    $product_codes = ['P001', 'P002', 'P003'];

    // 各キーに割り当てる値。これが内部配列となり、結果として多次元配列が生成されます。
    $default_product_details = [
        'name'  => 'Unknown Product',
        'price' => 0.00,
        'stock' => 0,
        'active' => false,
    ];

    // array_fill_keys を使用して、各製品コードに同じデフォルト詳細情報を割り当てる
    // $product_codes がキーとなり、$default_product_details が値として設定される
    $products_data = array_fill_keys($product_codes, $default_product_details);

    echo "--- 生成された多次元配列 ---" . PHP_EOL;
    print_r($products_data);

    echo PHP_EOL . "--- 特定の要素へのアクセス例 ---" . PHP_EOL;
    echo "製品P001の名前: " . $products_data['P001']['name'] . PHP_EOL;
    echo "製品P002の在庫: " . $products_data['P002']['stock'] . PHP_EOL;

    // 後から特定の製品の詳細を更新することも可能
    $products_data['P001']['name'] = 'High-End Widget';
    $products_data['P001']['price'] = 99.99;
    $products_data['P001']['stock'] = 50;
    $products_data['P001']['active'] = true;

    echo PHP_EOL . "--- 更新後の製品P001の詳細 ---" . PHP_EOL;
    print_r($products_data['P001']);
}

// 関数を実行して動作を確認
createMultidimensionalArrayUsingFillKeys();

?>

array_fill_keys関数は、指定したキーの配列に対して、すべて同じ値を割り当てて新しい配列を生成するPHPの関数です。最初の引数$keysには、新しく作る配列のキーとして使用したい値のリストを配列で渡します。2番目の引数$valueには、これらのキーすべてに割り当てたい値を指定します。この関数は、生成された新しい配列を戻り値として返します。

このサンプルコードでは、array_fill_keys関数を使用して、複数の製品コードを一括で管理する多次元配列を作成しています。$product_codes配列が新しい配列のキーとなり、それぞれのキーに対して$default_product_details配列が値として割り当てられています。$valueに配列を渡すことで、結果として「P001」などのキーの下に「name」や「price」といった詳細情報を持つ、入れ子になった多次元配列が効率的に生成されます。

このようにして作成された$products_data配列は、$products_data['P001']['name']のようにキーを重ねて指定することで、特定の製品の詳細情報に直接アクセスできます。また、必要に応じて$products_data['P001']['name'] = 'High-End Widget';のように値を更新することも容易に行えます。これにより、初期値を持つ複雑なデータ構造を簡潔に構築し、その後の管理も柔軟に行えるようになります。

<?php

/**
 * array_fill_keys 関数の基本的な使用方法を示します。
 *
 * この関数は、指定された配列の値を新しい配列のキーとして使用し、
 * それら全てのキーに指定された同じ値を割り当てた新しい連想配列を作成します。
 *
 * システムエンジニアを目指す初心者が、特定のキーセットに対して
 * デフォルト値を設定した配列を効率的に生成する際に役立ちます。
 */
function create_and_fill_array_with_keys(): void
{
    // 例1: ユーザー設定のデフォルト値を作成する
    // 新しい配列のキーとして使用したい設定項目名のリストを定義します。
    $settingKeys = ['username', 'email', 'language', 'theme'];

    // これらのキーに割り当てるデフォルト値を定義します。
    $defaultValue = 'N/A'; // 未設定の場合のデフォルト値

    // array_fill_keys() を使用して、新しい連想配列を作成します。
    // $settingKeys の各要素が新しい配列のキーとなり、
    // $defaultValue がそれらのキーに割り当てられる値となります。
    $userSettingsTemplate = array_fill_keys($settingKeys, $defaultValue);

    echo "--- array_fill_keys を使用したデフォルト設定配列の作成 ---\n";
    echo "作成された配列:\n";
    print_r($userSettingsTemplate);

    /*
    上記のコードを実行すると、以下の出力が得られます:
    Array
    (
        [username] => N/A
        [email] => N/A
        [language] => N/A
        [theme] => N/A
    )
    */

    echo "\n--- 別の例: 商品の初期在庫数を設定 ---\n";
    // 新しい配列のキーとして使用したい商品IDのリストを定義します。
    $productIds = [101, 102, 103, 104];
    // これらのキーに割り当てる値 (初期在庫数) を0とします。
    $initialStockCount = 0;

    // 商品IDをキーとし、初期在庫数を値とする配列を作成します。
    $productStocks = array_fill_keys($productIds, $initialStockCount);

    echo "作成された商品在庫配列:\n";
    print_r($productStocks);

    /*
    上記のコードを実行すると、以下の出力が得られます:
    Array
    (
        [101] => 0
        [102] => 0
        [103] => 0
        [104] => 0
    )
    */
}

// 関数を実行し、array_fill_keys の動作を確認します。
create_and_fill_array_with_keys();

?>

PHP 8.4のarray_fill_keys関数は、指定された配列の要素を新しい配列のキーとして使用し、それら全てのキーに同じ値を割り当てた連想配列を効率的に生成します。システムエンジニアを目指す初心者にとって、特定のキーセットに対してデフォルト値を一括で設定する際に非常に便利な機能です。

この関数は二つの引数を取ります。一つ目の$keys引数には、新しい配列のキーとして使用したい要素を含む配列を渡します。二つ目の$value引数には、これらのキーに割り当てたい任意の単一の値を指定します。関数は、指定されたキーと値で構成される新しい連想配列を戻り値として返します。

サンプルコードの最初の例では、['username', 'email', 'language', 'theme']というキーのリストに対し、デフォルト値として'N/A'を割り当てたユーザー設定テンプレート配列を作成しています。これにより、全ての項目が初期値を持つ配列を簡単に用意できます。また、二つ目の例では、[101, 102, 103, 104]といった商品IDをキーとし、初期在庫数0を値として設定した商品在庫配列を生成しています。このように、既知のキー群に対して共通の初期値を設定したい場合に、手動でキーと値を一つずつ定義する手間を省き、コードの可読性と保守性を向上させることができます。