PHPで変更不可で読み取り可能なプロパティオブジェクトを作る方法

こんにちは。ファガイです。
今回はPHPで変更不可で読み取り可能なプロパティオブジェクトを作る方法について考えてみます。

そもそも変更不可で読み取り可能なプロパティオブジェクトとは何か

例えばこのようなクラスがあったとします。

class Sample
{
    public $a;
    protected $b;
    private $c;

    public function __construct($public, $protected, $private)
    {
        $this->a = $public;
        $this->b = $protected;
        $this->c = $private;
    }
}

このクラスはコンストラクタから情報を受け取って、それをプロパティに登録して使うオブジェクトです。
このオブジェクトは作られたあとはイミュータブルでありたいです。

実際に作って取得しようとするとこうなります。

$sample = new Sample('public', 'protected', 'private');
var_dump($sample->a); // public
var_dump($sample->b); // Cannot access protected property
var_dump($sample->c); // Cannot access private property

publicにしたプロパティaにはアクセスできますが、外からプロパティaが変更できてしまう問題があります。

$sample->a = 'modify';
var_dump($sample->a); // modify

上記のように、PHPでreadonlyなプロパティは言語仕様的には無理です。
そのため、代替案を考えてみます。

素直にGetterを実装する

以下はgetterを実装する案です。

class GetSample
{
    private $c = 'private';

    public function getC(): string
    {
        return $this->c;
    }
}

試そうとするとこうなります。


$getSample = new GetSample;
var_dump($getSample->getC()); // private
var_dump($getSample->c); // Cannot access private property
$getSample->c = 'modify'; // Cannot access private property

上記のように、getC()メソッドでプロパティを取得できますが、直接は取得できませんし変更できません。
これで作ったあとは変更できないプロパティオブジェクトが出来上がります。

マジックメソッドを駆使して作る

あとはマジックメソッドを利用する方法です。こっちのほうが外から見る分にはリアルな感じがあります。


/**
 * @property-read String $c
 */
class MagicGetSample
{
    private $vars = [
        'c' => 'private',
        ];

    public function __get(string $name)
    {
        if (isset($this->vars[$name])) {
            return $this->vars[$name];
        }
    }

    public function __set(string $name, $value): void
    {
        if (isset($this->vars[$name])) {
            throw new ErrorException("cannot modify `{$name}` property.");
        }
        $this->{$name} = $value;
    }

    public function __isset(string $name): bool
    {
        return isset($this->vars[$name]);
    }
}

上記の解説をすると、__getはアクセス不能または存在しないプロパティにアクセスしようとすると呼ばれます。__set,__issetも同様な感じです。

まず、上記のマジックメソッドを呼ぶためにはそのプロパティが存在しない状況を作らないと行けないのでprivateな$varsプロパティに内包してます。

__getや__set、__issetはその$varsプロパティの中にあるかどうかで取得するか、エラーを出すかを決めます。

そしてこの状況ではこのクラスがcというプロパティを持っていないことになっているのでIDEなどで読み取れるようにクラスのPHPDOCに

@property-read String $c

を追加しています。
上記を追加することで存在はしないけどアクセスできるよということを明示しています。

このコードを動かした場合、以下のようになります。

$magicGetSample = new MagicGetSample();
var_dump($magicGetSample->c); // private
$magicGetSample->c = 'modify'; // cannot modify `c` property.

上記のように今までのプロパティアクセスと同じ形で記述ができて外から変更不可なオブジェクトが作成できます。

その他の案

もう一つ浮かんだのが、privateプロパティはそのままにしてマジックメソッドで読んじゃえば良いんじゃねという案です。
これはIDEがアクセス不能なプロパティと認識してきてしまうのもあり、あまり良くない気がしました。→一応phpdocで定義してしまえばちゃんと認識してもらえるようです。こちらでも良いかもしれません。

最後に

C#とかだとreadonlyみたいな定義ができたりと他の言語に比べて不便ではありますね。
今後、言語仕様として取り入れられたりしそうな予感はします。