interface PropertyAccessorInterface

Writes and reads values to/from an object/array graph.

Methods

setValue(object|array $objectOrArray, string|PropertyPathInterface $propertyPath, mixed $value)

Sets the value at the end of the property path of the object graph.

mixed
getValue(object|array $objectOrArray, string|PropertyPathInterface $propertyPath)

Returns the value at the end of the property path of the object graph.

bool
isWritable(object|array $objectOrArray, string|PropertyPathInterface $propertyPath)

Returns whether a value can be written at a given property path.

bool
isReadable(object|array $objectOrArray, string|PropertyPathInterface $propertyPath)

Returns whether a property path can be read from an object graph.

Details

at line 50
setValue(object|array $objectOrArray, string|PropertyPathInterface $propertyPath, mixed $value)

Sets the value at the end of the property path of the object graph.

Example:

use Symfony\Component\PropertyAccess\PropertyAccess;

$propertyAccessor = PropertyAccess::createPropertyAccessor();

echo $propertyAccessor->setValue($object, 'child.name', 'Fabien');
// equals echo $object->getChild()->setName('Fabien');

This method first tries to find a public setter for each property in the path. The name of the setter must be the camel-cased property name prefixed with "set".

If the setter does not exist, this method tries to find a public property. The value of the property is then changed.

If neither is found, an exception is thrown.

Parameters

object|array $objectOrArray The object or array to modify
string|PropertyPathInterface $propertyPath The property path to modify
mixed $value The value to set at the end of the property path

Exceptions

InvalidArgumentException If the property path is invalid
AccessException If a property/index does not exist or is not public
UnexpectedTypeException If a value within the path is neither object nor array

at line 83
mixed getValue(object|array $objectOrArray, string|PropertyPathInterface $propertyPath)

Returns the value at the end of the property path of the object graph.

Example:

use Symfony\Component\PropertyAccess\PropertyAccess;

$propertyAccessor = PropertyAccess::createPropertyAccessor();

echo $propertyAccessor->getValue($object, 'child.name);
// equals echo $object->getChild()->getName();

This method first tries to find a public getter for each property in the path. The name of the getter must be the camel-cased property name prefixed with "get", "is", or "has".

If the getter does not exist, this method tries to find a public property. The value of the property is then returned.

If none of them are found, an exception is thrown.

Parameters

object|array $objectOrArray The object or array to traverse
string|PropertyPathInterface $propertyPath The property path to read

Return Value

mixed The value at the end of the property path

Exceptions

InvalidArgumentException If the property path is invalid
AccessException If a property/index does not exist or is not public
UnexpectedTypeException If a value within the path is neither object nor array

at line 98
bool isWritable(object|array $objectOrArray, string|PropertyPathInterface $propertyPath)

Returns whether a value can be written at a given property path.

Whenever this method returns true, {@link setValue()} is guaranteed not to throw an exception when called with the same arguments.

Parameters

object|array $objectOrArray The object or array to check
string|PropertyPathInterface $propertyPath The property path to check

Return Value

bool Whether the value can be set

Exceptions

InvalidArgumentException If the property path is invalid

at line 113
bool isReadable(object|array $objectOrArray, string|PropertyPathInterface $propertyPath)

Returns whether a property path can be read from an object graph.

Whenever this method returns true, {@link getValue()} is guaranteed not to throw an exception when called with the same arguments.

Parameters

object|array $objectOrArray The object or array to check
string|PropertyPathInterface $propertyPath The property path to check

Return Value

bool Whether the property path can be read

Exceptions

InvalidArgumentException If the property path is invalid