【PHP8.x】attributesプロパティの使い方

Copy
1<?php
2
3/**
4 * XML文字列を解析し、最初の要素が持つ属性を一覧表示します。
5 * DOMDocumentの要素からattributesプロパティを使って属性情報を取得する方法を示します。
6 */
7function displayElementAttributes(): void
8{
9    // サンプルとして使用するXML文字列
10    $xmlString = <<<XML
11    <?xml version="1.0" encoding="UTF-8"?>
12    <book id="bk101" language="en" available="true">
13        <title>PHP Beginner's Guide</title>
14        <author>Jane Doe</author>
15    </book>
16    XML;
17
18    // 1. DOMDocumentオブジェクトをインスタンス化します
19    $dom = new DOMDocument();
20
21    // 2. XML文字列を読み込みます
22    $dom->loadXML($xmlString);
23
24    // 3. 'book'という名前のタグを持つ最初の要素を取得します
25    $bookElement = $dom->getElementsByTagName('book')->item(0);
26
27    // 4. 要素が取得できたか確認します
28    if ($bookElement) {
29        // 5. 'attributes'プロパティにアクセスします。
30        // これにより、要素のすべての属性を含むDOMNamedNodeMapオブジェクトが返されます。
31        $attributes = $bookElement->attributes;
32
33        // 6. 属性が存在するかどうかを確認します
34        if ($attributes->length > 0) {
35            echo "要素 <{$bookElement->tagName}> の属性一覧:\n";
36
37            // 7. DOMNamedNodeMapをforeachでループ処理し、各属性の名前と値を出力します
38            foreach ($attributes as $attribute) {
39                // DOMAttrオブジェクトのプロパティを使って名前と値を取得
40                $name = $attribute->nodeName;
41                $value = $attribute->nodeValue;
42                echo " - {$name}: {$value}\n";
43            }
44        } else {
45            echo "この要素には属性がありません。\n";
46        }
47    } else {
48        echo "指定された要素が見つかりませんでした。\n";
49    }
50}
51
52// 関数を実行して結果を表示します
53displayElementAttributes();
54
55?>

このPHPサンプルコードは、DOMDocumentクラスを使用してXML文字列を解析し、特定のXML要素が持つ属性の一覧を表示する方法を解説します。

まず、new DOMDocument()でオブジェクトを生成し、loadXML()メソッドでXMLデータを読み込みます。次にgetElementsByTagName()を使い、操作対象である<book>要素を取得します。

このコードの核心は、取得した要素オブジェクトのattributesプロパティにアクセスする部分です。このプロパティは引数を取らず、その要素が持つ全ての属性情報を格納したDOMNamedNodeMapオブジェクトを戻り値として返します。DOMNamedNodeMapは、属性の集まりを管理するための特別なオブジェクトです。

最後に、返されたDOMNamedNodeMapオブジェクトをforeach文で一つずつ処理します。ループの中で、個々の属性オブジェクトのnodeNameプロパティから属性名（例: "id"）を、nodeValueプロパティから属性値（例: "bk101"）を取得して出力しています。このようにattributesプロパティを利用することで、XML要素に定義された属性情報を簡単に取得し、操作することが可能になります。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * このサンプルコードは、2つの異なる「attribute」の概念を説明します。
7 * 1. PHP 8の言語機能である「アトリビュート (Attribute)」
8 * 2. DOMDocumentで扱うXML/HTML要素の「属性 (attribute)」
9 * これらは名前が似ていますが、全く異なるものです。
10 */
11final class AttributeConceptsDemo
12{
13    /**
14     * メインの処理を実行します。
15     */
16    public function run(): void
17    {
18        echo "--- 1. PHP 8の言語機能「アトリビュート」の例 ---" . PHP_EOL;
19        $this->demonstratePhpAttribute();
20
21        echo PHP_EOL;
22
23        echo "--- 2. DOMDocumentの「attributes」プロパティ (XML属性) の例 ---" . PHP_EOL;
24        $this->demonstrateDomAttribute();
25    }
26
27    /**
28     * PHP 8で導入された「アトリビュート」の使用例です。
29     * アトリビュートは、クラスやメソッド等にメタデータを付与するための構造化された構文です。
30     * ここではリフレクションAPIを使って、クラスに付与されたアトリビュートを読み取ります。
31     */
32    private function demonstratePhpAttribute(): void
33    {
34        // `MyEntity` クラスに付与されたアトリビュート情報を取得
35        $reflection = new ReflectionClass(MyEntity::class);
36        $attributes = $reflection->getAttributes(TableName::class);
37
38        if (count($attributes) > 0) {
39            // アトリビュートのインスタンスを生成し、引数の値を取得
40            $tableNameAttribute = $attributes[0]->newInstance();
41            echo "MyEntityクラスのTableNameアトリビュートの値: " . $tableNameAttribute->name . PHP_EOL;
42        }
43    }
44
45    /**
46     * DOMDocumentの「attributes」プロパティの使用例です。
47     * このプロパティは、XMLやHTMLの要素が持つ「属性」のコレクション（DOMNamedNodeMap）を返します。
48     * 例: <user id="123"> における id="123" の部分です。
49     */
50    private function demonstrateDomAttribute(): void
51    {
52        $xmlString = '<user id="123" status="active">Taro Yamada</user>';
53
54        $dom = new DOMDocument();
55        $dom->loadXML($xmlString);
56
57        // 最初の 'user' 要素ノードを取得
58        $userElement = $dom->getElementsByTagName('user')->item(0);
59
60        if ($userElement instanceof DOMElement) {
61            // DOMElementの `attributes` プロパティは、その要素の全属性を保持する
62            // DOMNamedNodeMapオブジェクトを返します。
63            $nodeAttributes = $userElement->attributes;
64
65            if ($nodeAttributes instanceof DOMNamedNodeMap) {
66                echo "XMLの<user>要素が持つ属性:" . PHP_EOL;
67                // DOMNamedNodeMapをループして各属性の名前と値を取得
68                foreach ($nodeAttributes as $attribute) {
69                    echo "  - {$attribute->name}: {$attribute->value}" . PHP_EOL;
70                }
71            }
72        }
73    }
74}
75
76// --- 以下はサンプルコードを動作させるための定義です ---
77
78/**
79 * PHP 8のアトリビュートクラスを定義します。
80 * このアトリビュートはクラスに対してのみ使用可能で、テーブル名を引数に取ります。
81 */
82#[Attribute(Attribute::TARGET_CLASS)]
83final class TableName
84{
85    public string $name;
86
87    public function __construct(string $name)
88    {
89        $this->name = $name;
90    }
91}
92
93/**
94 * 上で定義した`TableName`アトリビュートを使用して、メタデータを付与したクラスです。
95 */
96#[TableName('users')]
97class MyEntity
98{
99    // class implementation...
100}
101
102// サンプルコードの実行
103$demo = new AttributeConceptsDemo();
104$demo->run();

このPHPサンプルコードは、「attribute」という言葉が持つ2つの異なる概念を解説しています。

一つ目は、PHP 8で導入された言語機能である「アトリビュート」です。これは #[TableName('users')] のような構文を使い、クラスやメソッドなどに構造化されたメタデータを付与するための仕組みです。コード内では、リフレクションという機能を用いて MyEntity クラスに付与されたアトリビュートの情報をプログラム実行時に読み取り、その値を取得しています。

二つ目は、XMLやHTMLの要素が持つ「属性」を扱うための DOMDocument の attributes プロパティです。これは <user id="123"> のようなタグにおける id="123" の部分に相当します。DOMElement オブジェクトの attributes プロパティにアクセスすると、その要素が持つ全ての属性を格納した DOMNamedNodeMap オブジェクトが返されます。このプロパティに引数は不要です。DOMNamedNodeMap オブジェクトは、foreach でループ処理することで、各属性の名前と値を簡単に取り出すことができます。

このように、両者は名前が似ていますが、前者はコードに情報を埋め込むメタデータ機能、後者はXML/HTML要素の特性を定義するデータであり、全く異なるものであることを示しています。