【PHP8.x】DOMText::contains()メソッドの使い方

Copy
1<?php
2
3/**
4 * PHPで配列が特定の要素を含むかをチェックする関数。
5 * システムエンジニアを目指す初心者向けに、簡潔で分かりやすい例を提供します。
6 *
7 * PHP 8 で配列が特定の要素を「含む (contains)」かどうかを調べる際には、
8 * 主に in_array() 関数が使用されます。
9 * この関数は、指定された値が配列内に存在するかどうかを真偽値 (true/false) で返します。
10 *
11 * 元のリファレンス情報で示された DOMText::contains メソッドは、PHPの標準DOM拡張には存在せず、
12 * また、戻り値が「戻り値なし」とされているため、一般的な「含む」の判定には適しません。
13 * そのため、キーワード「php contains array」に最も関連性の高い、
14 * PHPで配列の要素をチェックする標準的な方法を紹介します。
15 */
16function checkArrayContainsElement(): void
17{
18    // 調べる対象の配列を定義します
19    $fruits = ['apple', 'banana', 'orange', 'grape'];
20
21    // 配列に含まれているか確認したい要素を定義します
22    $searchFruit1 = 'orange'; // 配列に存在する要素
23    $searchFruit2 = 'mango';  // 配列に存在しない要素
24
25    echo "--- 配列の要素チェック（in_array() を使用）---" . PHP_EOL;
26
27    // in_array() を使用して、'orange' が $fruits 配列に含まれるかチェックします。
28    // 構文: in_array(検索する値, 検索対象の配列, [厳密な比較を行うか])
29    // 3番目の引数を省略した場合、緩やかな比較 (==) が行われます。
30    if (in_array($searchFruit1, $fruits)) {
31        echo "'{$searchFruit1}' は配列に含まれています。" . PHP_EOL;
32    } else {
33        echo "'{$searchFruit1}' は配列に含まれていません。" . PHP_EOL;
34    }
35
36    // 'mango' が $fruits 配列に含まれるかチェックします。
37    if (in_array($searchFruit2, $fruits)) {
38        echo "'{$searchFruit2}' は配列に含まれています。" . PHP_EOL;
39    } else {
40        echo "'{$searchFruit2}' は配列に含まれていません。" . PHP_EOL;
41    }
42
43    // 厳密な型比較の例
44    // in_array() の3番目の引数に true を渡すと、厳密な比較 (===) が行われます。
45    $numbers = [1, 2, '3', 4]; // 整数と文字列の数字が混在する配列
46    $searchNumber1 = 3;   // 整数型
47    $searchNumber2 = '3'; // 文字列型
48
49    echo PHP_EOL . "--- 厳密な型比較の例 (in_array() の第3引数) ---" . PHP_EOL;
50
51    // 非厳密モード (デフォルト): 整数 3 と文字列 '3' は同じと見なされます
52    if (in_array($searchNumber1, $numbers)) {
53        echo "非厳密モード: '{$searchNumber1}' (整数) は配列に含まれています。" . PHP_EOL;
54    } else {
55        echo "非厳密モード: '{$searchNumber1}' (整数) は配列に含まれていません。" . PHP_EOL;
56    }
57
58    // 厳密モード (true を指定): 整数 3 と文字列 '3' は異なる型のため、含まれていないと判定されます
59    if (in_array($searchNumber1, $numbers, true)) {
60        echo "厳密モード: '{$searchNumber1}' (整数) は配列に含まれています。" . PHP_EOL;
61    } else {
62        echo "厳密モード: '{$searchNumber1}' (整数) は配列に含まれていません。" . PHP_EOL;
63    }
64    
65    // 厳密モードで文字列 '3' を検索: 文字列 '3' は配列に存在するため、含まれていると判定されます
66    if (in_array($searchNumber2, $numbers, true)) {
67        echo "厳密モード: '{$searchNumber2}' (文字列) は配列に含まれています。" . PHP_EOL;
68    } else {
69        echo "厳密モード: '{$searchNumber2}' (文字列) は配列に含まれていません。" . PHP_EOL;
70    }
71
72    // 配列のキーの存在チェック (もしキーの存在を「contains」と見なす場合)
73    $config = ['database' => 'mydb', 'user' => 'admin'];
74    echo PHP_EOL . "--- 配列のキーの存在チェック (array_key_exists()) ---" . PHP_EOL;
75
76    if (array_key_exists('database', $config)) {
77        echo "'database' キーは配列に存在します。" . PHP_EOL;
78    } else {
79        echo "'database' キーは配列に存在しません。" . PHP_EOL;
80    }
81
82    if (array_key_exists('password', $config)) {
83        echo "'password' キーは配列に存在します。" . PHP_EOL;
84    } else {
85        echo "'password' キーは配列に存在しません。" . PHP_EOL;
86    }
87}
88
89// 上記の関数を実行して、配列の要素チェックの動作を確認します
90checkArrayContainsElement();

提供されたリファレンス情報にあるDOMText::containsメソッドは、PHPのDOM拡張機能の一部であり、一般的な配列の要素チェックには直接使用されません。PHP 8で配列が特定の要素を含むかを調べる最も一般的な方法は、in_array()関数を使用することです。

in_array()関数は、第一引数に検索したい要素の値を、第二引数に検索対象の配列を受け取ります。この関数は、指定された値が配列内に存在すればtrueを、存在しなければfalseを戻り値として返します。例えば、$fruitsという配列に'orange'が含まれるかを知りたい場合、in_array('orange', $fruits)と記述することで結果が得られます。オプションで、第三引数にtrueを指定すると、検索する値と配列内の要素が型まで含めて厳密に比較されます。これにより、数値の3と文字列の'3'を異なるものとして区別できるようになります。

また、配列に特定の「キー」が存在するかを確認したい場合には、array_key_exists()関数を利用できます。この関数は、第一引数に確認したいキー名を、第二引数に配列を受け取り、キーが存在すればtrue、存在しなければfalseを返します。これらの関数を適切に使い分けることで、PHPにおける配列の要素やキーの存在チェックを効率的に行えます。

Copy
1<?php
2
3/**
4 * DOMText::contains メソッドの使用例を示します。
5 * このメソッドは、テキストノードが特定の文字列を含んでいるかを確認します。
6 * PHP 8.3 以降で利用可能です。
7 *
8 * システムエンジニアを目指す初心者の方へ：
9 * DOMはHTMLやXMLドキュメントをプログラムから操作するための標準APIです。
10 * DOMTextクラスは、テキストノード（要素内の文字列部分）を表します。
11 * containsメソッドを使うと、そのテキストノードに特定の文字列が含まれているかを簡単に確認できます。
12 */
13function demonstrateDomTextContains(): void
14{
15    // 新しいDOMドキュメントを作成します。
16    // ドキュメントはHTMLやXML構造のルートとなります。
17    $dom = new DOMDocument('1.0', 'UTF-8');
18
19    // ルート要素（例: <root>）を作成し、ドキュメントに追加します。
20    $rootElement = $dom->createElement('root');
21    $dom->appendChild($rootElement);
22
23    // テキストノード（例: "Hello, PHP World!"）を作成します。
24    // このテキストノードがcontainsメソッドの対象となります。
25    $textNode = $dom->createTextNode('Hello, PHP DOM World!');
26    $rootElement->appendChild($textNode);
27
28    echo "対象のテキストノードの内容: \"" . $textNode->textContent . "\"\n\n";
29
30    // DOMText::contains() メソッドを使用して、文字列が含まれているかを確認します。
31
32    // 例1: 含まれている文字列を検索
33    $searchString1 = 'PHP DOM';
34    if ($textNode->contains($searchString1)) {
35        echo "テキストノードは \"$searchString1\" を含んでいます。\n";
36    } else {
37        echo "テキストノードは \"$searchString1\" を含んでいません。\n";
38    }
39
40    // 例2: 含まれていない文字列を検索
41    $searchString2 = 'Python';
42    if ($textNode->contains($searchString2)) {
43        echo "テキストノードは \"$searchString2\" を含んでいます。\n";
44    } else {
45        echo "テキストノードは \"$searchString2\" を含んでいません。\n";
46    }
47
48    // 例3: 大文字・小文字を区別して検索
49    // 'Hello'はありますが、'hello'は完全に一致しないため、含まれていないと判定されます。
50    $searchString3 = 'hello';
51    if ($textNode->contains($searchString3)) {
52        echo "テキストノードは \"$searchString3\" を含んでいます。\n";
53    } else {
54        echo "テキストノードは \"$searchString3\" を含んでいません。\n";
55    }
56}
57
58// 上記の関数を実行し、DOMText::containsの動作を確認します。
59demonstrateDomTextContains();
60

PHPのDOMText::containsメソッドは、HTMLやXMLドキュメントの構造をプログラムで操作するDOM（Document Object Model）において、テキストノードが特定の文字列を含んでいるかを確認するための機能です。このメソッドはPHP 8.3以降で利用可能で、DOMTextクラスのインスタンス（ドキュメント内のテキスト部分を表すノード）に対して呼び出されます。

このメソッドの引数には、テキストノード内で検索したい文字列を指定します。例えば、「Hello, PHP DOM World!」というテキストノードに対して「PHP DOM」という文字列を渡すと、その文字列が含まれているかを判定します。戻り値はブール値となり、指定した文字列が含まれていればtrue、含まれていなければfalseを返します。この戻り値を利用することで、プログラムの条件分岐などにより、テキストノードの内容に応じた処理を行うことが可能になります。サンプルコードでは、文字列の有無や大文字・小文字を区別した検索結果が具体的に示されており、このメソッドの挙動を理解するのに役立ちます。