[edit] Last updated: Fri, 25 May 2012

ReflectionProperty::getValue

(PHP 5)

ReflectionProperty::getValue — Gets value

Description

public mixed ReflectionProperty::getValue ( object $object )

public mixed ReflectionProperty::getValue ( void )

Gets the properties value.

Parameters

object: If the property is non-static an object must be provided to fetch the property from. If you want to fetch the default property without providing an object use ReflectionClass::getDefaultProperties() instead.

Return Values

The current value of the property.

Errors/Exceptions

Throws a ReflectionException if the property is inaccessible. You can make a protected or private property accessible using ReflectionProperty::setAccessible().

Examples

Example #1 ReflectionProperty::getValue() example


<?php
class Foo {
    public static $staticProperty = 'foobar';
    
    public $property = 'barfoo';
    protected $privateProperty = 'foofoo';
}

$reflectionClass = new ReflectionClass('Foo');

var_dump($reflectionClass->getProperty('staticProperty')->getValue());
var_dump($reflectionClass->getProperty('property')->getValue(new Foo));

$reflectionProperty = $reflectionClass->getProperty('privateProperty');
$reflectionProperty->setAccessible(true);
var_dump($reflectionProperty->getValue(new Foo));
?>

The above example will output:

string(6) "foobar"
string(6) "barfoo"
string(6) "foofoo"


To allow protected and private properties to be accessed, you should use

ReflectionProperty::setAccessible(bool $accessible):



<?php

/** Class Foo with protected and private members */

class Foo {

    protected $bar = 'barrr!';

    private $baz = 'bazzz!';

}



$reflFoo = new ReflectionClass('Foo');

$reflBar = $reflFoo->getProperty('bar');

$reflBaz = $reflFoo->getProperty('baz');



// Set private and protected members accessible for getValue/setValue

$reflBar->setAccessible(true);

$reflBaz->setAccessible(true);



$foo = new Foo();

echo $reflBar->getValue($foo); // will output "barrr!"

echo $reflBaz->getValue($foo); // will output "bazzz!"



// You can also setValue

$reflBar->setValue($foo, "new value");

echo $reflBar->getValue($foo); // will output "new value"

?>

tedivm at tedivm dot com 09-Jan-2010 10:33


Note this function does not return the value for everything, only public properties. Protected or private properties will result in a exception being thrown.

add a note