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

Copy
1<?php
2
3/**
4 * HashContext::__construct を模倣し、
5 * PHP 8.0 の「コンストラクタプロパティ昇格」を説明するためのクラスです。
6 */
7class HashConfig
8{
9    /**
10     * コンストラクタの引数に可視性修飾子 (public) を付けることで、
11     * プロパティの宣言と初期化を同時に行います。
12     * これが「コンストラクタプロパティ昇格 (Constructor Property Promotion)」です。
13     *
14     * @param public string $algo ハッシュアルゴリズム名 (例: 'sha256')
15     * @param public int $flags ハッシュ生成オプション (例: HASH_HMAC)
16     * @param public ?string $key HMAC 計算で使用する共有秘密鍵
17     */
18    public function __construct(
19        public string $algo,
20        public int $flags = 0,
21        public ?string $key = null
22    ) {
23        // この中括弧の中は空ですが、PHPが裏側で
24        // プロパティの宣言と、引数からプロパティへの値の代入を自動的に行っています。
25        //
26        // 従来の書き方 (PHP 7.4 以前):
27        // public string $algo;
28        // public int $flags;
29        // public ?string $key;
30        //
31        // public function __construct(string $algo, int $flags = 0, ?string $key = null) {
32        //     $this->algo = $algo;
33        //     $this->flags = $flags;
34        //     $this->key = $key;
35        // }
36        // 上記の冗長な記述を省略できます。
37    }
38
39    /**
40     * 設定されたプロパティの情報を表示します。
41     */
42    public function displayConfiguration(): void
43    {
44        echo "Algorithm: " . $this->algo . PHP_EOL;
45        echo "Flags: " . $this->flags . PHP_EOL;
46        echo "Key: " . ($this->key ?? 'N/A') . PHP_EOL;
47    }
48}
49
50// HASH_HMAC は hash 拡張モジュールで定義されるPHPの組み込み定数です。
51$hmacFlag = defined('HASH_HMAC') ? HASH_HMAC : 1;
52
53// コンストラクタプロパティ昇格を利用してインスタンスを生成します。
54// 引数で渡した値が、直接インスタンスのプロパティに設定されます。
55$config = new HashConfig(
56    algo: 'sha256',
57    flags: $hmacFlag,
58    key: 'my-secret-key'
59);
60
61// メソッドを呼び出し、プロパティが正しくセットされていることを確認します。
62$config->displayConfiguration();
63

このPHPサンプルコードは、PHP 8.0で導入された「コンストラクタプロパティ昇格」という新機能を、HashContextクラスのコンストラクタを模倣して説明するものです。この機能を使うと、クラスのプロパティ宣言とコンストラクタ内での初期化処理を、より簡潔に記述できます。

HashConfigクラスの__constructメソッドでは、引数 $algo、$flags、$key の前に public という可視性修飾子が付与されています。これがコンストラクタプロパティ昇格の構文です。これにより、PHPは自動的に同名の公開プロパティをクラスに作成し、コンストラクタに渡された引数の値をそのプロパティへ代入します。その結果、従来は必要だったプロパティの明示的な宣言や、コンストラクタ内での $this->プロパティ = $引数; という代入文を省略できます。

__constructは、newキーワードでインスタンスが生成される際に自動的に呼び出される特別なメソッドです。オブジェクトの初期化を行い、このメソッド自体には戻り値はありません。コードの最後では、実際にHashConfigクラスのインスタンスを生成し、メソッドを呼び出すことでプロパティに値が正しく設定されていることを確認しています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * PHPの組み込みクラスである HashContext を継承したカスタムクラス。
7 * このクラスは、HMAC（Hash-based Message Authentication Code）の計算を簡単に行うことを目的とします。
8 */
9class HmacCalculator extends HashContext
10{
11    /**
12     * HmacCalculator クラスのコンストラクタ。
13     *
14     * 親クラスである HashContext のコンストラクタを呼び出し、
15     * HMAC計算に必要な初期設定を行います。
16     *
17     * @param string $algo 使用するハッシュアルゴリズム名 (例: 'sha256')。
18     * @param string $key  HMACの計算に使用する共有秘密鍵。
19     */
20    public function __construct(string $algo, string $key)
21    {
22        // 'parent::__construct()' を使用して、親クラス(HashContext)のコンストラクタを呼び出します。
23        // これにより、継承元のクラスが持つ初期化処理を実行できます。
24        // ここでは、HMAC計算を行うために HASH_HMAC フラグと共有秘密鍵を渡しています。
25        parent::__construct($algo, HASH_HMAC, $key);
26    }
27
28    /**
29     * 与えられたデータからHMAC値を計算し、16進数文字列として返します。
30     *
31     * @param string $data HMACを計算する対象のデータ。
32     * @return string 計算されたHMAC値。
33     */
34    public function generate(string $data): string
35    {
36        // データのハッシュ値を更新
37        hash_update($this, $data);
38        // 計算を完了し、最終的なハッシュ値を取得
39        return hash_final($this);
40    }
41}
42
43// --- このクラスの使用例 ---
44
45// HMAC計算に使用するパラメータ
46$algorithm = 'sha256';
47$secretKey = 'your-super-secret-key';
48$message = 'The quick brown fox jumps over the lazy dog';
49
50// HmacCalculatorクラスのインスタンスを生成します。
51// このとき、__constructメソッドが自動的に呼び出されます。
52$calculator = new HmacCalculator($algorithm, $secretKey);
53
54// generateメソッドを呼び出して、メッセージのHMAC値を計算します。
55$hmac = $calculator->generate($message);
56
57// 結果を出力します。
58echo "Message: " . $message . PHP_EOL;
59echo "HMAC (sha256): " . $hmac . PHP_EOL;
60
61?>

このサンプルコードは、PHPの組み込みクラス HashContext の機能を拡張し、HMAC（ハッシュベースのメッセージ認証コード）の計算をより簡単に行うためのカスタムクラス HmacCalculator を定義しています。

__construct メソッドはコンストラクタと呼ばれ、new HmacCalculator(...) のようにクラスのインスタンスを生成する際に自動的に呼び出される特別な初期化処理です。このメソッド自体に戻り値はありません。このクラスのコンストラクタは、第一引数 $algo でハッシュ計算に使うアルゴリズム名（例: 'sha256'）を、第二引数 $key でHMAC計算に必要な秘密鍵を受け取ります。

コードの中心となる parent::__construct() は、親クラスである HashContext のコンストラクタを呼び出すための記述です。これにより、子クラスは親クラスが持つ本来の初期化機能を実行できます。ここでは、親クラスに対して、指定されたアルゴリズム $algo、HMAC計算を行うことを示すフラグ HASH_HMAC、そして秘密鍵 $key を渡しています。このように、親クラスのコンストラクタを呼び出すことで、HMAC計算の準備を適切に行うことができます。