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

Copy
1<?php
2
3/**
4 * array_fill_keys関数の使用例を示します。
5 *
6 * この関数は、指定された配列の値を新しい配列のキーとして使用し、
7 * すべてのキーに同じ値を割り当てた新しい配列を生成します。
8 *
9 * @param array $keys  新しい配列のキーとして使用する値のリスト。
10 *                     これらの値は文字列または整数である必要があります。
11 * @param mixed $value 新しい配列のすべての要素に割り当てる値。
12 * @return array キーが $keys の要素で、値が $value で埋められた新しい配列。
13 */
14function illustrateArrayFillKeys(array $keys, mixed $value): array
15{
16    // array_fill_keys関数を呼び出し、指定されたキーと値で配列を生成します。
17    // 例: $keys = ['apple', 'banana'], $value = 'fruit' の場合、
18    // 結果は ['apple' => 'fruit', 'banana' => 'fruit'] となります。
19    return array_fill_keys($keys, $value);
20}
21
22// --- 使用例 ---
23
24// ケース1: 文字列のキーと文字列の値
25$productCategories = ['electronics', 'books', 'clothing'];
26$defaultStatus = 'available';
27$inventoryStatus = illustrateArrayFillKeys($productCategories, $defaultStatus);
28
29echo "--- ケース1: 文字列キーと文字列値 ---\n";
30echo "元のキー配列: ";
31print_r($productCategories);
32echo "共通の値: " . $defaultStatus . "\n";
33echo "生成された配列: ";
34print_r($inventoryStatus);
35/*
36期待される出力:
37Array
38(
39    [electronics] => available
40    [books] => available
41    [clothing] => available
42)
43*/
44
45echo "\n";
46
47// ケース2: 整数と文字列が混在したキーと数値の値
48$userIDs = [101, 'guest_user', 205];
49$defaultScore = 0;
50$initialScores = illustrateArrayFillKeys($userIDs, $defaultScore);
51
52echo "--- ケース2: 混在キーと数値値 ---\n";
53echo "元のキー配列: ";
54print_r($userIDs);
55echo "共通の値: " . $defaultScore . "\n";
56echo "生成された配列: ";
57print_r($initialScores);
58/*
59期待される出力:
60Array
61(
62    [101] => 0
63    [guest_user] => 0
64    [205] => 0
65)
66*/
67
68echo "\n";
69
70// ケース3: キー配列に重複する値がある場合
71// array_fill_keysは重複するキーを自動的に1つにまとめるため、
72// 'apple'が複数あっても結果には1つの'apple'キーのみが含まれます。
73$fruitNames = ['apple', 'banana', 'apple', 'orange'];
74$isSweet = true;
75$fruitSweetness = illustrateArrayFillKeys($fruitNames, $isSweet);
76
77echo "--- ケース3: 重複するキーがある場合 ---\n";
78echo "元のキー配列: ";
79print_r($fruitNames);
80echo "共通の値: " . ($isSweet ? 'true' : 'false') . "\n";
81echo "生成された配列: ";
82print_r($fruitSweetness);
83/*
84期待される出力:
85Array
86(
87    [apple] => 1
88    [banana] => 1
89    [orange] => 1
90)
91*/
92
93?>

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

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

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

Copy
1<?php
2
3/**
4 * array_fill 関数の基本的な使い方を示すサンプルコード。
5 * 指定された開始インデックスから、特定の数だけ同じ値で配列を埋めます。
6 */
7function demonstrateArrayFill(): void
8{
9    echo "--- array_fill の使用例 ---" . PHP_EOL;
10
11    // 例1: インデックス0から開始し、5つの要素を文字列 'Apple' で埋める
12    // array_fill(開始インデックス, 要素数, 埋める値)
13    $array1 = array_fill(0, 5, 'Apple');
14    echo "例1: インデックス0から開始し、5つの要素を 'Apple' で埋めた配列:\n";
15    print_r($array1);
16    /* 出力例:
17    Array
18    (
19        [0] => Apple
20        [1] => Apple
21        [2] => Apple
22        [3] => Apple
23        [4] => Apple
24    )
25    */
26
27    echo PHP_EOL;
28
29    // 例2: インデックス3から開始し、3つの要素を数値 123 で埋める
30    $array2 = array_fill(3, 3, 123);
31    echo "例2: インデックス3から開始し、3つの要素を 123 で埋めた配列:\n";
32    print_r($array2);
33    /* 出力例:
34    Array
35    (
36        [3] => 123
37        [4] => 123
38        [5] => 123
39    )
40    */
41
42    echo PHP_EOL;
43
44    // 例3: マイナスの開始インデックスと、ブール値で配列を埋める
45    // マイナスのインデックスはそのままキーとして使用されます。
46    $array3 = array_fill(-2, 4, true);
47    echo "例3: インデックス-2から開始し、4つの要素を true で埋めた配列:\n";
48    print_r($array3);
49    /* 出力例:
50    Array
51    (
52        [-2] => 1
53        [-1] => 1
54        [0] => 1
55        [1] => 1
56    )
57    */
58}
59
60// 関数を実行して結果を表示
61demonstrateArrayFill();
62
63?>

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関数は、配列を特定の同じ値で初期化したい場合に大変便利です。