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

Copy
1<?php
2
3/**
4 * 指定された値が配列内に存在するかどうかを確認します。
5 *
6 * このサンプルでは、PHPの標準関数である in_array() を使用して、
7 * 配列に特定の要素が含まれているか（contains）をチェックする方法を示します。
8 *
9 * @param array<int|string, mixed> $haystack 検索対象の配列。
10 * @param mixed $needle 検索する値。
11 * @return bool 値が配列内に存在すれば true、そうでなければ false を返します。
12 */
13function doesArrayContainValue(array $haystack, mixed $needle): bool
14{
15    // in_array() は、配列内に値が存在するかどうかをチェックするPHPの最も一般的な関数です。
16    // 第1引数に探したい値、第2引数に検索対象の配列を指定します。
17    // 第3引数に true を指定すると、値だけでなく型も厳密に比較します (例: 1 と '1' は別物として扱う)。
18    // PHP 8以降では、このような厳密な比較が推奨されます。
19    return in_array($needle, $haystack, true);
20}
21
22// --- サンプルコードの実行部分 ---
23
24// 検索対象の配列を準備します
25$programmingLanguages = ['PHP', 'JavaScript', 'Python', 'Java'];
26
27// ケース1: 配列に存在する値を探す
28$valueToFind1 = 'PHP';
29if (doesArrayContainValue($programmingLanguages, $valueToFind1)) {
30    echo "'{$valueToFind1}' は配列に含まれています。" . PHP_EOL;
31} else {
32    echo "'{$valueToFind1}' は配列に含まれていません。" . PHP_EOL;
33}
34
35// ケース2: 配列に存在しない値を探す
36$valueToFind2 = 'Ruby';
37if (doesArrayContainValue($programmingLanguages, $valueToFind2)) {
38    echo "'{$valueToFind2}' は配列に含まれています。" . PHP_EOL;
39} else {
40    echo "'{$valueToFind2}' は配列に含まれていません。" . PHP_EOL;
41}
42
43// ケース3: 大文字と小文字は区別される
44$valueToFind3 = 'php'; // 小文字の'php'
45if (doesArrayContainValue($programmingLanguages, $valueToFind3)) {
46    echo "'{$valueToFind3}' は配列に含まれています。" . PHP_EOL;
47} else {
48    echo "'{$valueToFind3}' は配列に含まれていません。大文字と小文字は区別されます。" . PHP_EOL;
49}
50
51?>

このサンプルコードは、PHPで配列内に特定の要素が存在するかどうかを確認する方法を説明しています。PHPの標準関数であるin_array()を使用することで、配列に特定の値が含まれているか（contains）を簡単にチェックできます。

doesArrayContainValue関数は、検索対象の配列$haystackと検索する値$needleを引数として受け取ります。この関数は内部でin_array($needle, $haystack, true)を呼び出しており、$needleが$haystack内に存在するかどうかを判定します。ここで、第3引数にtrueを指定することは重要で、値だけでなくデータの型も厳密に比較します。例えば、数値の1と文字列の'1'は異なるものとして扱われます。もし値が存在すればtrue、存在しなければfalseが戻り値として返されます。

実行部分では、いくつかの状況が示されています。'PHP'は配列内に存在するため「含まれています」と表示されますが、'Ruby'は存在しないため「含まれていません」と表示されます。また、'php'（小文字）は'PHP'（大文字）とは異なる値として扱われるため、「含まれていません。大文字と小文字は区別されます」と出力されます。このようにin_array()関数を活用することで、配列内の値の有無を正確に判別することが可能です。

Copy
1<?php
2
3// ドキュメントタイプ (DTD) が "example.dtd" という名前の XML ドキュメントを作成します。
4$dom = new DOMDocument('1.0', 'UTF-8');
5$dtd = $dom->implementation->createDocumentType('root', '', 'example.dtd');
6$dom->appendChild($dtd);
7
8// 別の DOMDocument を作成し、要素を追加します。
9$otherDom = new DOMDocument('1.0', 'UTF-8');
10$otherElement = $otherDom->createElement('element');
11$otherDom->appendChild($otherElement);
12
13// DOMDocumentType が DOMNode を含んでいるか確認します。
14$contains = $dtd->contains($otherElement);
15
16// 結果を出力します。通常、DOMDocumentType は DOMNode を含んでいないため、false になります。
17var_dump($contains);
18
19// ドキュメントタイプを表示
20echo $dom->saveXML();
21
22?>

PHP 8 の DOMDocumentType クラスにおける contains メソッドは、ドキュメントタイプ (DTD) が指定されたノード (DOMNode または DOMNameSpaceNode) を含んでいるかどうかを判定するために使用します。引数 $other には、包含関係を確認したいノードを指定します。

サンプルコードでは、まず DOMDocument オブジェクトを作成し、createDocumentType メソッドを使用して DTD を定義しています。このDTDをXMLドキュメントに追加しています。次に、別の DOMDocument オブジェクトを作成し、要素を追加します。

$dtd->contains($otherElement) では、DTD ($dtd) が $otherElement (別のドキュメントに作成された要素) を含んでいるかどうかを確認します。contains メソッドは、指定されたノードが DTD によって定義された要素であるか、または DTD の一部である場合に true を返します。一般的に、別のドキュメントで作成された要素を DTD が含むことはないため、この例では false が返されます。

var_dump($contains) は、contains メソッドの結果 (true または false) を出力します。echo $dom->saveXML() は、作成した XML ドキュメントを文字列として出力します。これにより、DTD がどのようにドキュメントに関連付けられているかを確認できます。システムエンジニアを目指す上で、DTD が XML ドキュメントの構造を定義し、contains メソッドがその構造に基づいた包含関係を検証するために使用されることを理解することは重要です。