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

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

作成日: 2025年09月11日更新日: 2025年11月24日

基本的な使い方

lengthプロパティは、DOMTextノードが保持するテキストデータの文字列長を返却するプロパティです。DOMTextは、XMLドキュメントやHTMLドキュメント内のテキストコンテンツを表すノードであり、このプロパティを使用することで、そのテキストコンテンツが何文字で構成されているかを取得できます。

具体的には、DOMTextオブジェクトに対して$domtext->lengthのようにアクセスすることで、整数値として文字列長が得られます。この値は、テキストデータに含まれる文字数（UTF-8エンコーディングにおける文字数）に相当します。

システムエンジニアを目指す初心者の方にとって、このプロパティは、XMLやHTMLドキュメントをプログラムで操作する際に、テキストデータの長さを確認したり、特定の長さに基づいて処理を分岐させたりするのに役立ちます。例えば、テキストデータが一定の長さを超える場合にエラーを発生させたり、長いテキストを分割して表示したりする処理を実装する際に利用できます。また、データベースに保存する際の文字数制限を確認する際にも利用可能です。DOMTextオブジェクトが保持するテキストデータの文字数を動的に取得できるため、柔軟なテキスト処理を実現できます。

構文(syntax)


1DOMText::$length;

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

このプロパティは、DOMTextノードに含まれる文字数を整数で返します。

サンプルコード

PHP DOMTextのlengthで文字数を取得する


1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMTextのlengthプロパティを使用して、テキストノードの文字数を取得する例
7 *
8 * この関数は、HTML文字列から特定のテキストノードを抽出し、
9 * その文字数を`length`プロパティで取得して表示します。
10 */
11function getDomTextLengthExample(): void
12{
13    // 1. 解析対象のHTML文字列を定義します。
14    // 日本語のようなマルチバイト文字を含むテキストを用意します。
15    $html = '<!DOCTYPE html>
16<html lang="ja">
17<head>
18    <meta charset="UTF-8">
19    <title>サンプル</title>
20</head>
21<body>
22    <p>こんにちは、世界！</p>
23</body>
24</html>';
25
26    // 2. DOMDocumentオブジェクトをインスタンス化します。
27    $dom = new DOMDocument();
28
29    // 3. HTML文字列を読み込みます。
30    // libxmlのエラーを表示しないようにエラーハンドリングを有効にします。
31    libxml_use_internal_errors(true);
32    $dom->loadHTML($html);
33    libxml_clear_errors();
34
35    // 4. <p>タグの要素を取得します。
36    $pElement = $dom->getElementsByTagName('p')->item(0);
37
38    // 5. <p>要素内の最初のノード（この場合はテキストノード）を取得します。
39    // $textNodeはDOMTextクラスのインスタンスです。
40    $textNode = $pElement->firstChild;
41
42    // 6. DOMTextオブジェクトの`length`プロパティにアクセスして文字数を取得します。
43    // このプロパティは、マルチバイト文字も1文字として正しくカウントします。
44    $length = $textNode->length;
45    $content = $textNode->textContent;
46
47    // 7. 取得したテキスト内容と文字数を出力します。
48    echo 'テキスト: ' . $content . PHP_EOL;
49    echo '文字数: ' . $length . PHP_EOL; // 出力結果: 文字数: 9
50}
51
52// 関数を実行して結果を表示します。
53getDomTextLengthExample();
54

DOMTextクラスのlengthプロパティは、テキストノードに含まれる文字の数を取得するために使用します。このプロパティは引数を取らず、戻り値として文字数を整数（int型）で返します。

サンプルコードでは、まずDOMDocumentオブジェクトを使ってHTML文字列を解析し、DOMツリーを構築しています。次に、getElementsByTagNameメソッドで<p>タグの要素を取得し、その中にある最初のノード（この場合は「こんにちは、世界！」というテキスト）をfirstChildプロパティで取り出しています。この取得したテキストノードはDOMTextクラスのインスタンスとなります。

このDOMTextオブジェクトのlengthプロパティにアクセスすることで、テキストノードの文字数を簡単に取得できます。このプロパティの大きな特徴は、日本語のようなマルチバイト文字を1文字として正確に数える点です。そのため、サンプルコードの「こんにちは、世界！」は、見た目通りの9文字として正しくカウントされます。

このようにDOMText::lengthプロパティは、HTMLやXMLドキュメントを操作する際に、特定のテキスト部分の文字数を正確に把握したい場合に非常に便利な機能です。

DOMTextのlengthプロパティは、テキストノードの文字数を返します。PHPの標準関数であるstrlen()がバイト数を返すのに対し、このプロパティは日本語のようなマルチバイト文字を正しく1文字として数える点が重要です。HTMLを解析する際、DOMDocument::loadHTML()は不完全なHTMLでも解釈を試みますが、その過程で警告が発生することがあります。サンプルコードで使われているlibxml_use_internal_errors(true)は、これらの警告を画面に出さず内部的に処理するための仕組みです。getElementsByTagName()やfirstChildで要素やノードを取得する場合、対象が存在しないとnullが返ります。そのため、取得したオブジェクトのプロパティにアクセスする前には、nullでないことを確認するチェックを入れると、予期せぬエラーを防ぐことができます。また、要素内の最初のノードが必ずしもテキストとは限らず、改行コードなどが空のテキストノードとして解釈される場合もあるため、より複雑なHTMLを扱う際は注意が必要です。

PHP 配列の長さを取得する


1<?php
2
3declare(strict_types=1);
4
5/**
6 * 配列の要素数（長さ）を取得して表示します。
7 *
8 * PHPで配列の長さを取得する場合、一般的に `count()` 関数が使用されます。
9 * これは他の言語における `length` プロパティやメソッドに相当します。
10 *
11 * @param array $data 長さを調べたい配列
12 * @return void この関数は結果を直接出力するため、値を返しません。
13 */
14function printArrayLength(array $data): void
15{
16    // count() 関数を使用して配列の要素数を取得します。
17    $length = count($data);
18
19    // 配列の内容と要素数を出力します。
20    echo '配列: [' . implode(', ', $data) . ']' . PHP_EOL;
21    echo '要素数 (length): ' . $length . PHP_EOL;
22    echo '--------------------' . PHP_EOL;
23}
24
25// サンプルデータとして文字列の配列を定義します。
26$fruits = ['Apple', 'Banana', 'Cherry'];
27printArrayLength($fruits);
28
29// 数値の配列でも同様に動作します。
30$numbers = [10, 20, 30, 40, 50];
31printArrayLength($numbers);
32
33// 空の配列の場合、要素数は 0 となります。
34$emptyArray = [];
35printArrayLength($emptyArray);
36

このPHPコードは、配列に含まれる要素の数（長さ）を取得し、表示するサンプルです。他のプログラミング言語では length という名前のプロパティで配列の長さを取得することが多いですが、PHPでは count() という組み込み関数を使用するのが一般的です。

サンプルコードでは printArrayLength という関数を定義しています。この関数は、引数として要素数を調べたい配列を array 型で受け取ります。関数内では、count() 関数にその配列を渡すことで要素数を取得し、整数 (int) 型の値を変数 $length に代入します。そして、echo を使って元の配列の内容と、取得した要素数を出力します。この関数は特定の値を返すのではなく、結果を直接画面に出力するため、戻り値の型は void となっています。

コードの後半では、実際に3つの異なる配列（文字列、数値、空の配列）を引数として printArrayLength 関数を呼び出しています。これにより、count() 関数がどのような配列に対しても正しく要素数を計算できることが分かります。例えば、空の配列を渡した場合は、要素数として 0 が返され、その結果が表示されます。このコードは、PHPで配列の要素数を扱う際の基本的な方法を示しています。

PHPの配列には、他の言語でよく見られる length というプロパティはありません。配列の要素数を取得するには、サンプルコードのように count() 関数を使用するのが標準的な方法です。length という名前は、DOMオブジェクトなど特定のクラスのプロパティとして存在しますが、配列の要素数を取得する目的では使えないため注意が必要です。count() 関数は、変数が配列でなかったり null だったりするとエラーや警告の原因となります。そのため、is_array() 関数で事前に配列かどうかを確認するか、関数の引数で型を array に指定すると、より安全にコードを記述できます。