Edit Report a Bug

    ReflectionProperty::setValue

    (PHP 5, PHP 7, PHP 8)

    ReflectionProperty::setValue — プロパティの値を設定する

    説明

    public ReflectionProperty::setValue(object $object, mixed $value): void
    public ReflectionProperty::setValue(mixed $value): void

    プロパティの値を設定 (変更) します。

    注意: PHP 8.3.0 以降では、このメソッドにひとつだけ引数を渡してコールすることは、推奨されなくなりました。ReflectionClass::setStaticPropertyValue() を使いましょう。

    パラメータ

    object

    static でないプロパティの場合は、プロパティを変更したいオブジェクトを指定しなければなりません。 staticプロパティ の場合、null を指定しなければ なりません。

    value

    新しい値。

    戻り値

    値を返しません。

    変更履歴

    バージョン 説明
    8.3.0 このメソッドにひとつだけ引数を渡してコールすることは、推奨されなくなりました。static プロパティを変更する場合は、代わりに ReflectionClass::setStaticPropertyValue() を使ってください。
    8.1.0 private と protected なプロパティは ReflectionProperty::setValue() ですぐにアクセスできるようになりました。 これより前のバージョンでは、 ReflectionProperty::setAccessible() をコールすることでアクセスできるようにする必要がありました。 そうしない場合、 ReflectionException がスローされていました。

    例

    例1 ReflectionProperty::setValue() の例

    <?php
    class Foo {
    public static     $staticProperty;

    public     $property;
    protected     $privateProperty;
    }

    $reflectionClass = new ReflectionClass('Foo');

    // PHP 8.3 以降では、static プロパティを設定する目的で setValue メソッドを使うべきではありません。代わりに、setStaticPropertyValue() を使いましょう。
    $reflectionClass->setStaticPropertyValue('staticProperty', 'foo');
    var_dump(Foo::$staticProperty);

    $foo = new Foo;

    $reflectionClass->getProperty('property')->setValue($foo, 'bar');
    var_dump($foo->property);

    $reflectionProperty = $reflectionClass->getProperty('privateProperty');
    $reflectionProperty->setAccessible(true); // PHP 8.1.0 より前のバージョンのみ、この行の実行が必須でした
    $reflectionProperty->setValue($foo, 'foobar');
    var_dump($reflectionProperty->getValue($foo));
    ?>

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

    string(3) "foo"
string(3) "bar"
string(6) "foobar"

    参考

    add a note add a note

    User Contributed Notes 3 notes

    up
    2
    me at ircmaxell dot om
    13 years ago
    You can use ReflectionProperty::setValue to set the value on static properties as well as regular instance properties.  Simply pass null in place of the instance:

    <?php
    class Foo {
        protected static     $bar = null;
        public static function     sayBar() {
            echo     self::$bar;
        }
    }

    $r = new ReflectionProperty('Foo', 'bar');
    $r->setAccessible(true);
    $r->setValue(null, 'foo');

    Foo::sayBar(); // "foo"
    ?>
    up
    2
    p stewart imperial ac uk
    1 year ago
    setValue can be used for readonly properties, but only if the property has not yet been initialised:

    <?php

    class Person
    {
        private     readonly int $age;
        public function     __construct(array $props = []) {
            if (isset(    $props['age'])) {
                    $this->age = (int)$props['age'];
            }
        }
    }

    $personWithKnownAge = new Person(['age' => 50]);

    $reflection = new ReflectionProperty($personWithKnownAge, 'age');
    $reflection->setValue($personWithKnownAge, 10); // Fails - Age is already initialised, value cannot be changed.

    $personWithUnknownAge = new Person();

    $reflection = new ReflectionProperty($personWithUnknownAge, 'age');
    $reflection->setValue($personWithUnknownAge, 10); // Succeeeds - Age is not yet initialised, value can be set.
    ?>

    This can be useful for situations where it is desirable to initialise properties from outside of the defining class, for example an ORM setup where the parent class is responsible for setting properties on a model subclass instance.
    up
    -1
    temirkhan.nasukhov
    2 years ago
    Keep in mind that setValue won't work for readonly properties. 

    <?php

    class Person
    {
        public function     __construct(private readonly int $age) {}
    }

    $someOldPerson = new Person(80);

    $reflection = new ReflectionProperty($someOldPerson, 'age');
    $reflection->setValue($someOldPerson, 10); // Fatal error: Uncaught Error: Cannot modify readonly property Person::$age
    add a note add a note
    To Top