vendor/symfony/property-access/PropertyAccessor.php line 108

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\PropertyAccess;
  14. use Psr\Cache\CacheItemPoolInterface;
  15. use Psr\Log\LoggerInterface;
  16. use Psr\Log\NullLogger;
  17. use Symfony\Component\Cache\Adapter\AdapterInterface;
  18. use Symfony\Component\Cache\Adapter\ApcuAdapter;
  19. use Symfony\Component\Cache\Adapter\NullAdapter;
  20. use Symfony\Component\PropertyAccess\Exception\AccessException;
  21. use Symfony\Component\PropertyAccess\Exception\InvalidArgumentException;
  22. use Symfony\Component\PropertyAccess\Exception\NoSuchIndexException;
  23. use Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException;
  24. use Symfony\Component\PropertyAccess\Exception\UnexpectedTypeException;
  25. use Symfony\Component\PropertyAccess\Exception\UninitializedPropertyException;
  26. use Symfony\Component\PropertyInfo\Extractor\ReflectionExtractor;
  27. use Symfony\Component\PropertyInfo\PropertyReadInfo;
  28. use Symfony\Component\PropertyInfo\PropertyReadInfoExtractorInterface;
  29. use Symfony\Component\PropertyInfo\PropertyWriteInfo;
  30. use Symfony\Component\PropertyInfo\PropertyWriteInfoExtractorInterface;
  32. /**
  33.  * Default implementation of {@link PropertyAccessorInterface}.
  34.  *
  35.  * @author Bernhard Schussek <bschussek@gmail.com>
  36.  * @author Kévin Dunglas <dunglas@gmail.com>
  37.  * @author Nicolas Grekas <p@tchwork.com>
  38.  */
  39. class PropertyAccessor implements PropertyAccessorInterface
  40. {
  41.     /** @var int Allow none of the magic methods */
  42.     public const DISALLOW_MAGIC_METHODS = ReflectionExtractor::DISALLOW_MAGIC_METHODS;
  43.     /** @var int Allow magic __get methods */
  44.     public const MAGIC_GET = ReflectionExtractor::ALLOW_MAGIC_GET;
  45.     /** @var int Allow magic __set methods */
  46.     public const MAGIC_SET = ReflectionExtractor::ALLOW_MAGIC_SET;
  47.     /** @var int Allow magic __call methods */
  48.     public const MAGIC_CALL = ReflectionExtractor::ALLOW_MAGIC_CALL;
  50.     public const DO_NOT_THROW = 0;
  51.     public const THROW_ON_INVALID_INDEX = 1;
  52.     public const THROW_ON_INVALID_PROPERTY_PATH = 2;
  54.     private const VALUE = 0;
  55.     private const REF = 1;
  56.     private const IS_REF_CHAINED = 2;
  57.     private const CACHE_PREFIX_READ = 'r';
  58.     private const CACHE_PREFIX_WRITE = 'w';
  59.     private const CACHE_PREFIX_PROPERTY_PATH = 'p';
  61.     private $magicMethodsFlags;
  62.     private $ignoreInvalidIndices;
  63.     private $ignoreInvalidProperty;
  65.     /**
  66.      * @var CacheItemPoolInterface
  67.      */
  68.     private $cacheItemPool;
  70.     private $propertyPathCache = [];
  72.     /**
  73.      * @var PropertyReadInfoExtractorInterface
  74.      */
  75.     private $readInfoExtractor;
  77.     /**
  78.      * @var PropertyWriteInfoExtractorInterface
  79.      */
  80.     private $writeInfoExtractor;
  81.     private $readPropertyCache = [];
  82.     private $writePropertyCache = [];
  83.     private const RESULT_PROTO = [self::VALUE => null];
  85.     /**
  86.      * Should not be used by application code. Use
  87.      * {@link PropertyAccess::createPropertyAccessor()} instead.
  88.      *
  89.      * @param int                                 $magicMethods       A bitwise combination of the MAGIC_* constants
  90.      *                                                                to specify the allowed magic methods (__get, __set, __call)
  91.      *                                                                or self::DISALLOW_MAGIC_METHODS for none
  92.      * @param int                                 $throw              A bitwise combination of the THROW_* constants
  93.      *                                                                to specify when exceptions should be thrown
  94.      * @param PropertyReadInfoExtractorInterface  $readInfoExtractor
  95.      * @param PropertyWriteInfoExtractorInterface $writeInfoExtractor
  96.      */
  97.     public function __construct($magicMethods = self::MAGIC_GET | self::MAGIC_SET, $throw = self::THROW_ON_INVALID_PROPERTY_PATH, ?CacheItemPoolInterface $cacheItemPool = null, $readInfoExtractor = null, $writeInfoExtractor = null)
  98.     {
  99.         if (\is_bool($magicMethods)) {
  100.             trigger_deprecation('symfony/property-access', '5.2', 'Passing a boolean as the first argument to "%s()" is deprecated. Pass a combination of bitwise flags instead (i.e an integer).', __METHOD__);
  102.             $magicMethods = ($magicMethods ? self::MAGIC_CALL : 0) | self::MAGIC_GET | self::MAGIC_SET;
  103.         } elseif (!\is_int($magicMethods)) {
  104.             throw new \TypeError(sprintf('Argument 1 passed to "%s()" must be an integer, "%s" given.', __METHOD__, get_debug_type($readInfoExtractor)));
  105.         }
  107.         if (\is_bool($throw)) {
  108.             trigger_deprecation('symfony/property-access', '5.3', 'Passing a boolean as the second argument to "%s()" is deprecated. Pass a combination of bitwise flags instead (i.e an integer).', __METHOD__);
  110.             $throw = $throw ? self::THROW_ON_INVALID_INDEX : self::DO_NOT_THROW;
  112.             if (!\is_bool($readInfoExtractor)) {
  113.                 $throw |= self::THROW_ON_INVALID_PROPERTY_PATH;
  114.             }
  115.         }
  117.         if (\is_bool($readInfoExtractor)) {
  118.             trigger_deprecation('symfony/property-access', '5.3', 'Passing a boolean as the fourth argument to "%s()" is deprecated. Pass a combination of bitwise flags as the second argument instead (i.e an integer).', __METHOD__);
  120.             if ($readInfoExtractor) {
  121.                 $throw |= self::THROW_ON_INVALID_PROPERTY_PATH;
  122.             }
  124.             $readInfoExtractor = $writeInfoExtractor;
  125.             $writeInfoExtractor = 4 < \func_num_args() ? func_get_arg(4) : null;
  126.         }
  128.         if (null !== $readInfoExtractor && !$readInfoExtractor instanceof PropertyReadInfoExtractorInterface) {
  129.             throw new \TypeError(sprintf('Argument 4 passed to "%s()" must be null or an instance of "%s", "%s" given.', __METHOD__, PropertyReadInfoExtractorInterface::class, get_debug_type($readInfoExtractor)));
  130.         }
  132.         if (null !== $writeInfoExtractor && !$writeInfoExtractor instanceof PropertyWriteInfoExtractorInterface) {
  133.             throw new \TypeError(sprintf('Argument 5 passed to "%s()" must be null or an instance of "%s", "%s" given.', __METHOD__, PropertyWriteInfoExtractorInterface::class, get_debug_type($writeInfoExtractor)));
  134.         }
  136.         $this->magicMethodsFlags = $magicMethods;
  137.         $this->ignoreInvalidIndices = 0 === ($throw & self::THROW_ON_INVALID_INDEX);
  138.         $this->cacheItemPool = $cacheItemPool instanceof NullAdapter ? null : $cacheItemPool; // Replace the NullAdapter by the null value
  139.         $this->ignoreInvalidProperty = 0 === ($throw & self::THROW_ON_INVALID_PROPERTY_PATH);
  140.         $this->readInfoExtractor = $readInfoExtractor ?? new ReflectionExtractor([], null, null, false);
  141.         $this->writeInfoExtractor = $writeInfoExtractor ?? new ReflectionExtractor(['set'], null, null, false);
  142.     }
  144.     /**
  145.      * {@inheritdoc}
  146.      */
  147.     public function getValue($objectOrArray, $propertyPath)
  148.     {
  149.         $zval = [
  150.             self::VALUE => $objectOrArray,
  151.         ];
  153.         if (\is_object($objectOrArray) && false === strpbrk((string) $propertyPath, '.[')) {
  154.             return $this->readProperty($zval, $propertyPath, $this->ignoreInvalidProperty)[self::VALUE];
  155.         }
  157.         $propertyPath = $this->getPropertyPath($propertyPath);
  159.         $propertyValues = $this->readPropertiesUntil($zval, $propertyPath, $propertyPath->getLength(), $this->ignoreInvalidIndices);
  161.         return $propertyValues[\count($propertyValues) - 1][self::VALUE];
  162.     }
  164.     /**
  165.      * {@inheritdoc}
  166.      */
  167.     public function setValue(&$objectOrArray, $propertyPath, $value)
  168.     {
  169.         if (\is_object($objectOrArray) && false === strpbrk((string) $propertyPath, '.[')) {
  170.             $zval = [
  171.                 self::VALUE => $objectOrArray,
  172.             ];
  174.             try {
  175.                 $this->writeProperty($zval, $propertyPath, $value);
  177.                 return;
  178.             } catch (\TypeError $e) {
  179.                 self::throwInvalidArgumentException($e->getMessage(), $e->getTrace(), 0, $propertyPath, $e);
  180.                 // It wasn't thrown in this class so rethrow it
  181.                 throw $e;
  182.             }
  183.         }
  185.         $propertyPath = $this->getPropertyPath($propertyPath);
  187.         $zval = [
  188.             self::VALUE => $objectOrArray,
  189.             self::REF => &$objectOrArray,
  190.         ];
  191.         $propertyValues = $this->readPropertiesUntil($zval, $propertyPath, $propertyPath->getLength() - 1);
  192.         $overwrite = true;
  194.         try {
  195.             for ($i = \count($propertyValues) - 1; 0 <= $i; --$i) {
  196.                 $zval = $propertyValues[$i];
  197.                 unset($propertyValues[$i]);
  199.                 // You only need set value for current element if:
  200.                 // 1. it's the parent of the last index element
  201.                 // OR
  202.                 // 2. its child is not passed by reference
  203.                 //
  204.                 // This may avoid unnecessary value setting process for array elements.
  205.                 // For example:
  206.                 // '[a][b][c]' => 'old-value'
  207.                 // If you want to change its value to 'new-value',
  208.                 // you only need set value for '[a][b][c]' and it's safe to ignore '[a][b]' and '[a]'
  209.                 if ($overwrite) {
  210.                     $property = $propertyPath->getElement($i);
  212.                     if ($propertyPath->isIndex($i)) {
  213.                         if ($overwrite = !isset($zval[self::REF])) {
  214.                             $ref = &$zval[self::REF];
  215.                             $ref = $zval[self::VALUE];
  216.                         }
  217.                         $this->writeIndex($zval, $property, $value);
  218.                         if ($overwrite) {
  219.                             $zval[self::VALUE] = $zval[self::REF];
  220.                         }
  221.                     } else {
  222.                         $this->writeProperty($zval, $property, $value);
  223.                     }
  225.                     // if current element is an object
  226.                     // OR
  227.                     // if current element's reference chain is not broken - current element
  228.                     // as well as all its ancients in the property path are all passed by reference,
  229.                     // then there is no need to continue the value setting process
  230.                     if (\is_object($zval[self::VALUE]) || isset($zval[self::IS_REF_CHAINED])) {
  231.                         break;
  232.                     }
  233.                 }
  235.                 $value = $zval[self::VALUE];
  236.             }
  237.         } catch (\TypeError $e) {
  238.             self::throwInvalidArgumentException($e->getMessage(), $e->getTrace(), 0, $propertyPath, $e);
  240.             // It wasn't thrown in this class so rethrow it
  241.             throw $e;
  242.         }
  243.     }
  245.     private static function throwInvalidArgumentException(string $message, array $trace, int $i, string $propertyPath, ?\Throwable $previous = null): void
  246.     {
  247.         if (!isset($trace[$i]['file']) || __FILE__ !== $trace[$i]['file']) {
  248.             return;
  249.         }
  251.         if (\PHP_VERSION_ID < 80000) {
  252.             if (preg_match('/^Typed property \S+::\$\S+ must be (\S+), (\S+) used$/', $message, $matches)) {
  253.                 [, $expectedType, $actualType] = $matches;
  255.                 throw new InvalidArgumentException(sprintf('Expected argument of type "%s", "%s" given at property path "%s".', $expectedType, 'NULL' === $actualType ? 'null' : $actualType, $propertyPath), 0, $previous);
  256.             }
  258.             if (!str_starts_with($message, 'Argument ')) {
  259.                 return;
  260.             }
  262.             $pos = strpos($message, $delim = 'must be of the type ') ?: (strpos($message, $delim = 'must be an instance of ') ?: strpos($message, $delim = 'must implement interface '));
  263.             $pos += \strlen($delim);
  264.             $j = strpos($message, ',', $pos);
  265.             $type = substr($message, 2 + $j, strpos($message, ' given', $j) - $j - 2);
  266.             $message = substr($message, $pos, $j - $pos);
  268.             throw new InvalidArgumentException(sprintf('Expected argument of type "%s", "%s" given at property path "%s".', $message, 'NULL' === $type ? 'null' : $type, $propertyPath), 0, $previous);
  269.         }
  271.         if (preg_match('/^\S+::\S+\(\): Argument #\d+ \(\$\S+\) must be of type (\S+), (\S+) given/', $message, $matches)) {
  272.             [, $expectedType, $actualType] = $matches;
  274.             throw new InvalidArgumentException(sprintf('Expected argument of type "%s", "%s" given at property path "%s".', $expectedType, 'NULL' === $actualType ? 'null' : $actualType, $propertyPath), 0, $previous);
  275.         }
  276.         if (preg_match('/^Cannot assign (\S+) to property \S+::\$\S+ of type (\S+)$/', $message, $matches)) {
  277.             [, $actualType, $expectedType] = $matches;
  279.             throw new InvalidArgumentException(sprintf('Expected argument of type "%s", "%s" given at property path "%s".', $expectedType, 'NULL' === $actualType ? 'null' : $actualType, $propertyPath), 0, $previous);
  280.         }
  281.     }
  283.     /**
  284.      * {@inheritdoc}
  285.      */
  286.     public function isReadable($objectOrArray, $propertyPath)
  287.     {
  288.         if (!$propertyPath instanceof PropertyPathInterface) {
  289.             $propertyPath = new PropertyPath($propertyPath);
  290.         }
  292.         try {
  293.             $zval = [
  294.                 self::VALUE => $objectOrArray,
  295.             ];
  296.             $this->readPropertiesUntil($zval, $propertyPath, $propertyPath->getLength(), $this->ignoreInvalidIndices);
  298.             return true;
  299.         } catch (AccessException $e) {
  300.             return false;
  301.         } catch (UnexpectedTypeException $e) {
  302.             return false;
  303.         }
  304.     }
  306.     /**
  307.      * {@inheritdoc}
  308.      */
  309.     public function isWritable($objectOrArray, $propertyPath)
  310.     {
  311.         $propertyPath = $this->getPropertyPath($propertyPath);
  313.         try {
  314.             $zval = [
  315.                 self::VALUE => $objectOrArray,
  316.             ];
  317.             $propertyValues = $this->readPropertiesUntil($zval, $propertyPath, $propertyPath->getLength() - 1);
  319.             for ($i = \count($propertyValues) - 1; 0 <= $i; --$i) {
  320.                 $zval = $propertyValues[$i];
  321.                 unset($propertyValues[$i]);
  323.                 if ($propertyPath->isIndex($i)) {
  324.                     if (!$zval[self::VALUE] instanceof \ArrayAccess && !\is_array($zval[self::VALUE])) {
  325.                         return false;
  326.                     }
  327.                 } elseif (!\is_object($zval[self::VALUE]) || !$this->isPropertyWritable($zval[self::VALUE], $propertyPath->getElement($i))) {
  328.                     return false;
  329.                 }
  331.                 if (\is_object($zval[self::VALUE])) {
  332.                     return true;
  333.                 }
  334.             }
  336.             return true;
  337.         } catch (AccessException $e) {
  338.             return false;
  339.         } catch (UnexpectedTypeException $e) {
  340.             return false;
  341.         }
  342.     }
  344.     /**
  345.      * Reads the path from an object up to a given path index.
  346.      *
  347.      * @throws UnexpectedTypeException if a value within the path is neither object nor array
  348.      * @throws NoSuchIndexException    If a non-existing index is accessed
  349.      */
  350.     private function readPropertiesUntil(array $zval, PropertyPathInterface $propertyPath, int $lastIndex, bool $ignoreInvalidIndices = true): array
  351.     {
  352.         if (!\is_object($zval[self::VALUE]) && !\is_array($zval[self::VALUE])) {
  353.             throw new UnexpectedTypeException($zval[self::VALUE], $propertyPath, 0);
  354.         }
  356.         // Add the root object to the list
  357.         $propertyValues = [$zval];
  359.         for ($i = 0; $i < $lastIndex; ++$i) {
  360.             $property = $propertyPath->getElement($i);
  361.             $isIndex = $propertyPath->isIndex($i);
  363.             if ($isIndex) {
  364.                 // Create missing nested arrays on demand
  365.                 if (($zval[self::VALUE] instanceof \ArrayAccess && !$zval[self::VALUE]->offsetExists($property)) ||
  366.                     (\is_array($zval[self::VALUE]) && !isset($zval[self::VALUE][$property]) && !\array_key_exists($property, $zval[self::VALUE]))
  367.                 ) {
  368.                     if (!$ignoreInvalidIndices) {
  369.                         if (!\is_array($zval[self::VALUE])) {
  370.                             if (!$zval[self::VALUE] instanceof \Traversable) {
  371.                                 throw new NoSuchIndexException(sprintf('Cannot read index "%s" while trying to traverse path "%s".', $property, (string) $propertyPath));
  372.                             }
  374.                             $zval[self::VALUE] = iterator_to_array($zval[self::VALUE]);
  375.                         }
  377.                         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)));
  378.                     }
  380.                     if ($i + 1 < $propertyPath->getLength()) {
  381.                         if (isset($zval[self::REF])) {
  382.                             $zval[self::VALUE][$property] = [];
  383.                             $zval[self::REF] = $zval[self::VALUE];
  384.                         } else {
  385.                             $zval[self::VALUE] = [$property => []];
  386.                         }
  387.                     }
  388.                 }
  390.                 $zval = $this->readIndex($zval, $property);
  391.             } else {
  392.                 $zval = $this->readProperty($zval, $property, $this->ignoreInvalidProperty);
  393.             }
  395.             // the final value of the path must not be validated
  396.             if ($i + 1 < $propertyPath->getLength() && !\is_object($zval[self::VALUE]) && !\is_array($zval[self::VALUE])) {
  397.                 throw new UnexpectedTypeException($zval[self::VALUE], $propertyPath, $i + 1);
  398.             }
  400.             if (isset($zval[self::REF]) && (0 === $i || isset($propertyValues[$i - 1][self::IS_REF_CHAINED]))) {
  401.                 // Set the IS_REF_CHAINED flag to true if:
  402.                 // current property is passed by reference and
  403.                 // it is the first element in the property path or
  404.                 // the IS_REF_CHAINED flag of its parent element is true
  405.                 // Basically, this flag is true only when the reference chain from the top element to current element is not broken
  406.                 $zval[self::IS_REF_CHAINED] = true;
  407.             }
  409.             $propertyValues[] = $zval;
  410.         }
  412.         return $propertyValues;
  413.     }
  415.     /**
  416.      * Reads a key from an array-like structure.
  417.      *
  418.      * @param string|int $index The key to read
  419.      *
  420.      * @throws NoSuchIndexException If the array does not implement \ArrayAccess or it is not an array
  421.      */
  422.     private function readIndex(array $zval, $index): array
  423.     {
  424.         if (!$zval[self::VALUE] instanceof \ArrayAccess && !\is_array($zval[self::VALUE])) {
  425.             throw new NoSuchIndexException(sprintf('Cannot read index "%s" from object of type "%s" because it doesn\'t implement \ArrayAccess.', $index, get_debug_type($zval[self::VALUE])));
  426.         }
  428.         $result = self::RESULT_PROTO;
  430.         if (isset($zval[self::VALUE][$index])) {
  431.             $result[self::VALUE] = $zval[self::VALUE][$index];
  433.             if (!isset($zval[self::REF])) {
  434.                 // Save creating references when doing read-only lookups
  435.             } elseif (\is_array($zval[self::VALUE])) {
  436.                 $result[self::REF] = &$zval[self::REF][$index];
  437.             } elseif (\is_object($result[self::VALUE])) {
  438.                 $result[self::REF] = $result[self::VALUE];
  439.             }
  440.         }
  442.         return $result;
  443.     }
  445.     /**
  446.      * Reads the value of a property from an object.
  447.      *
  448.      * @throws NoSuchPropertyException If $ignoreInvalidProperty is false and the property does not exist or is not public
  449.      */
  450.     private function readProperty(array $zval, string $property, bool $ignoreInvalidProperty = false): array
  451.     {
  452.         if (!\is_object($zval[self::VALUE])) {
  453.             throw new NoSuchPropertyException(sprintf('Cannot read property "%s" from an array. Maybe you intended to write the property path as "[%1$s]" instead.', $property));
  454.         }
  456.         $result = self::RESULT_PROTO;
  457.         $object = $zval[self::VALUE];
  458.         $class = \get_class($object);
  459.         $access = $this->getReadInfo($class, $property);
  461.         if (null !== $access) {
  462.             $name = $access->getName();
  463.             $type = $access->getType();
  465.             try {
  466.                 if (PropertyReadInfo::TYPE_METHOD === $type) {
  467.                     try {
  468.                         $result[self::VALUE] = $object->$name();
  469.                     } catch (\TypeError $e) {
  470.                         [$trace] = $e->getTrace();
  472.                         // handle uninitialized properties in PHP >= 7
  473.                         if (__FILE__ === ($trace['file'] ?? null)
  474.                             && $name === $trace['function']
  475.                             && $object instanceof $trace['class']
  476.                             && preg_match('/Return value (?:of .*::\w+\(\) )?must be of (?:the )?type (\w+), null returned$/', $e->getMessage(), $matches)
  477.                         ) {
  478.                             throw new UninitializedPropertyException(sprintf('The method "%s::%s()" returned "null", but expected type "%3$s". Did you forget to initialize a property or to make the return type nullable using "?%3$s"?', get_debug_type($object), $name, $matches[1]), 0, $e);
  479.                         }
  481.                         throw $e;
  482.                     }
  483.                 } elseif (PropertyReadInfo::TYPE_PROPERTY === $type) {
  484.                     if ($access->canBeReference() && !isset($object->$name) && !\array_key_exists($name, (array) $object) && (\PHP_VERSION_ID < 70400 || !(new \ReflectionProperty($class, $name))->hasType())) {
  485.                         throw new UninitializedPropertyException(sprintf('The property "%s::$%s" is not initialized.', $class, $name));
  486.                     }
  488.                     $result[self::VALUE] = $object->$name;
  490.                     if (isset($zval[self::REF]) && $access->canBeReference()) {
  491.                         $result[self::REF] = &$object->$name;
  492.                     }
  493.                 }
  494.             } catch (\Error $e) {
  495.                 // handle uninitialized properties in PHP >= 7.4
  496.                 if (\PHP_VERSION_ID >= 70400 && preg_match('/^Typed property ([\w\\\\@]+)::\$(\w+) must not be accessed before initialization$/', $e->getMessage(), $matches)) {
  497.                     $r = new \ReflectionProperty(str_contains($matches[1], '@anonymous') ? $class : $matches[1], $matches[2]);
  498.                     $type = ($type = $r->getType()) instanceof \ReflectionNamedType ? $type->getName() : (string) $type;
  500.                     throw new UninitializedPropertyException(sprintf('The property "%s::$%s" is not readable because it is typed "%s". You should initialize it or declare a default value instead.', $matches[1], $r->getName(), $type), 0, $e);
  501.                 }
  503.                 throw $e;
  504.             }
  505.         } elseif (property_exists($object, $property) && \array_key_exists($property, (array) $object)) {
  506.             $result[self::VALUE] = $object->$property;
  507.             if (isset($zval[self::REF])) {
  508.                 $result[self::REF] = &$object->$property;
  509.             }
  510.         } elseif (!$ignoreInvalidProperty) {
  511.             throw new NoSuchPropertyException(sprintf('Can\'t get a way to read the property "%s" in class "%s".', $property, $class));
  512.         }
  514.         // Objects are always passed around by reference
  515.         if (isset($zval[self::REF]) && \is_object($result[self::VALUE])) {
  516.             $result[self::REF] = $result[self::VALUE];
  517.         }
  519.         return $result;
  520.     }
  522.     /**
  523.      * Guesses how to read the property value.
  524.      */
  525.     private function getReadInfo(string $class, string $property): ?PropertyReadInfo
  526.     {
  527.         $key = str_replace('\\', '.', $class).'..'.$property;
  529.         if (isset($this->readPropertyCache[$key])) {
  530.             return $this->readPropertyCache[$key];
  531.         }
  533.         if ($this->cacheItemPool) {
  534.             $item = $this->cacheItemPool->getItem(self::CACHE_PREFIX_READ.rawurlencode($key));
  535.             if ($item->isHit()) {
  536.                 return $this->readPropertyCache[$key] = $item->get();
  537.             }
  538.         }
  540.         $accessor = $this->readInfoExtractor->getReadInfo($class, $property, [
  541.             'enable_getter_setter_extraction' => true,
  542.             'enable_magic_methods_extraction' => $this->magicMethodsFlags,
  543.             'enable_constructor_extraction' => false,
  544.         ]);
  546.         if (isset($item)) {
  547.             $this->cacheItemPool->save($item->set($accessor));
  548.         }
  550.         return $this->readPropertyCache[$key] = $accessor;
  551.     }
  553.     /**
  554.      * Sets the value of an index in a given array-accessible value.
  555.      *
  556.      * @param string|int $index The index to write at
  557.      * @param mixed      $value The value to write
  558.      *
  559.      * @throws NoSuchIndexException If the array does not implement \ArrayAccess or it is not an array
  560.      */
  561.     private function writeIndex(array $zval, $index, $value)
  562.     {
  563.         if (!$zval[self::VALUE] instanceof \ArrayAccess && !\is_array($zval[self::VALUE])) {
  564.             throw new NoSuchIndexException(sprintf('Cannot modify index "%s" in object of type "%s" because it doesn\'t implement \ArrayAccess.', $index, get_debug_type($zval[self::VALUE])));
  565.         }
  567.         $zval[self::REF][$index] = $value;
  568.     }
  570.     /**
  571.      * Sets the value of a property in the given object.
  572.      *
  573.      * @param mixed $value The value to write
  574.      *
  575.      * @throws NoSuchPropertyException if the property does not exist or is not public
  576.      */
  577.     private function writeProperty(array $zval, string $property, $value)
  578.     {
  579.         if (!\is_object($zval[self::VALUE])) {
  580.             throw new NoSuchPropertyException(sprintf('Cannot write property "%s" to an array. Maybe you should write the property path as "[%1$s]" instead?', $property));
  581.         }
  583.         $object = $zval[self::VALUE];
  584.         $class = \get_class($object);
  585.         $mutator = $this->getWriteInfo($class, $property, $value);
  587.         if (PropertyWriteInfo::TYPE_NONE !== $mutator->getType()) {
  588.             $type = $mutator->getType();
  590.             if (PropertyWriteInfo::TYPE_METHOD === $type) {
  591.                 $object->{$mutator->getName()}($value);
  592.             } elseif (PropertyWriteInfo::TYPE_PROPERTY === $type) {
  593.                 $object->{$mutator->getName()} = $value;
  594.             } elseif (PropertyWriteInfo::TYPE_ADDER_AND_REMOVER === $type) {
  595.                 $this->writeCollection($zval, $property, $value, $mutator->getAdderInfo(), $mutator->getRemoverInfo());
  596.             }
  597.         } elseif ($object instanceof \stdClass && property_exists($object, $property)) {
  598.             $object->$property = $value;
  599.         } elseif (!$this->ignoreInvalidProperty) {
  600.             if ($mutator->hasErrors()) {
  601.                 throw new NoSuchPropertyException(implode('. ', $mutator->getErrors()).'.');
  602.             }
  604.             throw new NoSuchPropertyException(sprintf('Could not determine access type for property "%s" in class "%s".', $property, get_debug_type($object)));
  605.         }
  606.     }
  608.     /**
  609.      * Adjusts a collection-valued property by calling add*() and remove*() methods.
  610.      */
  611.     private function writeCollection(array $zval, string $property, iterable $collection, PropertyWriteInfo $addMethod, PropertyWriteInfo $removeMethod)
  612.     {
  613.         // At this point the add and remove methods have been found
  614.         $previousValue = $this->readProperty($zval, $property);
  615.         $previousValue = $previousValue[self::VALUE];
  617.         $removeMethodName = $removeMethod->getName();
  618.         $addMethodName = $addMethod->getName();
  620.         if ($previousValue instanceof \Traversable) {
  621.             $previousValue = iterator_to_array($previousValue);
  622.         }
  623.         if ($previousValue && \is_array($previousValue)) {
  624.             if (\is_object($collection)) {
  625.                 $collection = iterator_to_array($collection);
  626.             }
  627.             foreach ($previousValue as $key => $item) {
  628.                 if (!\in_array($item, $collection, true)) {
  629.                     unset($previousValue[$key]);
  630.                     $zval[self::VALUE]->$removeMethodName($item);
  631.                 }
  632.             }
  633.         } else {
  634.             $previousValue = false;
  635.         }
  637.         foreach ($collection as $item) {
  638.             if (!$previousValue || !\in_array($item, $previousValue, true)) {
  639.                 $zval[self::VALUE]->$addMethodName($item);
  640.             }
  641.         }
  642.     }
  644.     private function getWriteInfo(string $class, string $property, $value): PropertyWriteInfo
  645.     {
  646.         $useAdderAndRemover = is_iterable($value);
  647.         $key = str_replace('\\', '.', $class).'..'.$property.'..'.(int) $useAdderAndRemover;
  649.         if (isset($this->writePropertyCache[$key])) {
  650.             return $this->writePropertyCache[$key];
  651.         }
  653.         if ($this->cacheItemPool) {
  654.             $item = $this->cacheItemPool->getItem(self::CACHE_PREFIX_WRITE.rawurlencode($key));
  655.             if ($item->isHit()) {
  656.                 return $this->writePropertyCache[$key] = $item->get();
  657.             }
  658.         }
  660.         $mutator = $this->writeInfoExtractor->getWriteInfo($class, $property, [
  661.             'enable_getter_setter_extraction' => true,
  662.             'enable_magic_methods_extraction' => $this->magicMethodsFlags,
  663.             'enable_constructor_extraction' => false,
  664.             'enable_adder_remover_extraction' => $useAdderAndRemover,
  665.         ]);
  667.         if (isset($item)) {
  668.             $this->cacheItemPool->save($item->set($mutator));
  669.         }
  671.         return $this->writePropertyCache[$key] = $mutator;
  672.     }
  674.     /**
  675.      * Returns whether a property is writable in the given object.
  676.      */
  677.     private function isPropertyWritable(object $object, string $property): bool
  678.     {
  679.         $mutatorForArray = $this->getWriteInfo(\get_class($object), $property, []);
  681.         if (PropertyWriteInfo::TYPE_NONE !== $mutatorForArray->getType() || ($object instanceof \stdClass && property_exists($object, $property))) {
  682.             return true;
  683.         }
  685.         $mutator = $this->getWriteInfo(\get_class($object), $property, '');
  687.         return PropertyWriteInfo::TYPE_NONE !== $mutator->getType() || ($object instanceof \stdClass && property_exists($object, $property));
  688.     }
  690.     /**
  691.      * Gets a PropertyPath instance and caches it.
  692.      *
  693.      * @param string|PropertyPath $propertyPath
  694.      */
  695.     private function getPropertyPath($propertyPath): PropertyPath
  696.     {
  697.         if ($propertyPath instanceof PropertyPathInterface) {
  698.             // Don't call the copy constructor has it is not needed here
  699.             return $propertyPath;
  700.         }
  702.         if (isset($this->propertyPathCache[$propertyPath])) {
  703.             return $this->propertyPathCache[$propertyPath];
  704.         }
  706.         if ($this->cacheItemPool) {
  707.             $item = $this->cacheItemPool->getItem(self::CACHE_PREFIX_PROPERTY_PATH.rawurlencode($propertyPath));
  708.             if ($item->isHit()) {
  709.                 return $this->propertyPathCache[$propertyPath] = $item->get();
  710.             }
  711.         }
  713.         $propertyPathInstance = new PropertyPath($propertyPath);
  714.         if (isset($item)) {
  715.             $item->set($propertyPathInstance);
  716.             $this->cacheItemPool->save($item);
  717.         }
  719.         return $this->propertyPathCache[$propertyPath] = $propertyPathInstance;
  720.     }
  722.     /**
  723.      * Creates the APCu adapter if applicable.
  724.      *
  725.      * @return AdapterInterface
  726.      *
  727.      * @throws \LogicException When the Cache Component isn't available
  728.      */
  729.     public static function createCache(string $namespace, int $defaultLifetime, string $version, ?LoggerInterface $logger = null)
  730.     {
  731.         if (!class_exists(ApcuAdapter::class)) {
  732.             throw new \LogicException(sprintf('The Symfony Cache component must be installed to use "%s()".', __METHOD__));
  733.         }
  735.         if (!ApcuAdapter::isSupported()) {
  736.             return new NullAdapter();
  737.         }
  739.         $apcu = new ApcuAdapter($namespace, $defaultLifetime / 5, $version);
  740.         if ('cli' === \PHP_SAPI && !filter_var(\ini_get('apc.enable_cli'), \FILTER_VALIDATE_BOOLEAN)) {
  741.             $apcu->setLogger(new NullLogger());
  742.         } elseif (null !== $logger) {
  743.             $apcu->setLogger($logger);
  744.         }
  746.         return $apcu;
  747.     }
  748. }