【PHP8.x】AppendIterator::__construct()メソッドの使い方

Copy
1<?php
2
3/**
4 * PHP 8 で導入されたコンストラクタプロモーションの例を示すクラスです。
5 *
6 * コンストラクタプロモーションにより、コンストラクタの引数として
7 * プロパティの可視性、型、名前を宣言することで、自動的にプロパティが作成され、
8 * 初期化されるため、冗長なコードを削減できます。
9 */
10class Product
11{
12    /**
13     * 商品名と価格をコンストラクタプロモーションを使って初期化します。
14     * 引数として定義された `$name` と `$price` は、自動的にこのクラスの
15     * プロパティ (private $name, private float $price) となります。
16     *
17     * @param string $name  商品の名前
18     * @param float  $price 商品の価格
19     * @throws InvalidArgumentException 価格が0以下の場合
20     */
21    public function __construct(
22        private string $name,
23        private float $price
24    ) {
25        // コンストラクタプロモーションを使用しても、追加のロジックを記述できます。
26        // ここでは、価格の妥当性チェックを行っています。
27        if ($this->price <= 0) {
28            throw new InvalidArgumentException("商品の価格は0より大きくする必要があります。");
29        }
30    }
31
32    /**
33     * 商品名を取得します。
34     *
35     * @return string 商品名
36     */
37    public function getName(): string
38    {
39        return $this->name;
40    }
41
42    /**
43     * 商品価格を取得します。
44     *
45     * @return float 商品価格
46     */
47    public function getPrice(): float
48    {
49        return $this->price;
50    }
51}
52
53// Product クラスの使用例
54
55try {
56    // 正常なインスタンスの作成
57    $product1 = new Product("Laptop", 1200.50);
58    echo "商品1: " . $product1->getName() . ", 価格: $" . $product1->getPrice() . PHP_EOL;
59
60    $product2 = new Product("Mouse", 25.00);
61    echo "商品2: " . $product2->getName() . ", 価格: $" . $product2->getPrice() . PHP_EOL;
62
63    // 不正な価格でインスタンスを作成しようとすると例外が発生します
64    $invalidProduct = new Product("Invalid Item", -10.00);
65    echo "不正な商品: " . $invalidProduct->getName() . ", 価格: $" . $invalidProduct->getPrice() . PHP_EOL;
66
67} catch (InvalidArgumentException $e) {
68    echo "エラー: " . $e->getMessage() . PHP_EOL;
69}

このコードは、PHP 8で導入された「コンストラクタプロモーション」という便利な機能を示すものです。クラスを作成する際、その初期状態を設定するための特別なメソッドが__construct（コンストラクタ）です。通常、クラスのプロパティを定義し、その後コンストラクタ内でそのプロパティに値を代入して初期化するという二段階の記述が必要です。

しかし、コンストラクタプロモーションを利用すると、__constructメソッドの引数として、プロパティの可視性（例：private）、型、名前を直接宣言できます。これにより、自動的にその引数がクラスのプロパティとして定義され、さらにインスタンス作成時に渡された値で初期化されるため、記述が大幅に簡潔になります。

サンプルコードのProductクラスでは、public function __construct(private string $name, private float $price)と記述することで、$nameと$priceがそれぞれプライベートプロパティとして定義され、同時に初期化されています。__constructメソッドの引数は、クラスのインスタンスを生成する際に渡される値であり、この例では商品の名前と価格です。

コンストラクタプロモーションを使用しても、引数の妥当性チェックなど、初期化に関する追加のロジックをコンストラクタ内に記述することは可能です。この例では、価格が0以下でないことを確認する処理が含まれています。__constructメソッドはクラスのインスタンスを初期化する役割を持つため、明示的な戻り値はありません。new Product("Laptop", 1200.50)のように記述することで、指定した値で初期化されたProductオブジェクトが作成されます。

Copy
1<?php
2
3/**
4 * PHP 8のコンストラクタプロパティプロモーションとAppendIteratorの使用例。
5 *
6 * システムエンジニアを目指す初心者向けに、複数のイテレータを結合するAppendIteratorを
7 * 活用しつつ、PHP 8で導入されたプロパティプロモーションの概念を理解できるサンプルです。
8 */
9class DataAggregator
10{
11    /**
12     * 結合されたイテレータを管理するAppendIteratorのインスタンス。
13     * AppendIteratorの__constructメソッドは引数をとりません。
14     *
15     * @var AppendIterator
16     */
17    private AppendIterator $combinedIterator;
18
19    /**
20     * DataAggregatorのコンストラクタ。
21     *
22     * PHP 8の「プロパティプロモーション」機能を使用して、$labelプロパティを
23     * コンストラクタ引数から直接宣言し、初期化します。
24     * これにより、プロパティの宣言とコンストラクタ内での代入が簡略化されます。
25     *
26     * @param string $label このデータアグリゲーターの識別用ラベル
27     */
28    public function __construct(
29        private string $label // ここで `$label` はプロパティとしても自動的に定義・初期化されます。
30    ) {
31        // AppendIteratorのコンストラクタは引数なしで呼び出されます。
32        // ここでインスタンスを生成し、プロパティに割り当てます。
33        $this->combinedIterator = new AppendIterator();
34    }
35
36    /**
37     * 新しいイテレータを結合リストに追加します。
38     *
39     * @param Iterator $iterator 追加するイテレータ
40     */
41    public function addIterator(Iterator $iterator): void
42    {
43        $this->combinedIterator->append($iterator);
44    }
45
46    /**
47     * 結合されたデータを取得するためのAppendIteratorインスタンスを返します。
48     * これを使って、追加されたすべてのイテレータのデータを順にループできます。
49     *
50     * @return AppendIterator 結合されたイテレータ
51     */
52    public function getCombinedData(): AppendIterator
53    {
54        return $this->combinedIterator;
55    }
56
57    /**
58     * このアグリゲーターのラベルを返します。
59     * プロパティプロモーションで初期化された `$label` プロパティを利用しています。
60     *
61     * @return string ラベル
62     */
63    public function getLabel(): string
64    {
65        return $this->label;
66    }
67}
68
69// --- サンプル使用例 ---
70
71// DataAggregatorのインスタンスを作成します。
72// コンストラクタ引数 'Log Entries' は、プロパティプロモーションにより
73// DataAggregator::$label プロパティとして自動的に初期化されます。
74$aggregator = new DataAggregator('Log Entries');
75
76// 最初のログデータを含むArrayIteratorを作成し、アグリゲーターに追加します。
77$logIterator1 = new ArrayIterator([
78    '[2023-01-01] User login successful.',
79    '[2023-01-01] New item added to cart.'
80]);
81$aggregator->addIterator($logIterator1);
82
83// 2番目のログデータを含むArrayIteratorを作成し、アグリゲーターに追加します。
84$logIterator2 = new ArrayIterator([
85    '[2023-01-02] Order placed successfully.',
86    '[2023-01-02] Email notification sent.'
87]);
88$aggregator->addIterator($logIterator2);
89
90// アグリゲーターのラベルを出力します。
91echo "--- " . $aggregator->getLabel() . " ---\n";
92
93// AppendIteratorによって結合されたすべてのログエントリをループして表示します。
94foreach ($aggregator->getCombinedData() as $logEntry) {
95    echo $logEntry . "\n";
96}
97

PHPのAppendIteratorクラスは、複数のイテレータ（データ源を順番に処理するオブジェクト）を一つにまとめて、あたかも一つのデータ源であるかのように扱うための便利な機能です。そのコンストラクタであるAppendIterator::__constructメソッドは、引数を一切とりません。これは、AppendIteratorのインスタンスを生成する際に特別な初期設定を必要とせず、後からappendメソッドを使ってイテレータを追加していく設計になっているためです。

このサンプルコードでは、AppendIteratorの利用に加え、PHP 8で導入された「コンストラクタプロパティプロモーション」という新機能も紹介しています。これは、コンストラクタの引数にアクセス修飾子（privateやpublicなど）を付与することで、その引数が自動的にクラスのプロパティとして定義され、同時に初期化される機能です。これにより、プロパティの宣言とコンストラクタ内での代入が不要になり、クラスのコードをより簡潔に記述できます。

DataAggregatorクラスの__constructメソッドでは、private string $labelのように引数を記述することで、$labelが自動的にプライベートプロパティとして宣言され、インスタンス化時に渡された値で初期化されます。そして、クラス内部では引数なしで$this->combinedIterator = new AppendIterator();と記述することで、AppendIteratorのインスタンスを生成し、複数のイテレータを結合するための準備を整えています。最終的に、addIteratorメソッドで追加された複数のイテレータのデータは、getCombinedDataメソッドが返すAppendIteratorを通じて、foreachループでまとめて処理できるようになります。