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

Copy
1<?php
2
3declare(strict_types=1);
4
5// 名前空間 'Dom' に属する 'AdjacentPosition' という enum (列挙型) をインポートします。
6// 'use' キーワードを使うことで、以降のコードでは完全修飾名 \Dom\AdjacentPosition の代わりに、
7// 短い名前 'AdjacentPosition' でこの enum を参照できるようになります。
8// これがキーワード 'php namespace' の実践的な使い方です。
9use Dom\AdjacentPosition;
10
11/**
12 * Dom\AdjacentPosition enum の 'name' プロパティの使用例を示します。
13 * この enum は PHP 8.3 以降の DOM 拡張で利用可能です。
14 */
15function showEnumNameProperty(): void
16{
17    // AdjacentPosition enum の各ケースは、DOM要素に対する相対的な位置を表します。
18    $position1 = AdjacentPosition::BeforeBegin;
19    $position2 = AdjacentPosition::AfterBegin;
20    $position3 = AdjacentPosition::BeforeEnd;
21    $position4 = AdjacentPosition::AfterEnd;
22
23    // すべての enum ケースは、読み取り専用の 'name' プロパティを持っています。
24    // このプロパティは、ケース自身の名前を文字列として返します。
25    echo 'Case Name: ' . $position1->name . PHP_EOL; // 出力: Case Name: BeforeBegin
26    echo 'Case Name: ' . $position2->name . PHP_EOL; // 出力: Case Name: AfterBegin
27    echo 'Case Name: ' . $position3->name . PHP_EOL; // 出力: Case Name: BeforeEnd
28    echo 'Case Name: ' . $position4->name . PHP_EOL; // 出力: Case Name: AfterEnd
29}
30
31// 関数を実行して結果を表示します。
32showEnumNameProperty();

このサンプルコードは、PHP 8.3以降で利用可能なDom\AdjacentPositionという列挙型（enum）のnameプロパティの使い方を説明します。Dom\AdjacentPositionは、HTMLやXMLなどのDOM要素に対し、特定の隣接位置（例えば、要素の開始タグの前や終了タグの後など）を表すための標準的な値を提供するものです。

まず、use Dom\AdjacentPosition;という記述は、PHPの名前空間（php namespace）を効率的に利用する例です。これにより、長い完全修飾名である\Dom\AdjacentPositionの代わりに、コード内で短いAdjacentPositionとして参照できるようになり、コードの可読性が向上します。

nameプロパティは、Dom\AdjacentPositionを含むすべてのPHP列挙型ケースが持つ、組み込みの読み取り専用プロパティです。このプロパティにアクセスすると、その列挙型ケース自身の定義名が文字列として返されます。例えば、AdjacentPosition::BeforeBeginというケースのnameプロパティは「BeforeBegin」という文字列を返します。このプロパティは引数を受け取りません。

サンプルコードでは、AdjacentPositionの異なるケースをいくつか定義し、それぞれのnameプロパティにアクセスしてその値をechoで出力しています。これにより、列挙型ケースの定義名をプログラム内で文字列として簡単に利用できることが示されています。

Copy
1<?php
2
3// PHP 8.1以降で導入された Dom\AdjacentPosition Enum を使用します。
4// 名前空間の解決: 'use' 文を使うことで、長い名前空間（Dom\AdjacentPosition）を
5// 毎回完全に記述することなく、直接 'AdjacentPosition' として参照できるようになります。
6use Dom\AdjacentPosition;
7
8/**
9 * Dom\AdjacentPosition Enum の 'name' プロパティの使用例を示します。
10 *
11 * この関数は、PHPの 'Dom' 名前空間に属する Enum である Dom\AdjacentPosition の
12 * 各ケースについて、'name' プロパティがどのような値を返すかをデモンストレーションします。
13 *
14 * 'name' プロパティは、Enumケースが持つ固有の名前（文字列）を返します。
15 * これは、PHPで Enum を利用する際に、現在のEnumケースの名前を取得するための
16 * 標準的な方法です。システムエンジニアを目指す初心者の方は、PHPのEnumの基本的な
17 * 使い方、名前空間の解決、およびプロパティへのアクセス方法を学ぶことができます。
18 *
19 * @return void
20 */
21function demonstrateAdjacentPositionNameProperty(): void
22{
23    echo "--- Dom\\AdjacentPosition::name プロパティの使用例 ---" . PHP_EOL;
24    echo "（PHPの名前空間解決とEnumプロパティへのアクセス）" . PHP_EOL . PHP_EOL;
25
26    // Dom\AdjacentPosition の全てのEnumケースを取得し、ループで処理します。
27    // 'cases()' メソッドはPHP 8.1以降のEnumで利用可能で、全てのケースの配列を返します。
28    foreach (AdjacentPosition::cases() as $position) {
29        // 'name' プロパティにアクセスし、Enumケースの文字列名を取得します。
30        // 例えば、AdjacentPosition::Beforebegin->name は "Beforebegin" という文字列を返します。
31        $caseName = $position->name;
32
33        echo "Enumケース: " . $position::class . "::" . $position->name . PHP_EOL;
34        echo "  'name' プロパティの値: '" . $caseName . "' (型: " . gettype($caseName) . ")" . PHP_EOL;
35        echo "--------------------------------------------------" . PHP_EOL;
36    }
37
38    echo PHP_EOL . "この例は、PHPの 'use' 文による名前空間の解決と、" . PHP_EOL;
39    echo "Enumの 'name' プロパティへのアクセス方法を示しています。" . PHP_EOL;
40}
41
42// 上記で定義した関数を実行し、デモンストレーションを開始します。
43demonstrateAdjacentPositionNameProperty();
44

このサンプルコードは、PHP 8.1以降で導入されたDom\AdjacentPosition Enumのnameプロパティの使い方を、システムエンジニアを目指す初心者向けに解説しています。Dom\AdjacentPositionは、ウェブページなどのDOM要素に対して、どこにコンテンツを挿入するかを示すための列挙型です。

コードの冒頭にあるuse Dom\AdjacentPosition;は「名前空間の解決」と呼ばれる機能で、Dom\AdjacentPositionという長い名前を、以降は単にAdjacentPositionと省略して使えるようにします。これは、コードを読みやすく、書きやすくするための一般的な手法です。

nameプロパティは、AdjacentPosition::Beforebeginのような特定のEnumケースから、そのケース固有の「名前」を文字列として取得するために使用されます。このプロパティに引数を渡す必要はありません。例えば、AdjacentPosition::Beforebegin->nameは"Beforebegin"という文字列を返します。このプロパティは、Enumが持つ名前をプログラム内で利用する際に役立ちます。

サンプルコードでは、AdjacentPosition::cases()メソッドを使ってDom\AdjacentPositionのすべてのケースを取得し、それぞれのケースで->nameと記述して名前を取得し、その値と型を表示しています。これにより、PHPのEnumの基本的な利用方法、名前空間の解決の概念、そしてEnumプロパティへのアクセス方法を具体的に学ぶことができます。