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

lengthプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

lengthプロパティは、DOMNodeListオブジェクトに含まれるノードの数を表すプロパティです。DOMNodeListは、例えばgetElementByIdやgetElementsByTagNameなどのDOM操作によって取得されるノードのコレクションです。lengthプロパティを参照することで、そのコレクション内にいくつのノードが含まれているかを簡単に知ることができます。

具体的には、$nodeList->lengthのようにアクセスすることで、整数値としてノード数が取得できます。この値は読み取り専用であり、直接変更することはできません。ノードの追加や削除を行うことで、自動的に更新されます。

lengthプロパティは、DOMDocumentを操作する際に非常に役立ちます。例えば、特定のタグを持つ要素がいくつ存在するかを調べたり、ノードリストをループ処理する際の反復回数を決定したりするのに利用できます。

以下に簡単な使用例を示します。

$dom = new DOMDocument();
$dom->loadHTML('<html><body><h1>Hello</h1><p>World</p><p>!</p></body></html>');

$paragraphs = $dom->getElementsByTagName('p');
$numberOfParagraphs = $paragraphs->length;

echo "段落の数: " . $numberOfParagraphs . PHP_EOL; // 出力: 段落の数: 2

この例では、getElementsByTagName('p')で取得したノードリストに含まれる段落要素の数をlengthプロパティで取得し、画面に出力しています。このように、lengthプロパティはDOM操作において、ノードリストのサイズを確認するための基本的な手段となります。システムエンジニアを目指す上で、DOMDocumentを扱う場合には必須の知識となります。

構文(syntax)

1<?php
2$dom = new DOMDocument();
3$dom->loadHTML('<div><p>First paragraph</p><p>Second paragraph</p></div>');
4$paragraphs = $dom->getElementsByTagName('p');
5echo $paragraphs->length;
6?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

DOMNodeList に含まれるノードの数を示す整数値です。

【PHP8.x】lengthプロパティの使い方 | いっしー@Webエンジニア