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

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

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

基本的な使い方

『lengthプロパティは、Dom\CDATASectionオブジェクトが表現するCDATAセクションに含まれるテキストの文字数を保持するプロパティです。Dom\CDATASectionクラスは、XMLやHTMLドキュメント内で、HTMLタグのような特殊な文字を特別な意味を持つマークアップとして解釈させず、単なる文字列として扱うためのCDATAセクション（<![CDATA[...]]>）を表します。このlengthプロパティを参照することで、CDATAセクション内に記述されている文字列が何文字で構成されているかを簡単に取得できます。このプロパティは読み取り専用であり、プロパティ値を直接変更することはできません。実際のテキストデータが変更されると、lengthプロパティの値も自動的に更新されます。例えば、CDATAセクションの内容がシステムの要件で定められた文字数制限を超えていないかを検証する場合や、取得したテキストデータに対して何らかの処理を行う前の事前確認などに利用されます。なお、このプロパティは親クラスであるDom\CharacterDataから継承されたものであり、テキストやコメントなど、文字データを持つ他のDOMノードにも同様に存在します。』

構文(syntax)


1<?php
2
3$document = new \DOMDocument();
4$cdata = $document->createCDATASection('This is a sample CDATA content.');
5
6// The length property returns the number of characters.
7echo $cdata->length;

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

Dom\CDATASection::length は、CDATA セクションに含まれる文字数を整数（int）で返します。

サンプルコード

PHP CDATASectionの長さを取得する


1<?php
2
3// CDATASection ノードの長さを取得する例
4$dom = new DOMDocument();
5$cdata = $dom->createCDATASection("This is a CDATA section.");
6
7// CDATASection ノードの文字列の長さを取得
8$length = $cdata->length;
9
10echo "CDATASection の長さ: " . $length . PHP_EOL; // 出力: CDATASection の長さ: 25
11

PHPのDom\CDATASectionクラスにおけるlengthプロパティは、CDATAセクションに含まれる文字列の長さを整数値（int型）で取得するために使用します。このプロパティは読み取り専用であり、値を直接変更することはできません。

サンプルコードでは、まずDOMDocumentクラスのインスタンスを作成し、createCDATASection()メソッドを用いてCDATAセクションノードを作成しています。このCDATAセクションノードには、"This is a CDATA section."という文字列が格納されています。

次に、作成したCDATAセクションノードのlengthプロパティにアクセスし、その値を $length 変数に格納します。$cdata->lengthと記述することで、CDATAセクション内の文字列（"This is a CDATA section."）の文字数が取得できます。

最後に、echo文を用いて、取得した文字列の長さ（この場合は25文字）を画面に出力しています。PHP_EOLは改行コードを表し、出力結果を見やすくするために追加しています。

このようにlengthプロパティを利用することで、CDATAセクションに含まれる文字列の長さを簡単に取得することができます。これは、例えば、文字列の長さに応じて処理を分岐させたい場合などに役立ちます。

DOM\CDATASection クラスの length プロパティは、CDATAセクションに含まれる文字列の文字数を返します。これは、文字列のバイト数ではなく、文字数である点に注意が必要です。例えば、UTF-8エンコーディングで日本語などのマルチバイト文字が含まれている場合、strlen() 関数で得られるバイト数とは異なる結果になります。CDATAセクションの長さは、ノードが持つテキストコンテンツの長さを表します。ノードが空の場合、length は 0 を返します。length はプロパティとしてアクセスするため、メソッドのように () を付けて呼び出さないように注意してください。

PHPでCDATAセクションと配列の長さを取得する


1<?php
2
3// CDATASection ノードの長さを取得する例
4$dom = new DOMDocument();
5$cdata = $dom->createCDATASection("This is a CDATA section.");
6
7// CDATASectionノードをドキュメントに追加
8$dom->appendChild($cdata);
9
10// CDATASectionノードの長さを取得
11$length = $cdata->length;
12
13// 結果を出力
14echo "CDATA section length: " . $length . PHP_EOL;
15
16// 配列の長さを取得する例
17$array = ["apple", "banana", "cherry"];
18$arrayLength = count($array);
19
20// 結果を出力
21echo "Array length: " . $arrayLength . PHP_EOL;
22
23?>

このサンプルコードは、PHPでDom\CDATASectionオブジェクトのlengthプロパティを使用して、CDATAセクションノードの長さを取得する方法と、配列の要素数を取得する方法を示しています。

まず、DOMDocumentオブジェクトを作成し、createCDATASection()メソッドでCDATAセクションノードを生成します。Dom\CDATASectionクラスのlengthプロパティは、CDATAセクションに含まれる文字列の長さを整数値（int）で返します。この例では、"This is a CDATA section."という文字列がCDATAセクションに格納されているため、$cdata->length は文字列の長さを返します。

次に、配列の要素数を取得する方法を示します。PHPのcount()関数は、配列の要素数を返します。サンプルコードでは、$array = ["apple", "banana", "cherry"]という配列を定義し、count($array)で配列の要素数（この場合は3）を取得しています。

Dom\CDATASectionのlengthプロパティは、CDATAセクション内のテキストの長さを取得するために使用されます。一方、count()関数は、配列の要素数を取得するために使用されます。これらは、それぞれ異なるコンテキストで文字列や配列のサイズを扱うための便利な機能です。このサンプルコードを実行すると、CDATAセクションの長さと配列の要素数がそれぞれ出力されます。

Dom\CDATASectionのlengthは、CDATAセクションの文字列としての長さを返します。配列の要素数を取得する場合は、count()関数を使用します。Dom\CDATASectionのlengthと配列のcount()は目的が異なるため、混同しないように注意が必要です。lengthはDom\CDATASectionオブジェクトに対してのみ有効です。また、lengthはプロパティとしてアクセスするため、$cdata->length()のように括弧を付けて関数として呼び出さないようにしてください。DOMDocumentを扱う際は、文字コードやXMLの構造に注意し、意図しないエラーが発生しないようにしましょう。