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

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.      */
  95.     public function __construct(int $magicMethods = self::MAGIC_GET | self::MAGIC_SET, int $throw = self::THROW_ON_INVALID_PROPERTY_PATH, CacheItemPoolInterface $cacheItemPool = null, PropertyReadInfoExtractorInterface $readInfoExtractor = null, PropertyWriteInfoExtractorInterface $writeInfoExtractor = null)
  96.     {
  97.         $this->magicMethodsFlags = $magicMethods;
  98.         $this->ignoreInvalidIndices = 0 === ($throw & self::THROW_ON_INVALID_INDEX);
  99.         $this->cacheItemPool = $cacheItemPool instanceof NullAdapter ? null : $cacheItemPool; // Replace the NullAdapter by the null value
  100.         $this->ignoreInvalidProperty = 0 === ($throw & self::THROW_ON_INVALID_PROPERTY_PATH);
  101.         $this->readInfoExtractor = $readInfoExtractor ?? new ReflectionExtractor([], null, null, false);
  102.         $this->writeInfoExtractor = $writeInfoExtractor ?? new ReflectionExtractor(['set'], null, null, false);
  103.     }
  105.     /**
  106.      * {@inheritdoc}
  107.      */
  108.     public function getValue(object|array $objectOrArray, string|PropertyPathInterface $propertyPath): mixed
  109.     {
  110.         $zval = [
  111.             self::VALUE => $objectOrArray,
  112.         ];
  114.         if (\is_object($objectOrArray) && false === strpbrk((string) $propertyPath, '.[')) {
  115.             return $this->readProperty($zval, $propertyPath, $this->ignoreInvalidProperty)[self::VALUE];
  116.         }
  118.         $propertyPath = $this->getPropertyPath($propertyPath);
  120.         $propertyValues = $this->readPropertiesUntil($zval, $propertyPath, $propertyPath->getLength(), $this->ignoreInvalidIndices);
  122.         return $propertyValues[\count($propertyValues) - 1][self::VALUE];
  123.     }
  125.     /**
  126.      * {@inheritdoc}
  127.      */
  128.     public function setValue(object|array &$objectOrArray, string|PropertyPathInterface $propertyPath, mixed $value)
  129.     {
  130.         if (\is_object($objectOrArray) && false === strpbrk((string) $propertyPath, '.[')) {
  131.             $zval = [
  132.                 self::VALUE => $objectOrArray,
  133.             ];
  135.             try {
  136.                 $this->writeProperty($zval, $propertyPath, $value);
  138.                 return;
  139.             } catch (\TypeError $e) {
  140.                 self::throwInvalidArgumentException($e->getMessage(), $e->getTrace(), 0, $propertyPath, $e);
  141.                 // It wasn't thrown in this class so rethrow it
  142.                 throw $e;
  143.             }
  144.         }
  146.         $propertyPath = $this->getPropertyPath($propertyPath);
  148.         $zval = [
  149.             self::VALUE => $objectOrArray,
  150.             self::REF => &$objectOrArray,
  151.         ];
  152.         $propertyValues = $this->readPropertiesUntil($zval, $propertyPath, $propertyPath->getLength() - 1);
  153.         $overwrite = true;
  155.         try {
  156.             for ($i = \count($propertyValues) - 1; 0 <= $i; --$i) {
  157.                 $zval = $propertyValues[$i];
  158.                 unset($propertyValues[$i]);
  160.                 // You only need set value for current element if:
  161.                 // 1. it's the parent of the last index element
  162.                 // OR
  163.                 // 2. its child is not passed by reference
  164.                 //
  165.                 // This may avoid unnecessary value setting process for array elements.
  166.                 // For example:
  167.                 // '[a][b][c]' => 'old-value'
  168.                 // If you want to change its value to 'new-value',
  169.                 // you only need set value for '[a][b][c]' and it's safe to ignore '[a][b]' and '[a]'
  170.                 if ($overwrite) {
  171.                     $property = $propertyPath->getElement($i);
  173.                     if ($propertyPath->isIndex($i)) {
  174.                         if ($overwrite = !isset($zval[self::REF])) {
  175.                             $ref = &$zval[self::REF];
  176.                             $ref = $zval[self::VALUE];
  177.                         }
  178.                         $this->writeIndex($zval, $property, $value);
  179.                         if ($overwrite) {
  180.                             $zval[self::VALUE] = $zval[self::REF];
  181.                         }
  182.                     } else {
  183.                         $this->writeProperty($zval, $property, $value);
  184.                     }
  186.                     // if current element is an object
  187.                     // OR
  188.                     // if current element's reference chain is not broken - current element
  189.                     // as well as all its ancients in the property path are all passed by reference,
  190.                     // then there is no need to continue the value setting process
  191.                     if (\is_object($zval[self::VALUE]) || isset($zval[self::IS_REF_CHAINED])) {
  192.                         break;
  193.                     }
  194.                 }
  196.                 $value = $zval[self::VALUE];
  197.             }
  198.         } catch (\TypeError $e) {
  199.             self::throwInvalidArgumentException($e->getMessage(), $e->getTrace(), 0, $propertyPath, $e);
  201.             // It wasn't thrown in this class so rethrow it
  202.             throw $e;
  203.         }
  204.     }
  206.     private static function throwInvalidArgumentException(string $message, array $trace, int $i, string $propertyPath, \Throwable $previous = null): void
  207.     {
  208.         if (!isset($trace[$i]['file']) || __FILE__ !== $trace[$i]['file']) {
  209.             return;
  210.         }
  211.         if (preg_match('/^\S+::\S+\(\): Argument #\d+ \(\$\S+\) must be of type (\S+), (\S+) given/', $message, $matches)) {
  212.             [, $expectedType, $actualType] = $matches;
  214.             throw new InvalidArgumentException(sprintf('Expected argument of type "%s", "%s" given at property path "%s".', $expectedType, 'NULL' === $actualType ? 'null' : $actualType, $propertyPath), 0, $previous);
  215.         }
  216.         if (preg_match('/^Cannot assign (\S+) to property \S+::\$\S+ of type (\S+)$/', $message, $matches)) {
  217.             [, $actualType, $expectedType] = $matches;
  219.             throw new InvalidArgumentException(sprintf('Expected argument of type "%s", "%s" given at property path "%s".', $expectedType, 'NULL' === $actualType ? 'null' : $actualType, $propertyPath), 0, $previous);
  220.         }
  221.     }
  223.     /**
  224.      * {@inheritdoc}
  225.      */
  226.     public function isReadable(object|array $objectOrArray, string|PropertyPathInterface $propertyPath): bool
  227.     {
  228.         if (!$propertyPath instanceof PropertyPathInterface) {
  229.             $propertyPath = new PropertyPath($propertyPath);
  230.         }
  232.         try {
  233.             $zval = [
  234.                 self::VALUE => $objectOrArray,
  235.             ];
  236.             $this->readPropertiesUntil($zval, $propertyPath, $propertyPath->getLength(), $this->ignoreInvalidIndices);
  238.             return true;
  239.         } catch (AccessException) {
  240.             return false;
  241.         } catch (UnexpectedTypeException) {
  242.             return false;
  243.         }
  244.     }
  246.     /**
  247.      * {@inheritdoc}
  248.      */
  249.     public function isWritable(object|array $objectOrArray, string|PropertyPathInterface $propertyPath): bool
  250.     {
  251.         $propertyPath = $this->getPropertyPath($propertyPath);
  253.         try {
  254.             $zval = [
  255.                 self::VALUE => $objectOrArray,
  256.             ];
  257.             $propertyValues = $this->readPropertiesUntil($zval, $propertyPath, $propertyPath->getLength() - 1);
  259.             for ($i = \count($propertyValues) - 1; 0 <= $i; --$i) {
  260.                 $zval = $propertyValues[$i];
  261.                 unset($propertyValues[$i]);
  263.                 if ($propertyPath->isIndex($i)) {
  264.                     if (!$zval[self::VALUE] instanceof \ArrayAccess && !\is_array($zval[self::VALUE])) {
  265.                         return false;
  266.                     }
  267.                 } elseif (!\is_object($zval[self::VALUE]) || !$this->isPropertyWritable($zval[self::VALUE], $propertyPath->getElement($i))) {
  268.                     return false;
  269.                 }
  271.                 if (\is_object($zval[self::VALUE])) {
  272.                     return true;
  273.                 }
  274.             }
  276.             return true;
  277.         } catch (AccessException) {
  278.             return false;
  279.         } catch (UnexpectedTypeException) {
  280.             return false;
  281.         }
  282.     }
  284.     /**
  285.      * Reads the path from an object up to a given path index.
  286.      *
  287.      * @throws UnexpectedTypeException if a value within the path is neither object nor array
  288.      * @throws NoSuchIndexException    If a non-existing index is accessed
  289.      */
  290.     private function readPropertiesUntil(array $zval, PropertyPathInterface $propertyPath, int $lastIndex, bool $ignoreInvalidIndices = true): array
  291.     {
  292.         if (!\is_object($zval[self::VALUE]) && !\is_array($zval[self::VALUE])) {
  293.             throw new UnexpectedTypeException($zval[self::VALUE], $propertyPath, 0);
  294.         }
  296.         // Add the root object to the list
  297.         $propertyValues = [$zval];
  299.         for ($i = 0; $i < $lastIndex; ++$i) {
  300.             $property = $propertyPath->getElement($i);
  301.             $isIndex = $propertyPath->isIndex($i);
  303.             if ($isIndex) {
  304.                 // Create missing nested arrays on demand
  305.                 if (($zval[self::VALUE] instanceof \ArrayAccess && !$zval[self::VALUE]->offsetExists($property)) ||
  306.                     (\is_array($zval[self::VALUE]) && !isset($zval[self::VALUE][$property]) && !\array_key_exists($property, $zval[self::VALUE]))
  307.                 ) {
  308.                     if (!$ignoreInvalidIndices) {
  309.                         if (!\is_array($zval[self::VALUE])) {
  310.                             if (!$zval[self::VALUE] instanceof \Traversable) {
  311.                                 throw new NoSuchIndexException(sprintf('Cannot read index "%s" while trying to traverse path "%s".', $property, (string) $propertyPath));
  312.                             }
  314.                             $zval[self::VALUE] = iterator_to_array($zval[self::VALUE]);
  315.                         }
  317.                         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)));
  318.                     }
  320.                     if ($i + 1 < $propertyPath->getLength()) {
  321.                         if (isset($zval[self::REF])) {
  322.                             $zval[self::VALUE][$property] = [];
  323.                             $zval[self::REF] = $zval[self::VALUE];
  324.                         } else {
  325.                             $zval[self::VALUE] = [$property => []];
  326.                         }
  327.                     }
  328.                 }
  330.                 $zval = $this->readIndex($zval, $property);
  331.             } else {
  332.                 $zval = $this->readProperty($zval, $property, $this->ignoreInvalidProperty);
  333.             }
  335.             // the final value of the path must not be validated
  336.             if ($i + 1 < $propertyPath->getLength() && !\is_object($zval[self::VALUE]) && !\is_array($zval[self::VALUE])) {
  337.                 throw new UnexpectedTypeException($zval[self::VALUE], $propertyPath, $i + 1);
  338.             }
  340.             if (isset($zval[self::REF]) && (0 === $i || isset($propertyValues[$i - 1][self::IS_REF_CHAINED]))) {
  341.                 // Set the IS_REF_CHAINED flag to true if:
  342.                 // current property is passed by reference and
  343.                 // it is the first element in the property path or
  344.                 // the IS_REF_CHAINED flag of its parent element is true
  345.                 // Basically, this flag is true only when the reference chain from the top element to current element is not broken
  346.                 $zval[self::IS_REF_CHAINED] = true;
  347.             }
  349.             $propertyValues[] = $zval;
  350.         }
  352.         return $propertyValues;
  353.     }
  355.     /**
  356.      * Reads a key from an array-like structure.
  357.      *
  358.      * @throws NoSuchIndexException If the array does not implement \ArrayAccess or it is not an array
  359.      */
  360.     private function readIndex(array $zval, string|int $index): array
  361.     {
  362.         if (!$zval[self::VALUE] instanceof \ArrayAccess && !\is_array($zval[self::VALUE])) {
  363.             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])));
  364.         }
  366.         $result = self::RESULT_PROTO;
  368.         if (isset($zval[self::VALUE][$index])) {
  369.             $result[self::VALUE] = $zval[self::VALUE][$index];
  371.             if (!isset($zval[self::REF])) {
  372.                 // Save creating references when doing read-only lookups
  373.             } elseif (\is_array($zval[self::VALUE])) {
  374.                 $result[self::REF] = &$zval[self::REF][$index];
  375.             } elseif (\is_object($result[self::VALUE])) {
  376.                 $result[self::REF] = $result[self::VALUE];
  377.             }
  378.         }
  380.         return $result;
  381.     }
  383.     /**
  384.      * Reads the value of a property from an object.
  385.      *
  386.      * @throws NoSuchPropertyException If $ignoreInvalidProperty is false and the property does not exist or is not public
  387.      */
  388.     private function readProperty(array $zval, string $property, bool $ignoreInvalidProperty = false): array
  389.     {
  390.         if (!\is_object($zval[self::VALUE])) {
  391.             throw new NoSuchPropertyException(sprintf('Cannot read property "%s" from an array. Maybe you intended to write the property path as "[%1$s]" instead.', $property));
  392.         }
  394.         $result = self::RESULT_PROTO;
  395.         $object = $zval[self::VALUE];
  396.         $class = \get_class($object);
  397.         $access = $this->getReadInfo($class, $property);
  399.         if (null !== $access) {
  400.             $name = $access->getName();
  401.             $type = $access->getType();
  403.             try {
  404.                 if (PropertyReadInfo::TYPE_METHOD === $type) {
  405.                     try {
  406.                         $result[self::VALUE] = $object->$name();
  407.                     } catch (\TypeError $e) {
  408.                         [$trace] = $e->getTrace();
  410.                         // handle uninitialized properties in PHP >= 7
  411.                         if (__FILE__ === $trace['file']
  412.                             && $name === $trace['function']
  413.                             && $object instanceof $trace['class']
  414.                             && preg_match('/Return value (?:of .*::\w+\(\) )?must be of (?:the )?type (\w+), null returned$/', $e->getMessage(), $matches)
  415.                         ) {
  416.                             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);
  417.                         }
  419.                         throw $e;
  420.                     }
  421.                 } elseif (PropertyReadInfo::TYPE_PROPERTY === $type) {
  422.                     if ($access->canBeReference() && !isset($object->$name) && !\array_key_exists($name, (array) $object) && !(new \ReflectionProperty($class, $name))->hasType()) {
  423.                         throw new UninitializedPropertyException(sprintf('The property "%s::$%s" is not initialized.', $class, $name));
  424.                     }
  426.                     $result[self::VALUE] = $object->$name;
  428.                     if (isset($zval[self::REF]) && $access->canBeReference()) {
  429.                         $result[self::REF] = &$object->$name;
  430.                     }
  431.                 }
  432.             } catch (\Error $e) {
  433.                 // handle uninitialized properties in PHP >= 7.4
  434.                 if (preg_match('/^Typed property ([\w\\\\@]+)::\$(\w+) must not be accessed before initialization$/', $e->getMessage(), $matches)) {
  435.                     $r = new \ReflectionProperty(str_contains($matches[1], '@anonymous') ? $class : $matches[1], $matches[2]);
  436.                     $type = ($type = $r->getType()) instanceof \ReflectionNamedType ? $type->getName() : (string) $type;
  438.                     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);
  439.                 }
  441.                 throw $e;
  442.             }
  443.         } elseif (property_exists($object, $property) && \array_key_exists($property, (array) $object)) {
  444.             $result[self::VALUE] = $object->$property;
  445.             if (isset($zval[self::REF])) {
  446.                 $result[self::REF] = &$object->$property;
  447.             }
  448.         } elseif (!$ignoreInvalidProperty) {
  449.             throw new NoSuchPropertyException(sprintf('Can\'t get a way to read the property "%s" in class "%s".', $property, $class));
  450.         }
  452.         // Objects are always passed around by reference
  453.         if (isset($zval[self::REF]) && \is_object($result[self::VALUE])) {
  454.             $result[self::REF] = $result[self::VALUE];
  455.         }
  457.         return $result;
  458.     }
  460.     /**
  461.      * Guesses how to read the property value.
  462.      */
  463.     private function getReadInfo(string $class, string $property): ?PropertyReadInfo
  464.     {
  465.         $key = str_replace('\\', '.', $class).'..'.$property;
  467.         if (isset($this->readPropertyCache[$key])) {
  468.             return $this->readPropertyCache[$key];
  469.         }
  471.         if ($this->cacheItemPool) {
  472.             $item = $this->cacheItemPool->getItem(self::CACHE_PREFIX_READ.rawurlencode($key));
  473.             if ($item->isHit()) {
  474.                 return $this->readPropertyCache[$key] = $item->get();
  475.             }
  476.         }
  478.         $accessor = $this->readInfoExtractor->getReadInfo($class, $property, [
  479.             'enable_getter_setter_extraction' => true,
  480.             'enable_magic_methods_extraction' => $this->magicMethodsFlags,
  481.             'enable_constructor_extraction' => false,
  482.         ]);
  484.         if (isset($item)) {
  485.             $this->cacheItemPool->save($item->set($accessor));
  486.         }
  488.         return $this->readPropertyCache[$key] = $accessor;
  489.     }
  491.     /**
  492.      * Sets the value of an index in a given array-accessible value.
  493.      *
  494.      * @throws NoSuchIndexException If the array does not implement \ArrayAccess or it is not an array
  495.      */
  496.     private function writeIndex(array $zval, string|int $index, mixed $value)
  497.     {
  498.         if (!$zval[self::VALUE] instanceof \ArrayAccess && !\is_array($zval[self::VALUE])) {
  499.             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])));
  500.         }
  502.         $zval[self::REF][$index] = $value;
  503.     }
  505.     /**
  506.      * Sets the value of a property in the given object.
  507.      *
  508.      * @throws NoSuchPropertyException if the property does not exist or is not public
  509.      */
  510.     private function writeProperty(array $zval, string $property, mixed $value)
  511.     {
  512.         if (!\is_object($zval[self::VALUE])) {
  513.             throw new NoSuchPropertyException(sprintf('Cannot write property "%s" to an array. Maybe you should write the property path as "[%1$s]" instead?', $property));
  514.         }
  516.         $object = $zval[self::VALUE];
  517.         $class = \get_class($object);
  518.         $mutator = $this->getWriteInfo($class, $property, $value);
  520.         if (PropertyWriteInfo::TYPE_NONE !== $mutator->getType()) {
  521.             $type = $mutator->getType();
  523.             if (PropertyWriteInfo::TYPE_METHOD === $type) {
  524.                 $object->{$mutator->getName()}($value);
  525.             } elseif (PropertyWriteInfo::TYPE_PROPERTY === $type) {
  526.                 $object->{$mutator->getName()} = $value;
  527.             } elseif (PropertyWriteInfo::TYPE_ADDER_AND_REMOVER === $type) {
  528.                 $this->writeCollection($zval, $property, $value, $mutator->getAdderInfo(), $mutator->getRemoverInfo());
  529.             }
  530.         } elseif ($object instanceof \stdClass && property_exists($object, $property)) {
  531.             $object->$property = $value;
  532.         } elseif (!$this->ignoreInvalidProperty) {
  533.             if ($mutator->hasErrors()) {
  534.                 throw new NoSuchPropertyException(implode('. ', $mutator->getErrors()).'.');
  535.             }
  537.             throw new NoSuchPropertyException(sprintf('Could not determine access type for property "%s" in class "%s".', $property, get_debug_type($object)));
  538.         }
  539.     }
  541.     /**
  542.      * Adjusts a collection-valued property by calling add*() and remove*() methods.
  543.      */
  544.     private function writeCollection(array $zval, string $property, iterable $collection, PropertyWriteInfo $addMethod, PropertyWriteInfo $removeMethod)
  545.     {
  546.         // At this point the add and remove methods have been found
  547.         $previousValue = $this->readProperty($zval, $property);
  548.         $previousValue = $previousValue[self::VALUE];
  550.         $removeMethodName = $removeMethod->getName();
  551.         $addMethodName = $addMethod->getName();
  553.         if ($previousValue instanceof \Traversable) {
  554.             $previousValue = iterator_to_array($previousValue);
  555.         }
  556.         if ($previousValue && \is_array($previousValue)) {
  557.             if (\is_object($collection)) {
  558.                 $collection = iterator_to_array($collection);
  559.             }
  560.             foreach ($previousValue as $key => $item) {
  561.                 if (!\in_array($item, $collection, true)) {
  562.                     unset($previousValue[$key]);
  563.                     $zval[self::VALUE]->$removeMethodName($item);
  564.                 }
  565.             }
  566.         } else {
  567.             $previousValue = false;
  568.         }
  570.         foreach ($collection as $item) {
  571.             if (!$previousValue || !\in_array($item, $previousValue, true)) {
  572.                 $zval[self::VALUE]->$addMethodName($item);
  573.             }
  574.         }
  575.     }
  577.     private function getWriteInfo(string $class, string $property, mixed $value): PropertyWriteInfo
  578.     {
  579.         $useAdderAndRemover = is_iterable($value);
  580.         $key = str_replace('\\', '.', $class).'..'.$property.'..'.(int) $useAdderAndRemover;
  582.         if (isset($this->writePropertyCache[$key])) {
  583.             return $this->writePropertyCache[$key];
  584.         }
  586.         if ($this->cacheItemPool) {
  587.             $item = $this->cacheItemPool->getItem(self::CACHE_PREFIX_WRITE.rawurlencode($key));
  588.             if ($item->isHit()) {
  589.                 return $this->writePropertyCache[$key] = $item->get();
  590.             }
  591.         }
  593.         $mutator = $this->writeInfoExtractor->getWriteInfo($class, $property, [
  594.             'enable_getter_setter_extraction' => true,
  595.             'enable_magic_methods_extraction' => $this->magicMethodsFlags,
  596.             'enable_constructor_extraction' => false,
  597.             'enable_adder_remover_extraction' => $useAdderAndRemover,
  598.         ]);
  600.         if (isset($item)) {
  601.             $this->cacheItemPool->save($item->set($mutator));
  602.         }
  604.         return $this->writePropertyCache[$key] = $mutator;
  605.     }
  607.     /**
  608.      * Returns whether a property is writable in the given object.
  609.      */
  610.     private function isPropertyWritable(object $object, string $property): bool
  611.     {
  612.         $mutatorForArray = $this->getWriteInfo(\get_class($object), $property, []);
  614.         if (PropertyWriteInfo::TYPE_NONE !== $mutatorForArray->getType() || ($object instanceof \stdClass && property_exists($object, $property))) {
  615.             return true;
  616.         }
  618.         $mutator = $this->getWriteInfo(\get_class($object), $property, '');
  620.         return PropertyWriteInfo::TYPE_NONE !== $mutator->getType() || ($object instanceof \stdClass && property_exists($object, $property));
  621.     }
  623.     /**
  624.      * Gets a PropertyPath instance and caches it.
  625.      */
  626.     private function getPropertyPath(string|PropertyPath $propertyPath): PropertyPath
  627.     {
  628.         if ($propertyPath instanceof PropertyPathInterface) {
  629.             // Don't call the copy constructor has it is not needed here
  630.             return $propertyPath;
  631.         }
  633.         if (isset($this->propertyPathCache[$propertyPath])) {
  634.             return $this->propertyPathCache[$propertyPath];
  635.         }
  637.         if ($this->cacheItemPool) {
  638.             $item = $this->cacheItemPool->getItem(self::CACHE_PREFIX_PROPERTY_PATH.rawurlencode($propertyPath));
  639.             if ($item->isHit()) {
  640.                 return $this->propertyPathCache[$propertyPath] = $item->get();
  641.             }
  642.         }
  644.         $propertyPathInstance = new PropertyPath($propertyPath);
  645.         if (isset($item)) {
  646.             $item->set($propertyPathInstance);
  647.             $this->cacheItemPool->save($item);
  648.         }
  650.         return $this->propertyPathCache[$propertyPath] = $propertyPathInstance;
  651.     }
  653.     /**
  654.      * Creates the APCu adapter if applicable.
  655.      *
  656.      * @throws \LogicException When the Cache Component isn't available
  657.      */
  658.     public static function createCache(string $namespace, int $defaultLifetime, string $version, LoggerInterface $logger = null): AdapterInterface
  659.     {
  660.         if (!class_exists(ApcuAdapter::class)) {
  661.             throw new \LogicException(sprintf('The Symfony Cache component must be installed to use "%s()".', __METHOD__));
  662.         }
  664.         if (!ApcuAdapter::isSupported()) {
  665.             return new NullAdapter();
  666.         }
  668.         $apcu = new ApcuAdapter($namespace, $defaultLifetime / 5, $version);
  669.         if ('cli' === \PHP_SAPI && !filter_var(\ini_get('apc.enable_cli'), \FILTER_VALIDATE_BOOLEAN)) {
  670.             $apcu->setLogger(new NullLogger());
  671.         } elseif (null !== $logger) {
  672.             $apcu->setLogger($logger);
  673.         }
  675.         return $apcu;
  676.     }
  677. }