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

Copy
1<?php
2
3// PHP 8で導入されたAttributes（属性）機能のサンプルコードです。
4// コードにメタデータを付与し、実行時にリフレクションAPIを通じてその情報を取得するために使用されます。
5// 提供されたリファレンス情報「名前: attributes」「引数: なし」「戻り値: 戻り値なし」は、
6// Attributesが特定のクラスのプロパティではなく、コードに付与されるメタデータであり、
7// それ自体の宣言や適用が直接的な引数や戻り値を持つ関数呼び出しではない、という文脈で解釈されます。
8
9// 1. Attribute（属性）クラスの定義
10// #[Attribute] を使うことで、このクラスが他のコードに適用可能な属性であることを示します。
11// #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_PROPERTY)] は、
12// この属性がクラスとプロパティの両方に適用できることを指定しています。
13#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_PROPERTY)]
14class MyCustomMetadata
15{
16    public string $description;
17    public int $version;
18
19    public function __construct(string $description, int $version = 1)
20    {
21        $this->description = $description;
22        $this->version = $version;
23    }
24}
25
26// 2. 定義したAttributeをコードに適用
27// MyService クラスとそのプロパティに MyCustomMetadata 属性を付与しています。
28#[MyCustomMetadata('このクラスは主要なビジネスロジックを提供します。', 2)]
29class MyService
30{
31    #[MyCustomMetadata('サービスの名前を表します。', 1)]
32    public string $serviceName;
33
34    public function __construct(string $name)
35    {
36        $this->serviceName = $name;
37    }
38
39    public function performTask(): void
40    {
41        echo "{$this->serviceName} がタスクを実行しました。\n";
42    }
43}
44
45/**
46 * PHP 8のAttributes機能の基本的な使い方をデモンストレーションします。
47 * クラスやプロパティに適用されたAttributesをリフレクションAPIで読み取ります。
48 */
49function demonstratePhpAttributes(): void
50{
51    echo "--- PHP 8 Attributes のデモンストレーション ---\n\n";
52
53    $serviceInstance = new MyService('データ処理サービス');
54    $serviceInstance->performTask();
55
56    echo "\n--- クラスとプロパティの属性情報を取得 ---\n";
57
58    // クラスのリフレクションオブジェクトを作成
59    $reflectionClass = new ReflectionClass($serviceInstance);
60
61    // クラスに適用されたMyCustomMetadata属性を取得
62    $classAttributes = $reflectionClass->getAttributes(MyCustomMetadata::class);
63
64    echo "\nクラス '{$reflectionClass->getName()}' の属性:\n";
65    foreach ($classAttributes as $attribute) {
66        // Attributeインスタンスを生成し、そのプロパティにアクセス
67        $metadata = $attribute->newInstance();
68        echo "- {$attribute->getName()}: 説明='{$metadata->description}', バージョン='{$metadata->version}'\n";
69    }
70
71    // プロパティのリフレクションオブジェクトを取得
72    $reflectionProperty = $reflectionClass->getProperty('serviceName');
73
74    // プロパティに適用されたMyCustomMetadata属性を取得
75    $propertyAttributes = $reflectionProperty->getAttributes(MyCustomMetadata::class);
76
77    echo "\nプロパティ '{$reflectionProperty->getName()}' の属性:\n";
78    foreach ($propertyAttributes as $attribute) {
79        $metadata = $attribute->newInstance();
80        echo "- {$attribute->getName()}: 説明='{$metadata->description}', バージョン='{$metadata->version}'\n";
81    }
82
83    echo "\n--- デモンストレーション終了 ---\n";
84}
85
86// デモンストレーション関数を実行します。
87demonstratePhpAttributes();

PHP 8で導入されたAttributes（属性）機能は、クラス、プロパティ、メソッドなどのコード要素にメタデータと呼ばれる付加情報を付与するための仕組みです。これにより、コードの意味や振る舞いを宣言的に記述し、実行時にリフレクションAPIを通じてその情報を取得できるようになります。プログラムの動的な挙動制御や、フレームワークによる自動処理、開発ツールの利用などに役立ちます。

このサンプルコードでは、MyCustomMetadataという独自の属性を定義しています。#[Attribute]という構文で、このクラスが属性として利用できることを宣言し、適用可能なターゲット（クラスやプロパティ）を指定しています。その後、MyServiceクラスやそのserviceNameプロパティに、定義したMyCustomMetadata属性を具体的な説明やバージョン情報とともに付与しています。

demonstratePhpAttributes関数では、ReflectionClassやReflectionPropertyといったリフレクションAPIを使用して、適用された属性情報を動的に読み出しています。getAttributes()メソッドで取得した属性から、newInstance()を使って元の属性クラスのインスタンスを生成し、そのdescriptionやversionといったデータを表示することで、属性情報がどのように利用されるかを示しています。

提示されたリファレンス情報にある「DOMAttr::attributes」は、HTMLやXML要素の属性の集合を指すDOMツリーのプロパティであり、直接的な引数や戻り値を持たずに属性ノードを扱います。一方、本サンプルコードで扱っている「Attributes」はPHP 8で導入された全く異なる言語機能で、コード自体にメタ情報を付与するものです。この属性機能自体は、特定の関数呼び出しのように引数や戻り値を直接持つものではなく、宣言されたメタデータとして扱われ、コードの記述をより豊かにし、拡張性を高めます。

Copy
1<?php
2
3/**
4 *  PHP 8 以降の attributes と annotations の比較サンプルコード
5 */
6
7// PHP 8 Attributes (リフレクションで使用)
8#[ExampleAttribute('Some value')]
9class MyClass {
10    #[ExampleAttribute('Another value')]
11    public $myProperty;
12
13    #[ExampleAttribute('Method value')]
14    public function myMethod() {
15        // 処理
16    }
17}
18
19// Attribute の定義
20#[Attribute(Attribute::TARGET_ALL)] // どこに適用できるかを指定
21class ExampleAttribute {
22    public string $value;
23
24    public function __construct(string $value) {
25        $this->value = $value;
26    }
27}
28
29
30// リフレクションを使って Attribute の情報を取得
31$reflectionClass = new ReflectionClass(MyClass::class);
32
33// クラスの Attribute を取得
34$attributes = $reflectionClass->getAttributes(ExampleAttribute::class);
35foreach ($attributes as $attribute) {
36    $instance = $attribute->newInstance();
37    echo "Class Attribute Value: " . $instance->value . PHP_EOL;
38}
39
40// プロパティの Attribute を取得
41$reflectionProperty = $reflectionClass->getProperty('myProperty');
42$attributes = $reflectionProperty->getAttributes(ExampleAttribute::class);
43foreach ($attributes as $attribute) {
44    $instance = $attribute->newInstance();
45    echo "Property Attribute Value: " . $instance->value . PHP_EOL;
46}
47
48
49// メソッドの Attribute を取得
50$reflectionMethod = $reflectionClass->getMethod('myMethod');
51$attributes = $reflectionMethod->getAttributes(ExampleAttribute::class);
52foreach ($attributes as $attribute) {
53    $instance = $attribute->newInstance();
54    echo "Method Attribute Value: " . $instance->value . PHP_EOL;
55}
56
57
58// PHP 7 以前の Annotations (DocBlock コメントで記述、ライブラリが必要)
59/**
60 * @AnnotationExample("Legacy value")
61 */
62class LegacyClass {
63    /**
64     * @AnnotationExample("Legacy property value")
65     */
66    public $legacyProperty;
67
68    /**
69     * @AnnotationExample("Legacy method value")
70     */
71    public function legacyMethod() {
72        // 処理
73    }
74}
75
76//  PHP 7以前のAnnotationsの例：
77//  Annotationsを使用するには、Doctrine Annotationsなどのライブラリが必要です。
78//  この例はDoctrine Annotationsを使用していることを前提としています。
79
80use Doctrine\Common\Annotations\AnnotationReader;
81
82$reader = new AnnotationReader();
83$legacyReflectionClass = new ReflectionClass(LegacyClass::class);
84
85// クラスの Annotation を取得
86$legacyClassAnnotation = $reader->getClassAnnotation($legacyReflectionClass, 'AnnotationExample');
87
88// Annotation は ExampleAttribute クラスのようなクラスとして定義されていません。
89// そのため、Reflection APIで簡単に扱うことができません。
90// ライブラリごとのAPIを使う必要があります。
91// この例では AnnotationExample アノテーションが存在すると仮定していますが、
92// 実際にはライブラリで定義されている必要があります。

このサンプルコードは、PHP 8で導入されたAttributes（属性）と、PHP 7以前で用いられていたAnnotations（注釈）の比較を示しています。

PHP 8のAttributesは、クラス、プロパティ、メソッドなどの宣言にメタデータを付加する機能です。#[ExampleAttribute('Some value')]のように記述し、リフレクションAPIを通じて実行時に情報を取得できます。#[Attribute(Attribute::TARGET_ALL)]は、この属性がどこに適用可能かを指定しています。ReflectionClass::getAttributes()メソッドを使用することで、指定した属性のインスタンスを取得し、その値を参照できます。

一方、PHP 7以前のAnnotationsは、DocBlockコメントに@AnnotationExample("Legacy value")のように記述します。Annotationsの利用には、Doctrine Annotationsなどのライブラリが必要です。リフレクションAPIだけでは直接扱うことが難しく、ライブラリ固有のAPIを使用する必要があります。

AttributesはPHP 8以降で標準機能として提供され、リフレクションAPIとの連携が容易であるため、Annotationsよりも扱いやすくなっています。Attributesを利用することで、コードの可読性や保守性を向上させることができます。このサンプルコードは、Attributesの定義方法、適用方法、そしてリフレクションによる情報取得方法を具体的に示しています。システムエンジニアを目指す方は、Attributesの仕組みを理解し、積極的に活用することで、より高度なプログラミングスキルを習得できるでしょう。