【PHP8.x】containsメソッドの使い方
containsメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
containsメソッドは、PHPのDOM拡張機能におけるDom\Notationクラスに属し、XMLドキュメントのDTD（Document Type Definition）で定義される記法（NOTATION）に関する処理を実行するメソッドです。このメソッドは、特定の文字列が、対象となるDom\Notationオブジェクトが保持する情報の中に存在するかどうかを判定します。
具体的には、Dom\Notationが表す記法名や、その記法に関連付けられている公開識別子（PUBLIC ID）またはシステム識別子（SYSTEM ID）といった識別子に対して、引数として渡された文字列が含まれているかを確認します。例えば、XML文書で特定の外部リソースのタイプ（例：画像フォーマット、アプリケーションの種類）を定義するためにNOTATIONが使われることがありますが、このメソッドはそのNOTATIONの定義の中に特定のキーワードや識別子の部分文字列が含まれているかを効率的にチェックする際に役立ちます。
戻り値は真偽値（boolean）となり、指定された文字列がDom\Notationオブジェクトの情報に含まれていればtrueを、含まれていなければfalseを返します。この機能を利用することで、プログラム上でXMLのDTD定義を動的に検証したり、外部リソースのタイプに基づいて条件分岐を行ったりするなど、XML文書の解析や処理における柔軟なロジックを実装することが可能になります。システムエンジニアを目指す方にとって、XMLデータの構造を深く理解し、その定義をプログラムで操作する上で重要なツールとなるでしょう。
構文(syntax)
1public function contains(?Dom\Node $other): bool
引数(parameters)
?Dom\Node $other
- ?Dom\Node $other: 比較対象となるDom\Nodeオブジェクト。このノードが、メソッドが呼び出されたノードのツリーに含まれているかどうかを判定します。
nullを指定した場合、必ずfalseを返します。
戻り値(return)
bool
Dom\Notation::contains() メソッドは、指定された文字列がこのノードのコンテンツに含まれているかどうかを判定し、真偽値（bool）を返します。このメソッドは、ノードが指定された文字列を部分的にでも含んでいれば true を、そうでなければ false を返します。