【PHP8.x】__constructメソッドの使い方

Copy
1<?php
2
3/**
4 * InternalIterator のコンストラクタのサンプルコード。
5 *
6 * InternalIterator は PHP 8.0 以降で使用できる内部イテレータクラスの基底クラスです。
7 * 直接インスタンス化することはできませんが、その振る舞いを理解するために、
8 * 継承したクラスでコンストラクタを定義する例を示します。
9 */
10class MyIterator extends InternalIterator
11{
12    public function __construct()
13    {
14        // 親クラスのコンストラクタを呼び出す必要がある場合。
15        // parent::__construct();
16
17        // イテレータの初期化処理をここに記述します。
18        echo "MyIterator コンストラクタが呼ばれました。\n";
19    }
20
21    public function current(): mixed
22    {
23        // current() メソッドの実装
24        return null;
25    }
26
27    public function next(): void
28    {
29        // next() メソッドの実装
30    }
31
32    public function key(): mixed
33    {
34        // key() メソッドの実装
35        return null;
36    }
37
38    public function valid(): bool
39    {
40        // valid() メソッドの実装
41        return false;
42    }
43
44    public function rewind(): void
45    {
46        // rewind() メソッドの実装
47    }
48}
49
50// MyIterator のインスタンスを作成
51$myIterator = new MyIterator();
52
53?>

PHP 8 における InternalIterator クラスのコンストラクタ __construct の使用例です。InternalIterator は、PHP 内部で使用されるイテレータの基底クラスであり、直接インスタンス化することは想定されていません。

このサンプルコードでは、InternalIterator を継承した MyIterator クラスを定義し、その中でコンストラクタ __construct を実装しています。__construct は、オブジェクトが生成される際に自動的に呼び出される特別なメソッドです。引数はなく、戻り値もありません。

MyIterator のコンストラクタ内では、イテレータの初期化処理を記述します。例えば、イテレータが扱うデータ構造の準備などを行います。必要に応じて、親クラス (InternalIterator) のコンストラクタを parent::__construct() で呼び出すことも可能です。

サンプルコードでは、コンストラクタが呼び出されたことを示すメッセージを echo で出力しています。また、MyIterator クラスは InternalIterator を継承しているため、current(), next(), key(), valid(), rewind() などの抽象メソッドを実装する必要があります。これらのメソッドは、イテレータの各操作（現在の要素の取得、次の要素への移動、キーの取得、イテレータが有効かどうかの判定、イテレータの先頭への巻き戻し）を定義します。

最後に、MyIterator クラスのインスタンスを作成し、コンストラクタが実行されることを確認しています。この例を通じて、InternalIterator の継承とコンストラクタの役割を理解することができます。

Copy
1<?php
2
3/**
4 * InternalIterator のコンストラクタのサンプルコード (Property Promotion を使用).
5 */
6class MyIterator implements Iterator
7{
8    private int $position = 0;
9    private array $array = [
10        "first",
11        "second",
12        "third"
13    ];
14
15    public function __construct(
16        // Property Promotion: コンストラクタ引数でプロパティを定義し初期化
17        private string $name = 'default_name',
18        private int $id = 0
19    ) {
20    }
21
22    public function rewind(): void
23    {
24        $this->position = 0;
25    }
26
27    public function current(): mixed
28    {
29        return $this->array[$this->position];
30    }
31
32    public function key(): mixed
33    {
34        return $this->position;
35    }
36
37    public function next(): void
38    {
39        ++$this->position;
40    }
41
42    public function valid(): bool
43    {
44        return isset($this->array[$this->position]);
45    }
46
47    public function getName(): string
48    {
49        return $this->name;
50    }
51
52    public function getId(): int
53    {
54        return $this->id;
55    }
56}
57
58// MyIterator のインスタンスを生成
59$myIterator = new MyIterator('MyIterator instance', 123);
60
61// イテレータを使用
62foreach ($myIterator as $key => $value) {
63    echo "Key: $key, Value: $value\n";
64}
65
66// Property Promotion で定義されたプロパティにアクセス
67echo "Name: " . $myIterator->getName() . "\n";
68echo "ID: " . $myIterator->getId() . "\n";

このサンプルコードは、PHP 8 の InternalIterator を実装したクラス MyIterator のコンストラクタ (__construct) の使用例を示しています。InternalIterator は、Iterator インターフェースを実装するために内部的に使用されるクラスですが、ここでは例として Iterator インターフェースを直接実装した MyIterator クラスを作成しています。

コンストラクタの特徴的な点として、PHP 8 で導入された Property Promotion を利用していることが挙げられます。Property Promotion を使うと、コンストラクタの引数でクラスのプロパティを定義し、同時に初期化できます。これにより、private string $name = 'default_name' や private int $id = 0 のように、引数の定義と同時にプロパティの定義と初期化が一度に行えます。

この例では、$name と $id という2つのプロパティをコンストラクタで定義し、それぞれデフォルト値を設定しています。MyIterator クラスのインスタンス生成時に引数を渡すことで、これらのプロパティの値を上書きできます。

サンプルコードでは、MyIterator のインスタンスを生成し、foreach ループを使ってイテレータとして使用しています。また、Property Promotion で定義されたプロパティにアクセスするために、getName() メソッドと getId() メソッドを使用し、それぞれの値を出力しています。Property Promotion を利用することで、コードをより簡潔に記述できます。