ReflectionProperty::isReadable
指定したスコープからプロパティを読み取れるかどうかを調べる
説明
public bool ReflectionProperty::isReadable(stringnull $scope, objectnull $object = null)
指定した scope からプロパティを読み取れるかどうかを調べます。
プロパティのアクセス権、
フック、
マジックメソッド __get() と
__isset() を考慮します。
object を渡した場合、
オブジェクトにおけるプロパティの状態も考慮します。
注意:
戻り値が true であっても、プロパティの読み取りが成功するとは限りません。
たとえば、get フックや
__get() が例外をスローすることがあります。
パラメータ
-
scope
-
プロパティを読み取る側のクラスの名前。
グローバルスコープ(クラスの外にあるコード)の場合は
null を指定します。
クラスの中から呼び出す場合、呼び出し元のスコープで調べるには
static::class を渡します。
-
object
-
プロパティを読み取る対象のオブジェクト。
null の場合、プロパティの宣言だけを考慮します。
static プロパティでは null でなければなりません。
戻り値
プロパティが scope からアクセスできないか、
get フックのない仮想プロパティであるか、
初期化されていない場合は false を返します。
それ以外の場合は true を返します。
ただし、クラスが __get() を定義していれば、
static でないプロパティが scope からアクセスできないか
object に存在しない場合に true を返します。
object を渡し、クラスが
__isset() も定義している場合、
代わりに __isset() を呼び出した結果を返します。
エラー / 例外
static プロパティに対して object を渡した場合や、
object がプロパティを宣言したクラスのインスタンスでない場合、
ReflectionException をスローします。
scope に存在しないクラスの名前を渡した場合、
Error をスローします。
例
例1 ReflectionProperty::isReadable の例
<?php
class User
{
public string $name;
private string $password = 'secret';
}
$user = new User();
$nameProperty = new ReflectionProperty(User::class, 'name');
// オブジェクトを渡さない場合、プロパティの宣言だけを考慮します
var_dump($nameProperty->isReadable(null));
// プロパティはまだ初期化されていません
var_dump($nameProperty->isReadable(null, $user));
$user->name = 'Alice';
var_dump($nameProperty->isReadable(null, $user));
$passwordProperty = new ReflectionProperty(User::class, 'password');
// private プロパティはクラスの内部からしか読み取れません
var_dump($passwordProperty->isReadable(null));
var_dump($passwordProperty->isReadable(User::class));
bool(true)
bool(false)
bool(true)
bool(false)
bool(true)
注意
注意:
object が未初期化の
レイジーオブジェクトの場合、
このメソッドを呼び出すとオブジェクトの初期化がトリガーされることがあります。
参考
- ReflectionProperty::isWritable
- ReflectionProperty::isInitialized
- ReflectionProperty::hasHook
- プロパティのオーバーロード