XML形式の値を配列形式に変換・PHPでは simplexml_load_string()

2017/05/14

XML形式の値を PHPで配列に変換する処理

XMLとは？

　
XMLとは、「Extensible Markup Language」の略で、JSONと同じくテキストベースのデータフォーマットです。
JISによる訳語は「拡張可能なマーク付け言語」で、任意の用途向けの言語に拡張することを容易にしたマークアップ言語の総称になります。
　
見た目は HTMLに似ていますが、XMLでは各項目ごとにデータの情報を持っていますので、プログラムでデータベースのように容易に扱うことができるようになっています。
　
　
Webサービスでの利用方法では、他サービスから APIを利用してデータを取得する場合のデータの受け取り方法として、JSON形式や XML形式でデータを受け渡しする場合が多々あります。
　
JSONに関しては「JSON形式の値を配列形式に変換・PHPでは json_decode()、json_encode()」の記事を参照してください。
　
　
今回の記事では、XML形式のデータを配列形式に変換するツール「XMLを配列に変換するツール」の紹介と、ツールの処理に関する解説を行います。
　
　

XML形式のデータのサンプル

　
この記事を書いていた時とほぼ同じタイミングで公開したツールに以下の 2つがあります。
　2点間の直線距離計算ツール（地点1の緯度に基づき簡易計算）
　
　路線・駅検索＋駅からの距離検索
　
それぞれのツールに関する解説は以下の記事を参照してください。
路線・駅検索のために緯度経度からPHPで2点間の距離を計算する処理解説
 路線・駅検索をPHPで実装する方法解説。GoogleMapsの緯度経度から計算し検索
　
　
このツールを作成する際に利用した「路線・駅」のデータ、および、APIは「駅データ.jp」を利用させていただいています。
「駅データ.jp」の APIを利用した場合、路線や駅の情報は、JSON形式か、XML形式かのいずれかで取得することができます。
　
その「駅データ.jp」の「路線API」から「りんかい線」の路線情報を取得した XMLの値が下記の様になります。
　

<?xml version="1.0" encoding="UTF-8"?>
<ekidata version="ekidata.jp line api 1.0">
	<line>
		<line_cd>99337</line_cd>
		<line_name>りんかい線</line_name>
		<line_lon>139.7661296428223</line_lon>
		<line_lat>35.62373301157322</line_lat>
		<line_zoom>13</line_zoom>
	</line>
	<station>
		<station_cd>9933701</station_cd>
		<station_g_cd>1132605</station_g_cd>
		<station_name>新木場</station_name>
		<lon>139.827402</lon>
		<lat>35.646172</lat>
	</station>
	<station>
		<station_cd>9933702</station_cd>
		<station_g_cd>9933702</station_g_cd>
		<station_name>東雲</station_name>
		<lon>139.804395</lon>
		<lat>35.640987</lat>
	</station>
	<station>
		<station_cd>9933703</station_cd>
		<station_g_cd>9933703</station_g_cd>
		<station_name>国際展示場</station_name>
		<lon>139.791617</lon>
		<lat>35.63441</lat>
	</station>
	<station>
		<station_cd>9933704</station_cd>
		<station_g_cd>9933704</station_g_cd>
		<station_name>東京テレポート</station_name>
		<lon>139.778896</lon>
		<lat>35.62753</lat>
	</station>
	<station>
		<station_cd>9933705</station_cd>
		<station_g_cd>9933602</station_g_cd>
		<station_name>天王洲アイル</station_name>
		<lon>139.750793</lon>
		<lat>35.620562</lat>
	</station>
	<station>
		<station_cd>9933706</station_cd>
		<station_g_cd>9933706</station_g_cd>
		<station_name>品川シーサイド</station_name>
		<lon>139.749549</lon>
		<lat>35.608524</lat>
	</station>
	<station>
		<station_cd>9933707</station_cd>
		<station_g_cd>1133228</station_g_cd>
		<station_name>大井町</station_name>
		<lon>139.735025</lon>
		<lat>35.607535</lat>
	</station>
	<station>
		<station_cd>9933708</station_cd>
		<station_g_cd>1130201</station_g_cd>
		<station_name>大崎</station_name>
		<lon>139.728439</lon>
		<lat>35.619772</lat>
	</station>
</ekidata>

<?xml version="1.0" encoding="UTF-8"?>

<line>

<line_cd>99337</line_cd>

<line_name>りんかい線</line_name>

<line_lon>139.7661296428223</line_lon>

<line_lat>35.62373301157322</line_lat>

<line_zoom>13</line_zoom>

</line>

<station_cd>9933701</station_cd>

<station_g_cd>1132605</station_g_cd>

<station_name>新木場</station_name>

</station>

<station_cd>9933702</station_cd>

<station_g_cd>9933702</station_g_cd>

<station_name>東雲</station_name>

</station>

<station_cd>9933703</station_cd>

<station_g_cd>9933703</station_g_cd>

<station_name>国際展示場</station_name>

</station>

<station_cd>9933704</station_cd>

<station_g_cd>9933704</station_g_cd>

<station_name>東京テレポート</station_name>

</station>

<station_cd>9933705</station_cd>

<station_g_cd>9933602</station_g_cd>

<station_name>天王洲アイル</station_name>

</station>

<station_cd>9933706</station_cd>

<station_g_cd>9933706</station_g_cd>

<station_name>品川シーサイド</station_name>

</station>

<station_cd>9933707</station_cd>

<station_g_cd>1133228</station_g_cd>

<station_name>大井町</station_name>

</station>

<station_cd>9933708</station_cd>

<station_g_cd>1130201</station_g_cd>

<station_name>大崎</station_name>

</station>

</ekidata>

　
下記サイトから取得。
http://www.ekidata.jp/api/api_line.php
　
上記の情報が XML形式のデータなのですが、APIに対して「『りんかい線』の路線情報をください」という指示を出すと返ってくるデータです。
　
APIを利用する側のプログラムは、今回私が使用した PHPをはじめとして、Perl（CGI）、Python、Rubyなど様々です。
そのとき、何か特定の言語に依存する形で情報が戻ってくると、受け取る側のプログラムも限定してしまう可能性が出てきます。
　
そのため、どういう言語であっても支障なく情報のやりとりができるようにしたものが、テキストベースのデータフォーマットであり、その一つの形式が XMLということになります。
　
XMLは、HTMLのように、値が項目名が指定されたタグで囲まれる形式になっています。
これが XML形式のデータです。
　
これを受け取った後、PHPなら PHPで、そのプログラムで扱いやすいような配列などの形式に変換して使用するわけです。
　
　
「XMLってなに？」っていう事を検索してみてもイマイチなんだかよく分からない説明のサイトしかないのは、具体的な説明なしに理解することが難しいからでしょう。
　
　

「XMLを配列に変換するツール」とは？

　
「XMLを配列に変換するツール」は、入力された XML形式のデータを配列形式に変換するツールです。
　
この記事は、この「XMLを配列に変換するツール」を紹介する記事なのですが、「XMLを配列に変換するツール」は、XML形式のデータを配列形式に変換するだけの機能しかなく、非常に単純なツールです。
　
そもそもは、「JSON形式の値を配列形式に変換・PHPでは json_decode()、json_encode()」に書いていますが、「JSONの値のデコードツール」を作成したのですが、XMLの変換ツールもあればそのうち使うんじゃないか、と思い作ったものです。
まぁ、「JSONの値のデコードツール」の JSONの変換処理を XML変換処理に変えただけのツールですが．．．
　
　

simplexml_load_string()で XML形式を配列に変換

　
XMLを配列に変換するには、一度 XMLをオブジェクトに変換し、そのあと配列に変換する、という 2段階の手順を採ります。
　
　

simplexml_load_string ( $xml_data )

1	simplexml_load_string ( $xml_data )

　
第一引数に、XML形式の値を編集します。
基本的にはこれだけでOKです。
　
第二引数以下はマニュアルを参照してください。
　http://php.net/manual/ja/function.simplexml-load-string.php
　
　
「simplexml_load_string()」関数を実行して取得できる値は、Object形式の値になります。
Object形式で表示する（処理する）ことで問題なければ、「simplexml_load_string()」関数を実行して取得した値をそのまま「print_r()」関数で表示すれば OKです。
　
ですが、ここでは配列にすることを目的としていますので、「simplexml_load_string()」関数で取得した Object形式のデータを、「json_encode()」関数で JSON形式に変換し、「json_decode()」関数で配列に変換する、という手順を採ります。
　

$object_data = simplexml_load_string ( $xml_data );
$json_data   = json_encode ( $object_data );
$array_data  = json_decode ( $json_data, true );

$object_data = simplexml_load_string ( $xml_data );

$json_data = json_encode ( $object_data );

$array_data = json_decode ( $json_data, true );

　
　
「json_encode()」関数、「json_decode()」関数の詳細については「」の記事を参照してもらえれば、と思いますが、「json_decode()」関数は、第二引数に「true」を指定することで配列として取得することが可能になります。
　
そのために、オブジェクトを一度 JSON形式にエンコードし、改めて配列にデコードしなおすという手順を採っています。
これは、PHPには、オブジェクトを配列に変換する関数が存在しないためです。
　

- PHP・Smarty・ECCUBE

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: ECCUBEの新規追加ページがInternal Server Error・Not Foundに

ECCUBEで新規追加したページがInternal Server Errorに！原因はファイルのパーミッションの場合が多くその対処方法とプログラムの修正ポイントを解説。Not Foundも解説。

: ファイル変更だけ！ECCUBEの本番から開発環境をコピーする手順を解説

ECCUBEを本番から開発環境をコピーする際の手順を解説。PGMメンテに必要な開発環境を構築する手順を解説。ECCUBEの仕組みは簡単なので作業は5分ほど。

: ECCUBE2.13.3で商品規格の在庫数が無制限から変更できないバグがある

2.13.3固有のバグである商品規格の在庫数の入力エリアがアクティブにならない不具合を解消する解説です。product_class.tplの2行を修正するだけの簡単対応です。

: ECCUBE mtb_constants initパラメータ設定の項目を追加する方法

ECCUBEのパラメータ設定で設定できる項目を追加する方法を説明します。

: Smartyの修飾子regex_replaceで正規表現の後方参照・PHPではpreg_replace

ECCUBEで使われているSmartyで文字列を正規表現で置換し後方参照で値を利用する装飾子regex_replaceの解説です。細かな条件がありますので注意が必要です。

: 指定した数で文字列を丸める（n文字目で…にする）関数substr、mb_substr、mb_strimwidthの違い

文字列を指定された数で抜き出すPHPの関数、substr、mb_substr、mb_strimwidthについての解説。似た関数だが引数の指定方法が違ったり、文字数がバイト数か文字数かも違ったり、注意が必要だ。