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

Copy
1<?php
2
3/**
4 * DOMDocumentFragment の attributes プロパティとアノテーションの比較を示すサンプル.
5 * DOMDocumentFragment はノードの断片を表し、attributes プロパティは属性のリストを返します。
6 * 一方、アノテーションはメタデータをコード自体に埋め込む方法であり、リフレクションを使ってアクセスします。
7 */
8
9// DOMDocumentFragment の属性の例
10$dom = new DOMDocument();
11$fragment = $dom->createDocumentFragment();
12$element = $dom->createElement('div');
13$element->setAttribute('class', 'container');
14$fragment->appendChild($element);
15
16$attributes = $fragment->firstChild->attributes;
17
18if ($attributes->length > 0) {
19    echo "DOMDocumentFragment attributes:\n";
20    foreach ($attributes as $attribute) {
21        echo $attribute->name . " = " . $attribute->value . "\n";
22    }
23} else {
24    echo "DOMDocumentFragment has no attributes.\n";
25}
26
27// アノテーション (PHP 8 Attributes) の例
28#[Attribute]
29class ExampleAttribute
30{
31    public function __construct(public string $value) {}
32}
33
34#[ExampleAttribute("example value")]
35class ExampleClass
36{
37    public function exampleMethod(): void
38    {
39        echo "Example method called.\n";
40    }
41}
42
43$reflectionClass = new ReflectionClass(ExampleClass::class);
44$attributes = $reflectionClass->getAttributes(ExampleAttribute::class);
45
46if (!empty($attributes)) {
47    echo "\nAnnotations:\n";
48    foreach ($attributes as $attribute) {
49        $instance = $attribute->newInstance();
50        echo "Attribute value: " . $instance->value . "\n";
51    }
52} else {
53    echo "\nNo annotations found.\n";
54}

このサンプルコードは、PHPにおけるDOMDocumentFragmentのattributesプロパティと、PHP 8で導入されたアノテーション（Attributes）の違いを示すものです。

まず、DOMDocumentFragmentは、XMLドキュメントの一部分（ノードの断片）を表すオブジェクトです。attributesプロパティは、その断片の最初の要素ノードが持つ属性のリストをDOMNamedNodeMapオブジェクトとして返します。サンプルコードでは、div要素にclass属性を設定し、attributesプロパティを使ってその属性名と値を取得しています。DOMNamedNodeMapは、属性を名前で参照できる連想配列のようなものです。

一方、アノテーションは、クラスやメソッドなどの宣言にメタデータ（付加情報）を埋め込むための仕組みです。サンプルコードでは、ExampleAttributeというアノテーションを定義し、ExampleClassに適用しています。アノテーションは、リフレクションAPIを使って実行時にアクセスできます。ReflectionClassオブジェクトのgetAttributes()メソッドを使うことで、指定したアノテーションが適用されているかどうか、またその値を調べることができます。

この例では、ExampleAttributeのアノテーションがExampleClassに付与されていることを確認し、アノテーションに設定されたvalueを表示しています。アノテーションは、設定ファイルやコメントに記述していた設定情報をコード内に直接記述できるため、可読性や保守性を向上させる効果が期待できます。