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

Copy
1<?php
2
3/**
4 * SensitiveParameterValue は、PHP 8.2 で導入されたクラスで、
5 * スタックトレース（エラー発生時の呼び出し履歴）に表示される可能性のある機密情報を隠蔽するために使用されます。
6 * そのコンストラクタ `__construct(mixed $value)` は、隠蔽したい値をラップします。
7 *
8 * このサンプルコードでは、PHP 8 の「コンストラクタプロパティプロモーション」と組み合わせて、
9 * SensitiveParameterValue の使用方法を示します。
10 * コンストラクタプロパティプロモーションは、コンストラクタの引数を直接クラスのプロパティとして定義できる機能です。
11 */
12class UserAccount
13{
14    // コンストラクタプロパティプロモーションを使用してプロパティを定義します。
15    // 引数 $username は公開プロパティ $username として直接宣言されます。
16    // 引数 $password は、機密情報として SensitiveParameterValue のインスタンスとして受け取り、
17    // private プロパティ $password として直接宣言されます。
18    public function __construct(
19        public string $username,
20        private SensitiveParameterValue $password // SensitiveParameterValue オブジェクトをプロモートされたプロパティとして定義
21    ) {
22        // コンストラクタプロパティプロモーションを使用しているため、
23        // ここで $this->username = $username; や $this->password = $password; を書く必要はありません。
24    }
25
26    /**
27     * ユーザー名を取得します。
28     * @return string
29     */
30    public function getUsername(): string
31    {
32        return $this->username;
33    }
34
35    /**
36     * ラップされたパスワードオブジェクト (SensitiveParameterValue) を取得します。
37     * 実際のパスワード文字列は取得しません。
38     * @return SensitiveParameterValue
39     */
40    public function getPasswordObject(): SensitiveParameterValue
41    {
42        return $this->password;
43    }
44
45    /**
46     * 実際のパスワード文字列を取得します。
47     * このメソッドは、内部処理でのみ使用されるべきであり、セキュリティ上の注意が必要です。
48     * @return mixed
49     */
50    public function getActualPasswordValue(): mixed
51    {
52        return $this->password->getValue();
53    }
54}
55
56// UserAccount クラスのインスタンスを作成します。
57// パスワードは SensitiveParameterValue クラスのインスタンスとしてコンストラクタに渡されます。
58// ここで SensitiveParameterValue::__construct('mySuperSecretPassword123!') が呼び出されます。
59$user = new UserAccount(
60    'alice_smith',
61    new SensitiveParameterValue('mySuperSecretPassword123!')
62);
63
64echo "--- ユーザーアカウント情報 ---" . PHP_EOL;
65echo "ユーザー名: " . $user->getUsername() . PHP_EOL;
66
67// SensitiveParameterValue オブジェクトを var_dump すると、
68// 内部の機密値は `(redacted)` と表示され、直接公開されません。
69echo "パスワードオブジェクト (var_dump): " . PHP_EOL;
70var_dump($user->getPasswordObject());
71
72// UserAccount オブジェクト全体を var_dump した場合も同様に、機密値は redacted されます。
73echo "UserAccount オブジェクト全体 (var_dump): " . PHP_EOL;
74var_dump($user);
75
76// 実際のパスワード値にアクセスするには、`SensitiveParameterValue::getValue()` メソッドを呼び出す必要があります。
77// これは、特定の処理（例：パスワードの検証）で必要な場合にのみ行われるべきです。
78echo "実際のパスワード値: " . $user->getActualPasswordValue() . PHP_EOL;
79
80// (補足) もしこのコード内でエラーが発生し、スタックトレースが生成された場合、
81// `mySuperSecretPassword123!` という文字列はスタックトレースには表示されません。
82// これが SensitiveParameterValue の主な目的です。
83

PHP 8 の SensitiveParameterValue クラスは、スタックトレースに表示される可能性のある機密情報を隠蔽するために使用されます。そのコンストラクタである __construct(mixed $value) は、引数 $value で渡された隠蔽したい値を内部に保持し、値を返しません。

このサンプルコードでは、PHP 8 で導入された「コンストラクタプロパティプロモーション」という簡潔な記法と組み合わせて、SensitiveParameterValue の利用方法を示しています。UserAccount クラスでは、パスワードを SensitiveParameterValue のインスタンスとしてプロパティに定義しています。これにより、クラスのインスタンスを var_dump する際などに、パスワードの実際の文字列は (redacted) と表示され、誤って機密情報がログなどに記録されることを防ぎます。

もし実際のパスワード文字列が必要な場合は、SensitiveParameterValue オブジェクトの getValue() メソッドを明示的に呼び出す必要があります。これは、パスワードの検証など、特定の用途に限って慎重に行うべき操作です。この仕組みによって、開発者は機密情報の取り扱いにより注意を払うことができ、セキュリティ向上に貢献します。