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

<?php

/**
 * array_fill_keys関数の使用例を示します。
 *
 * この関数は、指定された配列の値を新しい配列のキーとして使用し、
 * すべてのキーに同じ値を割り当てた新しい配列を生成します。
 *
 * @param array $keys  新しい配列のキーとして使用する値のリスト。
 *                     これらの値は文字列または整数である必要があります。
 * @param mixed $value 新しい配列のすべての要素に割り当てる値。
 * @return array キーが $keys の要素で、値が $value で埋められた新しい配列。
 */
function illustrateArrayFillKeys(array $keys, mixed $value): array
{
    // array_fill_keys関数を呼び出し、指定されたキーと値で配列を生成します。
    // 例: $keys = ['apple', 'banana'], $value = 'fruit' の場合、
    // 結果は ['apple' => 'fruit', 'banana' => 'fruit'] となります。
    return array_fill_keys($keys, $value);
}

// --- 使用例 ---

// ケース1: 文字列のキーと文字列の値
$productCategories = ['electronics', 'books', 'clothing'];
$defaultStatus = 'available';
$inventoryStatus = illustrateArrayFillKeys($productCategories, $defaultStatus);

echo "--- ケース1: 文字列キーと文字列値 ---\n";
echo "元のキー配列: ";
print_r($productCategories);
echo "共通の値: " . $defaultStatus . "\n";
echo "生成された配列: ";
print_r($inventoryStatus);
/*
期待される出力:
Array
(
    [electronics] => available
    [books] => available
    [clothing] => available
)
*/

echo "\n";

// ケース2: 整数と文字列が混在したキーと数値の値
$userIDs = [101, 'guest_user', 205];
$defaultScore = 0;
$initialScores = illustrateArrayFillKeys($userIDs, $defaultScore);

echo "--- ケース2: 混在キーと数値値 ---\n";
echo "元のキー配列: ";
print_r($userIDs);
echo "共通の値: " . $defaultScore . "\n";
echo "生成された配列: ";
print_r($initialScores);
/*
期待される出力:
Array
(
    [101] => 0
    [guest_user] => 0
    [205] => 0
)
*/

echo "\n";

// ケース3: キー配列に重複する値がある場合
// array_fill_keysは重複するキーを自動的に1つにまとめるため、
// 'apple'が複数あっても結果には1つの'apple'キーのみが含まれます。
$fruitNames = ['apple', 'banana', 'apple', 'orange'];
$isSweet = true;
$fruitSweetness = illustrateArrayFillKeys($fruitNames, $isSweet);

echo "--- ケース3: 重複するキーがある場合 ---\n";
echo "元のキー配列: ";
print_r($fruitNames);
echo "共通の値: " . ($isSweet ? 'true' : 'false') . "\n";
echo "生成された配列: ";
print_r($fruitSweetness);
/*
期待される出力:
Array
(
    [apple] => 1
    [banana] => 1
    [orange] => 1
)
*/

?>

PHPのarray_fill_keys関数は、指定された配列の要素を新しい配列のキーとして使用し、それらのすべてのキーに同じ単一の値を割り当てることで、新しい配列を生成します。

この関数は二つの引数を取ります。最初の引数$keysには、新しい配列のキーとして利用したい値のリストを配列として渡します。この配列の要素は文字列か整数である必要があります。二番目の引数$valueには、生成される配列のすべてのキーに割り当てたい単一の値を指定します。

array_fill_keys関数は、これらの引数をもとに、新しい配列を返します。この戻り値の配列では、$keysで指定された要素がキーとなり、それぞれのキーに対応する値は$valueで指定した値で統一されます。例えば、商品カテゴリのリストをキーとして、すべて「利用可能」というステータスを設定する初期化処理などに便利です。また、$keys配列に重複する値が含まれている場合でも、array_fill_keysは自動的にキーを一つにまとめ、そのキーには指定された$valueが割り当てられます。この関数を使うことで、特定のパターンで初期化された連想配列を簡単に作成できます。

<?php

/**
 * array_fill 関数の基本的な使い方を示すサンプルコード。
 * 指定された開始インデックスから、特定の数だけ同じ値で配列を埋めます。
 */
function demonstrateArrayFill(): void
{
    echo "--- array_fill の使用例 ---" . PHP_EOL;

    // 例1: インデックス0から開始し、5つの要素を文字列 'Apple' で埋める
    // array_fill(開始インデックス, 要素数, 埋める値)
    $array1 = array_fill(0, 5, 'Apple');
    echo "例1: インデックス0から開始し、5つの要素を 'Apple' で埋めた配列:\n";
    print_r($array1);
    /* 出力例:
    Array
    (
        [0] => Apple
        [1] => Apple
        [2] => Apple
        [3] => Apple
        [4] => Apple
    )
    */

    echo PHP_EOL;

    // 例2: インデックス3から開始し、3つの要素を数値 123 で埋める
    $array2 = array_fill(3, 3, 123);
    echo "例2: インデックス3から開始し、3つの要素を 123 で埋めた配列:\n";
    print_r($array2);
    /* 出力例:
    Array
    (
        [3] => 123
        [4] => 123
        [5] => 123
    )
    */

    echo PHP_EOL;

    // 例3: マイナスの開始インデックスと、ブール値で配列を埋める
    // マイナスのインデックスはそのままキーとして使用されます。
    $array3 = array_fill(-2, 4, true);
    echo "例3: インデックス-2から開始し、4つの要素を true で埋めた配列:\n";
    print_r($array3);
    /* 出力例:
    Array
    (
        [-2] => 1
        [-1] => 1
        [0] => 1
        [1] => 1
    )
    */
}

// 関数を実行して結果を表示
demonstrateArrayFill();

?>

PHP 8.4のarray_fill関数は、新しい配列を効率的に作成するための機能です。この関数は、指定された開始インデックスから、特定の数だけ同じ値で配列の要素を埋める際に使用します。

引数は3つあります。$start_indexは、配列のキーが始まるインデックスを整数で指定します。この値は負の数でも可能で、その場合も指定された負のインデックスからキーが順に増加します。$countは、作成する配列に含める要素の総数を整数で指定します。そして$valueは、配列のすべての要素に設定される値で、文字列、数値、ブール値など、どのようなデータ型でも指定できます。

この関数は、引数で定義された条件に従って生成された新しい配列を返します。例えば、インデックス0から開始して5つの要素を「Apple」で埋めると、キー0から4までの要素がすべて「Apple」となる配列が生成されます。また、インデックス3から3つの要素を数値の123で埋めると、キー3から5までの要素が123となる配列が得られます。負のインデックスである-2から4つの要素をtrueで埋める例では、キー-2から1までの要素がtrue（PHPでは数値の1と表示されることがあります）となる配列が作成されます。このようにarray_fill関数は、配列を特定の同じ値で初期化したい場合に大変便利です。