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

Copy
1<?php
2
3namespace App\Math; // 名前空間を定義し、コードを論理的にグループ化します。
4
5use RoundingMode; // PHP組み込みのRoundingMode列挙型をインポートします。
6                  // これにより、完全修飾名(\RoundingMode)ではなく簡潔に参照できます。
7
8/**
9 * 指定された丸めモードのケース名を取得し、出力する関数です。
10 *
11 * システムエンジニア初心者向けに、名前空間内での列挙型の使用方法と
12 * その名前プロパティへのアクセス方法を示します。
13 */
14function demonstrateRoundingModeName(): void
15{
16    // RoundingMode列挙型の特定のケースを代入します。
17    // PHP 8.1以降で導入された列挙型 (Enums) の使用例です。
18    $mode = RoundingMode::HalfUp;
19
20    // 列挙型のケース名(文字列)を'name'プロパティから取得します。
21    // 例えば、RoundingMode::HalfUp の場合は "HalfUp" という文字列が返されます。
22    $modeName = $mode->name;
23
24    // 取得した丸めモードの名前を出力します。
25    echo "選択された丸めモードの名称: " . $modeName . PHP_EOL;
26}
27
28// 名前空間内で定義された関数を呼び出す際は、
29// その名前空間を明示するか、useステートメントでインポートする必要があります。
30// ここでは、グローバルスコープからApp\Math名前空間内の関数を完全修飾名で呼び出しています。
31\App\Math\demonstrateRoundingModeName();

このサンプルコードは、PHPにおける名前空間の利用と、RoundingMode列挙型のnameプロパティの使い方をシステムエンジニアの初心者向けに解説しています。

まず、namespace App\Math;でコードを論理的に整理するための名前空間を定義し、use RoundingMode;でPHP標準のRoundingMode列挙型をインポートしています。これにより、コード内でRoundingModeを簡潔に参照できるようになります。

demonstrateRoundingModeName関数内では、$mode = RoundingMode::HalfUp;のように、丸め処理の種類を示すRoundingMode列挙型の特定のケースを代入しています。RoundingMode列挙型はPHP 8.1以降で導入され、数値の丸め方を明示的に指定するために使用されます。

$mode->name;と記述することで、代入された列挙型ケースの正式名称を文字列として取得できます。例えばRoundingMode::HalfUpの場合、このnameプロパティは"HalfUp"という文字列を戻り値として返します。このプロパティは引数を一切取らず、常に列挙型ケースの名称をstring型で提供します。

最後に、取得した丸めモードの名称を出力し、名前空間で定義された関数をグローバルスコープから完全修飾名で呼び出す方法も示しています。このサンプルは、コードの構造化と、PHPの列挙型を活用したデータ表現の基礎を理解する上で役立ちます。

Copy
1<?php
2
3namespace MyCompany\Utility;
4
5/**
6 * RoundingModeInspector クラスは、PHPの組み込みEnumである RoundingMode の
7 * name プロパティの使用方法と、名前空間内での利用方法を示します。
8 *
9 * システムエンジニアを目指す初心者向けに、Enumの基本的な使い方と
10 * 名前空間（namespace）内で外部のクラス（この場合は組み込みEnum）を
11 * 参照する際の概念（php namespace resolver）を簡潔に示します。
12 */
13class RoundingModeInspector
14{
15    /**
16     * 指定された丸めモードのEnumケース名を文字列として取得します。
17     *
18     * RoundingMode::name プロパティは、Enumケースが定義された際の文字列名を返します。
19     * たとえば、RoundingMode::HALF_UP->name は "HALF_UP" という文字列を返します。
20     *
21     * RoundingMode はPHPのグローバル名前空間に存在する組み込みEnumのため、
22     * `use` ステートメントは必須ではありませんが、引数の型ヒントでは
23     * 完全修飾名（Fully Qualified Name: \RoundingMode）を使用することで、
24     * どの `RoundingMode` を指しているかを明確にし、名前空間の概念を示します。
25     *
26     * @param \RoundingMode $mode 検査する RoundingMode のEnumケース
27     * @return string 指定されたEnumケースの文字列名
28     */
29    public function getCaseName(\RoundingMode $mode): string
30    {
31        // Enumケースの `name` プロパティにアクセスし、その文字列名を取得します。
32        return $mode->name;
33    }
34}
35
36// クラスをインスタンス化します。
37// この例では、MyCompany\Utility 名前空間内のクラスを名前空間外から使用するため、
38// 完全修飾名で参照しています。
39$inspector = new MyCompany\Utility\RoundingModeInspector();
40
41// RoundingMode::HALF_UP のEnumケース名を取得します。
42// RoundingMode はグローバル名前空間にあるため、`\RoundingMode` または `RoundingMode`
43// のいずれでも参照可能ですが、ここでは FQN を用いて名前空間の概念を強調します。
44$halfUpName = $inspector->getCaseName(\RoundingMode::HALF_UP);
45echo "RoundingMode::HALF_UP の名前: " . $halfUpName . PHP_EOL;
46
47// RoundingMode::DOWN のEnumケース名を取得します。
48$downName = $inspector->getCaseName(\RoundingMode::DOWN);
49echo "RoundingMode::DOWN の名前: " . $downName . PHP_EOL;
50
51// RoundingMode::CEILING のEnumケース名を取得します。
52$ceilingName = $inspector->getCaseName(\RoundingMode::CEILING);
53echo "RoundingMode::CEILING の名前: " . $ceilingName . PHP_EOL;
54
55?>

このコードは、PHP 8で導入されたRoundingModeという「Enum（列挙型）」のnameプロパティの利用方法と、名前空間（namespace）を持つPHPアプリケーションでのその扱い方を示すサンプルです。

RoundingModeは、数値の丸め方を示す定数をまとめたもので、例えばHALF_UPは四捨五入、DOWNは切り捨てを表します。各Enumケースには、そのケース名そのものを文字列として取得できるnameという組み込みプロパティが用意されています。例えば、RoundingMode::HALF_UP->nameは"HALF_UP"という文字列を返します。

サンプルコードのgetCaseNameメソッドは、引数として\RoundingMode $modeを受け取ります。これは、検査したい特定の丸めモードのEnumケースを指定することを意味します。メソッドの内部では、受け取った$modeのnameプロパティにアクセスし、その文字列名を戻り値として返します。戻り値の型はstringです。

\RoundingModeのようにクラス名の前にバックスラッシュを付けるのは、「完全修飾名（Fully Qualified Name）」と呼ばれ、現在の名前空間に関わらず、グローバル名前空間に存在するRoundingModeクラスを明確に参照するための「名前空間解決」の概念を示しています。これにより、どのRoundingModeクラスを指しているのかが明確になり、大規模なプロジェクトでもクラス名の衝突を避けてコードを整理しやすくなります。このサンプルコードは、丸めモードの各ケースの文字列名が正しく出力されることを示しています。