第2回 「SimpleXML」と「JSON」で共通データ形式を便利に

亀本 大地
アシアル株式会社

2008/6/19

PHP4のサポートが終了し、これまでPHP4が中心だった開発現場でも、いよいよPHP5への移行を視野に入れる時期が来た。PHP5ならではの機能を生かした開発を進めるためのポイントを紹介する(編集部)
- PR -

 第1回「例外処理の実装を把握する」では、「try〜catch」ブロック「Exception」オブジェクトを利用した例外処理を解説した。今回からは、PHP5から実装された機能やモジュールの中から、特に便利なモジュールをピックアップして紹介していきたい。まずは比較的メジャーで使いどころも多い「SimpleXML」「JSON」「PDO」といったモジュールを紹介する。

関連記事:
リンク ベータリリース目前!? PHP5の新機能
http://www.atmarkit.co.jp/fcoding/articles/php5/01/php501a.html
リンク PHP5の新機能とPHP4との互換性
http://www.atmarkit.co.jp/fcoding/articles/php5/02/php502a.html

手軽にXMLを扱えるようにしたSimpleXML

 共通データ形式にはさまざまなものがあるが、最も一般的なデータ形式といえば、やはりXMLだろう。XMLは多くのWebサービスにおいてデータ交換に用いられており、WebAPIを利用するときには、その運用は必須ともいえる。

 これまで、PHP4でもSAXDOM_XMLモジュール(※注:PHP5ではDOMモジュールとして実装し直された)を利用することで、XMLを扱うことはできた。DOM_XMLモジュールはオブジェクト指向的な操作が可能で、XMLを深く使い込んで運用するには十分な機能を備えていた。

 だが、実際にはWebアプリケーションでXMLが用いられる場合、単なるデータの受け渡しだけであることが多い。中には、パースさえ容易にできればそれで十分ということも多い。簡単に使いたいからXMLを利用しているのに、DOM_XMLモジュールでは逆に面倒な処理を行わなければならなかった。

 そこで、より単純にXMLを使いたいという要望に応える形で実装されたのが「SimpleXML」モジュールである。

 このモジュールを使うと、XMLのツリーを、タグをプロパティ名としたシンプルなPHPのオブジェクト(SimpleXMLElementオブジェクト)にマッピングできる。XMLの整形式に準拠したAPIになっているわけではないので、XMLの生成や細やかな操作に向いているわけではないが、データをパースして扱う場合には簡素なコードで扱うことができるため、とても便利だ。

 SimpleXMLモジュールは、PHP5では標準で利用できるようになっている。

 まず、例として以下のようなXMLデータが保存されたファイルsample.xmlを考えよう。

<?xml version='1.0' encoding='utf-8' ?>
<document>
 <title>PHPで広がる!開発環境</title>
 <author>亀本大地</author>
 <body>PHP4の終了に備え、PHP5による開発のポイントを解説する。</body>
</document>
XMLデータを保存したサンプルファイル「sample.xml」

 これを、題名・著者・本文という項目ごとに整形する場合にも、SimpleXMLモジュールを使えば、以下のようにsimplexml_load_file関数1つでパースすることができる。また、渡されるオブジェクトも、タグがプロパティ名になった素直な形になっており、ループでも容易に扱える。

<?php
$filename = "sample.xml";

$obj = simplexml_load_file($filename);

foreach ($obj as $key => $value) {
  switch($key) {
    case 'title':
      echo '題名:' . $value . PHP_EOL;
      break;
    case 'author':
      echo '著者:' . $value . PHP_EOL;
      break;
    case 'body':
      echo '本文:' . $value . PHP_EOL;
      break;
    default:
      break;
  }
}

題名:PHPで広がる!開発環境
著者:亀本大地
本文:PHP4の終了に備え、PHP5による開発のポイントを解説する。
結果

 このようにSimpleXMLモジュールを用いることによって、RSSの処理などを非常に簡単に行えるようになる。

 また、SimpleXMLは「データを簡単に扱う」という点に重点が置かれているため、ツリーの柔軟な操作は苦手だ。だが、単純な追加操作であれば手軽に行うことができる。

<?php

$obj = simplexml_load_file('sample.xml');

$obj->description = 'PHP5に備える';
$obj->toc->first = '例外処理';
$obj->toc->second = 'SimpleXML/PDO';

echo
$obj->asXml();

<?xml version="1.0" encoding="utf-8"?>
<document>
<title>PHPで広がる!開発環境</title>
<author>亀本大地</author>
<body>PHP4の終了に備え、PHP5による開発のポイントを解説する。</body>
<description>PHP5に備える</description><toc><first>例外処理</first><second>SimpleXML/PDO</second></toc></document>
結果

 整形されていないため若干見づらいが、きちんとXMLのノードが追加されているのが分かる。

 また、名前空間の指定や属性の追加などを行いたい場合には、addChile()やaddAttrbute()といったメソッドを利用することもできる。そのため、必要最低限の追加操作はSimpleXMLで事足りてしまうことも多いだろう。

 ただし、いくつか注意点もある。

 SimpleXMLでは、読み込んだXMLの内容はSimpleXMLElementという専用のオブジェクトにマッピングされる。このオブジェクトは、自分と同じ階層のXML要素については、属性値も「@attribute」というキーとして保持する。

 しかし子要素については、表面的にはプロパティとして要素名が表れるだけで、属性が見えなくなってしまう。このため、受け取るXMLの構造が未知の場合、属性値のチェック漏れが出てしまう可能性があるので、注意が必要だ。これを正しく扱うためには、きちんと1階層ずつ見ていく必要がある。

<?php
$obj = simplexml_load_file('sample.xml');

var_dump($obj);// これでは子要素の属性が見えない

foreach($obj as $value) {
  var_dump($value);
}

object(SimpleXMLElement)#1 (3) {
  ["title"]=>
  string(32) "PHPで広がる"!'開発環境"
  ["author"]=>
  string(12) "亀本大地"
  ["body"]=>
  string(77) "PHP4の終了に備え、PHP5による開発のポイントを解説する。"
}
object(SimpleXMLElement)#3 (1) {
  [0]=>
  string(32) "PHPで広がる"!'開発環境"
}
object(SimpleXMLElement)#4 (1) {
  [0]=>
  string(12) "亀本大地"
}
object(SimpleXMLElement)#3 (2) {
  ["@attributes"]=>
  array(1) {
    ["id"]=>
    string(4) "main"
  }
  [0]=>
  string(77) "PHP4の終了に備え、PHP5による開発のポイントを解説する。"
}
結果

 また、最初のXML宣言が不適切なものであったりすると、asXml()メソッド(SimpleXMLElementオブジェクトをXMLの文字列として出力するメソッド)を利用するとき、マルチバイト文字列が数値実体参照になってしまう。

 適切にXML宣言のencodingまで記述している場合には実体参照にはならないが、encodingの記述をしていなかったり、XML宣言自体を書かずに自動生成に任せるようなことをしてしまったりすると、思わぬところで文字が化けてしまう。

 XML宣言はSimpleXMLの関数群で操作することはできない。従ってこの問題に対処するには、オブジェクトとしてパースする前に文字列として付け加えておくしかない。特に、HTMLなどを解析・再構成する場合などにSimpleXMLを使おうとするとハマりがちな部分なので、気を付けよう。

<?php

// XML宣言をencoding付きで与えておく
$obj = new SimpleXMLElement('<?xml version="1.0" encoding="utf-8" ?><document></document>');

$obj->title = 'PHPで広がる!開発環境';
$obj->author = '亀本大地';
$obj->body = 'PHP4の終了に備え、PHP5による開発のポイントを解説する。';
$obj->body->addAttribute('id', 'main');

echo $obj->asXml();

関連リンク:
リンク PHPマニュアル SimpleXML
http://jp.php.net/manual/ja/book.simplexml.php

 
1/2

Index
「SimpleXML」と「JSON」で共通データ形式を便利に
Page1
手軽にXMLを扱えるようにしたSimpleXML
  Page2
JavaScriptでの運用が容易なJSON
ネイティブのデータベース抽象化レイヤ「PDO」

PHP5で広がる! 開発環境

 PHP関連記事
例外処理の実装を把握する
PHP5で広がる! 開発環境(1)
 PHP4のサポートが終了し、いよいよPHP5への移行を視野に入れる時期が来た。PHP5の機能を生かした開発のポイントを紹介
クライアントPCに言語環境を入れる理由
Mac OS X+PHPでオールインワン環境(準備編)
 Webアプリ開発者に人気のMac OS X。効率的な開発のために複数バージョンのPHPを実行する環境を構築してみよう
PHPに押し寄せるリスクと国際化の波
PHPカンファレンス2008レポート(前編)
 PHP4のサポートが完全に終了する。多くの新機能が投入されるPHP5.3へ移行か、国際化対応で開発が遅れるPHP6を待つか
PHPによる大規模商用サービスの裏側
PHPカンファレンス2008レポート(中編)
 企業のWebアプリケーション開発現場で利用されるPHP。開発現場の裏側にはさまざまなドラマが隠されている
PHPユーザーは本当にほかの言語を知らないのか?
PHPカンファレンス2008レポート(後編)
 PHPは本当にダメな言語なのだろうか。Perl、Ruby、Python、Java、JavaScriptの使い手が白熱した議論を行った
  Coding Edgeフォーラムフィード  2.01.00.91

@IT Special

- PR -

TechTargetジャパン


Coding Edge フォーラム 新着記事
@ITメールマガジン 新着情報やスタッフのコラムがメールで届きます(無料)

イベントカレンダー

PickUpイベント

- PR -

アクセスランキング

もっと見る

ホワイトペーパーTechTargetジャパン

注目のテーマ

Coding Edge 記事ランキング

本日 月間
ソリューションFLASH