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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定された配列に特定の値が含まれているかを確認し、結果を表示します。
7 *
8 * PHPの配列に特定の値が含まれているか (contains) を確認する場合、
9 * 標準関数の `in_array()` を使うのが最も一般的です。
10 *
11 * @param array<int, string> $haystack 検索対象の配列。
12 * @param string $needle 検索する値。
13 * @return void
14 */
15function checkValueInArray(array $haystack, string $needle): void
16{
17    // 第3引数に true を指定すると、型も厳密に比較します (===)。
18    $isFound = in_array($needle, $haystack, true);
19
20    if ($isFound) {
21        echo "配列に '{$needle}' は含まれています。" . PHP_EOL;
22    } else {
23        echo "配列に '{$needle}' は含まれていません。" . PHP_EOL;
24    }
25}
26
27// サンプルデータとして、ユーザー名のリストを配列で定義します。
28$userList = ['tanaka', 'suzuki', 'sato'];
29
30// 配列に含まれているかチェックしたいユーザー名
31$userA = 'suzuki';
32$userB = 'yamada';
33
34// 関数を呼び出して結果を確認します。
35checkValueInArray($userList, $userA);
36checkValueInArray($userList, $userB);
37
38?>

このサンプルコードは、PHPで配列に特定の値が含まれているかどうかを確認する方法を示しています。Dom\DocumentFragment クラスの contains メソッドではなく、PHPの標準関数である in_array() 関数を使用しています。

checkValueInArray() 関数は、配列 $haystack と検索する値 $needle を引数として受け取ります。in_array() 関数は、$needle が $haystack 内に存在するかどうかを調べ、存在する場合は true、存在しない場合は false を返します。第3引数に true を指定すると、型の比較も厳密に行われます（=== と同じ）。

この関数内では、in_array() 関数の結果に基づいて、指定された値が配列に含まれているかどうかのメッセージをechoで出力します。サンプルでは、$userList というユーザー名の配列を定義し、$userA と $userB という2つの異なるユーザー名が配列に含まれているかをチェックしています。

システムエンジニアを目指す上で、配列に対する値の存在確認は基本的な操作です。in_array() 関数は、配列から特定の値を探す際に非常に役立ちます。特に、ユーザー入力の検証や、設定ファイルの読み込み結果の確認など、さまざまな場面で活用できます。

Copy
1<?php
2
3// DomDocumentFragment::contains() の使用例
4
5// ドキュメントフラグメントを作成
6$dom = new DOMDocument();
7$fragment = $dom->createDocumentFragment();
8
9// 子ノードを作成
10$node1 = $dom->createElement('div');
11$node2 = $dom->createElement('span');
12
13// フラグメントに子ノードを追加
14$fragment->appendChild($node1);
15
16// 別のノードを作成 (フラグメントには追加しない)
17$node3 = $dom->createElement('p');
18
19// contains() でノードが含まれているか確認
20$containsNode1 = $fragment->contains($node1); // true
21$containsNode2 = $fragment->contains($node2); // false
22$containsNode3 = $fragment->contains($node3); // false
23
24// 結果を出力
25var_dump($containsNode1);
26var_dump($containsNode2);
27var_dump($containsNode3);
28
29?>

このサンプルコードは、PHP 8における DomDocumentFragment::contains() メソッドの使い方を示しています。DomDocumentFragment は、DOMノードの軽量なコンテナとして機能し、DOMツリーの一部として挿入される前に、ノードのグループを保持するために使用されます。

contains() メソッドは、引数として与えられた Dom\Node オブジェクトが、DomDocumentFragment 内に含まれているかどうかを調べます。具体的には、引数 $other にチェックしたい Dom\Node オブジェクトを渡します。

サンプルコードでは、まず DOMDocument オブジェクトと DOMDocumentFragment オブジェクトを作成し、DOMDocumentFragment に子ノードとして <div> 要素を追加しています。その後、contains() メソッドを使って、<div> 要素 ($node1)、<span> 要素 ($node2)、<p> 要素 ($node3) がフラグメントに含まれているかをチェックしています。

$node1 はフラグメントに追加されているため、contains($node1) は true を返します。一方、$node2 と $node3 はフラグメントに追加されていないため、contains($node2) と contains($node3) は false を返します。

戻り値は bool 型であり、指定されたノードが DomDocumentFragment に含まれている場合は true、そうでない場合は false を返します。このメソッドを使用することで、特定のノードがフラグメント内に存在するかどうかを効率的に判断できます。