【PHP8.x】containsメソッドの使い方
containsメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
containsメソッドは、DOMCommentノード（コメントノード）が指定された文字列を含んでいるかどうかを判定するメソッドです。PHP 8.0以降で使用可能です。このメソッドは、コメントノードの内容全体に対して、指定された文字列が部分文字列として存在するかどうかを調べます。
システムエンジニアを目指す初心者の方にとって、DOMCommentノードはHTMLやXMLドキュメント内のコメントを表すオブジェクトだと考えると理解しやすいでしょう。containsメソッドを利用することで、特定のキーワードやフレーズがコメントに含まれているかをプログラムで効率的に確認できます。
例えば、HTMLのテンプレートエンジンなどで、特定の条件に基づいてコメントの内容を処理する必要がある場合に、このメソッドは非常に役立ちます。また、XMLドキュメントの解析において、特定のコメントを目印に処理を分岐させる場合などにも利用できます。
containsメソッドは、大文字と小文字を区別して文字列を検索します。もし大文字小文字を区別せずに検索したい場合は、strtolower関数やstrtoupper関数などを用いて、比較する文字列を事前に小文字または大文字に変換する必要があります。
戻り値は、指定された文字列がコメントノードに含まれている場合はtrue、そうでない場合はfalseとなります。このboolean型の戻り値を利用することで、条件分岐処理を記述し、プログラムの動作を制御することが可能です。このように、containsメソッドは、DOMDocumentを操作する上で、コメントノードの内容を検証するための重要なツールとなります。
構文(syntax)
1DOMComment::contains(string $needle, int $offset = 0): bool
引数(parameters)
DOMNode|DOMNameSpaceNode|null $other
- DOMNode|DOMNameSpaceNode|null $other: 比較対象となるDOMNodeまたはDOMNameSpaceNodeオブジェクト、あるいはnull
戻り値(return)
bool
指定された文字列がDOMCommentノードのコンテンツに含まれている場合にtrueを、含まれていない場合にfalseを返します。