【PHP8.x】containsメソッドの使い方

containsメソッドは、指定された文字列がDOMCharacterDataオブジェクトの保持する文字データ内に含まれているかどうかを判定するメソッドです。このメソッドはPHP 8.3.0で追加されました。そのため、現在ご利用のPHPバージョンが8.0から8.2の場合、このメソッドは利用できませんのでご注意ください。

DOMCharacterDataクラスは、XMLやHTMLドキュメント内でテキスト、コメント、CDATAセクションなどの文字データを直接表現するノードの基底クラスです。これらのノードが実際に持つ文字列データに対して、特定の文字列が含まれているかを簡単に確認するためにcontainsメソッドが提供されています。

具体的には、containsメソッドは第一引数に検索したい文字列を受け取ります。そして、対象となるDOMCharacterDataオブジェクトが内部に持つ全データ（dataプロパティに相当）の中に、引数で与えられた文字列が部分文字列として存在するかどうかを調べます。もし検索文字列が見つかればtrueを、見つからなければfalseをブール値として返します。この検索は、大文字と小文字を区別して行われます。例えば、コメントノードのテキストに特定のキーワードが含まれているかを確認したり、テキストノードの内容を検証したりする際に役立ちます。

Copy
1<?php
2$dom = new DOMDocument();
3$textNode = $dom->createTextNode('This is a sample text.');
4$hasSubstring = $textNode->contains('sample');
5?>

DOMNode $other

• DOMNode $other: 検索対象となる別のDOMCharacterDataノード

bool

指定された文字列がDOMCharacterDataオブジェクトのテキストコンテンツに含まれているかどうかを示します。含まれている場合はtrue、含まれていない場合はfalseを返します。