【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|int $needle 配列内で検索する値。
13 * @return void
14 */
15function checkValueInArray(array $haystack, string|int $needle): void
16{
17    // in_array() は、第一引数の配列に第二引数の値が存在すれば true を返す。
18    // 第三引数に true を指定すると、値だけでなく型も一致するかを厳密にチェックする (===)。
19    if (in_array($needle, $haystack, true)) {
20        // var_export() は、変数をPHPコードとして表現できる文字列で出力する。
21        echo var_export($needle, true) . " は配列に含まれています。\n";
22    } else {
23        echo var_export($needle, true) . " は配列に含まれていません。\n";
24    }
25}
26
27// チェック対象のサンプル配列
28$webFrameworks = ['Laravel', 'Symfony', 'CakePHP'];
29
30// 配列に含まれている値をチェック
31checkValueInArray($webFrameworks, 'Symfony');
32
33// 配列に含まれていない値をチェック
34checkValueInArray($webFrameworks, 'Ruby on Rails');
35
36echo "----\n";
37
38// 数値と文字列が混在した配列での厳密なチェック
39$mixedArray = [1, '2', 3, null];
40
41// 数値の 1 は配列に含まれている
42checkValueInArray($mixedArray, 1);
43
44// 文字列の '1' は厳密なチェックでは含まれていないと判断される
45checkValueInArray($mixedArray, '1');
46

PHPでは、配列の中に特定の要素が含まれているかを確認する際に、in_array()関数が一般的に使用されます。この関数は、第一引数で指定した検索値（needle）が、第二引数で渡された配列（haystack）の中に存在するかどうかを調べます。存在すればtrueを、存在しなければfalseを戻り値として返します。特に重要なのは、第三引数にtrueを指定することで、値だけでなく型も一致するかを厳密にチェックできる点です。

提供されたサンプルコードは、このin_array()関数の使い方を示しています。checkValueInArray関数は、配列$haystackから$needleを探し、見つかれば「含まれています」、見つからなければ「含まれていません」と結果を表示します。var_export()関数は、変数の内容をPHPコードとして表現できる形式で出力するために利用されています。

このコードでは、$webFrameworks配列で文字列の検索を行う例や、$mixedArrayという数値と文字列が混在した配列で、数値の1と文字列の'1'が厳密なチェック（in_array()の第三引数がtrue）によって異なる結果となることが示されています。これは、厳密な比較が値と型の両方を一致させる必要があるためです。

なお、ご提示いただいたリファレンス情報にあるDom\DocumentType::containsメソッドは、XMLやHTMLなどのDOMツリー構造において、あるノードが別のノードを含んでいるかどうかを判別する際に用いるもので、配列の要素確認とは用途が異なります。PHPで配列の要素を確認するには、in_array()関数が適切です。

Copy
1<?php
2
3// PHP 8 の Dom\DocumentType::contains メソッドの使用例
4// システムエンジニアを目指す初心者向けに、DTD内のエンティティや表記法の存在確認を示します。
5
6/**
7 * Dom\DocumentType::contains メソッドの動作を示すサンプル関数。
8 * DTD（Document Type Definition）内の特定のエンティティ名や表記法名、
9 * あるいはそれらに対応する Dom\Node オブジェクトが含まれるかをチェックします。
10 */
11function demonstrateDocumentTypeContains(): void
12{
13    // Dom\Document オブジェクトを新しく作成します。
14    $dom = new Dom\Document();
15
16    // 内部DTDサブセットを持つXML文字列を定義します。
17    // ここで 'writer' というエンティティと 'text' という表記法を定義しています。
18    $xmlString = <<<XML
19<?xml version="1.0" encoding="UTF-8"?>
20<!DOCTYPE greeting [
21  <!ENTITY writer "PHP Developer">
22  <!NOTATION text PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
23]>
24<greeting>Hello, &writer;!</greeting>
25XML;
26
27    // 定義したXML文字列をDom\Documentにロードします。
28    $dom->loadXML($xmlString);
29
30    // ドキュメントの Dom\DocumentType オブジェクトを取得します。
31    // これはXML/HTMLの <!DOCTYPE ...> 部分に相当します。
32    $documentType = $dom->doctype;
33
34    // ドキュメントタイプが正しく取得できたか確認します。
35    if ($documentType instanceof Dom\DocumentType) {
36        echo "--- Dom\\DocumentType::contains() の使用例 ---\n";
37
38        // 1. 文字列 'writer' がDTD内のエンティティ名として存在するかチェックします。
39        $containsWriterString = $documentType->contains('writer');
40        echo "ドキュメントタイプは文字列 'writer' を含みますか？ " . ($containsWriterString ? "はい" : "いいえ") . "\n";
41
42        // 2. 実際の Dom\Entity ノード ('writer' エンティティ) が存在するかチェックします。
43        // エンティティノードは $documentType->entities からアクセスできます。
44        if (isset($documentType->entities['writer'])) {
45            $writerEntityNode = $documentType->entities['writer'];
46            $containsWriterNode = $documentType->contains($writerEntityNode);
47            echo "ドキュメントタイプはエンティティノード 'writer' を含みますか？ " . ($containsWriterNode ? "はい" : "いいえ") . "\n";
48        }
49
50        // 3. 文字列 'text' がDTD内の表記法名として存在するかチェックします。
51        $containsTextString = $documentType->contains('text');
52        echo "ドキュメントタイプは文字列 'text' を含みますか？ " . ($containsTextString ? "はい" : "いいえ") . "\n";
53
54        // 4. 実際の Dom\Notation ノード ('text' 表記法) が存在するかチェックします。
55        // 表記法ノードは $documentType->notations からアクセスできます。
56        if (isset($documentType->notations['text'])) {
57            $textNotationNode = $documentType->notations['text'];
58            $containsTextNode = $documentType->contains($textNotationNode);
59            echo "ドキュメントタイプは表記法ノード 'text' を含みますか？ " . ($containsTextNode ? "はい" : "いいえ") . "\n";
60        }
61
62        // 5. 存在しない文字列をチェックします。結果は 'いいえ' になるはずです。
63        $containsNonExistent = $documentType->contains('nonExistentEntity');
64        echo "ドキュメントタイプは文字列 'nonExistentEntity' を含みますか？ " . ($containsNonExistent ? "はい" : "いいえ") . "\n";
65
66    } else {
67        echo "エラー: Dom\\DocumentType オブジェクトが見つかりませんでした。XMLにDOCTYPEが定義されているか確認してください。\n";
68    }
69}
70
71// 上記で定義したサンプル関数を実行します。
72demonstrateDocumentTypeContains();
73

PHP 8のDom\DocumentType::containsメソッドは、XMLドキュメントのDOCTYPE宣言内で定義されたDTD（Document Type Definition、ドキュメントの構造や使用できる要素などを定義する部分）に、特定のエンティティや表記法が存在するかを確認するための機能です。

このメソッドは、引数としてDom\Nodeオブジェクト、またはそのエンティティや表記法の名前を表す文字列$otherを受け取ります。例えば、XMLのDTD内で「writer」というエンティティが定義されていれば、contains('writer')と文字列で渡すか、あるいはその「writer」エンティティに対応するDom\Entityノードを渡すことで、その存在を確認できます。

メソッドは、指定されたエンティティまたは表記法がDTD内に実際に定義されていればtrueを、存在しない場合はfalseをブール値として戻り値に返します。

サンプルコードでは、<!DOCTYPE greeting [...]>という内部DTDサブセットを持つXMLを作成し、その中で定義された「writer」というエンティティや「text」という表記法が、Dom\DocumentTypeオブジェクトに含まれているかを検証しています。文字列でのチェックと、取得したDom\Nodeオブジェクトでのチェックの両方が示されており、XMLデータが期待する構造定義に準拠しているかを確認する際に非常に便利です。