【PHP8.x】appendメソッドの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 2つの配列を結合して、新しい配列として返す.
7 *
8 * PHP 7.4以降で導入されたスプレッド演算子(...)を使うことで、
9 * 配列を簡潔かつ効率的に結合できます。
10 *
11 * @param array<int|string, mixed> $baseArray   結合の元となる配列
12 * @param array<int|string, mixed> $appendArray 元の配列に追加する配列
13 * @return array<int|string, mixed> 2つの配列が結合された新しい配列
14 */
15function appendArrayToArray(array $baseArray, array $appendArray): array
16{
17    // スプレッド演算子(...)を使用して2つの配列を展開し、1つの新しい配列にまとめる
18    return [...$baseArray, ...$appendArray];
19}
20
21// 結合の元となる配列
22$array1 = ['apple', 'banana', 'orange'];
23
24// 追加したい配列
25$array2 = ['grape', 'melon'];
26
27// 関数を呼び出して配列を結合する
28$resultArray = appendArrayToArray($array1, $array2);
29
30// 結果を分かりやすく表示する
31echo "--- 元の配列 ---\n";
32print_r($array1);
33echo "\n";
34
35echo "--- 追加する配列 ---\n";
36print_r($array2);
37echo "\n";
38
39echo "--- 結合後の配列 ---\n";
40print_r($resultArray);
41
42/*
43--- 出力結果 ---
44--- 元の配列 ---
45Array
46(
47    [0] => apple
48    [1] => banana
49    [2] => orange
50)
51
52--- 追加する配列 ---
53Array
54(
55    [0] => grape
56    [1] => melon
57)
58
59--- 結合後の配列 ---
60Array
61(
62    [0] => apple
63    [1] => banana
64    [2] => orange
65    [3] => grape
66    [4] => melon
67)
68*/

このPHPサンプルコードは、2つの配列を結合して、1つの新しい配列を作成する方法を示しています。

appendArrayToArray という名前の関数が定義されており、この関数が配列の結合処理を行います。この関数は引数として2つの配列を受け取ります。第1引数 $baseArray が結合の元になる配列、第2引数 $appendArray が追加したい要素を持つ配列です。

関数の内部では、PHP 7.4から導入されたスプレッド演算子（...）が使われています。[...$baseArray, ...$appendArray] という記述は、それぞれの配列の要素をその場で展開し、それらをすべて含む新しい1つの配列を生成します。この結合によって新しく作られた配列が、関数の戻り値として返されます。この方法では、元の2つの配列（$array1 と $array2）は変更されません。

コードの後半では、実際に2つのサンプル配列を準備し、appendArrayToArray 関数を呼び出して結合結果を取得しています。最後に print_r を使って、結合前後の配列の内容を出力し、どのように配列が結合されたかを確認できるようにしています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 配列のデータを元にリスト要素を生成し、DOMDocumentFragmentを使って一括で追加します。
7 *
8 * DOMDocumentFragmentは、DOMノードを一時的に格納するための軽量なコンテナです。
9 * これに複数のノードをappendしておき、最後にドキュメント本体に一度に追加することで、
10 * パフォーマンスを向上させることができます。
11 * これは、配列に複数の要素を追加していく操作に似ています。
12 *
13 * @return void
14 */
15function appendNodesFromDataArray(): void
16{
17    // 操作の基点となるDOMDocumentオブジェクトを生成します。
18    $dom = new DOMDocument('1.0', 'UTF-8');
19    $dom->formatOutput = true; // 出力HTMLを整形します。
20
21    // HTMLの body タグと、リストの親となる ul タグを作成します。
22    $body = $dom->createElement('body');
23    $dom->appendChild($body);
24    $ul = $dom->createElement('ul');
25    $body->appendChild($ul);
26
27    // リスト項目となるデータの配列を定義します。
28    $items = ['PHP: Hypertext Preprocessor', 'JavaScript', 'Python'];
29
30    // 複数のノードを一時的に保持するためのDOMDocumentFragmentを生成します。
31    $fragment = $dom->createDocumentFragment();
32
33    // 配列の各要素をループ処理して、<li>要素を生成し、フラグメントに追加します。
34    foreach ($items as $itemText) {
35        $li = $dom->createElement('li', htmlspecialchars($itemText, ENT_QUOTES, 'UTF-8'));
36        
37        // DOMDocumentFragment::append() を使い、生成した<li>ノードをフラグメントに追加します。
38        // このメソッドは、追加されたノード自体を返します。
39        $fragment->append($li);
40    }
41
42    // すべての<li>要素が格納されたフラグメントを、<ul>要素に一度に追加します。
43    $ul->appendChild($fragment);
44
45    // 生成されたHTML全体を出力します。
46    echo $dom->saveHTML();
47}
48
49appendNodesFromDataArray();

このPHPサンプルコードは、DOMDocumentFragment::append() メソッドを使い、配列のデータを元に複数のHTMLリスト要素 (<li>) を効率的に生成してドキュメントに追加する方法を示しています。

DOMDocumentFragment は、DOMノードを一時的に格納するための特別なコンテナです。ドキュメント本体に一つずつノードを追加するのではなく、まずこのフラグメントにまとめて追加し、最後に一度にドキュメントへ挿入することで、DOM操作のパフォーマンスを向上させることができます。これは、プログラム内で配列に複数の要素を順番に追加していく操作と似ています。

foreach ループ内では、配列の各データから <li> 要素を生成しています。そして、DOMDocumentFragment::append() メソッドが呼び出されます。このメソッドの引数 DOMNode $node には、追加したいノードオブジェクト（ここでは <li> 要素）を指定します。メソッドは、指定されたノードをフラグメントの子ノードの末尾に追加し、戻り値として追加されたノード自体 (DOMNode) を返します。

ループが完了すると、すべての <li> 要素が格納されたフラグメントが完成します。これを appendChild() を使って <ul> 要素に追加することで、フラグメント内のすべての子ノードがまとめて <ul> の子要素としてDOMツリーに挿入されます。