2013-01-07 08:19:31 +00:00
< ? php
/*
* This file is part of the Symfony package .
*
* ( c ) Fabien Potencier < fabien @ symfony . com >
*
* For the full copyright and license information , please view the LICENSE
* file that was distributed with this source code .
*/
namespace Symfony\Component\PropertyAccess ;
use Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException ;
use Symfony\Component\PropertyAccess\Exception\UnexpectedTypeException ;
/**
* Default implementation of { @ link PropertyAccessorInterface } .
*
* @ author Bernhard Schussek < bschussek @ gmail . com >
*/
class PropertyAccessor implements PropertyAccessorInterface
{
const VALUE = 0 ;
const IS_REF = 1 ;
2013-03-04 22:59:45 +00:00
private $magicCall ;
2013-01-07 08:19:31 +00:00
/**
* Should not be used by application code . Use
* { @ link PropertyAccess :: getPropertyAccessor ()} instead .
*/
2013-03-04 22:59:45 +00:00
public function __construct ( $magicCall = false )
2013-01-07 08:19:31 +00:00
{
2013-03-04 22:59:45 +00:00
$this -> magicCall = $magicCall ;
2013-01-07 08:19:31 +00:00
}
/**
* { @ inheritdoc }
*/
public function getValue ( $objectOrArray , $propertyPath )
{
if ( is_string ( $propertyPath )) {
$propertyPath = new PropertyPath ( $propertyPath );
} elseif ( ! $propertyPath instanceof PropertyPathInterface ) {
throw new UnexpectedTypeException ( $propertyPath , 'string or Symfony\Component\PropertyAccess\PropertyPathInterface' );
}
2014-09-21 19:53:12 +01:00
$propertyValues = & $this -> readPropertiesUntil ( $objectOrArray , $propertyPath , $propertyPath -> getLength ());
2013-01-07 08:19:31 +00:00
return $propertyValues [ count ( $propertyValues ) - 1 ][ self :: VALUE ];
}
/**
* { @ inheritdoc }
*/
public function setValue ( & $objectOrArray , $propertyPath , $value )
{
if ( is_string ( $propertyPath )) {
$propertyPath = new PropertyPath ( $propertyPath );
} elseif ( ! $propertyPath instanceof PropertyPathInterface ) {
throw new UnexpectedTypeException ( $propertyPath , 'string or Symfony\Component\PropertyAccess\PropertyPathInterface' );
}
2014-09-21 19:53:12 +01:00
$propertyValues = & $this -> readPropertiesUntil ( $objectOrArray , $propertyPath , $propertyPath -> getLength () - 1 );
2013-01-07 08:19:31 +00:00
$overwrite = true ;
// Add the root object to the list
array_unshift ( $propertyValues , array (
self :: VALUE => & $objectOrArray ,
self :: IS_REF => true ,
));
for ( $i = count ( $propertyValues ) - 1 ; $i >= 0 ; -- $i ) {
2014-09-21 19:53:12 +01:00
$objectOrArray = & $propertyValues [ $i ][ self :: VALUE ];
2013-01-07 08:19:31 +00:00
if ( $overwrite ) {
if ( ! is_object ( $objectOrArray ) && ! is_array ( $objectOrArray )) {
throw new UnexpectedTypeException ( $objectOrArray , 'object or array' );
}
$property = $propertyPath -> getElement ( $i );
//$singular = $propertyPath->singulars[$i];
$singular = null ;
2012-07-31 12:15:57 +01:00
if ( $propertyPath -> isIndex ( $i )) {
$this -> writeIndex ( $objectOrArray , $property , $value );
} else {
$this -> writeProperty ( $objectOrArray , $property , $singular , $value );
}
2013-01-07 08:19:31 +00:00
}
2014-09-21 19:53:12 +01:00
$value = & $objectOrArray ;
2013-01-07 08:19:31 +00:00
$overwrite = ! $propertyValues [ $i ][ self :: IS_REF ];
}
}
/**
* Reads the path from an object up to a given path index .
*
2013-03-27 22:40:36 +00:00
* @ param object | array $objectOrArray The object or array to read from
* @ param PropertyPathInterface $propertyPath The property path to read
2014-04-12 18:54:57 +01:00
* @ param int $lastIndex The index up to which should be read
2013-01-07 08:19:31 +00:00
*
* @ return array The values read in the path .
*
* @ throws UnexpectedTypeException If a value within the path is neither object nor array .
*/
private function & readPropertiesUntil ( & $objectOrArray , PropertyPathInterface $propertyPath , $lastIndex )
{
$propertyValues = array ();
2012-07-31 12:15:57 +01:00
for ( $i = 0 ; $i < $lastIndex ; ++ $i ) {
2013-01-07 08:19:31 +00:00
if ( ! is_object ( $objectOrArray ) && ! is_array ( $objectOrArray )) {
throw new UnexpectedTypeException ( $objectOrArray , 'object or array' );
}
$property = $propertyPath -> getElement ( $i );
$isIndex = $propertyPath -> isIndex ( $i );
$isArrayAccess = is_array ( $objectOrArray ) || $objectOrArray instanceof \ArrayAccess ;
// Create missing nested arrays on demand
if ( $isIndex && $isArrayAccess && ! isset ( $objectOrArray [ $property ])) {
$objectOrArray [ $property ] = $i + 1 < $propertyPath -> getLength () ? array () : null ;
}
2012-07-31 12:15:57 +01:00
if ( $isIndex ) {
2014-09-21 19:53:12 +01:00
$propertyValue = & $this -> readIndex ( $objectOrArray , $property );
2012-07-31 12:15:57 +01:00
} else {
2014-09-21 19:53:12 +01:00
$propertyValue = & $this -> readProperty ( $objectOrArray , $property );
2012-07-31 12:15:57 +01:00
}
2014-09-21 19:53:12 +01:00
$objectOrArray = & $propertyValue [ self :: VALUE ];
2013-01-07 08:19:31 +00:00
2014-09-21 19:53:12 +01:00
$propertyValues [] = & $propertyValue ;
2013-01-07 08:19:31 +00:00
}
return $propertyValues ;
}
2012-07-31 12:15:57 +01:00
/**
* Reads a key from an array - like structure .
*
2013-03-27 22:40:36 +00:00
* @ param \ArrayAccess | array $array The array or \ArrayAccess object to read from
2014-04-16 07:51:57 +01:00
* @ param string | int $index The key to read
2012-07-31 12:15:57 +01:00
*
* @ return mixed The value of the key
*
2013-03-27 22:40:36 +00:00
* @ throws NoSuchPropertyException If the array does not implement \ArrayAccess or it is not an array
2012-07-31 12:15:57 +01:00
*/
private function & readIndex ( & $array , $index )
{
if ( ! $array instanceof \ArrayAccess && ! is_array ( $array )) {
throw new NoSuchPropertyException ( sprintf ( 'Index "%s" cannot be read from object of type "%s" because it doesn\'t implement \ArrayAccess' , $index , get_class ( $array )));
}
// Use an array instead of an object since performance is very crucial here
$result = array (
self :: VALUE => null ,
2014-09-21 19:53:12 +01:00
self :: IS_REF => false ,
2012-07-31 12:15:57 +01:00
);
if ( isset ( $array [ $index ])) {
if ( is_array ( $array )) {
2014-09-21 19:53:12 +01:00
$result [ self :: VALUE ] = & $array [ $index ];
2012-07-31 12:15:57 +01:00
$result [ self :: IS_REF ] = true ;
} else {
$result [ self :: VALUE ] = $array [ $index ];
// Objects are always passed around by reference
$result [ self :: IS_REF ] = is_object ( $array [ $index ]) ? true : false ;
}
}
return $result ;
}
2013-01-07 08:19:31 +00:00
/**
* Reads the a property from an object or array .
*
2012-07-31 12:15:57 +01:00
* @ param object $object The object to read from .
* @ param string $property The property to read .
2013-01-07 08:19:31 +00:00
*
* @ return mixed The value of the read property
*
2013-04-18 15:39:54 +01:00
* @ throws NoSuchPropertyException If the property does not exist or is not
* public .
2013-01-07 08:19:31 +00:00
*/
2012-07-31 12:15:57 +01:00
private function & readProperty ( & $object , $property )
2013-01-07 08:19:31 +00:00
{
// Use an array instead of an object since performance is
// very crucial here
$result = array (
self :: VALUE => null ,
2014-09-21 19:53:12 +01:00
self :: IS_REF => false ,
2013-01-07 08:19:31 +00:00
);
2012-07-31 12:15:57 +01:00
if ( ! is_object ( $object )) {
throw new NoSuchPropertyException ( sprintf ( 'Cannot read property "%s" from an array. Maybe you should write the property path as "[%s]" instead?' , $property , $property ));
}
2013-01-07 08:19:31 +00:00
2012-07-31 12:15:57 +01:00
$camelProp = $this -> camelize ( $property );
$reflClass = new \ReflectionClass ( $object );
$getter = 'get' . $camelProp ;
$isser = 'is' . $camelProp ;
$hasser = 'has' . $camelProp ;
2013-04-18 15:39:54 +01:00
$classHasProperty = $reflClass -> hasProperty ( $property );
2013-01-07 08:19:31 +00:00
2013-04-18 15:39:54 +01:00
if ( $reflClass -> hasMethod ( $getter ) && $reflClass -> getMethod ( $getter ) -> isPublic ()) {
2012-07-31 12:15:57 +01:00
$result [ self :: VALUE ] = $object -> $getter ();
2013-04-18 15:39:54 +01:00
} elseif ( $reflClass -> hasMethod ( $isser ) && $reflClass -> getMethod ( $isser ) -> isPublic ()) {
2012-07-31 12:15:57 +01:00
$result [ self :: VALUE ] = $object -> $isser ();
2013-04-18 15:39:54 +01:00
} elseif ( $reflClass -> hasMethod ( $hasser ) && $reflClass -> getMethod ( $hasser ) -> isPublic ()) {
2012-07-31 12:15:57 +01:00
$result [ self :: VALUE ] = $object -> $hasser ();
2013-04-18 15:39:54 +01:00
} elseif ( $reflClass -> hasMethod ( '__get' ) && $reflClass -> getMethod ( '__get' ) -> isPublic ()) {
2012-07-31 12:15:57 +01:00
$result [ self :: VALUE ] = $object -> $property ;
2013-04-18 15:39:54 +01:00
} elseif ( $classHasProperty && $reflClass -> getProperty ( $property ) -> isPublic ()) {
2014-09-21 19:53:12 +01:00
$result [ self :: VALUE ] = & $object -> $property ;
2012-07-31 12:15:57 +01:00
$result [ self :: IS_REF ] = true ;
2013-04-18 15:39:54 +01:00
} elseif ( ! $classHasProperty && property_exists ( $object , $property )) {
// Needed to support \stdClass instances. We need to explicitly
// exclude $classHasProperty, otherwise if in the previous clause
// a *protected* property was found on the class, property_exists()
// returns true, consequently the following line will result in a
// fatal error.
2014-09-21 19:53:12 +01:00
$result [ self :: VALUE ] = & $object -> $property ;
2012-07-31 12:15:57 +01:00
$result [ self :: IS_REF ] = true ;
2013-03-04 22:59:45 +00:00
} elseif ( $this -> magicCall && $reflClass -> hasMethod ( '__call' ) && $reflClass -> getMethod ( '__call' ) -> isPublic ()) {
// we call the getter and hope the __call do the job
$result [ self :: VALUE ] = $object -> $getter ();
2013-01-07 08:19:31 +00:00
} else {
2013-11-06 08:08:50 +00:00
$methods = array ( $getter , $isser , $hasser , '__get' );
if ( $this -> magicCall ) {
$methods [] = '__call' ;
}
2013-04-18 15:39:54 +01:00
throw new NoSuchPropertyException ( sprintf (
2013-11-06 09:08:18 +00:00
'Neither the property "%s" nor one of the methods "%s()" ' .
2013-11-06 08:08:50 +00:00
'exist and have public access in class "%s".' ,
2013-04-18 15:39:54 +01:00
$property ,
2013-11-06 09:08:18 +00:00
implode ( '()", "' , $methods ),
2013-04-18 15:39:54 +01:00
$reflClass -> name
));
2013-01-07 08:19:31 +00:00
}
// Objects are always passed around by reference
if ( is_object ( $result [ self :: VALUE ])) {
$result [ self :: IS_REF ] = true ;
}
return $result ;
}
/**
* Sets the value of the property at the given index in the path
*
2013-03-27 22:40:36 +00:00
* @ param \ArrayAccess | array $array An array or \ArrayAccess object to write to
2014-04-16 07:51:57 +01:00
* @ param string | int $index The index to write at
2013-03-27 22:40:36 +00:00
* @ param mixed $value The value to write
2012-07-31 12:15:57 +01:00
*
2013-03-27 22:40:36 +00:00
* @ throws NoSuchPropertyException If the array does not implement \ArrayAccess or it is not an array
2012-07-31 12:15:57 +01:00
*/
private function writeIndex ( & $array , $index , $value )
{
if ( ! $array instanceof \ArrayAccess && ! is_array ( $array )) {
throw new NoSuchPropertyException ( sprintf ( 'Index "%s" cannot be modified in object of type "%s" because it doesn\'t implement \ArrayAccess' , $index , get_class ( $array )));
}
$array [ $index ] = $value ;
}
/**
* Sets the value of the property at the given index in the path
*
2013-04-18 15:39:54 +01:00
* @ param object | array $object The object or array to write to
* @ param string $property The property to write
* @ param string | null $singular The singular form of the property name or null
* @ param mixed $value The value to write
2013-01-07 08:19:31 +00:00
*
2013-04-18 15:39:54 +01:00
* @ throws NoSuchPropertyException If the property does not exist or is not
* public .
2013-01-07 08:19:31 +00:00
*/
2012-07-31 12:15:57 +01:00
private function writeProperty ( & $object , $property , $singular , $value )
2013-01-07 08:19:31 +00:00
{
2013-04-18 15:39:54 +01:00
$guessedAdders = '' ;
2013-01-07 08:19:31 +00:00
2012-07-31 12:15:57 +01:00
if ( ! is_object ( $object )) {
throw new NoSuchPropertyException ( sprintf ( 'Cannot write property "%s" to an array. Maybe you should write the property path as "[%s]" instead?' , $property , $property ));
}
2013-01-07 08:19:31 +00:00
2012-07-31 12:15:57 +01:00
$reflClass = new \ReflectionClass ( $object );
$plural = $this -> camelize ( $property );
// Any of the two methods is required, but not yet known
$singulars = null !== $singular ? array ( $singular ) : ( array ) StringUtil :: singularify ( $plural );
if ( is_array ( $value ) || $value instanceof \Traversable ) {
$methods = $this -> findAdderAndRemover ( $reflClass , $singulars );
if ( null !== $methods ) {
// At this point the add and remove methods have been found
// Use iterator_to_array() instead of clone in order to prevent side effects
// see https://github.com/symfony/symfony/issues/4670
$itemsToAdd = is_object ( $value ) ? iterator_to_array ( $value ) : $value ;
$itemToRemove = array ();
$propertyValue = $this -> readProperty ( $object , $property );
$previousValue = $propertyValue [ self :: VALUE ];
if ( is_array ( $previousValue ) || $previousValue instanceof \Traversable ) {
foreach ( $previousValue as $previousItem ) {
foreach ( $value as $key => $item ) {
if ( $item === $previousItem ) {
// Item found, don't add
unset ( $itemsToAdd [ $key ]);
// Next $previousItem
continue 2 ;
2013-01-07 08:19:31 +00:00
}
}
2012-07-31 12:15:57 +01:00
// Item not found, add to remove list
$itemToRemove [] = $previousItem ;
2013-01-07 08:19:31 +00:00
}
2012-07-31 12:15:57 +01:00
}
2013-01-07 08:19:31 +00:00
2012-07-31 12:15:57 +01:00
foreach ( $itemToRemove as $item ) {
call_user_func ( array ( $object , $methods [ 1 ]), $item );
}
2013-01-07 08:19:31 +00:00
2012-07-31 12:15:57 +01:00
foreach ( $itemsToAdd as $item ) {
call_user_func ( array ( $object , $methods [ 0 ]), $item );
}
return ;
} else {
2013-04-18 15:39:54 +01:00
// It is sufficient to include only the adders in the error
// message. If the user implements the adder but not the remover,
// an exception will be thrown in findAdderAndRemover() that
// the remover has to be implemented as well.
$guessedAdders = '"add' . implode ( '()", "add' , $singulars ) . '()", ' ;
2013-01-07 08:19:31 +00:00
}
2012-07-31 12:15:57 +01:00
}
2013-01-07 08:19:31 +00:00
2012-07-31 12:15:57 +01:00
$setter = 'set' . $this -> camelize ( $property );
2013-04-18 15:39:54 +01:00
$classHasProperty = $reflClass -> hasProperty ( $property );
2013-01-07 08:19:31 +00:00
2013-04-18 15:39:54 +01:00
if ( $reflClass -> hasMethod ( $setter ) && $reflClass -> getMethod ( $setter ) -> isPublic ()) {
2012-07-31 12:15:57 +01:00
$object -> $setter ( $value );
2013-04-18 15:39:54 +01:00
} elseif ( $reflClass -> hasMethod ( '__set' ) && $reflClass -> getMethod ( '__set' ) -> isPublic ()) {
2012-07-31 12:15:57 +01:00
$object -> $property = $value ;
2013-04-18 15:39:54 +01:00
} elseif ( $classHasProperty && $reflClass -> getProperty ( $property ) -> isPublic ()) {
2012-07-31 12:15:57 +01:00
$object -> $property = $value ;
2013-04-18 15:39:54 +01:00
} elseif ( ! $classHasProperty && property_exists ( $object , $property )) {
// Needed to support \stdClass instances. We need to explicitly
// exclude $classHasProperty, otherwise if in the previous clause
// a *protected* property was found on the class, property_exists()
// returns true, consequently the following line will result in a
// fatal error.
2012-07-31 12:15:57 +01:00
$object -> $property = $value ;
2013-03-04 22:59:45 +00:00
} elseif ( $this -> magicCall && $reflClass -> hasMethod ( '__call' ) && $reflClass -> getMethod ( '__call' ) -> isPublic ()) {
// we call the getter and hope the __call do the job
$object -> $setter ( $value );
2013-01-07 08:19:31 +00:00
} else {
2013-04-18 15:39:54 +01:00
throw new NoSuchPropertyException ( sprintf (
2013-03-04 22:59:45 +00:00
'Neither the property "%s" nor one of the methods %s"%s()", ' .
'"__set()" or "__call()" exist and have public access in class "%s".' ,
2013-04-18 15:39:54 +01:00
$property ,
$guessedAdders ,
$setter ,
$reflClass -> name
));
2013-01-07 08:19:31 +00:00
}
}
/**
* Camelizes a given string .
*
2014-11-30 13:33:44 +00:00
* @ param string $string Some string
2013-01-07 08:19:31 +00:00
*
2013-03-27 22:40:36 +00:00
* @ return string The camelized version of the string
2013-01-07 08:19:31 +00:00
*/
private function camelize ( $string )
{
return preg_replace_callback ( '/(^|_|\.)+(.)/' , function ( $match ) { return ( '.' === $match [ 1 ] ? '_' : '' ) . strtoupper ( $match [ 2 ]); }, $string );
}
/**
* Searches for add and remove methods .
*
* @ param \ReflectionClass $reflClass The reflection class for the given object
2013-03-27 22:40:36 +00:00
* @ param array $singulars The singular form of the property name or null
2013-01-07 08:19:31 +00:00
*
2013-03-27 22:40:36 +00:00
* @ return array | null An array containing the adder and remover when found , null otherwise
2013-01-07 08:19:31 +00:00
*
2013-03-27 22:40:36 +00:00
* @ throws NoSuchPropertyException If the property does not exist
2013-01-07 08:19:31 +00:00
*/
private function findAdderAndRemover ( \ReflectionClass $reflClass , array $singulars )
{
foreach ( $singulars as $singular ) {
2013-04-02 10:39:57 +01:00
$addMethod = 'add' . $singular ;
$removeMethod = 'remove' . $singular ;
2013-01-07 08:19:31 +00:00
$addMethodFound = $this -> isAccessible ( $reflClass , $addMethod , 1 );
$removeMethodFound = $this -> isAccessible ( $reflClass , $removeMethod , 1 );
if ( $addMethodFound && $removeMethodFound ) {
return array ( $addMethod , $removeMethod );
}
if ( $addMethodFound xor $removeMethodFound ) {
throw new NoSuchPropertyException ( sprintf (
2013-04-18 15:39:54 +01:00
'Found the public method "%s()", but did not find a public "%s()" on class %s' ,
2013-01-07 08:19:31 +00:00
$addMethodFound ? $addMethod : $removeMethod ,
$addMethodFound ? $removeMethod : $addMethod ,
$reflClass -> name
));
}
}
}
/**
* Returns whether a method is public and has a specific number of required parameters .
*
2014-11-30 13:33:44 +00:00
* @ param \ReflectionClass $class The class of the method
* @ param string $methodName The method name
* @ param int $parameters The number of parameters
2013-01-07 08:19:31 +00:00
*
2014-11-30 13:33:44 +00:00
* @ return bool Whether the method is public and has $parameters
* required parameters
2013-01-07 08:19:31 +00:00
*/
private function isAccessible ( \ReflectionClass $class , $methodName , $parameters )
{
if ( $class -> hasMethod ( $methodName )) {
$method = $class -> getMethod ( $methodName );
if ( $method -> isPublic () && $method -> getNumberOfRequiredParameters () === $parameters ) {
return true ;
}
}
return false ;
}
}