ReflectionProperty::isWritable

指定したスコープからプロパティに書き込めるかどうかを調べる

説明

public bool ReflectionProperty::isWritable(stringnull $scope, objectnull $object = null)

指定した scope からプロパティに書き込めるかどうかを調べます。 プロパティのアクセス権(非対称可視性を含む)、 フック、 マジックメソッド __set() を考慮します。 object を渡した場合、 オブジェクトにおける読み取り専用プロパティの状態も考慮します。

注意: 戻り値が true であっても、プロパティへの書き込みが成功するとは限りません。 たとえば、set フックや __set() が例外をスローすることがあります。 また、代入する値の型も考慮しません。

パラメータ

scope
プロパティに書き込む側のクラスの名前。 グローバルスコープ(クラスの外にあるコード)の場合は null を指定します。 クラスの中から呼び出す場合、呼び出し元のスコープで調べるには static::class を渡します。
object
プロパティに書き込む対象のオブジェクト。 null の場合、プロパティの宣言だけを考慮します。 static プロパティでは null でなければなりません。

戻り値

プロパティが、アクセス権や set のアクセス権によって scope から書き込めないか、 set フックのない仮想プロパティであるか、 object を渡していて、 読み取り専用プロパティがそのオブジェクトですでに初期化されている場合は false を返します。 それ以外の場合は true を返します。

ただし、クラスが __set() を定義していれば、 static でないプロパティのアクセス権が scope からのアクセスを許可しない場合に true を返します。

エラー / 例外

static プロパティに対して object を渡した場合や、 object がプロパティを宣言したクラスのインスタンスでない場合、 ReflectionException をスローします。

scope に存在しないクラスの名前を渡した場合、 Error をスローします。

例

例1 ReflectionProperty::isWritable の例

<?php
class User
{
    public readonly string $name;

    public function setName(string $name): void
    {
        $this->name = $name;
    }
}

$reflectionProperty = new ReflectionProperty(User::class, 'name');
$user = new User();

// 読み取り専用プロパティにはクラスの内部からしか書き込めません
var_dump($reflectionProperty->isWritable(null, $user));

// プロパティはまだ初期化されていません
var_dump($reflectionProperty->isWritable(User::class, $user));

$user->setName('Alice');
var_dump($reflectionProperty->isWritable(User::class, $user));

// オブジェクトを渡さない場合、プロパティの宣言だけを考慮します
var_dump($reflectionProperty->isWritable(User::class));

上の例の出力は以下となります。

bool(false)
bool(true)
bool(false)
bool(true)

注意

注意: object が未初期化の レイジーオブジェクトの場合、 読み取り専用プロパティに対してこのメソッドを呼び出すと、 オブジェクトの初期化がトリガーされることがあります。

参考

  • ReflectionProperty::isReadable
  • ReflectionProperty::isReadOnly
  • ReflectionProperty::isPrivateSet
  • ReflectionProperty::isProtectedSet