【PHP8.x】xml_set_object()関数の使い方

Copy
1<?php
2
3/**
4 * XMLパースのイベントを処理するハンドラクラス。
5 * xml_set_objectとxml_set_element_handlerを組み合わせて使用する方法を示します。
6 */
7class MyXmlHandler
8{
9    /**
10     * 要素の開始タグが検出されたときに呼び出されるメソッド。
11     *
12     * @param XMLParser $parser XMLパーサーオブジェクト
13     * @param string $name 要素名
14     * @param array $attrs 属性の連想配列
15     * @return void
16     */
17    public function startElement(XMLParser $parser, string $name, array $attrs): void
18    {
19        echo "要素開始: " . $name;
20        if (!empty($attrs)) {
21            echo " 属性: " . json_encode($attrs);
22        }
23        echo "\n";
24    }
25
26    /**
27     * 要素の終了タグが検出されたときに呼び出されるメソッド。
28     *
29     * @param XMLParser $parser XMLパーサーオブジェクト
30     * @param string $name 要素名
31     * @return void
32     */
33    public function endElement(XMLParser $parser, string $name): void
34    {
35        echo "要素終了: " . $name . "\n";
36    }
37
38    /**
39     * 文字データが検出されたときに呼び出されるメソッド。
40     *
41     * @param XMLParser $parser XMLパーサーオブジェクト
42     * @param string $data 文字データ
43     * @return void
44     */
45    public function characterData(XMLParser $parser, string $data): void
46    {
47        $trimmedData = trim($data);
48        if ($trimmedData !== '') {
49            echo "文字データ: " . $trimmedData . "\n";
50        }
51    }
52}
53
54// パースするXMLデータ
55$xmlData = <<<XML
56<?xml version="1.0" encoding="UTF-8"?>
57<root>
58    <item id="1">
59        <name>サンプルアイテムA</name>
60        <value>123</value>
61    </item>
62    <item id="2">
63        <name>サンプルアイテムB</name>
64        <value>456</value>
65    </item>
66    <emptyTag/>
67</root>
68XML;
69
70// 1. XMLパーサーを作成します (PHP 8ではXMLParserオブジェクトを返します)
71$parser = xml_parser_create();
72
73// パーサー作成の失敗チェック
74if ($parser === false) {
75    echo "XMLパーサーの作成に失敗しました。\n";
76    exit(1);
77}
78
79// 2. ハンドラクラスのインスタンスを作成します
80$handler = new MyXmlHandler();
81
82// 3. xml_set_object を使用して、パーサーとハンドラオブジェクトを関連付けます。
83//    これにより、後で設定するコールバック関数が、このオブジェクトのメソッドとして呼び出されるようになります。
84//    また、コールバックを文字列 ('メソッド名') で指定できるようになります。
85if (!xml_set_object($parser, $handler)) {
86    echo "xml_set_object の設定に失敗しました。\n";
87    xml_parser_free($parser); // エラー時はパーサーを解放
88    exit(1);
89}
90
91// 4. xml_set_element_handler を使用して、要素の開始・終了ハンドラを設定します。
92//    xml_set_object を使用したため、メソッド名を文字列で直接指定できます。
93if (!xml_set_element_handler($parser, 'startElement', 'endElement')) {
94    echo "xml_set_element_handler の設定に失敗しました。\n";
95    xml_parser_free($parser); // エラー時はパーサーを解放
96    exit(1);
97}
98
99// 5. xml_set_character_data_handler を使用して、文字データハンドラを設定します。
100//    同様に、メソッド名を文字列で直接指定できます。
101if (!xml_set_character_data_handler($parser, 'characterData')) {
102    echo "xml_set_character_data_handler の設定に失敗しました。\n";
103    xml_parser_free($parser); // エラー時はパーサーを解放
104    exit(1);
105}
106
107// 6. XMLデータをパースします
108// 第3引数にtrueを渡すと、パースが完了するとパーサーがリセットされ、再度パースできる状態になります。
109// (今回は一度に全てパース)
110if (!xml_parse($parser, $xmlData, true)) {
111    // パース中にエラーが発生した場合
112    $errorCode = xml_get_error_code($parser);
113    $errorString = xml_error_string($errorCode);
114    $line = xml_get_current_line_number($parser);
115    $col = xml_get_current_column_number($parser);
116    echo "XMLパースエラー: {$errorString} (コード: {$errorCode}) at line {$line}, column {$col}\n";
117}
118
119// 7. XMLパーサーを解放します
120xml_parser_free($parser);

PHP 8のxml_set_object関数は、XMLデータを解析する際に発生するイベント（要素の開始・終了、文字データなど）の処理を、オブジェクトのメソッドに委譲するために使用されます。

この関数は、xml_parser_create()で作成したXMLParserオブジェクトと、イベント処理メソッドを持つカスタムクラスのインスタンス（object）を引数に取ります。設定が成功するとtrueを、失敗するとfalseを返します。xml_set_objectを利用することで、xml_set_element_handlerやxml_set_character_data_handlerといった他のハンドラ設定関数で、コールバックとしてオブジェクトのメソッド名を文字列（例: 'startElement'）で直接指定できるようになります。これにより、XMLパースのイベント処理ロジックをオブジェクト指向的にクラス内に集約し、コードの可読性と保守性を高めることができます。

サンプルコードでは、MyXmlHandlerクラスがXML要素の開始、終了、文字データを処理する各メソッドを定義しています。最初にxml_parser_create()でパーサーを作成し、次にMyXmlHandlerのインスタンスを生成します。その後、xml_set_object()でこのパーサーとハンドラオブジェクトを関連付けます。この設定を行った上で、xml_set_element_handler()やxml_set_character_data_handler()を使って、MyXmlHandlerのメソッド名を指定し、イベントハンドラを設定します。最後にxml_parse()でXMLデータを解析すると、XML構造に対応してMyXmlHandlerの定義されたメソッドが自動的に呼び出され、パース処理が実行されます。

Copy
1<?php
2
3/**
4 * XMLデータをパースし、書籍情報をオブジェクトとして抽出するクラスです。
5 * XMLパーサーのイベントハンドラをオブジェクトメソッドとして登録するために
6 * xml_set_object 関数を使用しています。
7 * これは、XMLデータをPHPのデータ構造（この場合は書籍情報の配列）にデシリアライズする一例です。
8 */
9class BookXmlParser
10{
11    /** @var array 抽出されたすべての書籍情報を格納する配列 */
12    private array $books = [];
13    /** @var array 現在処理中の書籍情報を一時的に格納する配列 */
14    private array $currentBook = [];
15    /** @var string 現在処理中のXML要素のタグ名（例: 'title', 'author'） */
16    private string $currentTag = '';
17    /** @var bool 現在 <book> 要素の内側にいるかを示すフラグ */
18    private bool $inBook = false;
19
20    /**
21     * XMLパース中に検出されたすべての書籍情報を取得します。
22     *
23     * @return array 抽出された書籍情報の配列
24     */
25    public function getBooks(): array
26    {
27        return $this->books;
28    }
29
30    /**
31     * XML要素の開始タグが検出された際に呼び出されるハンドラです。
32     *
33     * @param XMLParser $parser XMLパーサーリソース
34     * @param string $name 要素名 (XMLからの元のケース)
35     * @param array $attrs 要素の属性 (キーは大文字で提供されます)
36     */
37    public function startElement(XMLParser $parser, string $name, array $attrs): void
38    {
39        // 要素名を小文字に統一して処理します。
40        $name = strtolower($name);
41
42        if ($name === 'book') {
43            $this->inBook = true;
44            // 新しい書籍の処理を開始し、属性からカテゴリを取得します。
45            $this->currentBook = [
46                'category' => $attrs['CATEGORY'] ?? null, // 属性キーは常に大文字で渡されます
47                'title' => '',
48                'author' => '',
49                'year' => '',
50                'price' => '',
51            ];
52        } elseif ($this->inBook) {
53            // <book> 要素の内側にある子要素のタグ名を記録します。
54            $this->currentTag = $name;
55        }
56    }
57
58    /**
59     * XML要素の終了タグが検出された際に呼び出されるハンドラです。
60     *
61     * @param XMLParser $parser XMLパーサーリソース
62     * @param string $name 要素名 (XMLからの元のケース)
63     */
64    public function endElement(XMLParser $parser, string $name): void
65    {
66        // 要素名を小文字に統一して処理します。
67        $name = strtolower($name);
68
69        if ($name === 'book' && $this->inBook) {
70            // 書籍要素の終了時、現在の書籍情報をリストに追加し、クリアします。
71            $this->books[] = $this->currentBook;
72            $this->currentBook = [];
73            $this->inBook = false;
74        } elseif ($this->inBook) {
75            // 子要素の終了時、現在のタグ情報をクリアします。
76            $this->currentTag = '';
77        }
78    }
79
80    /**
81     * 文字データが検出された際に呼び出されるハンドラです。
82     *
83     * @param XMLParser $parser XMLパーサーリソース
84     * @param string $data 検出された文字データ
85     */
86    public function characterData(XMLParser $parser, string $data): void
87    {
88        // 余分な空白を除去し、有効なデータであれば処理します。
89        $data = trim($data);
90        if ($this->inBook && $this->currentTag !== '' && $data !== '') {
91            // 現在のタグに対応する書籍情報フィールドにデータを追加します。
92            // 複数行にわたるテキストに対応するため、文字列を結合します。
93            $this->currentBook[$this->currentTag] .= $data;
94        }
95    }
96
97    /**
98     * 指定されたXML文字列をパースし、抽出された書籍情報の配列を返します。
99     *
100     * @param string $xmlString パースするXML文字列
101     * @return array 抽出された書籍情報の配列
102     * @throws Exception XMLパースエラーが発生した場合
103     */
104    public static function parse(string $xmlString): array
105    {
106        // 1. XMLパーサーを作成します。
107        $parser = xml_parser_create();
108
109        // XMLパーサーはデフォルトで要素名をケースセンシティブに扱います。
110        // 属性名は常に大文字で渡されます。
111
112        // 2. BookXmlParserのインスタンスを作成します。
113        $bookParser = new self();
114
115        // 3. xml_set_object を使用して、パーサーのコールバック関数がこの $bookParser インスタンスの
116        //    メソッドを呼び出すように設定します。
117        //    これにより、xml_set_element_handler などでメソッド名を文字列 ('startElement' など) で指定した場合でも、
118        //    自動的にこのオブジェクトの該当メソッドが呼び出されます。
119        xml_set_object($parser, $bookParser);
120
121        // 4. XML要素の開始/終了ハンドラを設定します。
122        //    xml_set_object が設定されているため、'startElement' や 'endElement' は
123        //    $bookParser インスタンスのメソッドとして自動的に解決されます。
124        xml_set_element_handler($parser, 'startElement', 'endElement');
125
126        // 5. 文字データハンドラを設定します。
127        xml_set_character_data_handler($parser, 'characterData');
128
129        // 6. XML文字列をパースします。
130        //    第3引数に true を指定することで、これが最後のデータであることをパーサーに伝えます。
131        if (!xml_parse($parser, $xmlString, true)) {
132            $errorCode = xml_get_error_code($parser);
133            $errorString = xml_error_string($errorCode);
134            $line = xml_get_current_line_number($parser);
135            throw new Exception("XML Parse Error: {$errorString} at line {$line}");
136        }
137
138        // 7. パーサーリソースを解放します。
139        xml_parser_free($parser);
140
141        // 8. 抽出した書籍情報を返します。
142        return $bookParser->getBooks();
143    }
144}
145
146// === サンプルコードの実行 ===
147
148// パースするXMLデータ
149$xmlData = <<<XML
150<?xml version="1.0" encoding="UTF-8"?>
151<bookstore>
152    <book category="cooking">
153        <title lang="en">Everyday Italian</title>
154        <author>Giada De Laurentiis</author>
155        <year>2005</year>
156        <price>30.00</price>
157    </book>
158    <book category="children">
159        <title lang="en">Harry Potter</title>
160        <author>J.K. Rowling</author>
161        <year>1997</year>
162        <price>29.99</price>
163    </book>
164    <book category="web">
165        <title lang="en">Learning XML</title>
166        <author>Erik T. Ray</author>
167        <year>2003</year>
168        <price>39.95</price>
169    </book>
170</bookstore>
171XML;
172
173// BookXmlParserクラスを使ってXMLをパースし、書籍情報を取得します。
174try {
175    $books = BookXmlParser::parse($xmlData);
176
177    // 抽出された書籍情報をコンソールに表示します。
178    echo "--- Parsed Books ---\n";
179    foreach ($books as $index => $book) {
180        echo "Book " . ($index + 1) . ":\n";
181        echo "  Category: " . ($book['category'] ?? 'N/A') . "\n";
182        echo "  Title:    " . $book['title'] . "\n";
183        echo "  Author:   " . $book['author'] . "\n";
184        echo "  Year:     " . $book['year'] . "\n";
185        echo "  Price:    " . $book['price'] . "\n";
186        echo "\n";
187    }
188} catch (Exception $e) {
189    // パース中にエラーが発生した場合、エラーメッセージを表示します。
190    echo "Error: " . $e->getMessage() . "\n";
191}
192
193?>

PHPの xml_set_object 関数は、XMLデータを解析する「XMLパーサー」がイベント（タグの開始、終了、文字データなど）を検出した際に、どのPHPオブジェクトのメソッドを呼び出すかを設定するために利用されます。

第一引数 XMLParser $parser には、操作対象となるXMLパーサーリソースを指定します。これは xml_parser_create() 関数などで作成されたものです。 第二引数 object $object には、XMLイベントのハンドラメソッド（例: 開始タグを処理するメソッド、文字データを処理するメソッド）を定義しているクラスのインスタンスを指定します。この関数を使うことで、開発者はオブジェクト指向的なアプローチでXMLの解析処理を記述できるようになります。 戻り値は bool 型で、オブジェクトの設定が成功した場合は true、失敗した場合は false を返します。

サンプルコードでは、BookXmlParser クラスのインスタンスを xml_set_object に渡しています。これにより、XMLパーサーはタグの開始時に startElement メソッド、文字データ検出時に characterData メソッドといった形で、この BookXmlParser インスタンスのメソッドを自動的に呼び出します。この仕組みを使って、XML形式の書籍データを読み込み、それをPHPの扱いやすい配列形式（オブジェクトデシリアライズの一種）に変換しています。これにより、XML処理の状態管理をオブジェクト内部で行うことができ、コードの見通しが良くなります。