PHPでXMLを読み込む：readOuterXml() 関数 vs DOMDocument::loadXML() vs SimpleXMLElement::loadXML()

PHPのXMLライブラリ「XMLReader」：readOuterXml() 関数を徹底解説

このチュートリアルでは、readOuterXml() 関数の詳細な解説と、実際のコード例を通して、その使用方法を分かりやすく説明します。

目次

1. readOuterXml() 関数の概要
   • 機能
   • 戻り値
   • 使用例
2. readOuterXml() 関数の詳細
   • 動作
   • 属性の扱い
   • 名前空間の扱い
   • エラー処理
3. コード例
   • シンプルなXMLドキュメントの読み込み
   • 複雑なXMLドキュメントの読み込み
   • 特定のノードのみを読み込む

readOuterXml() 関数の概要

機能

readOuterXml() 関数は、現在のノードとその子孫ノードを含む、XMLドキュメントの一部を読み込みます。読み込んだ内容は、文字列として返されます。

戻り値

• 成功した場合：読み込んだXMLドキュメントの一部を文字列として返します。
• 失敗した場合：空文字列("")を返します。

使用例

$xml = <<<XML
<root>
  <node1>
    <child1>value1</child1>
    <child2>value2</child2>
  </node1>
  <node2>value3</node2>
</root>
XML;

$reader = new XMLReader();
$reader->xml($xml);

// 現在のノードは <root>
$xmlString = $reader->readOuterXml();

echo $xmlString; // 出力: <root><node1><child1>value1</child1><child2>value2</child2></node1><node2>value3</node2></root>

readOuterXml() 関数の詳細

動作

readOuterXml() 関数は、以下の手順で動作します。

1. 現在のノードの種類を確認します。
2. ノードの種類に応じて、以下の処理を行います。
   • 要素ノード:
     • 開始タグ、属性、子孫ノード、終了タグを読み込みます。
   • 属性ノード:
     • 属性名と属性値を読み込みます。
   • テキストノード:
     • テキスト内容を読み込みます。
   • その他:
     • 何もしません。
3. 読み込んだ内容を文字列として返します。

属性の扱い

readOuterXml() 関数は、属性も読み込みます。属性は、要素ノードの開始タグ内に記述されます。

例:

<node1 attr1="value1" attr2="value2">
  <child1>value3</child1>
</node1>

上記の例では、readOuterXml() 関数は以下の文字列を返します。

<node1 attr1="value1" attr2="value2">
  <child1>value3</child1>
</node1>

名前空間の扱い

readOuterXml() 関数は、名前空間も読み込みます。名前空間は、要素ノードの開始タグ内にプレフィックスとして記述されます。

例:

<root xmlns:ns="http://example.com">
  <ns:node1>value1</ns:node1>
</root>

上記の例では、readOuterXml() 関数は以下の文字列を返します。

<root xmlns:ns="http://example.com">
  <ns:node1>value1</ns:node1>
</root>

エラー処理

readOuterXml() 関数は、エラーが発生した場合、空文字列("")を返します。エラーの詳細を確認するには、XMLReader::getErrors() 関数を使用します。

コード例

シンプルなXMLドキュメントの読み込み

$xml = <<<XML
<root>
  <node>value</node>
</root>
XML;

$reader = new XMLReader();
$reader->xml($xml);

$xmlString = $reader->readOuterXml();

echo $xmlString; // 出力: <root><node>

PHPのXMLライブラリ「XMLReader」：readOuterXml() 関数のサンプルコード

$xml = <<<XML
<root>
  <node>value</node>
</root>
XML;

$reader = new XMLReader();
$reader->xml($xml);

$xmlString = $reader->readOuterXml();

echo $xmlString; // 出力: <root><node>value</node></root>

複雑なXMLドキュメントの読み込み

$xml = <<<XML
<root>
  <node1>
    <child1>value1</child1>
    <child2>value2</child2>
  </node1>
  <node2>value3</node2>
</root>
XML;

$reader = new XMLReader();
$reader->xml($xml);

// 現在のノードは <root>
$xmlString = $reader->readOuterXml();

echo $xmlString; // 出力: <root><node1><child1>value1</child1><child2>value2</child2></node1><node2>value3</node2></root>

特定のノードのみを読み込む

$xml = <<<XML
<root>
  <node1>
    <child1>value1</child1>
    <child2>value2</child2>
  </node1>
  <node2>value3</node2>
</root>
XML;

$reader = new XMLReader();
$reader->xml($xml);

// <node1> ノードのみを読み込む
while ($reader->read()) {
  if ($reader->nodeType === XMLReader::ELEMENT && $reader->name === 'node1') {
    $xmlString = $reader->readOuterXml();
    break;
  }
}

echo $xmlString; // 出力: <node1><child1>value1</child1><child2>value2</child2></node1>

属性の読み込み

$xml = <<<XML
<node attr1="value1" attr2="value2">
  <child>value</child>
</node>
XML;

$reader = new XMLReader();
$reader->xml($xml);

$xmlString = $reader->readOuterXml();

echo $xmlString; // 出力: <node attr1="value1" attr2="value2"><child>value</child></node>

名前空間の読み込み

$xml = <<<XML
<root xmlns:ns="http://example.com">
  <ns:node>value</ns:node>
</root>
XML;

$reader = new XMLReader();
$reader->xml($xml);

$xmlString = $reader->readOuterXml();

echo $xmlString; // 出力: <root xmlns:ns="http://example.com"><ns:node>value</ns:node></root>

エラー処理

$xml = <<<XML
<root>
  <node>
    <child>value</child>
  </node>
</root>
XML;

$reader = new XMLReader();
$reader->xml($xml);

// 存在しないノードを読み込もうとする
$xmlString = $reader->readOuterXml('invalid_node');

if ($reader->error

PHPでXMLを読み込むその他の方法

DOMDocument::loadXML() 関数は、XMLドキュメントをメモリに読み込み、DOMDocumentオブジェクトとして返します。DOMDocumentオブジェクトは、XMLドキュメントを操作するための様々なメソッドを提供します。

例:

$xml = <<<XML
<root>
  <node>value</node>
</root>
XML;

$doc = new DOMDocument();
$doc->loadXML($xml);

// 読み込んだXMLドキュメントを操作する

$nodes = $doc->getElementsByTagName('node');
foreach ($nodes as $node) {
  echo $node->textContent; // 出力: value
}

SimpleXMLElement::loadXML() 関数は、XMLドキュメントをメモリに読み込み、SimpleXMLElementオブジェクトとして返します。SimpleXMLElementオブジェクトは、