【PHP】SimpleXMLElement::key メソッドの使い方とサンプルコード【初心者向け】

PHP の SimpleXMLElement::key メソッド解説

メソッドの概要

• 戻り値: 文字列 - 現在の要素の XML タグ名
• パラメータ: なし
• 使用例:

$xml = new SimpleXMLElement('<book>PHP 入門</book>');
echo $xml->key; // 出力: book

詳細

SimpleXMLElement クラスは、PHP における XML パースのための便利なツールです。このクラスのオブジェクトは、XML ドキュメントの要素を表します。

SimpleXMLElement::key メソッドは、現在の要素の XML タグ名を返すために使用されます。これは、要素の種類を特定したり、要素を処理するためのコードを記述したりする際に役立ちます。

注意点:

• PHP 8.0 より前のバージョンでは、SimpleXMLElement::key メソッドは SimpleXMLIterator サブクラスでのみ使用できました。
• 無効なイテレータに SimpleXMLElement::key メソッドを呼び出すと、Error 例外がスローされます。以前のバージョンでは、false が返されていました。

例

SimpleXMLElement::key メソッドの使用方法をいくつか例示します。

例 1: 現在の要素の XML タグ名を取得する

$xml = new SimpleXMLElement('<book>PHP 入門</book>');
echo $xml->key; // 出力: book

例 2: 要素の種類に基づいて処理を行う

$xml = new SimpleXMLElement('<books><book>PHP 入門</book><chapter>オブジェクト指向</chapter></books>');

foreach ($xml->children() as $element) {
  switch ($element->key) {
    case 'book':
      echo "書籍: " . $element . PHP_EOL;
      break;
    case 'chapter':
      echo "章: " . $element . PHP_EOL;
      break;
  }
}

出力:

書籍: PHP 入門
章: オブジェクト指向

例 3: SimpleXMLIterator と組み合わせて使用

$xml = new SimpleXMLElement('<books><book>PHP 入門</book><book>XML 入門</book></books>');

$iterator = $xml->children();
while ($iterator->valid()) {
  echo $iterator->key . ": " . $iterator->current() . PHP_EOL;
  $iterator->next();
}

出力:

book: PHP 入門
book: XML 入門

SimpleXMLElement::key メソッドは、現在の要素の XML タグ名を取得するための便利なメソッドです。このメソッドを理解することで、SimpleXMLElement オブジェクトをより効果的に処理することができます。

SimpleXMLElement::key メソッドのサンプルコード

要素名の取得

$xml = new SimpleXMLElement('<book>PHP 入門</book>');

// 要素名の取得
$tagName = $xml->key;

echo "要素名: " . $tagName . PHP_EOL; // 出力: 要素名: book

要素の種類に基づいて処理を行う

$xml = new SimpleXMLElement('<books><book>PHP 入門</book><chapter>オブジェクト指向</chapter></books>');

foreach ($xml->children() as $element) {
  switch ($element->key) {
    case 'book':
      echo "書籍: " . $element . PHP_EOL;
      break;
    case 'chapter':
      echo "章: " . $element . PHP_EOL;
      break;
    default:
      echo "不明な要素: " . $element->key . PHP_EOL;
  }
}

書籍: PHP 入門
章: オブジェクト指向

名前空間付き要素の処理

$xml = new SimpleXMLElement('<?xml version="1.0" encoding="UTF-8"?>
<ns:books xmlns:ns="http://example.com/books">
  <ns:book>PHP 入門</ns:book>
  <ns:chapter>オブジェクト指向</ns:chapter>
</ns:books>');

$namespaces = $xml->getNamespaces(true);

foreach ($xml->children() as $element) {
  // 名前空間プレフィックス付きの要素名を取得
  $prefixedTagName = $namespaces['ns'] . ':' . $element->key;

  echo "要素名: " . $prefixedTagName . PHP_EOL;
}

出力:

要素名: ns:book
要素名: ns:chapter

属性の取得

$xml = new SimpleXMLElement('<book title="PHP 入門" author="John Doe">入門書</book>');

// 属性値の取得
$title = $xml['title'];
$author = $xml['author'];

echo "タイトル: " . $title . PHP_EOL;
echo "著者: " . $author . PHP_EOL;

出力:

タイトル: PHP 入門
著者: John Doe

子要素の取得

$xml = new SimpleXMLElement('<book>
  <title>PHP 入門</title>
  <author>John Doe</author>
  <chapter>
    <title>オブジェクト指向</title>
  </chapter>
</book>');

// 子要素の取得
$title = $xml->title;
$author = $xml->author;
$chapter = $xml->chapter;

echo "タイトル: " . $title . PHP_EOL;
echo "著者: " . $author . PHP_EOL;

// 子要素の再帰処理
foreach ($chapter->children() as $element) {
  echo "章タイトル: " . $element->title . PHP_EOL;
}

出力:

タイトル: PHP 入門
著者: John Doe
章タイトル: オブジェクト指向

XPath 式による要素の検索

$xml = new SimpleXMLElement('<book>
  <title>PHP 入門</title>
  <author>John Doe</author>
  <chapter>
    <title>オブジェクト指向</title>
  </chapter>
</book>');

// XPath 式による要素の検索
$author = $xml->xpath('//author')[0];

echo "著者: " . $author . PHP_EOL;

出力:

著者: John Doe

SimpleXMLElement::key メソッドは、さまざまな方法で使用できます。これらのサンプルコードを参考に、ご自身の目的に合わせて活用してください。

SimpleXMLElement::key メソッドの代替方法

tagName プロパティ

SimpleXMLElement オブジェクトには、tagName プロパティという、現在の要素の XML タグ名を取得するためのプロパティがあります。

$xml = new SimpleXMLElement('<book>PHP 入門</book>');

// 要素名の取得
$tagName = $xml->tagName;

echo "要素名: " . $tagName . PHP_EOL; // 出力: 要素名: book

getName() メソッド

SimpleXMLElement オブジェクトには、getName() メソッドという、現在の要素の XML タグ名を取得するためのメソッドがあります。

$xml = new SimpleXMLElement('<book>PHP 入門</book>');

// 要素名の取得
$tagName = $xml->getName();

echo "要素名: " . $tagName . PHP_EOL; // 出力: 要素名: book

文字列比較

現在の要素の XML タグ名を直接文字列と比較することもできます。

$xml = new SimpleXMLElement('<book>PHP 入門</book>');

// 要素名の比較
if ($xml->getName() === 'book') {
  echo "要素名は 'book' です。" . PHP_EOL;
}

出力:

要素名は 'book' です。

SimpleXMLElement::key メソッド以外にも、さまざまな方法で現在の要素の XML タグ名を取得することができます。ご自身の目的に合わせて、最適な方法を選択してください。