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

Copy
1<?php
2
3/**
4 * SplFixedArray と PHP 8 のコンストラクタプロパティプロモーションの使用例を示すクラス。
5 * SplFixedArray は固定サイズの配列を提供し、メモリ効率が良いのが特徴です。
6 */
7class FixedArrayContainer
8{
9    /**
10     * @var SplFixedArray 実際に固定サイズのデータを保持する配列。
11     */
12    private SplFixedArray $data;
13
14    /**
15     * コンストラクタプロパティプロモーションを使用して、固定配列のサイズを初期化します。
16     *
17     * PHP 8 では、コンストラクタの引数にアクセス修飾子 (public, protected, private) をつけることで、
18     * その引数を自動的に同名のプロパティとして宣言し、初期化することができます。
19     *
20     * @param int $size SplFixedArray の初期サイズ。0以上である必要があります。
21     */
22    public function __construct(private int $size) // PHP 8 のコンストラクタプロパティプロモーション
23    {
24        // SplFixedArray を指定されたサイズで初期化します。
25        // SplFixedArray の __construct メソッドは、引数として整数のサイズを受け取ります。
26        // ここで指定されたサイズに基づいて、内部的に固定長の配列が確保されます。
27        $this->data = new SplFixedArray($this->size);
28    }
29
30    /**
31     * 指定されたインデックスに値を設定します。
32     * SplFixedArray は固定サイズのため、範囲外のインデックスには設定できません。
33     *
34     * @param int $index 設定するインデックス。
35     * @param mixed $value 設定する値。
36     */
37    public function set(int $index, mixed $value): void
38    {
39        $this->data[$index] = $value;
40    }
41
42    /**
43     * 指定されたインデックスの値を取得します。
44     *
45     * @param int $index 取得するインデックス。
46     * @return mixed 取得した値。
47     */
48    public function get(int $index): mixed
49    {
50        return $this->data[$index];
51    }
52
53    /**
54     * 固定配列の現在のサイズを返します。
55     *
56     * @return int 配列のサイズ。
57     */
58    public function getSize(): int
59    {
60        return $this->data->getSize();
61    }
62}
63
64// --- クラスの使用例 ---
65
66// 1. 固定サイズ3の配列コンテナを作成します。
67//    この時、FixedArrayContainer のコンストラクタが呼び出され、
68//    プロパティ `$this->size` が `3` で初期化され、
69//    その `$this->size` の値で `new SplFixedArray(3)` が実行されます。
70$container = new FixedArrayContainer(3);
71
72echo "配列のサイズ: " . $container->getSize() . "\n";
73
74// 2. 値を設定します。
75$container->set(0, "Apple");
76$container->set(1, 123);
77$container->set(2, true);
78
79// 3. 値を取得して表示します。
80echo "インデックス0の値: " . $container->get(0) . "\n";
81echo "インデックス1の値: " . $container->get(1) . "\n";
82echo "インデックス2の値: " . $container->get(2) . "\n";
83
84// 4. SplFixedArray は固定サイズのため、存在しないインデックスにアクセスすると RangeError が発生します。
85//    以下の行をコメント解除するとエラーが発生します。
86// try {
87//     $container->set(3, "OutOfRange");
88// } catch (RangeException $e) {
89//     echo "エラー: " . $e->getMessage() . "\n";
90// }

このコードは、PHPのSplFixedArrayという固定サイズの配列と、PHP 8で導入されたコンストラクタプロパティプロモーションの利用方法を示しています。SplFixedArrayは、あらかじめサイズを決めておくことでメモリ効率良く動作する配列です。

FixedArrayContainerクラスは、内部にSplFixedArrayを保持し、その操作を提供します。__constructメソッドは、クラスが新しく作られる際に自動的に実行される初期化のための特別なメソッドです。PHP 8からは、この__constructの引数にprivateなどのアクセス修飾子を付けることで、その引数を自動的に同名のプロパティとして宣言し、値を初期化できるようになりました。これをコンストラクタプロパティプロモーションと呼び、コードを簡潔にする効果があります。

このサンプルでは、public function __construct(private int $size) のように記述することで、$size引数をprivateプロパティとして自動的に作成し、初期化しています。この$sizeはSplFixedArrayのコンストラクタへ渡され、固定配列の要素数として利用されます。SplFixedArrayの__constructメソッドは、引数で受け取ったint $sizeに基づいて、内部的に固定長の配列領域を確保します。

コードの後半では、FixedArrayContainerのインスタンスを生成し、setメソッドで値を設定、getメソッドで値を取得、getSizeメソッドで配列のサイズを確認する一連の操作を行っています。SplFixedArrayは固定サイズのため、指定された範囲外のインデックスにアクセスしようとするとエラーが発生する点に注意が必要です。

Copy
1<?php
2
3/**
4 * SplFixedArray を継承するカスタムクラスの例です。
5 * このクラスは、固定サイズの配列の初期化に parent::__construct() を使用します。
6 * システムエンジニアを目指す初心者にも分かりやすいよう、シンプルに構成しています。
7 */
8class MyCustomFixedArray extends SplFixedArray
9{
10    /**
11     * MyCustomFixedArray のコンストラクタ。
12     *
13     * @param int $size 作成する固定配列の初期サイズを指定します。
14     *                  この値は、親クラスである SplFixedArray のコンストラクタに渡されます。
15     */
16    public function __construct(int $size)
17    {
18        // 親クラス (SplFixedArray) のコンストラクタを呼び出します。
19        // これにより、指定された $size の要素を保持できる固定配列が初期化されます。
20        // 子クラスで親クラスの機能（ここではSplFixedArrayの固定サイズ配列としての初期化）
21        // を利用する際に 'parent::__construct()' が使われます。
22        parent::__construct($size);
23
24        echo "MyCustomFixedArray がサイズ " . $size . " で初期化されました。\n";
25        echo "親クラス SplFixedArray のコンストラクタが呼び出され、基盤が構築されました。\n";
26    }
27
28    // 必要に応じて、MyCustomFixedArray 独自のメソッドを追加できますが、
29    // この例ではコンストラクタと parent::__construct の動作に焦点を当てています。
30}
31
32// --- MyCustomFixedArray の使用例 ---
33
34echo "新しい MyCustomFixedArray インスタンスを作成します。\n";
35// サイズ 3 の MyCustomFixedArray インスタンスを作成します。
36// このとき MyCustomFixedArray::__construct() が呼び出され、
37// その中で parent::__construct(3) が実行されます。
38$fixedArray = new MyCustomFixedArray(3);
39
40echo "\n--- 作成された配列の状態 --- \n";
41// 作成された固定配列の現在の要素数を確認します。
42echo "配列の要素数: " . $fixedArray->count() . "\n";
43
44// 配列に値を設定する例
45// SplFixedArray は通常の配列のように [] でアクセスできます。
46$fixedArray[0] = 'PHP';
47$fixedArray[1] = 'Version';
48$fixedArray[2] = 8;
49
50echo "設定された値:\n";
51foreach ($fixedArray as $index => $value) {
52    echo "  [" . $index . "] = " . $value . "\n";
53}
54
55// 固定サイズであることの確認:
56// 初期化時に指定したサイズを超えて要素を追加しようとすると、
57// OutOfBoundsException がスローされます。
58echo "\n--- サイズ超過のアクセスを試みる例 ---\n";
59try {
60    echo "インデックス 3 に値を設定しようとしています...\n";
61    $fixedArray[3] = 'New Element'; // サイズ 3 の配列にはインデックス 3 は存在しない
62} catch (OutOfBoundsException $e) {
63    echo "エラーが発生しました: " . $e->getMessage() . "\n";
64    echo "これは、SplFixedArray が固定サイズであるため、範囲外へのアクセスができないことを示しています。\n";
65}
66
67?>

PHP 8のSplFixedArrayは、あらかじめサイズを決めておく固定長の配列を扱うためのクラスです。このクラスの__constructメソッドは、新しいSplFixedArrayのインスタンスが作られるときに自動的に実行され、配列の準備を行います。引数$sizeには、作成したい固定配列の要素数を整数で指定します。このサイズは後から変更できません。このメソッドは、インスタンスの初期化を行うため、特定の値を返しません。

提供されたサンプルコードでは、SplFixedArrayを継承したMyCustomFixedArrayクラスが登場します。子クラスのコンストラクタ内でparent::__construct($size)を呼び出すことで、親クラスであるSplFixedArrayの初期化処理を確実に実行し、固定サイズの配列としての基盤を構築しています。これにより、子クラスは親クラスの持つ固定サイズ配列としての機能を引き継ぎつつ、独自の処理を追加できます。指定されたサイズを超える要素へのアクセスは、エラー（OutOfBoundsException）となります。このように、parent::__construct()を使うことで、クラスの継承関係を適切に管理し、親クラスの重要な初期化処理を子クラスでも活用できるのです。