Menu
CoddyTech

Readonlyプロパティ(PHP 8.1)

CoddyのPHPジャーニー「オブジェクト指向プログラミング」セクションの一部。レッスン 19/91。

PHP 8.1ではreadonlyプロパティが導入されました。このプロパティには一度だけ値を代入でき、その後は変更できません。定数とは異なり、readonlyプロパティはクラス定義時ではなく、オブジェクトの初期化時に設定されます。

型宣言の前にreadonlyキーワードを追加すると、読み取り専用プロパティを宣言できます。

<?php
class User {
    public readonly string $id;
    public readonly string $name;
    
    public function __construct(string $id, string $name) {
        $this->id = $id;
        $this->name = $name;
    }
}

$user = new User("U001", "Alice");
echo $user->id . "\n";
echo $user->name;

出力:

U001
Alice

一度割り当てると、読み取り専用プロパティを変更しようとしたときにエラーが発生します。これらは、IDや作成タイムスタンプのように、オブジェクトの存続期間を通じて一定に保つべき値に最適です。

読み取り専用プロパティには型宣言が必要で、宣言したクラス内から一度だけ代入できます(通常はコンストラクター内で代入します)。通常のプロパティとは異なり、宣言時にデフォルト値を設定することはできません。どの可視性修飾子とも併用できます。

<?php
class Product {
    public function __construct(
        public readonly string $sku,
        private readonly float $cost
    ) {}
    
    public function getCost(): float {
        return $this->cost;
    }
}

$product = new Product("ABC123", 29.99);
echo $product->sku;

出力:

ABC123

重要なポイント:読み取り専用プロパティは、プロパティ単位で不変性を提供します。オブジェクトを識別するデータや、作成後に変更すべきでないデータに最適で、実行時初期化の柔軟性と、誤った変更を防ぐ安全性を兼ね備えています。

challenge icon

チャレンジ

簡単

初期化後に重要な設定が誤って変更されないよう、readonlyプロパティを使用する不変の設定システムを作りましょう。

アプリケーションの設定を管理するために、連携して動作する2つのファイルを作成します。

  • Config.php: 不変の設定を表すConfigクラスを定義します。このクラスには、3つのpublic readonlyプロパティstring $appName、string $version、int $maxConnectionsを持たせます。コンストラクタプロモーションを使って、1つの簡潔なコンストラクタ定義で3つのreadonlyプロパティすべてを宣言して初期化します。getInfo()メソッドを追加し、"[appName] v[version] (max: [maxConnections] connections)"の形式の文字列を返すようにします。
  • main.php: Configクラスのファイルを読み込みます。アプリ名、バージョン、最大接続数(整数に変換する必要がある文字列)の3つの入力を受け取ります。これらの値を使ってConfigオブジェクトを作成します。1行目にgetInfo()の結果を出力します。次に、各readonlyプロパティに直接アクセスし、アプリ名、バージョン、最大接続数をそれぞれ別の行に出力します。

readonlyプロパティを使うと、設定を作成した後にその値を固定できます。これは、アプリケーションの実行中ずっと一定に保つべき設定に最適です。コンストラクタプロモーションとreadonlyを組み合わせると、不変の値オブジェクトを非常に簡潔に定義できることに注目してください。

出力には、書式設定された情報文字列に続いて各プロパティの値が表示されます。これにより、readonlyプロパティをクラスの外部からも読み取れることを確認できます。

自分で試してみよう

<?php

require_once 'Config.php';

// 入力を読み取る
$appName = trim(fgets(STDIN));
$version = trim(fgets(STDIN));
$maxConnections = intval(trim(fgets(STDIN)));

// TODO: 入力値を使ってConfigオブジェクトを作成する

// TODO: getInfo()の結果を出力する

// TODO: 各readonlyプロパティをそれぞれ別の行に出力する:
// - アプリ名
// - バージョン
// - 最大接続数

?>
quiz icon腕試し

このレッスンには短いクイズがあります。レッスンを始めて解答し、進捗を記録しましょう。

オブジェクト指向プログラミングのすべてのレッスン

自分で練習してみよう: PHPオンラインコンパイラ