【PHP8.x】lengthプロパティの使い方

lengthプロパティは、PHPのDOM拡張機能におけるDOMCommentクラスのインスタンスが表す、コメントノードのテキストコンテンツの長さを保持するプロパティです。

DOMCommentクラスは、XMLやHTMLドキュメント内で「<!-- ... -->」形式で記述されるコメントノードをプログラム上で操作するためのクラスです。このクラスはDOM（Document Object Model）ツリー構造の一部として、ドキュメントのコメント部分を表現します。

lengthプロパティにアクセスすることで、該当するDOMCommentオブジェクトが保持するコメントテキストの内容が何文字であるかを取得できます。具体的には、コメントの開始区切りである「<!--」と終了区切りである「-->」を除いた、純粋なコメント部分の文字列の文字数を整数値で返します。例えば、「<!-- これはテストコメントです -->」というコメントノードの場合、lengthプロパティは「これはテストコメントです」という文字列の文字数である11を返します。

このプロパティは読み取り専用であり、コメントの長さを直接変更することはできません。主に、ドキュメント内のコメントの文字数を確認したり、コメントの内容に基づいて処理を分岐させたりする際に利用されます。システムエンジニアを目指す初心者の方々がDOM操作を行う際、コメントの情報を取得する上で基本的な情報となるでしょう。

Copy
1<?php
2$dom = new DOMDocument();
3$commentNode = $dom->createComment('コメントテキスト');
4echo $commentNode->length;
5?>

引数なし

引数はありません

int

DOMComment オブジェクトに格納されているコメントの文字数を整数で返します。