* * 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\AccessException; use Symfony\Component\PropertyAccess\Exception\InvalidArgumentException; use Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException; use Symfony\Component\PropertyAccess\Exception\NoSuchIndexException; use Symfony\Component\PropertyAccess\Exception\UnexpectedTypeException; /** * Default implementation of {@link PropertyAccessorInterface}. * * @author Bernhard Schussek * @author Kévin Dunglas * @author Nicolas Grekas */ class PropertyAccessor implements PropertyAccessorInterface { /** * @internal */ const VALUE = 0; /** * @internal */ const REF = 1; /** * @internal */ const IS_REF_CHAINED = 2; /** * @internal */ const ACCESS_HAS_PROPERTY = 0; /** * @internal */ const ACCESS_TYPE = 1; /** * @internal */ const ACCESS_NAME = 2; /** * @internal */ const ACCESS_REF = 3; /** * @internal */ const ACCESS_ADDER = 4; /** * @internal */ const ACCESS_REMOVER = 5; /** * @internal */ const ACCESS_TYPE_METHOD = 0; /** * @internal */ const ACCESS_TYPE_PROPERTY = 1; /** * @internal */ const ACCESS_TYPE_MAGIC = 2; /** * @internal */ const ACCESS_TYPE_ADDER_AND_REMOVER = 3; /** * @internal */ const ACCESS_TYPE_NOT_FOUND = 4; /** * @var bool */ private $magicCall; /** * @var bool */ private $ignoreInvalidIndices; /** * @var array */ private $readPropertyCache = array(); /** * @var array */ private $writePropertyCache = array(); private static $previousErrorHandler = false; private static $errorHandler = array(__CLASS__, 'handleError'); private static $resultProto = array(self::VALUE => null); /** * Should not be used by application code. Use * {@link PropertyAccess::createPropertyAccessor()} instead. * * @param bool $magicCall * @param bool $throwExceptionOnInvalidIndex */ public function __construct($magicCall = false, $throwExceptionOnInvalidIndex = false) { $this->magicCall = $magicCall; $this->ignoreInvalidIndices = !$throwExceptionOnInvalidIndex; } /** * {@inheritdoc} */ public function getValue($objectOrArray, $propertyPath) { if (!$propertyPath instanceof PropertyPathInterface) { $propertyPath = new PropertyPath($propertyPath); } $zval = array( self::VALUE => $objectOrArray, ); $propertyValues = $this->readPropertiesUntil($zval, $propertyPath, $propertyPath->getLength(), $this->ignoreInvalidIndices); return $propertyValues[count($propertyValues) - 1][self::VALUE]; } /** * {@inheritdoc} */ public function setValue(&$objectOrArray, $propertyPath, $value) { if (!$propertyPath instanceof PropertyPathInterface) { $propertyPath = new PropertyPath($propertyPath); } $zval = array( self::VALUE => $objectOrArray, self::REF => &$objectOrArray, ); $propertyValues = $this->readPropertiesUntil($zval, $propertyPath, $propertyPath->getLength() - 1); $overwrite = true; try { if (PHP_VERSION_ID < 70000 && false === self::$previousErrorHandler) { self::$previousErrorHandler = set_error_handler(self::$errorHandler); } for ($i = count($propertyValues) - 1; 0 <= $i; --$i) { $zval = $propertyValues[$i]; unset($propertyValues[$i]); // You only need set value for current element if: // 1. it's the parent of the last index element // OR // 2. its child is not passed by reference // // This may avoid uncessary value setting process for array elements. // For example: // '[a][b][c]' => 'old-value' // If you want to change its value to 'new-value', // you only need set value for '[a][b][c]' and it's safe to ignore '[a][b]' and '[a]' // if ($overwrite) { $property = $propertyPath->getElement($i); if ($propertyPath->isIndex($i)) { if ($overwrite = !isset($zval[self::REF])) { $ref = &$zval[self::REF]; $ref = $zval[self::VALUE]; } $this->writeIndex($zval, $property, $value); if ($overwrite) { $zval[self::VALUE] = $zval[self::REF]; } } else { $this->writeProperty($zval, $property, $value); } // if current element is an object // OR // if current element's reference chain is not broken - current element // as well as all its ancients in the property path are all passed by reference, // then there is no need to continue the value setting process if (is_object($zval[self::VALUE]) || isset($zval[self::IS_REF_CHAINED])) { break; } } $value = $zval[self::VALUE]; } } catch (\TypeError $e) { try { self::throwInvalidArgumentException($e->getMessage(), $e->getTrace(), 0); } catch (InvalidArgumentException $e) { } } catch (\Exception $e) { } catch (\Throwable $e) { } if (PHP_VERSION_ID < 70000 && false !== self::$previousErrorHandler) { restore_error_handler(); self::$previousErrorHandler = false; } if (isset($e)) { throw $e; } } /** * @internal */ public static function handleError($type, $message, $file, $line, $context) { if (E_RECOVERABLE_ERROR === $type) { self::throwInvalidArgumentException($message, debug_backtrace(false), 1); } return null !== self::$previousErrorHandler && false !== call_user_func(self::$previousErrorHandler, $type, $message, $file, $line, $context); } private static function throwInvalidArgumentException($message, $trace, $i) { if (isset($trace[$i]['file']) && __FILE__ === $trace[$i]['file']) { $pos = strpos($message, $delim = 'must be of the type ') ?: strpos($message, $delim = 'must be an instance of '); $pos += strlen($delim); $type = $trace[$i]['args'][0]; $type = is_object($type) ? get_class($type) : gettype($type); throw new InvalidArgumentException(sprintf('Expected argument of type "%s", "%s" given', substr($message, $pos, strpos($message, ',', $pos) - $pos), $type)); } } /** * {@inheritdoc} */ public function isReadable($objectOrArray, $propertyPath) { if (!$propertyPath instanceof PropertyPathInterface) { $propertyPath = new PropertyPath($propertyPath); } try { $zval = array( self::VALUE => $objectOrArray, ); $this->readPropertiesUntil($zval, $propertyPath, $propertyPath->getLength(), $this->ignoreInvalidIndices); return true; } catch (AccessException $e) { return false; } catch (UnexpectedTypeException $e) { return false; } } /** * {@inheritdoc} */ public function isWritable($objectOrArray, $propertyPath) { if (!$propertyPath instanceof PropertyPathInterface) { $propertyPath = new PropertyPath($propertyPath); } try { $zval = array( self::VALUE => $objectOrArray, ); $propertyValues = $this->readPropertiesUntil($zval, $propertyPath, $propertyPath->getLength() - 1); for ($i = count($propertyValues) - 1; 0 <= $i; --$i) { $zval = $propertyValues[$i]; unset($propertyValues[$i]); if ($propertyPath->isIndex($i)) { if (!$zval[self::VALUE] instanceof \ArrayAccess && !is_array($zval[self::VALUE])) { return false; } } else { if (!$this->isPropertyWritable($zval[self::VALUE], $propertyPath->getElement($i))) { return false; } } if (is_object($zval[self::VALUE])) { return true; } } return true; } catch (AccessException $e) { return false; } catch (UnexpectedTypeException $e) { return false; } } /** * Reads the path from an object up to a given path index. * * @param array $zval The array containing the object or array to read from * @param PropertyPathInterface $propertyPath The property path to read * @param int $lastIndex The index up to which should be read * @param bool $ignoreInvalidIndices Whether to ignore invalid indices or throw an exception * * @return array The values read in the path * * @throws UnexpectedTypeException If a value within the path is neither object nor array. * @throws NoSuchIndexException If a non-existing index is accessed */ private function readPropertiesUntil($zval, PropertyPathInterface $propertyPath, $lastIndex, $ignoreInvalidIndices = true) { if (!is_object($zval[self::VALUE]) && !is_array($zval[self::VALUE])) { throw new UnexpectedTypeException($zval[self::VALUE], $propertyPath, 0); } // Add the root object to the list $propertyValues = array($zval); for ($i = 0; $i < $lastIndex; ++$i) { $property = $propertyPath->getElement($i); $isIndex = $propertyPath->isIndex($i); if ($isIndex) { // Create missing nested arrays on demand if (($zval[self::VALUE] instanceof \ArrayAccess && !$zval[self::VALUE]->offsetExists($property)) || (is_array($zval[self::VALUE]) && !isset($zval[self::VALUE][$property]) && !array_key_exists($property, $zval[self::VALUE])) ) { if (!$ignoreInvalidIndices) { if (!is_array($zval[self::VALUE])) { if (!$zval[self::VALUE] instanceof \Traversable) { throw new NoSuchIndexException(sprintf( 'Cannot read index "%s" while trying to traverse path "%s".', $property, (string) $propertyPath )); } $zval[self::VALUE] = iterator_to_array($zval[self::VALUE]); } throw new NoSuchIndexException(sprintf( 'Cannot read index "%s" while trying to traverse path "%s". Available indices are "%s".', $property, (string) $propertyPath, print_r(array_keys($zval[self::VALUE]), true) )); } if ($i + 1 < $propertyPath->getLength()) { if (isset($zval[self::REF])) { $zval[self::VALUE][$property] = array(); $zval[self::REF] = $zval[self::VALUE]; } else { $zval[self::VALUE] = array($property => array()); } } } $zval = $this->readIndex($zval, $property); } else { $zval = $this->readProperty($zval, $property); } // the final value of the path must not be validated if ($i + 1 < $propertyPath->getLength() && !is_object($zval[self::VALUE]) && !is_array($zval[self::VALUE])) { throw new UnexpectedTypeException($zval[self::VALUE], $propertyPath, $i + 1); } if (isset($zval[self::REF]) && (0 === $i || isset($propertyValues[$i - 1][self::IS_REF_CHAINED]))) { // Set the IS_REF_CHAINED flag to true if: // current property is passed by reference and // it is the first element in the property path or // the IS_REF_CHAINED flag of its parent element is true // Basically, this flag is true only when the reference chain from the top element to current element is not broken $zval[self::IS_REF_CHAINED] = true; } $propertyValues[] = $zval; } return $propertyValues; } /** * Reads a key from an array-like structure. * * @param array $zval The array containing the array or \ArrayAccess object to read from * @param string|int $index The key to read * * @return array The array containing the value of the key * * @throws NoSuchIndexException If the array does not implement \ArrayAccess or it is not an array */ private function readIndex($zval, $index) { if (!$zval[self::VALUE] instanceof \ArrayAccess && !is_array($zval[self::VALUE])) { throw new NoSuchIndexException(sprintf('Cannot read index "%s" from object of type "%s" because it doesn\'t implement \ArrayAccess.', $index, get_class($zval[self::VALUE]))); } $result = self::$resultProto; if (isset($zval[self::VALUE][$index])) { $result[self::VALUE] = $zval[self::VALUE][$index]; if (!isset($zval[self::REF])) { // Save creating references when doing read-only lookups } elseif (is_array($zval[self::VALUE])) { $result[self::REF] = &$zval[self::REF][$index]; } elseif (is_object($result[self::VALUE])) { $result[self::REF] = $result[self::VALUE]; } } return $result; } /** * Reads the a property from an object. * * @param array $zval The array containing the object to read from * @param string $property The property to read * * @return array The array containing the value of the property * * @throws NoSuchPropertyException If the property does not exist or is not public. */ private function readProperty($zval, $property) { if (!is_object($zval[self::VALUE])) { throw new NoSuchPropertyException(sprintf('Cannot read property "%s" from an array. Maybe you intended to write the property path as "[%s]" instead.', $property, $property)); } $result = self::$resultProto; $object = $zval[self::VALUE]; $access = $this->getReadAccessInfo(get_class($object), $property); if (self::ACCESS_TYPE_METHOD === $access[self::ACCESS_TYPE]) { $result[self::VALUE] = $object->{$access[self::ACCESS_NAME]}(); } elseif (self::ACCESS_TYPE_PROPERTY === $access[self::ACCESS_TYPE]) { $result[self::VALUE] = $object->{$access[self::ACCESS_NAME]}; if ($access[self::ACCESS_REF] && isset($zval[self::REF])) { $result[self::REF] = &$object->{$access[self::ACCESS_NAME]}; } } elseif (!$access[self::ACCESS_HAS_PROPERTY] && property_exists($object, $property)) { // Needed to support \stdClass instances. We need to explicitly // exclude $access[self::ACCESS_HAS_PROPERTY], otherwise if // a *protected* property was found on the class, property_exists() // returns true, consequently the following line will result in a // fatal error. $result[self::VALUE] = $object->$property; if (isset($zval[self::REF])) { $result[self::REF] = &$object->$property; } } elseif (self::ACCESS_TYPE_MAGIC === $access[self::ACCESS_TYPE]) { // we call the getter and hope the __call do the job $result[self::VALUE] = $object->{$access[self::ACCESS_NAME]}(); } else { throw new NoSuchPropertyException($access[self::ACCESS_NAME]); } // Objects are always passed around by reference if (isset($zval[self::REF]) && is_object($result[self::VALUE])) { $result[self::REF] = $result[self::VALUE]; } return $result; } /** * Guesses how to read the property value. * * @param string $class * @param string $property * * @return array */ private function getReadAccessInfo($class, $property) { $key = $class.'::'.$property; if (isset($this->readPropertyCache[$key])) { $access = $this->readPropertyCache[$key]; } else { $access = array(); $reflClass = new \ReflectionClass($class); $access[self::ACCESS_HAS_PROPERTY] = $reflClass->hasProperty($property); $camelProp = $this->camelize($property); $getter = 'get'.$camelProp; $getsetter = lcfirst($camelProp); // jQuery style, e.g. read: last(), write: last($item) $isser = 'is'.$camelProp; $hasser = 'has'.$camelProp; if ($reflClass->hasMethod($getter) && $reflClass->getMethod($getter)->isPublic()) { $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD; $access[self::ACCESS_NAME] = $getter; } elseif ($reflClass->hasMethod($getsetter) && $reflClass->getMethod($getsetter)->isPublic()) { $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD; $access[self::ACCESS_NAME] = $getsetter; } elseif ($reflClass->hasMethod($isser) && $reflClass->getMethod($isser)->isPublic()) { $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD; $access[self::ACCESS_NAME] = $isser; } elseif ($reflClass->hasMethod($hasser) && $reflClass->getMethod($hasser)->isPublic()) { $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD; $access[self::ACCESS_NAME] = $hasser; } elseif ($reflClass->hasMethod('__get') && $reflClass->getMethod('__get')->isPublic()) { $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_PROPERTY; $access[self::ACCESS_NAME] = $property; $access[self::ACCESS_REF] = false; } elseif ($access[self::ACCESS_HAS_PROPERTY] && $reflClass->getProperty($property)->isPublic()) { $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_PROPERTY; $access[self::ACCESS_NAME] = $property; $access[self::ACCESS_REF] = true; } elseif ($this->magicCall && $reflClass->hasMethod('__call') && $reflClass->getMethod('__call')->isPublic()) { // we call the getter and hope the __call do the job $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_MAGIC; $access[self::ACCESS_NAME] = $getter; } else { $methods = array($getter, $getsetter, $isser, $hasser, '__get'); if ($this->magicCall) { $methods[] = '__call'; } $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_NOT_FOUND; $access[self::ACCESS_NAME] = sprintf( 'Neither the property "%s" nor one of the methods "%s()" '. 'exist and have public access in class "%s".', $property, implode('()", "', $methods), $reflClass->name ); } $this->readPropertyCache[$key] = $access; } return $access; } /** * Sets the value of an index in a given array-accessible value. * * @param array $zval The array containing the array or \ArrayAccess object to write to * @param string|int $index The index to write at * @param mixed $value The value to write * * @throws NoSuchIndexException If the array does not implement \ArrayAccess or it is not an array */ private function writeIndex($zval, $index, $value) { if (!$zval[self::VALUE] instanceof \ArrayAccess && !is_array($zval[self::VALUE])) { throw new NoSuchIndexException(sprintf('Cannot modify index "%s" in object of type "%s" because it doesn\'t implement \ArrayAccess', $index, get_class($zval[self::VALUE]))); } $zval[self::REF][$index] = $value; } /** * Sets the value of a property in the given object. * * @param array $zval The array containing the object to write to * @param string $property The property to write * @param mixed $value The value to write * * @throws NoSuchPropertyException If the property does not exist or is not public. */ private function writeProperty($zval, $property, $value) { if (!is_object($zval[self::VALUE])) { throw new NoSuchPropertyException(sprintf('Cannot write property "%s" to an array. Maybe you should write the property path as "[%s]" instead?', $property, $property)); } $object = $zval[self::VALUE]; $access = $this->getWriteAccessInfo(get_class($object), $property, $value); if (self::ACCESS_TYPE_METHOD === $access[self::ACCESS_TYPE]) { $object->{$access[self::ACCESS_NAME]}($value); } elseif (self::ACCESS_TYPE_PROPERTY === $access[self::ACCESS_TYPE]) { $object->{$access[self::ACCESS_NAME]} = $value; } elseif (self::ACCESS_TYPE_ADDER_AND_REMOVER === $access[self::ACCESS_TYPE]) { $this->writeCollection($zval, $property, $value, $access[self::ACCESS_ADDER], $access[self::ACCESS_REMOVER]); } elseif (!$access[self::ACCESS_HAS_PROPERTY] && property_exists($object, $property)) { // Needed to support \stdClass instances. We need to explicitly // exclude $access[self::ACCESS_HAS_PROPERTY], otherwise if // a *protected* property was found on the class, property_exists() // returns true, consequently the following line will result in a // fatal error. $object->$property = $value; } elseif (self::ACCESS_TYPE_MAGIC === $access[self::ACCESS_TYPE]) { $object->{$access[self::ACCESS_NAME]}($value); } else { throw new NoSuchPropertyException($access[self::ACCESS_NAME]); } } /** * Adjusts a collection-valued property by calling add*() and remove*() methods. * * @param array $zval The array containing the object to write to * @param string $property The property to write * @param array|\Traversable $collection The collection to write * @param string $addMethod The add*() method * @param string $removeMethod The remove*() method */ private function writeCollection($zval, $property, $collection, $addMethod, $removeMethod) { // At this point the add and remove methods have been found $previousValue = $this->readProperty($zval, $property); $previousValue = $previousValue[self::VALUE]; if ($previousValue instanceof \Traversable) { $previousValue = iterator_to_array($previousValue); } if ($previousValue && is_array($previousValue)) { if (is_object($collection)) { $collection = iterator_to_array($collection); } foreach ($previousValue as $key => $item) { if (!in_array($item, $collection, true)) { unset($previousValue[$key]); $zval[self::VALUE]->{$removeMethod}($item); } } } else { $previousValue = false; } foreach ($collection as $item) { if (!$previousValue || !in_array($item, $previousValue, true)) { $zval[self::VALUE]->{$addMethod}($item); } } } /** * Guesses how to write the property value. * * @param string $class * @param string $property * @param mixed $value * * @return array */ private function getWriteAccessInfo($class, $property, $value) { $key = $class.'::'.$property; if (isset($this->writePropertyCache[$key])) { $access = $this->writePropertyCache[$key]; } else { $access = array(); $reflClass = new \ReflectionClass($class); $access[self::ACCESS_HAS_PROPERTY] = $reflClass->hasProperty($property); $camelized = $this->camelize($property); $singulars = (array) StringUtil::singularify($camelized); if (is_array($value) || $value instanceof \Traversable) { $methods = $this->findAdderAndRemover($reflClass, $singulars); if (null !== $methods) { $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_ADDER_AND_REMOVER; $access[self::ACCESS_ADDER] = $methods[0]; $access[self::ACCESS_REMOVER] = $methods[1]; } } if (!isset($access[self::ACCESS_TYPE])) { $setter = 'set'.$camelized; $getsetter = lcfirst($camelized); // jQuery style, e.g. read: last(), write: last($item) if ($this->isMethodAccessible($reflClass, $setter, 1)) { $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD; $access[self::ACCESS_NAME] = $setter; } elseif ($this->isMethodAccessible($reflClass, $getsetter, 1)) { $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD; $access[self::ACCESS_NAME] = $getsetter; } elseif ($this->isMethodAccessible($reflClass, '__set', 2)) { $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_PROPERTY; $access[self::ACCESS_NAME] = $property; } elseif ($access[self::ACCESS_HAS_PROPERTY] && $reflClass->getProperty($property)->isPublic()) { $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_PROPERTY; $access[self::ACCESS_NAME] = $property; } elseif ($this->magicCall && $this->isMethodAccessible($reflClass, '__call', 2)) { // we call the getter and hope the __call do the job $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_MAGIC; $access[self::ACCESS_NAME] = $setter; } elseif (null !== $methods = $this->findAdderAndRemover($reflClass, $singulars)) { $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_NOT_FOUND; $access[self::ACCESS_NAME] = sprintf( 'The property "%s" in class "%s" can be defined with the methods "%s()" but '. 'the new value must be an array or an instance of \Traversable, '. '"%s" given.', $property, $reflClass->name, implode('()", "', $methods), is_object($value) ? get_class($value) : gettype($value) ); } else { $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_NOT_FOUND; $access[self::ACCESS_NAME] = sprintf( 'Neither the property "%s" nor one of the methods %s"%s()", "%s()", '. '"__set()" or "__call()" exist and have public access in class "%s".', $property, implode('', array_map(function ($singular) { return '"add'.$singular.'()"/"remove'.$singular.'()", '; }, $singulars)), $setter, $getsetter, $reflClass->name ); } } $this->writePropertyCache[$key] = $access; } return $access; } /** * Returns whether a property is writable in the given object. * * @param object $object The object to write to * @param string $property The property to write * * @return bool Whether the property is writable */ private function isPropertyWritable($object, $property) { if (!is_object($object)) { return false; } $access = $this->getWriteAccessInfo(get_class($object), $property, array()); return self::ACCESS_TYPE_METHOD === $access[self::ACCESS_TYPE] || self::ACCESS_TYPE_PROPERTY === $access[self::ACCESS_TYPE] || self::ACCESS_TYPE_ADDER_AND_REMOVER === $access[self::ACCESS_TYPE] || (!$access[self::ACCESS_HAS_PROPERTY] && property_exists($object, $property)) || self::ACCESS_TYPE_MAGIC === $access[self::ACCESS_TYPE]; } /** * Camelizes a given string. * * @param string $string Some string * * @return string The camelized version of the string */ private function camelize($string) { return str_replace(' ', '', ucwords(str_replace('_', ' ', $string))); } /** * Searches for add and remove methods. * * @param \ReflectionClass $reflClass The reflection class for the given object * @param array $singulars The singular form of the property name or null * * @return array|null An array containing the adder and remover when found, null otherwise */ private function findAdderAndRemover(\ReflectionClass $reflClass, array $singulars) { foreach ($singulars as $singular) { $addMethod = 'add'.$singular; $removeMethod = 'remove'.$singular; $addMethodFound = $this->isMethodAccessible($reflClass, $addMethod, 1); $removeMethodFound = $this->isMethodAccessible($reflClass, $removeMethod, 1); if ($addMethodFound && $removeMethodFound) { return array($addMethod, $removeMethod); } } } /** * Returns whether a method is public and has the number of required parameters. * * @param \ReflectionClass $class The class of the method * @param string $methodName The method name * @param int $parameters The number of parameters * * @return bool Whether the method is public and has $parameters required parameters */ private function isMethodAccessible(\ReflectionClass $class, $methodName, $parameters) { if ($class->hasMethod($methodName)) { $method = $class->getMethod($methodName); if ($method->isPublic() && $method->getNumberOfRequiredParameters() <= $parameters && $method->getNumberOfParameters() >= $parameters) { return true; } } return false; } }