【PHP8.x】containsメソッドの使い方
containsメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
containsメソッドは、特定のDOMノードが保持する文字列の中に、指定した部分文字列が含まれているかどうかを確認するメソッドです。このメソッドは、Dom\CharacterDataクラスに属しており、Dom\CharacterDataクラスは、ウェブページの構造を表すDOM（Document Object Model）において、テキスト、コメント、CDATAセクションなど、文字データを直接保持するノードの基底クラスです。したがって、これらの文字データノードが持つテキストコンテンツに対して、特定の文字列が含まれているかを効率的に調べることができます。
利用する際は、検索したい部分文字列を引数として渡します。メソッドは、ノードの持つ文字列全体からその部分文字列を探し、見つかった場合には論理値のtrue（真）を返し、見つからなかった場合にはfalse（偽）を返します。これにより、例えばHTMLドキュメントのコメントに特定の情報が含まれているかを確認したり、ユーザーが入力したテキストノードの内容を検証したりする際に非常に便利です。検索は大文字と小文字を区別して行われるため、正確な文字列の一致を判定する際に役立ちます。このメソッドはPHP 8.3.0以降で利用可能です。
構文(syntax)
1<?php 2$booleanResult = $domCharacterDataInstance->contains('検索する文字列');
引数(parameters)
?Dom\Node $other
- ?Dom\Node $other: 比較対象となる Dom\Node オブジェクト。このノードが現在のノードに含まれているかを判定します。
戻り値(return)
戻り値なし
戻り値はありません