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

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\Inflector\Inflector;
  21. use Symfony\Component\PropertyAccess\Exception\AccessException;
  22. use Symfony\Component\PropertyAccess\Exception\InvalidArgumentException;
  23. use Symfony\Component\PropertyAccess\Exception\NoSuchIndexException;
  24. use Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException;
  25. use Symfony\Component\PropertyAccess\Exception\UnexpectedTypeException;
  27. /**
  28.  * Default implementation of {@link PropertyAccessorInterface}.
  29.  *
  30.  * @author Bernhard Schussek <bschussek@gmail.com>
  31.  * @author Kévin Dunglas <dunglas@gmail.com>
  32.  * @author Nicolas Grekas <p@tchwork.com>
  33.  */
  34. class PropertyAccessor implements PropertyAccessorInterface
  35. {
  36.     private const VALUE = 0;
  37.     private const REF = 1;
  38.     private const IS_REF_CHAINED = 2;
  39.     private const ACCESS_HAS_PROPERTY = 0;
  40.     private const ACCESS_TYPE = 1;
  41.     private const ACCESS_NAME = 2;
  42.     private const ACCESS_REF = 3;
  43.     private const ACCESS_ADDER = 4;
  44.     private const ACCESS_REMOVER = 5;
  45.     private const ACCESS_TYPE_METHOD = 0;
  46.     private const ACCESS_TYPE_PROPERTY = 1;
  47.     private const ACCESS_TYPE_MAGIC = 2;
  48.     private const ACCESS_TYPE_ADDER_AND_REMOVER = 3;
  49.     private const ACCESS_TYPE_NOT_FOUND = 4;
  50.     private const CACHE_PREFIX_READ = 'r';
  51.     private const CACHE_PREFIX_WRITE = 'w';
  52.     private const CACHE_PREFIX_PROPERTY_PATH = 'p';
  54.     /**
  55.      * @var bool
  56.      */
  57.     private $magicCall;
  58.     private $ignoreInvalidIndices;
  59.     private $ignoreInvalidProperty;
  61.     /**
  62.      * @var CacheItemPoolInterface
  63.      */
  64.     private $cacheItemPool;
  66.     private $propertyPathCache = [];
  67.     private $readPropertyCache = [];
  68.     private $writePropertyCache = [];
  69.     private static $resultProto = [self::VALUE => null];
  71.     /**
  72.      * Should not be used by application code. Use
  73.      * {@link PropertyAccess::createPropertyAccessor()} instead.
  74.      */
  75.     public function __construct(bool $magicCall = false, bool $throwExceptionOnInvalidIndex = false, CacheItemPoolInterface $cacheItemPool = null, bool $throwExceptionOnInvalidPropertyPath = true)
  76.     {
  77.         $this->magicCall = $magicCall;
  78.         $this->ignoreInvalidIndices = !$throwExceptionOnInvalidIndex;
  79.         $this->cacheItemPool = $cacheItemPool instanceof NullAdapter ? null : $cacheItemPool; // Replace the NullAdapter by the null value
  80.         $this->ignoreInvalidProperty = !$throwExceptionOnInvalidPropertyPath;
  81.     }
  83.     /**
  84.      * {@inheritdoc}
  85.      */
  86.     public function getValue($objectOrArray, $propertyPath)
  87.     {
  88.         $zval = [
  89.             self::VALUE => $objectOrArray,
  90.         ];
  92.         if (\is_object($objectOrArray) && false === strpbrk((string) $propertyPath, '.[')) {
  93.             return $this->readProperty($zval, $propertyPath, $this->ignoreInvalidProperty)[self::VALUE];
  94.         }
  96.         $propertyPath = $this->getPropertyPath($propertyPath);
  98.         $propertyValues = $this->readPropertiesUntil($zval, $propertyPath, $propertyPath->getLength(), $this->ignoreInvalidIndices);
  100.         return $propertyValues[\count($propertyValues) - 1][self::VALUE];
  101.     }
  103.     /**
  104.      * {@inheritdoc}
  105.      */
  106.     public function setValue(&$objectOrArray, $propertyPath, $value)
  107.     {
  108.         if (\is_object($objectOrArray) && false === strpbrk((string) $propertyPath, '.[')) {
  109.             $zval = [
  110.                 self::VALUE => $objectOrArray,
  111.             ];
  113.             try {
  114.                 $this->writeProperty($zval, $propertyPath, $value);
  116.                 return;
  117.             } catch (\TypeError $e) {
  118.                 self::throwInvalidArgumentException($e->getMessage(), $e->getTrace(), 0, $propertyPath);
  119.                 // It wasn't thrown in this class so rethrow it
  120.                 throw $e;
  121.             }
  122.         }
  124.         $propertyPath = $this->getPropertyPath($propertyPath);
  126.         $zval = [
  127.             self::VALUE => $objectOrArray,
  128.             self::REF => &$objectOrArray,
  129.         ];
  130.         $propertyValues = $this->readPropertiesUntil($zval, $propertyPath, $propertyPath->getLength() - 1);
  131.         $overwrite = true;
  133.         try {
  134.             for ($i = \count($propertyValues) - 1; 0 <= $i; --$i) {
  135.                 $zval = $propertyValues[$i];
  136.                 unset($propertyValues[$i]);
  138.                 // You only need set value for current element if:
  139.                 // 1. it's the parent of the last index element
  140.                 // OR
  141.                 // 2. its child is not passed by reference
  142.                 //
  143.                 // This may avoid uncessary value setting process for array elements.
  144.                 // For example:
  145.                 // '[a][b][c]' => 'old-value'
  146.                 // If you want to change its value to 'new-value',
  147.                 // you only need set value for '[a][b][c]' and it's safe to ignore '[a][b]' and '[a]'
  148.                 if ($overwrite) {
  149.                     $property = $propertyPath->getElement($i);
  151.                     if ($propertyPath->isIndex($i)) {
  152.                         if ($overwrite = !isset($zval[self::REF])) {
  153.                             $ref = &$zval[self::REF];
  154.                             $ref = $zval[self::VALUE];
  155.                         }
  156.                         $this->writeIndex($zval, $property, $value);
  157.                         if ($overwrite) {
  158.                             $zval[self::VALUE] = $zval[self::REF];
  159.                         }
  160.                     } else {
  161.                         $this->writeProperty($zval, $property, $value);
  162.                     }
  164.                     // if current element is an object
  165.                     // OR
  166.                     // if current element's reference chain is not broken - current element
  167.                     // as well as all its ancients in the property path are all passed by reference,
  168.                     // then there is no need to continue the value setting process
  169.                     if (\is_object($zval[self::VALUE]) || isset($zval[self::IS_REF_CHAINED])) {
  170.                         break;
  171.                     }
  172.                 }
  174.                 $value = $zval[self::VALUE];
  175.             }
  176.         } catch (\TypeError $e) {
  177.             self::throwInvalidArgumentException($e->getMessage(), $e->getTrace(), 0, $propertyPath, $e);
  179.             // It wasn't thrown in this class so rethrow it
  180.             throw $e;
  181.         }
  182.     }
  184.     private static function throwInvalidArgumentException(string $message, array $trace, int $i, string $propertyPath, \Throwable $previous = null): void
  185.     {
  186.         if (!isset($trace[$i]['file']) || __FILE__ !== $trace[$i]['file']) {
  187.             return;
  188.         }
  190.         if (\PHP_VERSION_ID < 80000) {
  191.             if (0 !== strpos($message, 'Argument ')) {
  192.                 return;
  193.             }
  195.             $pos = strpos($message, $delim = 'must be of the type ') ?: (strpos($message, $delim = 'must be an instance of ') ?: strpos($message, $delim = 'must implement interface '));
  196.             $pos += \strlen($delim);
  197.             $j = strpos($message, ',', $pos);
  198.             $type = substr($message, 2 + $j, strpos($message, ' given', $j) - $j - 2);
  199.             $message = substr($message, $pos, $j - $pos);
  201.             throw new InvalidArgumentException(sprintf('Expected argument of type "%s", "%s" given at property path "%s".', $message, 'NULL' === $type ? 'null' : $type, $propertyPath), 0, $previous);
  202.         }
  204.         if (preg_match('/^\S+::\S+\(\): Argument #\d+ \(\$\S+\) must be of type (\S+), (\S+) given/', $message, $matches)) {
  205.             list(, $expectedType, $actualType) = $matches;
  207.             throw new InvalidArgumentException(sprintf('Expected argument of type "%s", "%s" given at property path "%s".', $expectedType, 'NULL' === $actualType ? 'null' : $actualType, $propertyPath), 0, $previous);
  208.         }
  209.     }
  211.     /**
  212.      * {@inheritdoc}
  213.      */
  214.     public function isReadable($objectOrArray, $propertyPath)
  215.     {
  216.         if (!$propertyPath instanceof PropertyPathInterface) {
  217.             $propertyPath = new PropertyPath($propertyPath);
  218.         }
  220.         try {
  221.             $zval = [
  222.                 self::VALUE => $objectOrArray,
  223.             ];
  224.             $this->readPropertiesUntil($zval, $propertyPath, $propertyPath->getLength(), $this->ignoreInvalidIndices);
  226.             return true;
  227.         } catch (AccessException $e) {
  228.             return false;
  229.         } catch (UnexpectedTypeException $e) {
  230.             return false;
  231.         }
  232.     }
  234.     /**
  235.      * {@inheritdoc}
  236.      */
  237.     public function isWritable($objectOrArray, $propertyPath)
  238.     {
  239.         $propertyPath = $this->getPropertyPath($propertyPath);
  241.         try {
  242.             $zval = [
  243.                 self::VALUE => $objectOrArray,
  244.             ];
  245.             $propertyValues = $this->readPropertiesUntil($zval, $propertyPath, $propertyPath->getLength() - 1);
  247.             for ($i = \count($propertyValues) - 1; 0 <= $i; --$i) {
  248.                 $zval = $propertyValues[$i];
  249.                 unset($propertyValues[$i]);
  251.                 if ($propertyPath->isIndex($i)) {
  252.                     if (!$zval[self::VALUE] instanceof \ArrayAccess && !\is_array($zval[self::VALUE])) {
  253.                         return false;
  254.                     }
  255.                 } else {
  256.                     if (!$this->isPropertyWritable($zval[self::VALUE], $propertyPath->getElement($i))) {
  257.                         return false;
  258.                     }
  259.                 }
  261.                 if (\is_object($zval[self::VALUE])) {
  262.                     return true;
  263.                 }
  264.             }
  266.             return true;
  267.         } catch (AccessException $e) {
  268.             return false;
  269.         } catch (UnexpectedTypeException $e) {
  270.             return false;
  271.         }
  272.     }
  274.     /**
  275.      * Reads the path from an object up to a given path index.
  276.      *
  277.      * @throws UnexpectedTypeException if a value within the path is neither object nor array
  278.      * @throws NoSuchIndexException    If a non-existing index is accessed
  279.      */
  280.     private function readPropertiesUntil(array $zval, PropertyPathInterface $propertyPath, int $lastIndex, bool $ignoreInvalidIndices = true): array
  281.     {
  282.         if (!\is_object($zval[self::VALUE]) && !\is_array($zval[self::VALUE])) {
  283.             throw new UnexpectedTypeException($zval[self::VALUE], $propertyPath, 0);
  284.         }
  286.         // Add the root object to the list
  287.         $propertyValues = [$zval];
  289.         for ($i = 0; $i < $lastIndex; ++$i) {
  290.             $property = $propertyPath->getElement($i);
  291.             $isIndex = $propertyPath->isIndex($i);
  293.             if ($isIndex) {
  294.                 // Create missing nested arrays on demand
  295.                 if (($zval[self::VALUE] instanceof \ArrayAccess && !$zval[self::VALUE]->offsetExists($property)) ||
  296.                     (\is_array($zval[self::VALUE]) && !isset($zval[self::VALUE][$property]) && !\array_key_exists($property, $zval[self::VALUE]))
  297.                 ) {
  298.                     if (!$ignoreInvalidIndices) {
  299.                         if (!\is_array($zval[self::VALUE])) {
  300.                             if (!$zval[self::VALUE] instanceof \Traversable) {
  301.                                 throw new NoSuchIndexException(sprintf('Cannot read index "%s" while trying to traverse path "%s".', $property, (string) $propertyPath));
  302.                             }
  304.                             $zval[self::VALUE] = iterator_to_array($zval[self::VALUE]);
  305.                         }
  307.                         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)));
  308.                     }
  310.                     if ($i + 1 < $propertyPath->getLength()) {
  311.                         if (isset($zval[self::REF])) {
  312.                             $zval[self::VALUE][$property] = [];
  313.                             $zval[self::REF] = $zval[self::VALUE];
  314.                         } else {
  315.                             $zval[self::VALUE] = [$property => []];
  316.                         }
  317.                     }
  318.                 }
  320.                 $zval = $this->readIndex($zval, $property);
  321.             } else {
  322.                 $zval = $this->readProperty($zval, $property, $this->ignoreInvalidProperty);
  323.             }
  325.             // the final value of the path must not be validated
  326.             if ($i + 1 < $propertyPath->getLength() && !\is_object($zval[self::VALUE]) && !\is_array($zval[self::VALUE])) {
  327.                 throw new UnexpectedTypeException($zval[self::VALUE], $propertyPath, $i + 1);
  328.             }
  330.             if (isset($zval[self::REF]) && (0 === $i || isset($propertyValues[$i - 1][self::IS_REF_CHAINED]))) {
  331.                 // Set the IS_REF_CHAINED flag to true if:
  332.                 // current property is passed by reference and
  333.                 // it is the first element in the property path or
  334.                 // the IS_REF_CHAINED flag of its parent element is true
  335.                 // Basically, this flag is true only when the reference chain from the top element to current element is not broken
  336.                 $zval[self::IS_REF_CHAINED] = true;
  337.             }
  339.             $propertyValues[] = $zval;
  340.         }
  342.         return $propertyValues;
  343.     }
  345.     /**
  346.      * Reads a key from an array-like structure.
  347.      *
  348.      * @param string|int $index The key to read
  349.      *
  350.      * @throws NoSuchIndexException If the array does not implement \ArrayAccess or it is not an array
  351.      */
  352.     private function readIndex(array $zval, $index): array
  353.     {
  354.         if (!$zval[self::VALUE] instanceof \ArrayAccess && !\is_array($zval[self::VALUE])) {
  355.             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])));
  356.         }
  358.         $result = self::$resultProto;
  360.         if (isset($zval[self::VALUE][$index])) {
  361.             $result[self::VALUE] = $zval[self::VALUE][$index];
  363.             if (!isset($zval[self::REF])) {
  364.                 // Save creating references when doing read-only lookups
  365.             } elseif (\is_array($zval[self::VALUE])) {
  366.                 $result[self::REF] = &$zval[self::REF][$index];
  367.             } elseif (\is_object($result[self::VALUE])) {
  368.                 $result[self::REF] = $result[self::VALUE];
  369.             }
  370.         }
  372.         return $result;
  373.     }
  375.     /**
  376.      * Reads the a property from an object.
  377.      *
  378.      * @throws NoSuchPropertyException If $ignoreInvalidProperty is false and the property does not exist or is not public
  379.      */
  380.     private function readProperty(array $zval, string $property, bool $ignoreInvalidProperty = false): array
  381.     {
  382.         if (!\is_object($zval[self::VALUE])) {
  383.             throw new NoSuchPropertyException(sprintf('Cannot read property "%s" from an array. Maybe you intended to write the property path as "[%1$s]" instead.', $property));
  384.         }
  386.         $result = self::$resultProto;
  387.         $object = $zval[self::VALUE];
  388.         $access = $this->getReadAccessInfo(\get_class($object), $property);
  390.         try {
  391.             if (self::ACCESS_TYPE_METHOD === $access[self::ACCESS_TYPE]) {
  392.                 try {
  393.                     $result[self::VALUE] = $object->{$access[self::ACCESS_NAME]}();
  394.                 } catch (\TypeError $e) {
  395.                     list($trace) = $e->getTrace();
  397.                     // handle uninitialized properties in PHP >= 7
  398.                     if (__FILE__ === $trace['file']
  399.                         && $access[self::ACCESS_NAME] === $trace['function']
  400.                         && $object instanceof $trace['class']
  401.                         && preg_match((sprintf('/Return value (?:of .*::\w+\(\) )?must be of (?:the )?type (\w+), null returned$/')), $e->getMessage(), $matches)
  402.                     ) {
  403.                         throw new AccessException(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"?', false === strpos(\get_class($object), "@anonymous\0") ? \get_class($object) : (get_parent_class($object) ?: 'class').'@anonymous', $access[self::ACCESS_NAME], $matches[1]), 0, $e);
  404.                     }
  406.                     throw $e;
  407.                 }
  408.             } elseif (self::ACCESS_TYPE_PROPERTY === $access[self::ACCESS_TYPE]) {
  409.                 $result[self::VALUE] = $object->{$access[self::ACCESS_NAME]};
  411.                 if ($access[self::ACCESS_REF] && isset($zval[self::REF])) {
  412.                     $result[self::REF] = &$object->{$access[self::ACCESS_NAME]};
  413.                 }
  414.             } elseif (!$access[self::ACCESS_HAS_PROPERTY] && property_exists($object, $property)) {
  415.                 // Needed to support \stdClass instances. We need to explicitly
  416.                 // exclude $access[self::ACCESS_HAS_PROPERTY], otherwise if
  417.                 // a *protected* property was found on the class, property_exists()
  418.                 // returns true, consequently the following line will result in a
  419.                 // fatal error.
  421.                 $result[self::VALUE] = $object->$property;
  422.                 if (isset($zval[self::REF])) {
  423.                     $result[self::REF] = &$object->$property;
  424.                 }
  425.             } elseif (self::ACCESS_TYPE_MAGIC === $access[self::ACCESS_TYPE]) {
  426.                 // we call the getter and hope the __call do the job
  427.                 $result[self::VALUE] = $object->{$access[self::ACCESS_NAME]}();
  428.             } elseif (!$ignoreInvalidProperty) {
  429.                 throw new NoSuchPropertyException($access[self::ACCESS_NAME]);
  430.             }
  431.         } catch (\Error $e) {
  432.             // handle uninitialized properties in PHP >= 7.4
  433.             if (\PHP_VERSION_ID >= 70400 && preg_match('/^Typed property ([\w\\\]+)::\$(\w+) must not be accessed before initialization$/', $e->getMessage(), $matches)) {
  434.                 $r = new \ReflectionProperty($matches[1], $matches[2]);
  435.                 $type = ($type = $r->getType()) instanceof \ReflectionNamedType ? $type->getName() : (string) $type;
  437.                 throw new AccessException(sprintf('The property "%s::$%s" is not readable because it is typed "%s". You should initialize it or declare a default value instead.', $r->getDeclaringClass()->getName(), $r->getName(), $type), 0, $e);
  438.             }
  440.             throw $e;
  441.         }
  443.         // Objects are always passed around by reference
  444.         if (isset($zval[self::REF]) && \is_object($result[self::VALUE])) {
  445.             $result[self::REF] = $result[self::VALUE];
  446.         }
  448.         return $result;
  449.     }
  451.     /**
  452.      * Guesses how to read the property value.
  453.      */
  454.     private function getReadAccessInfo(string $class, string $property): array
  455.     {
  456.         $key = str_replace('\\', '.', $class).'..'.$property;
  458.         if (isset($this->readPropertyCache[$key])) {
  459.             return $this->readPropertyCache[$key];
  460.         }
  462.         if ($this->cacheItemPool) {
  463.             $item = $this->cacheItemPool->getItem(self::CACHE_PREFIX_READ.rawurlencode($key));
  464.             if ($item->isHit()) {
  465.                 return $this->readPropertyCache[$key] = $item->get();
  466.             }
  467.         }
  469.         $access = [];
  471.         $reflClass = new \ReflectionClass($class);
  472.         $access[self::ACCESS_HAS_PROPERTY] = $reflClass->hasProperty($property);
  473.         $camelProp = $this->camelize($property);
  474.         $getter = 'get'.$camelProp;
  475.         $getsetter = lcfirst($camelProp); // jQuery style, e.g. read: last(), write: last($item)
  476.         $isser = 'is'.$camelProp;
  477.         $hasser = 'has'.$camelProp;
  478.         $canAccessor = 'can'.$camelProp;
  480.         if ($reflClass->hasMethod($getter) && $reflClass->getMethod($getter)->isPublic()) {
  481.             $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD;
  482.             $access[self::ACCESS_NAME] = $getter;
  483.         } elseif ($reflClass->hasMethod($getsetter) && $reflClass->getMethod($getsetter)->isPublic()) {
  484.             $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD;
  485.             $access[self::ACCESS_NAME] = $getsetter;
  486.         } elseif ($reflClass->hasMethod($isser) && $reflClass->getMethod($isser)->isPublic()) {
  487.             $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD;
  488.             $access[self::ACCESS_NAME] = $isser;
  489.         } elseif ($reflClass->hasMethod($hasser) && $reflClass->getMethod($hasser)->isPublic()) {
  490.             $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD;
  491.             $access[self::ACCESS_NAME] = $hasser;
  492.         } elseif ($reflClass->hasMethod($canAccessor) && $reflClass->getMethod($canAccessor)->isPublic()) {
  493.             $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD;
  494.             $access[self::ACCESS_NAME] = $canAccessor;
  495.         } elseif ($reflClass->hasMethod('__get') && $reflClass->getMethod('__get')->isPublic()) {
  496.             $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_PROPERTY;
  497.             $access[self::ACCESS_NAME] = $property;
  498.             $access[self::ACCESS_REF] = false;
  499.         } elseif ($access[self::ACCESS_HAS_PROPERTY] && $reflClass->getProperty($property)->isPublic()) {
  500.             $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_PROPERTY;
  501.             $access[self::ACCESS_NAME] = $property;
  502.             $access[self::ACCESS_REF] = true;
  503.         } elseif ($this->magicCall && $reflClass->hasMethod('__call') && $reflClass->getMethod('__call')->isPublic()) {
  504.             // we call the getter and hope the __call do the job
  505.             $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_MAGIC;
  506.             $access[self::ACCESS_NAME] = $getter;
  507.         } else {
  508.             $methods = [$getter, $getsetter, $isser, $hasser, '__get'];
  509.             if ($this->magicCall) {
  510.                 $methods[] = '__call';
  511.             }
  513.             $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_NOT_FOUND;
  514.             $access[self::ACCESS_NAME] = sprintf(
  515.                 'Neither the property "%s" nor one of the methods "%s()" '.
  516.                 'exist and have public access in class "%s".',
  517.                 $property,
  518.                 implode('()", "', $methods),
  519.                 $reflClass->name
  520.             );
  521.         }
  523.         if (isset($item)) {
  524.             $this->cacheItemPool->save($item->set($access));
  525.         }
  527.         return $this->readPropertyCache[$key] = $access;
  528.     }
  530.     /**
  531.      * Sets the value of an index in a given array-accessible value.
  532.      *
  533.      * @param string|int $index The index to write at
  534.      * @param mixed      $value The value to write
  535.      *
  536.      * @throws NoSuchIndexException If the array does not implement \ArrayAccess or it is not an array
  537.      */
  538.     private function writeIndex(array $zval, $index, $value)
  539.     {
  540.         if (!$zval[self::VALUE] instanceof \ArrayAccess && !\is_array($zval[self::VALUE])) {
  541.             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])));
  542.         }
  544.         $zval[self::REF][$index] = $value;
  545.     }
  547.     /**
  548.      * Sets the value of a property in the given object.
  549.      *
  550.      * @param mixed $value The value to write
  551.      *
  552.      * @throws NoSuchPropertyException if the property does not exist or is not public
  553.      */
  554.     private function writeProperty(array $zval, string $property, $value)
  555.     {
  556.         if (!\is_object($zval[self::VALUE])) {
  557.             throw new NoSuchPropertyException(sprintf('Cannot write property "%s" to an array. Maybe you should write the property path as "[%1$s]" instead?', $property));
  558.         }
  560.         $object = $zval[self::VALUE];
  561.         $access = $this->getWriteAccessInfo(\get_class($object), $property, $value);
  563.         if (self::ACCESS_TYPE_METHOD === $access[self::ACCESS_TYPE]) {
  564.             $object->{$access[self::ACCESS_NAME]}($value);
  565.         } elseif (self::ACCESS_TYPE_PROPERTY === $access[self::ACCESS_TYPE]) {
  566.             $object->{$access[self::ACCESS_NAME]} = $value;
  567.         } elseif (self::ACCESS_TYPE_ADDER_AND_REMOVER === $access[self::ACCESS_TYPE]) {
  568.             $this->writeCollection($zval, $property, $value, $access[self::ACCESS_ADDER], $access[self::ACCESS_REMOVER]);
  569.         } elseif (!$access[self::ACCESS_HAS_PROPERTY] && property_exists($object, $property)) {
  570.             // Needed to support \stdClass instances. We need to explicitly
  571.             // exclude $access[self::ACCESS_HAS_PROPERTY], otherwise if
  572.             // a *protected* property was found on the class, property_exists()
  573.             // returns true, consequently the following line will result in a
  574.             // fatal error.
  576.             $object->$property = $value;
  577.         } elseif (self::ACCESS_TYPE_MAGIC === $access[self::ACCESS_TYPE]) {
  578.             $object->{$access[self::ACCESS_NAME]}($value);
  579.         } elseif (self::ACCESS_TYPE_NOT_FOUND === $access[self::ACCESS_TYPE]) {
  580.             throw new NoSuchPropertyException(sprintf('Could not determine access type for property "%s" in class "%s"%s.', $property, \get_class($object), isset($access[self::ACCESS_NAME]) ? ': '.$access[self::ACCESS_NAME] : '.'));
  581.         } else {
  582.             throw new NoSuchPropertyException($access[self::ACCESS_NAME]);
  583.         }
  584.     }
  586.     /**
  587.      * Adjusts a collection-valued property by calling add*() and remove*() methods.
  588.      */
  589.     private function writeCollection(array $zval, string $property, iterable $collection, string $addMethod, string $removeMethod)
  590.     {
  591.         // At this point the add and remove methods have been found
  592.         $previousValue = $this->readProperty($zval, $property);
  593.         $previousValue = $previousValue[self::VALUE];
  595.         if ($previousValue instanceof \Traversable) {
  596.             $previousValue = iterator_to_array($previousValue);
  597.         }
  598.         if ($previousValue && \is_array($previousValue)) {
  599.             if (\is_object($collection)) {
  600.                 $collection = iterator_to_array($collection);
  601.             }
  602.             foreach ($previousValue as $key => $item) {
  603.                 if (!\in_array($item, $collection, true)) {
  604.                     unset($previousValue[$key]);
  605.                     $zval[self::VALUE]->{$removeMethod}($item);
  606.                 }
  607.             }
  608.         } else {
  609.             $previousValue = false;
  610.         }
  612.         foreach ($collection as $item) {
  613.             if (!$previousValue || !\in_array($item, $previousValue, true)) {
  614.                 $zval[self::VALUE]->{$addMethod}($item);
  615.             }
  616.         }
  617.     }
  619.     /**
  620.      * Guesses how to write the property value.
  621.      *
  622.      * @param mixed $value
  623.      */
  624.     private function getWriteAccessInfo(string $class, string $property, $value): array
  625.     {
  626.         $useAdderAndRemover = \is_array($value) || $value instanceof \Traversable;
  627.         $key = str_replace('\\', '.', $class).'..'.$property.'..'.(int) $useAdderAndRemover;
  629.         if (isset($this->writePropertyCache[$key])) {
  630.             return $this->writePropertyCache[$key];
  631.         }
  633.         if ($this->cacheItemPool) {
  634.             $item = $this->cacheItemPool->getItem(self::CACHE_PREFIX_WRITE.rawurlencode($key));
  635.             if ($item->isHit()) {
  636.                 return $this->writePropertyCache[$key] = $item->get();
  637.             }
  638.         }
  640.         $access = [];
  642.         $reflClass = new \ReflectionClass($class);
  643.         $access[self::ACCESS_HAS_PROPERTY] = $reflClass->hasProperty($property);
  644.         $camelized = $this->camelize($property);
  645.         $singulars = (array) Inflector::singularize($camelized);
  646.         $errors = [];
  648.         if ($useAdderAndRemover) {
  649.             foreach ($this->findAdderAndRemover($reflClass, $singulars) as $methods) {
  650.                 if (3 === \count($methods)) {
  651.                     $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_ADDER_AND_REMOVER;
  652.                     $access[self::ACCESS_ADDER] = $methods[self::ACCESS_ADDER];
  653.                     $access[self::ACCESS_REMOVER] = $methods[self::ACCESS_REMOVER];
  654.                     break;
  655.                 }
  657.                 if (isset($methods[self::ACCESS_ADDER])) {
  658.                     $errors[] = sprintf('The add method "%s" in class "%s" was found, but the corresponding remove method "%s" was not found', $methods['methods'][self::ACCESS_ADDER], $reflClass->name, $methods['methods'][self::ACCESS_REMOVER]);
  659.                 }
  661.                 if (isset($methods[self::ACCESS_REMOVER])) {
  662.                     $errors[] = sprintf('The remove method "%s" in class "%s" was found, but the corresponding add method "%s" was not found', $methods['methods'][self::ACCESS_REMOVER], $reflClass->name, $methods['methods'][self::ACCESS_ADDER]);
  663.                 }
  664.             }
  665.         }
  667.         if (!isset($access[self::ACCESS_TYPE])) {
  668.             $setter = 'set'.$camelized;
  669.             $getsetter = lcfirst($camelized); // jQuery style, e.g. read: last(), write: last($item)
  671.             if ($this->isMethodAccessible($reflClass, $setter, 1)) {
  672.                 $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD;
  673.                 $access[self::ACCESS_NAME] = $setter;
  674.             } elseif ($this->isMethodAccessible($reflClass, $getsetter, 1)) {
  675.                 $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD;
  676.                 $access[self::ACCESS_NAME] = $getsetter;
  677.             } elseif ($this->isMethodAccessible($reflClass, '__set', 2)) {
  678.                 $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_PROPERTY;
  679.                 $access[self::ACCESS_NAME] = $property;
  680.             } elseif ($access[self::ACCESS_HAS_PROPERTY] && $reflClass->getProperty($property)->isPublic()) {
  681.                 $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_PROPERTY;
  682.                 $access[self::ACCESS_NAME] = $property;
  683.             } elseif ($this->magicCall && $this->isMethodAccessible($reflClass, '__call', 2)) {
  684.                 // we call the getter and hope the __call do the job
  685.                 $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_MAGIC;
  686.                 $access[self::ACCESS_NAME] = $setter;
  687.             } else {
  688.                 foreach ($this->findAdderAndRemover($reflClass, $singulars) as $methods) {
  689.                     if (3 === \count($methods)) {
  690.                         $errors[] = sprintf(
  691.                             'The property "%s" in class "%s" can be defined with the methods "%s()" but '.
  692.                             'the new value must be an array or an instance of \Traversable, '.
  693.                             '"%s" given.',
  694.                             $property,
  695.                             $reflClass->name,
  696.                             implode('()", "', [$methods[self::ACCESS_ADDER], $methods[self::ACCESS_REMOVER]]),
  697.                             \is_object($value) ? \get_class($value) : \gettype($value)
  698.                         );
  699.                     }
  700.                 }
  702.                 if (!isset($access[self::ACCESS_NAME])) {
  703.                     $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_NOT_FOUND;
  705.                     $triedMethods = [
  706.                         $setter => 1,
  707.                         $getsetter => 1,
  708.                         '__set' => 2,
  709.                         '__call' => 2,
  710.                     ];
  712.                     foreach ($singulars as $singular) {
  713.                         $triedMethods['add'.$singular] = 1;
  714.                         $triedMethods['remove'.$singular] = 1;
  715.                     }
  717.                     foreach ($triedMethods as $methodName => $parameters) {
  718.                         if (!$reflClass->hasMethod($methodName)) {
  719.                             continue;
  720.                         }
  722.                         $method = $reflClass->getMethod($methodName);
  724.                         if (!$method->isPublic()) {
  725.                             $errors[] = sprintf('The method "%s" in class "%s" was found but does not have public access', $methodName, $reflClass->name);
  726.                             continue;
  727.                         }
  729.                         if ($method->getNumberOfRequiredParameters() > $parameters || $method->getNumberOfParameters() < $parameters) {
  730.                             $errors[] = sprintf('The method "%s" in class "%s" requires %d arguments, but should accept only %d', $methodName, $reflClass->name, $method->getNumberOfRequiredParameters(), $parameters);
  731.                         }
  732.                     }
  734.                     if (\count($errors)) {
  735.                         $access[self::ACCESS_NAME] = implode('. ', $errors).'.';
  736.                     } else {
  737.                         $access[self::ACCESS_NAME] = sprintf(
  738.                             'Neither the property "%s" nor one of the methods %s"%s()", "%s()", '.
  739.                             '"__set()" or "__call()" exist and have public access in class "%s".',
  740.                             $property,
  741.                             implode('', array_map(function ($singular) {
  742.                                 return '"add'.$singular.'()"/"remove'.$singular.'()", ';
  743.                             }, $singulars)),
  744.                             $setter,
  745.                             $getsetter,
  746.                             $reflClass->name
  747.                         );
  748.                     }
  749.                 }
  750.             }
  751.         }
  753.         if (isset($item)) {
  754.             $this->cacheItemPool->save($item->set($access));
  755.         }
  757.         return $this->writePropertyCache[$key] = $access;
  758.     }
  760.     /**
  761.      * Returns whether a property is writable in the given object.
  762.      *
  763.      * @param object $object The object to write to
  764.      */
  765.     private function isPropertyWritable($object, string $property): bool
  766.     {
  767.         if (!\is_object($object)) {
  768.             return false;
  769.         }
  771.         $access = $this->getWriteAccessInfo(\get_class($object), $property, []);
  773.         $isWritable = self::ACCESS_TYPE_METHOD === $access[self::ACCESS_TYPE]
  774.             || self::ACCESS_TYPE_PROPERTY === $access[self::ACCESS_TYPE]
  775.             || self::ACCESS_TYPE_ADDER_AND_REMOVER === $access[self::ACCESS_TYPE]
  776.             || (!$access[self::ACCESS_HAS_PROPERTY] && property_exists($object, $property))
  777.             || self::ACCESS_TYPE_MAGIC === $access[self::ACCESS_TYPE];
  779.         if ($isWritable) {
  780.             return true;
  781.         }
  783.         $access = $this->getWriteAccessInfo(\get_class($object), $property, '');
  785.         return self::ACCESS_TYPE_METHOD === $access[self::ACCESS_TYPE]
  786.             || self::ACCESS_TYPE_PROPERTY === $access[self::ACCESS_TYPE]
  787.             || self::ACCESS_TYPE_ADDER_AND_REMOVER === $access[self::ACCESS_TYPE]
  788.             || (!$access[self::ACCESS_HAS_PROPERTY] && property_exists($object, $property))
  789.             || self::ACCESS_TYPE_MAGIC === $access[self::ACCESS_TYPE];
  790.     }
  792.     /**
  793.      * Camelizes a given string.
  794.      */
  795.     private function camelize(string $string): string
  796.     {
  797.         return str_replace(' ', '', ucwords(str_replace('_', ' ', $string)));
  798.     }
  800.     /**
  801.      * Searches for add and remove methods.
  802.      */
  803.     private function findAdderAndRemover(\ReflectionClass $reflClass, array $singulars): iterable
  804.     {
  805.         foreach ($singulars as $singular) {
  806.             $addMethod = 'add'.$singular;
  807.             $removeMethod = 'remove'.$singular;
  808.             $result = ['methods' => [self::ACCESS_ADDER => $addMethod, self::ACCESS_REMOVER => $removeMethod]];
  810.             $addMethodFound = $this->isMethodAccessible($reflClass, $addMethod, 1);
  812.             if ($addMethodFound) {
  813.                 $result[self::ACCESS_ADDER] = $addMethod;
  814.             }
  816.             $removeMethodFound = $this->isMethodAccessible($reflClass, $removeMethod, 1);
  818.             if ($removeMethodFound) {
  819.                 $result[self::ACCESS_REMOVER] = $removeMethod;
  820.             }
  822.             yield $result;
  823.         }
  825.         return null;
  826.     }
  828.     /**
  829.      * Returns whether a method is public and has the number of required parameters.
  830.      */
  831.     private function isMethodAccessible(\ReflectionClass $class, string $methodName, int $parameters): bool
  832.     {
  833.         if ($class->hasMethod($methodName)) {
  834.             $method = $class->getMethod($methodName);
  836.             if ($method->isPublic()
  837.                 && $method->getNumberOfRequiredParameters() <= $parameters
  838.                 && $method->getNumberOfParameters() >= $parameters) {
  839.                 return true;
  840.             }
  841.         }
  843.         return false;
  844.     }
  846.     /**
  847.      * Gets a PropertyPath instance and caches it.
  848.      *
  849.      * @param string|PropertyPath $propertyPath
  850.      */
  851.     private function getPropertyPath($propertyPath): PropertyPath
  852.     {
  853.         if ($propertyPath instanceof PropertyPathInterface) {
  854.             // Don't call the copy constructor has it is not needed here
  855.             return $propertyPath;
  856.         }
  858.         if (isset($this->propertyPathCache[$propertyPath])) {
  859.             return $this->propertyPathCache[$propertyPath];
  860.         }
  862.         if ($this->cacheItemPool) {
  863.             $item = $this->cacheItemPool->getItem(self::CACHE_PREFIX_PROPERTY_PATH.rawurlencode($propertyPath));
  864.             if ($item->isHit()) {
  865.                 return $this->propertyPathCache[$propertyPath] = $item->get();
  866.             }
  867.         }
  869.         $propertyPathInstance = new PropertyPath($propertyPath);
  870.         if (isset($item)) {
  871.             $item->set($propertyPathInstance);
  872.             $this->cacheItemPool->save($item);
  873.         }
  875.         return $this->propertyPathCache[$propertyPath] = $propertyPathInstance;
  876.     }
  878.     /**
  879.      * Creates the APCu adapter if applicable.
  880.      *
  881.      * @param string $namespace
  882.      * @param int    $defaultLifetime
  883.      * @param string $version
  884.      *
  885.      * @return AdapterInterface
  886.      *
  887.      * @throws \LogicException When the Cache Component isn't available
  888.      */
  889.     public static function createCache($namespace, $defaultLifetime, $version, LoggerInterface $logger = null)
  890.     {
  891.         if (null === $defaultLifetime) {
  892.             @trigger_error(sprintf('Passing null as "$defaultLifetime" 2nd argument of the "%s()" method is deprecated since Symfony 4.4, pass 0 instead.', __METHOD__), E_USER_DEPRECATED);
  893.         }
  895.         if (!class_exists('Symfony\Component\Cache\Adapter\ApcuAdapter')) {
  896.             throw new \LogicException(sprintf('The Symfony Cache component must be installed to use "%s()".', __METHOD__));
  897.         }
  899.         if (!ApcuAdapter::isSupported()) {
  900.             return new NullAdapter();
  901.         }
  903.         $apcu = new ApcuAdapter($namespace, $defaultLifetime / 5, $version);
  904.         if ('cli' === \PHP_SAPI && !filter_var(ini_get('apc.enable_cli'), FILTER_VALIDATE_BOOLEAN)) {
  905.             $apcu->setLogger(new NullLogger());
  906.         } elseif (null !== $logger) {
  907.             $apcu->setLogger($logger);
  908.         }
  910.         return $apcu;
  911.     }
  912. }