PHP - SAXパーサーの例：初めてのガイド

こんにちは、未来のPHP魔术師さんたち！今日は、PHPのSAXパーサーの世界に楽しく飛び込んでいきます。SAXという言葉を聞いたことがない方も安心してください。このチュートリアルが終わるまでには、プロのようにXMLをパースできるようになるでしょう！

SAXパーサーとは？

コードに取りかかる前に、まずSAXパーサーとは何かについて話しましょう。SAXは「Simple API for XML」の略で、XMLドキュメントを読み込む方法の一つです。大きなファイルを扱う場合や、XMLを読み込む過程で処理したい場合に特に便利です。

本を読むことを想像してみてください。SAXパーサーは、本を一ページずつ読み、そのページを理解するのと同じで、全文を一度に覚えることなく読み進める感じです。すごいですね？

PHPでSAXを始める

PHPには、内蔵のXMLパーサーがあり、SAXパーサーを使いやすくしています。まずは簡単な例から始めましょう：

<?php
$parser = xml_parser_create();
xml_parse($parser, "<book><title>PHP for Beginners</title></book>");
xml_parser_free($parser);
?>

このコードでは、パーサーを作成し、簡単なXML文字列をパースしてから、パーサーを解放しています。しかし、まだあまり役に立たないですね。パーサーを便利にするためには、XMLの異なる部分に遭遇したときに何をすべきかを教える必要があります。ここでhandler関数が登場します！

XML要素Handler

xml_set_element_handler()関数を使うと、パーサーが要素の開始と終了に遭遇したときに何をすべきかを指定できます。実際に見てみましょう：

<?php
function start_element($parser, $element_name, $element_attrs) {
echo "Start Element: $element_name<br>";
}

function end_element($parser, $element_name) {
echo "End Element: $element_name<br>";
}

$parser = xml_parser_create();
xml_set_element_handler($parser, "start_element", "end_element");

$xml = "<book><title>PHP for Beginners</title><author>John Doe</author></book>";
xml_parse($parser, $xml);
xml_parser_free($parser);
?>

このスクリプトは以下のように出力します：

Start Element: BOOK
Start Element: TITLE
End Element: TITLE
Start Element: AUTHOR
End Element: AUTHOR
End Element: BOOK

ご覧の通り、start_element関数は開始タグに遭遇するたびに呼ばれ、end_elementは終了タグに遭遇するたびに呼ばれます。

字符データHandler

タグの間のテキストはどうなるのでしょうか？ここでxml_set_character_data_handler()が役立ちます：

<?php
function char_data($parser, $data) {
echo "Character Data: " . trim($data) . "<br>";
}

$parser = xml_parser_create();
xml_set_character_data_handler($parser, "char_data");

$xml = "<book><title>PHP for Beginners</title><author>John Doe</author></book>";
xml_parse($parser, $xml);
xml_parser_free($parser);
?>

これは以下のように出力します：

Character Data: PHP for Beginners
Character Data: John Doe

処理指示Handler

XMLドキュメントには、時々処理指示が含まれていることがあります。これらは、XMLを処理するアプリケーションに対する特別な指示です。これらを処理するにはxml_set_processing_instruction_handler()を使います：

<?php
function pi_handler($parser, $target, $data) {
echo "Processing Instruction - Target: $target, Data: $data<br>";
}

$parser = xml_parser_create();
xml_set_processing_instruction_handler($parser, "pi_handler");

$xml = "<?xml version='1.0'?><?php echo 'Hello, World!'; ?><root>Some content</root>";
xml_parse($parser, $xml);
xml_parser_free($parser);
?>

これは以下のように出力します：

Processing Instruction - Target: php, Data: echo 'Hello, World!'

デフォルトHandler

最後に、他のhandlerに捕まらないXMLデータを処理するにはxml_set_default_handler()を使います：

<?php
function default_handler($parser, $data) {
echo "Default Handler: " . htmlspecialchars($data) . "<br>";
}

$parser = xml_parser_create();
xml_set_default_handler($parser, "default_handler");

$xml = "<?xml version='1.0'?><root>Some content</root>";
xml_parse($parser, $xml);
xml_parser_free($parser);
?>

これは以下のように出力します：

Default Handler: <?xml version='1.0'?>
Default Handler: <root>Some content</root>

すべてを合わせる

これまでのhandlerを全部合わせた、より完全な例を見てみましょう：

<?php
function start_element($parser, $element_name, $element_attrs) {
echo "Start Element: $element_name<br>";
if (!empty($element_attrs)) {
echo "Attributes: ";
print_r($element_attrs);
echo "<br>";
}
}

function end_element($parser, $element_name) {
echo "End Element: $element_name<br>";
}

function char_data($parser, $data) {
if (trim($data) !== '') {
echo "Character Data: " . trim($data) . "<br>";
}
}

function pi_handler($parser, $target, $data) {
echo "Processing Instruction - Target: $target, Data: $data<br>";
}

function default_handler($parser, $data) {
$data = trim($data);
if (!empty($data)) {
echo "Default Handler: " . htmlspecialchars($data) . "<br>";
}
}

$parser = xml_parser_create();

xml_set_element_handler($parser, "start_element", "end_element");
xml_set_character_data_handler($parser, "char_data");
xml_set_processing_instruction_handler($parser, "pi_handler");
xml_set_default_handler($parser, "default_handler");

$xml = <<<XML
<?xml version='1.0'?>
<?php echo 'Hello, World!'; ?>
<library>
<book id="1">
<title>PHP for Beginners</title>
<author>John Doe</author>
</book>
<book id="2">
<title>Advanced PHP Techniques</title>
<author>Jane Smith</author>
</book>
</library>
XML;

xml_parse($parser, $xml);
xml_parser_free($parser);
?>

この包括的な例は、私たちが話してきたすべてのhandlerを使っています。実際に実行してみて、出力結果を確認してみてください！

結論

おめでとうございます！あなたは刚刚PHPでのSAXパーサーの世界への第一歩を踏み出しました。練習することが大事です。さまざまなXML構造を試してみて、あなたのパーサーがどのように処理するかを確認してください。

SAXパーサーは、大きなXMLドキュメントを扱う際に特に強力なツールであり、効率的にXMLを処理し、必要なタイミングでデータを取得できるため、特定の状況では非常に役立ちます。

codingを続け、学び続けてください。そして、一番大切なのは楽しむことです！間もなく、あなたは経験豊富なプロのようにXMLをパースできるようになるでしょう。次回まで、ハッピーコーディングを！

Credits: Image by storyset