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

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);
  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): void
  185.     {
  186.         // the type mismatch is not caused by invalid arguments (but e.g. by an incompatible return type hint of the writer method)
  187.         if (0 !== strpos($message, 'Argument ')) {
  188.             return;
  189.         }
  191.         if (isset($trace[$i]['file']) && __FILE__ === $trace[$i]['file']) {
  192.             $pos = strpos($message, $delim = 'must be of the type ') ?: (strpos($message, $delim = 'must be an instance of ') ?: strpos($message, $delim = 'must implement interface '));
  193.             $pos += \strlen($delim);
  194.             $j = strpos($message, ',', $pos);
  195.             $type = substr($message, 2 + $j, strpos($message, ' given', $j) - $j - 2);
  196.             $message = substr($message, $pos, $j - $pos);
  198.             throw new InvalidArgumentException(sprintf('Expected argument of type "%s", "%s" given at property path "%s".', $message, 'NULL' === $type ? 'null' : $type, $propertyPath));
  199.         }
  200.     }
  202.     /**
  203.      * {@inheritdoc}
  204.      */
  205.     public function isReadable($objectOrArray, $propertyPath)
  206.     {
  207.         if (!$propertyPath instanceof PropertyPathInterface) {
  208.             $propertyPath = new PropertyPath($propertyPath);
  209.         }
  211.         try {
  212.             $zval = [
  213.                 self::VALUE => $objectOrArray,
  214.             ];
  215.             $this->readPropertiesUntil($zval, $propertyPath, $propertyPath->getLength(), $this->ignoreInvalidIndices);
  217.             return true;
  218.         } catch (AccessException $e) {
  219.             return false;
  220.         } catch (UnexpectedTypeException $e) {
  221.             return false;
  222.         }
  223.     }
  225.     /**
  226.      * {@inheritdoc}
  227.      */
  228.     public function isWritable($objectOrArray, $propertyPath)
  229.     {
  230.         $propertyPath = $this->getPropertyPath($propertyPath);
  232.         try {
  233.             $zval = [
  234.                 self::VALUE => $objectOrArray,
  235.             ];
  236.             $propertyValues = $this->readPropertiesUntil($zval, $propertyPath, $propertyPath->getLength() - 1);
  238.             for ($i = \count($propertyValues) - 1; 0 <= $i; --$i) {
  239.                 $zval = $propertyValues[$i];
  240.                 unset($propertyValues[$i]);
  242.                 if ($propertyPath->isIndex($i)) {
  243.                     if (!$zval[self::VALUE] instanceof \ArrayAccess && !\is_array($zval[self::VALUE])) {
  244.                         return false;
  245.                     }
  246.                 } else {
  247.                     if (!$this->isPropertyWritable($zval[self::VALUE], $propertyPath->getElement($i))) {
  248.                         return false;
  249.                     }
  250.                 }
  252.                 if (\is_object($zval[self::VALUE])) {
  253.                     return true;
  254.                 }
  255.             }
  257.             return true;
  258.         } catch (AccessException $e) {
  259.             return false;
  260.         } catch (UnexpectedTypeException $e) {
  261.             return false;
  262.         }
  263.     }
  265.     /**
  266.      * Reads the path from an object up to a given path index.
  267.      *
  268.      * @throws UnexpectedTypeException if a value within the path is neither object nor array
  269.      * @throws NoSuchIndexException    If a non-existing index is accessed
  270.      */
  271.     private function readPropertiesUntil(array $zval, PropertyPathInterface $propertyPath, int $lastIndex, bool $ignoreInvalidIndices = true): array
  272.     {
  273.         if (!\is_object($zval[self::VALUE]) && !\is_array($zval[self::VALUE])) {
  274.             throw new UnexpectedTypeException($zval[self::VALUE], $propertyPath, 0);
  275.         }
  277.         // Add the root object to the list
  278.         $propertyValues = [$zval];
  280.         for ($i = 0; $i < $lastIndex; ++$i) {
  281.             $property = $propertyPath->getElement($i);
  282.             $isIndex = $propertyPath->isIndex($i);
  284.             if ($isIndex) {
  285.                 // Create missing nested arrays on demand
  286.                 if (($zval[self::VALUE] instanceof \ArrayAccess && !$zval[self::VALUE]->offsetExists($property)) ||
  287.                     (\is_array($zval[self::VALUE]) && !isset($zval[self::VALUE][$property]) && !\array_key_exists($property, $zval[self::VALUE]))
  288.                 ) {
  289.                     if (!$ignoreInvalidIndices) {
  290.                         if (!\is_array($zval[self::VALUE])) {
  291.                             if (!$zval[self::VALUE] instanceof \Traversable) {
  292.                                 throw new NoSuchIndexException(sprintf('Cannot read index "%s" while trying to traverse path "%s".', $property, (string) $propertyPath));
  293.                             }
  295.                             $zval[self::VALUE] = iterator_to_array($zval[self::VALUE]);
  296.                         }
  298.                         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)));
  299.                     }
  301.                     if ($i + 1 < $propertyPath->getLength()) {
  302.                         if (isset($zval[self::REF])) {
  303.                             $zval[self::VALUE][$property] = [];
  304.                             $zval[self::REF] = $zval[self::VALUE];
  305.                         } else {
  306.                             $zval[self::VALUE] = [$property => []];
  307.                         }
  308.                     }
  309.                 }
  311.                 $zval = $this->readIndex($zval, $property);
  312.             } else {
  313.                 $zval = $this->readProperty($zval, $property, $this->ignoreInvalidProperty);
  314.             }
  316.             // the final value of the path must not be validated
  317.             if ($i + 1 < $propertyPath->getLength() && !\is_object($zval[self::VALUE]) && !\is_array($zval[self::VALUE])) {
  318.                 throw new UnexpectedTypeException($zval[self::VALUE], $propertyPath, $i + 1);
  319.             }
  321.             if (isset($zval[self::REF]) && (0 === $i || isset($propertyValues[$i - 1][self::IS_REF_CHAINED]))) {
  322.                 // Set the IS_REF_CHAINED flag to true if:
  323.                 // current property is passed by reference and
  324.                 // it is the first element in the property path or
  325.                 // the IS_REF_CHAINED flag of its parent element is true
  326.                 // Basically, this flag is true only when the reference chain from the top element to current element is not broken
  327.                 $zval[self::IS_REF_CHAINED] = true;
  328.             }
  330.             $propertyValues[] = $zval;
  331.         }
  333.         return $propertyValues;
  334.     }
  336.     /**
  337.      * Reads a key from an array-like structure.
  338.      *
  339.      * @param string|int $index The key to read
  340.      *
  341.      * @throws NoSuchIndexException If the array does not implement \ArrayAccess or it is not an array
  342.      */
  343.     private function readIndex(array $zval, $index): array
  344.     {
  345.         if (!$zval[self::VALUE] instanceof \ArrayAccess && !\is_array($zval[self::VALUE])) {
  346.             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])));
  347.         }
  349.         $result = self::$resultProto;
  351.         if (isset($zval[self::VALUE][$index])) {
  352.             $result[self::VALUE] = $zval[self::VALUE][$index];
  354.             if (!isset($zval[self::REF])) {
  355.                 // Save creating references when doing read-only lookups
  356.             } elseif (\is_array($zval[self::VALUE])) {
  357.                 $result[self::REF] = &$zval[self::REF][$index];
  358.             } elseif (\is_object($result[self::VALUE])) {
  359.                 $result[self::REF] = $result[self::VALUE];
  360.             }
  361.         }
  363.         return $result;
  364.     }
  366.     /**
  367.      * Reads the a property from an object.
  368.      *
  369.      * @throws NoSuchPropertyException If $ignoreInvalidProperty is false and the property does not exist or is not public
  370.      */
  371.     private function readProperty(array $zval, string $property, bool $ignoreInvalidProperty = false): array
  372.     {
  373.         if (!\is_object($zval[self::VALUE])) {
  374.             throw new NoSuchPropertyException(sprintf('Cannot read property "%s" from an array. Maybe you intended to write the property path as "[%1$s]" instead.', $property));
  375.         }
  377.         $result = self::$resultProto;
  378.         $object = $zval[self::VALUE];
  379.         $access = $this->getReadAccessInfo(\get_class($object), $property);
  381.         if (self::ACCESS_TYPE_METHOD === $access[self::ACCESS_TYPE]) {
  382.             $result[self::VALUE] = $object->{$access[self::ACCESS_NAME]}();
  383.         } elseif (self::ACCESS_TYPE_PROPERTY === $access[self::ACCESS_TYPE]) {
  384.             $result[self::VALUE] = $object->{$access[self::ACCESS_NAME]};
  386.             if ($access[self::ACCESS_REF] && isset($zval[self::REF])) {
  387.                 $result[self::REF] = &$object->{$access[self::ACCESS_NAME]};
  388.             }
  389.         } elseif (!$access[self::ACCESS_HAS_PROPERTY] && property_exists($object, $property)) {
  390.             // Needed to support \stdClass instances. We need to explicitly
  391.             // exclude $access[self::ACCESS_HAS_PROPERTY], otherwise if
  392.             // a *protected* property was found on the class, property_exists()
  393.             // returns true, consequently the following line will result in a
  394.             // fatal error.
  396.             $result[self::VALUE] = $object->$property;
  397.             if (isset($zval[self::REF])) {
  398.                 $result[self::REF] = &$object->$property;
  399.             }
  400.         } elseif (self::ACCESS_TYPE_MAGIC === $access[self::ACCESS_TYPE]) {
  401.             // we call the getter and hope the __call do the job
  402.             $result[self::VALUE] = $object->{$access[self::ACCESS_NAME]}();
  403.         } elseif (!$ignoreInvalidProperty) {
  404.             throw new NoSuchPropertyException($access[self::ACCESS_NAME]);
  405.         }
  407.         // Objects are always passed around by reference
  408.         if (isset($zval[self::REF]) && \is_object($result[self::VALUE])) {
  409.             $result[self::REF] = $result[self::VALUE];
  410.         }
  412.         return $result;
  413.     }
  415.     /**
  416.      * Guesses how to read the property value.
  417.      */
  418.     private function getReadAccessInfo(string $class, string $property): array
  419.     {
  420.         $key = str_replace('\\', '.', $class).'..'.$property;
  422.         if (isset($this->readPropertyCache[$key])) {
  423.             return $this->readPropertyCache[$key];
  424.         }
  426.         if ($this->cacheItemPool) {
  427.             $item = $this->cacheItemPool->getItem(self::CACHE_PREFIX_READ.rawurlencode($key));
  428.             if ($item->isHit()) {
  429.                 return $this->readPropertyCache[$key] = $item->get();
  430.             }
  431.         }
  433.         $access = [];
  435.         $reflClass = new \ReflectionClass($class);
  436.         $access[self::ACCESS_HAS_PROPERTY] = $reflClass->hasProperty($property);
  437.         $camelProp = $this->camelize($property);
  438.         $getter = 'get'.$camelProp;
  439.         $getsetter = lcfirst($camelProp); // jQuery style, e.g. read: last(), write: last($item)
  440.         $isser = 'is'.$camelProp;
  441.         $hasser = 'has'.$camelProp;
  442.         $canAccessor = 'can'.$camelProp;
  444.         if ($reflClass->hasMethod($getter) && $reflClass->getMethod($getter)->isPublic()) {
  445.             $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD;
  446.             $access[self::ACCESS_NAME] = $getter;
  447.         } elseif ($reflClass->hasMethod($getsetter) && $reflClass->getMethod($getsetter)->isPublic()) {
  448.             $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD;
  449.             $access[self::ACCESS_NAME] = $getsetter;
  450.         } elseif ($reflClass->hasMethod($isser) && $reflClass->getMethod($isser)->isPublic()) {
  451.             $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD;
  452.             $access[self::ACCESS_NAME] = $isser;
  453.         } elseif ($reflClass->hasMethod($hasser) && $reflClass->getMethod($hasser)->isPublic()) {
  454.             $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD;
  455.             $access[self::ACCESS_NAME] = $hasser;
  456.         } elseif ($reflClass->hasMethod($canAccessor) && $reflClass->getMethod($canAccessor)->isPublic()) {
  457.             $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD;
  458.             $access[self::ACCESS_NAME] = $canAccessor;
  459.         } elseif ($reflClass->hasMethod('__get') && $reflClass->getMethod('__get')->isPublic()) {
  460.             $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_PROPERTY;
  461.             $access[self::ACCESS_NAME] = $property;
  462.             $access[self::ACCESS_REF] = false;
  463.         } elseif ($access[self::ACCESS_HAS_PROPERTY] && $reflClass->getProperty($property)->isPublic()) {
  464.             $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_PROPERTY;
  465.             $access[self::ACCESS_NAME] = $property;
  466.             $access[self::ACCESS_REF] = true;
  467.         } elseif ($this->magicCall && $reflClass->hasMethod('__call') && $reflClass->getMethod('__call')->isPublic()) {
  468.             // we call the getter and hope the __call do the job
  469.             $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_MAGIC;
  470.             $access[self::ACCESS_NAME] = $getter;
  471.         } else {
  472.             $methods = [$getter, $getsetter, $isser, $hasser, '__get'];
  473.             if ($this->magicCall) {
  474.                 $methods[] = '__call';
  475.             }
  477.             $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_NOT_FOUND;
  478.             $access[self::ACCESS_NAME] = sprintf(
  479.                 'Neither the property "%s" nor one of the methods "%s()" '.
  480.                 'exist and have public access in class "%s".',
  481.                 $property,
  482.                 implode('()", "', $methods),
  483.                 $reflClass->name
  484.             );
  485.         }
  487.         if (isset($item)) {
  488.             $this->cacheItemPool->save($item->set($access));
  489.         }
  491.         return $this->readPropertyCache[$key] = $access;
  492.     }
  494.     /**
  495.      * Sets the value of an index in a given array-accessible value.
  496.      *
  497.      * @param string|int $index The index to write at
  498.      * @param mixed      $value The value to write
  499.      *
  500.      * @throws NoSuchIndexException If the array does not implement \ArrayAccess or it is not an array
  501.      */
  502.     private function writeIndex(array $zval, $index, $value)
  503.     {
  504.         if (!$zval[self::VALUE] instanceof \ArrayAccess && !\is_array($zval[self::VALUE])) {
  505.             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])));
  506.         }
  508.         $zval[self::REF][$index] = $value;
  509.     }
  511.     /**
  512.      * Sets the value of a property in the given object.
  513.      *
  514.      * @param mixed $value The value to write
  515.      *
  516.      * @throws NoSuchPropertyException if the property does not exist or is not public
  517.      */
  518.     private function writeProperty(array $zval, string $property, $value)
  519.     {
  520.         if (!\is_object($zval[self::VALUE])) {
  521.             throw new NoSuchPropertyException(sprintf('Cannot write property "%s" to an array. Maybe you should write the property path as "[%1$s]" instead?', $property));
  522.         }
  524.         $object = $zval[self::VALUE];
  525.         $access = $this->getWriteAccessInfo(\get_class($object), $property, $value);
  527.         if (self::ACCESS_TYPE_METHOD === $access[self::ACCESS_TYPE]) {
  528.             $object->{$access[self::ACCESS_NAME]}($value);
  529.         } elseif (self::ACCESS_TYPE_PROPERTY === $access[self::ACCESS_TYPE]) {
  530.             $object->{$access[self::ACCESS_NAME]} = $value;
  531.         } elseif (self::ACCESS_TYPE_ADDER_AND_REMOVER === $access[self::ACCESS_TYPE]) {
  532.             $this->writeCollection($zval, $property, $value, $access[self::ACCESS_ADDER], $access[self::ACCESS_REMOVER]);
  533.         } elseif (!$access[self::ACCESS_HAS_PROPERTY] && property_exists($object, $property)) {
  534.             // Needed to support \stdClass instances. We need to explicitly
  535.             // exclude $access[self::ACCESS_HAS_PROPERTY], otherwise if
  536.             // a *protected* property was found on the class, property_exists()
  537.             // returns true, consequently the following line will result in a
  538.             // fatal error.
  540.             $object->$property = $value;
  541.         } elseif (self::ACCESS_TYPE_MAGIC === $access[self::ACCESS_TYPE]) {
  542.             $object->{$access[self::ACCESS_NAME]}($value);
  543.         } elseif (self::ACCESS_TYPE_NOT_FOUND === $access[self::ACCESS_TYPE]) {
  544.             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] : '.'));
  545.         } else {
  546.             throw new NoSuchPropertyException($access[self::ACCESS_NAME]);
  547.         }
  548.     }
  550.     /**
  551.      * Adjusts a collection-valued property by calling add*() and remove*() methods.
  552.      */
  553.     private function writeCollection(array $zval, string $property, iterable $collection, string $addMethod, string $removeMethod)
  554.     {
  555.         // At this point the add and remove methods have been found
  556.         $previousValue = $this->readProperty($zval, $property);
  557.         $previousValue = $previousValue[self::VALUE];
  559.         if ($previousValue instanceof \Traversable) {
  560.             $previousValue = iterator_to_array($previousValue);
  561.         }
  562.         if ($previousValue && \is_array($previousValue)) {
  563.             if (\is_object($collection)) {
  564.                 $collection = iterator_to_array($collection);
  565.             }
  566.             foreach ($previousValue as $key => $item) {
  567.                 if (!\in_array($item, $collection, true)) {
  568.                     unset($previousValue[$key]);
  569.                     $zval[self::VALUE]->{$removeMethod}($item);
  570.                 }
  571.             }
  572.         } else {
  573.             $previousValue = false;
  574.         }
  576.         foreach ($collection as $item) {
  577.             if (!$previousValue || !\in_array($item, $previousValue, true)) {
  578.                 $zval[self::VALUE]->{$addMethod}($item);
  579.             }
  580.         }
  581.     }
  583.     /**
  584.      * Guesses how to write the property value.
  585.      *
  586.      * @param mixed $value
  587.      */
  588.     private function getWriteAccessInfo(string $class, string $property, $value): array
  589.     {
  590.         $useAdderAndRemover = \is_array($value) || $value instanceof \Traversable;
  591.         $key = str_replace('\\', '.', $class).'..'.$property.'..'.(int) $useAdderAndRemover;
  593.         if (isset($this->writePropertyCache[$key])) {
  594.             return $this->writePropertyCache[$key];
  595.         }
  597.         if ($this->cacheItemPool) {
  598.             $item = $this->cacheItemPool->getItem(self::CACHE_PREFIX_WRITE.rawurlencode($key));
  599.             if ($item->isHit()) {
  600.                 return $this->writePropertyCache[$key] = $item->get();
  601.             }
  602.         }
  604.         $access = [];
  606.         $reflClass = new \ReflectionClass($class);
  607.         $access[self::ACCESS_HAS_PROPERTY] = $reflClass->hasProperty($property);
  608.         $camelized = $this->camelize($property);
  609.         $singulars = (array) Inflector::singularize($camelized);
  610.         $errors = [];
  612.         if ($useAdderAndRemover) {
  613.             foreach ($this->findAdderAndRemover($reflClass, $singulars) as $methods) {
  614.                 if (3 === \count($methods)) {
  615.                     $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_ADDER_AND_REMOVER;
  616.                     $access[self::ACCESS_ADDER] = $methods[self::ACCESS_ADDER];
  617.                     $access[self::ACCESS_REMOVER] = $methods[self::ACCESS_REMOVER];
  618.                     break;
  619.                 }
  621.                 if (isset($methods[self::ACCESS_ADDER])) {
  622.                     $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]);
  623.                 }
  625.                 if (isset($methods[self::ACCESS_REMOVER])) {
  626.                     $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]);
  627.                 }
  628.             }
  629.         }
  631.         if (!isset($access[self::ACCESS_TYPE])) {
  632.             $setter = 'set'.$camelized;
  633.             $getsetter = lcfirst($camelized); // jQuery style, e.g. read: last(), write: last($item)
  635.             if ($this->isMethodAccessible($reflClass, $setter, 1)) {
  636.                 $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD;
  637.                 $access[self::ACCESS_NAME] = $setter;
  638.             } elseif ($this->isMethodAccessible($reflClass, $getsetter, 1)) {
  639.                 $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_METHOD;
  640.                 $access[self::ACCESS_NAME] = $getsetter;
  641.             } elseif ($this->isMethodAccessible($reflClass, '__set', 2)) {
  642.                 $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_PROPERTY;
  643.                 $access[self::ACCESS_NAME] = $property;
  644.             } elseif ($access[self::ACCESS_HAS_PROPERTY] && $reflClass->getProperty($property)->isPublic()) {
  645.                 $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_PROPERTY;
  646.                 $access[self::ACCESS_NAME] = $property;
  647.             } elseif ($this->magicCall && $this->isMethodAccessible($reflClass, '__call', 2)) {
  648.                 // we call the getter and hope the __call do the job
  649.                 $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_MAGIC;
  650.                 $access[self::ACCESS_NAME] = $setter;
  651.             } else {
  652.                 foreach ($this->findAdderAndRemover($reflClass, $singulars) as $methods) {
  653.                     if (3 === \count($methods)) {
  654.                         $errors[] = sprintf(
  655.                             'The property "%s" in class "%s" can be defined with the methods "%s()" but '.
  656.                             'the new value must be an array or an instance of \Traversable, '.
  657.                             '"%s" given.',
  658.                             $property,
  659.                             $reflClass->name,
  660.                             implode('()", "', [$methods[self::ACCESS_ADDER], $methods[self::ACCESS_REMOVER]]),
  661.                             \is_object($value) ? \get_class($value) : \gettype($value)
  662.                         );
  663.                     }
  664.                 }
  666.                 if (!isset($access[self::ACCESS_NAME])) {
  667.                     $access[self::ACCESS_TYPE] = self::ACCESS_TYPE_NOT_FOUND;
  669.                     $triedMethods = [
  670.                         $setter => 1,
  671.                         $getsetter => 1,
  672.                         '__set' => 2,
  673.                         '__call' => 2,
  674.                     ];
  676.                     foreach ($singulars as $singular) {
  677.                         $triedMethods['add'.$singular] = 1;
  678.                         $triedMethods['remove'.$singular] = 1;
  679.                     }
  681.                     foreach ($triedMethods as $methodName => $parameters) {
  682.                         if (!$reflClass->hasMethod($methodName)) {
  683.                             continue;
  684.                         }
  686.                         $method = $reflClass->getMethod($methodName);
  688.                         if (!$method->isPublic()) {
  689.                             $errors[] = sprintf('The method "%s" in class "%s" was found but does not have public access', $methodName, $reflClass->name);
  690.                             continue;
  691.                         }
  693.                         if ($method->getNumberOfRequiredParameters() > $parameters || $method->getNumberOfParameters() < $parameters) {
  694.                             $errors[] = sprintf('The method "%s" in class "%s" requires %d arguments, but should accept only %d', $methodName, $reflClass->name, $method->getNumberOfRequiredParameters(), $parameters);
  695.                         }
  696.                     }
  698.                     if (\count($errors)) {
  699.                         $access[self::ACCESS_NAME] = implode('. ', $errors).'.';
  700.                     } else {
  701.                         $access[self::ACCESS_NAME] = sprintf(
  702.                             'Neither the property "%s" nor one of the methods %s"%s()", "%s()", '.
  703.                             '"__set()" or "__call()" exist and have public access in class "%s".',
  704.                             $property,
  705.                             implode('', array_map(function ($singular) {
  706.                                 return '"add'.$singular.'()"/"remove'.$singular.'()", ';
  707.                             }, $singulars)),
  708.                             $setter,
  709.                             $getsetter,
  710.                             $reflClass->name
  711.                         );
  712.                     }
  713.                 }
  714.             }
  715.         }
  717.         if (isset($item)) {
  718.             $this->cacheItemPool->save($item->set($access));
  719.         }
  721.         return $this->writePropertyCache[$key] = $access;
  722.     }
  724.     /**
  725.      * Returns whether a property is writable in the given object.
  726.      *
  727.      * @param object $object The object to write to
  728.      */
  729.     private function isPropertyWritable($object, string $property): bool
  730.     {
  731.         if (!\is_object($object)) {
  732.             return false;
  733.         }
  735.         $access = $this->getWriteAccessInfo(\get_class($object), $property, []);
  737.         $isWritable = self::ACCESS_TYPE_METHOD === $access[self::ACCESS_TYPE]
  738.             || self::ACCESS_TYPE_PROPERTY === $access[self::ACCESS_TYPE]
  739.             || self::ACCESS_TYPE_ADDER_AND_REMOVER === $access[self::ACCESS_TYPE]
  740.             || (!$access[self::ACCESS_HAS_PROPERTY] && property_exists($object, $property))
  741.             || self::ACCESS_TYPE_MAGIC === $access[self::ACCESS_TYPE];
  743.         if ($isWritable) {
  744.             return true;
  745.         }
  747.         $access = $this->getWriteAccessInfo(\get_class($object), $property, '');
  749.         return self::ACCESS_TYPE_METHOD === $access[self::ACCESS_TYPE]
  750.             || self::ACCESS_TYPE_PROPERTY === $access[self::ACCESS_TYPE]
  751.             || self::ACCESS_TYPE_ADDER_AND_REMOVER === $access[self::ACCESS_TYPE]
  752.             || (!$access[self::ACCESS_HAS_PROPERTY] && property_exists($object, $property))
  753.             || self::ACCESS_TYPE_MAGIC === $access[self::ACCESS_TYPE];
  754.     }
  756.     /**
  757.      * Camelizes a given string.
  758.      */
  759.     private function camelize(string $string): string
  760.     {
  761.         return str_replace(' ', '', ucwords(str_replace('_', ' ', $string)));
  762.     }
  764.     /**
  765.      * Searches for add and remove methods.
  766.      */
  767.     private function findAdderAndRemover(\ReflectionClass $reflClass, array $singulars): iterable
  768.     {
  769.         foreach ($singulars as $singular) {
  770.             $addMethod = 'add'.$singular;
  771.             $removeMethod = 'remove'.$singular;
  772.             $result = ['methods' => [self::ACCESS_ADDER => $addMethod, self::ACCESS_REMOVER => $removeMethod]];
  774.             $addMethodFound = $this->isMethodAccessible($reflClass, $addMethod, 1);
  776.             if ($addMethodFound) {
  777.                 $result[self::ACCESS_ADDER] = $addMethod;
  778.             }
  780.             $removeMethodFound = $this->isMethodAccessible($reflClass, $removeMethod, 1);
  782.             if ($removeMethodFound) {
  783.                 $result[self::ACCESS_REMOVER] = $removeMethod;
  784.             }
  786.             yield $result;
  787.         }
  789.         return null;
  790.     }
  792.     /**
  793.      * Returns whether a method is public and has the number of required parameters.
  794.      */
  795.     private function isMethodAccessible(\ReflectionClass $class, string $methodName, int $parameters): bool
  796.     {
  797.         if ($class->hasMethod($methodName)) {
  798.             $method = $class->getMethod($methodName);
  800.             if ($method->isPublic()
  801.                 && $method->getNumberOfRequiredParameters() <= $parameters
  802.                 && $method->getNumberOfParameters() >= $parameters) {
  803.                 return true;
  804.             }
  805.         }
  807.         return false;
  808.     }
  810.     /**
  811.      * Gets a PropertyPath instance and caches it.
  812.      *
  813.      * @param string|PropertyPath $propertyPath
  814.      */
  815.     private function getPropertyPath($propertyPath): PropertyPath
  816.     {
  817.         if ($propertyPath instanceof PropertyPathInterface) {
  818.             // Don't call the copy constructor has it is not needed here
  819.             return $propertyPath;
  820.         }
  822.         if (isset($this->propertyPathCache[$propertyPath])) {
  823.             return $this->propertyPathCache[$propertyPath];
  824.         }
  826.         if ($this->cacheItemPool) {
  827.             $item = $this->cacheItemPool->getItem(self::CACHE_PREFIX_PROPERTY_PATH.rawurlencode($propertyPath));
  828.             if ($item->isHit()) {
  829.                 return $this->propertyPathCache[$propertyPath] = $item->get();
  830.             }
  831.         }
  833.         $propertyPathInstance = new PropertyPath($propertyPath);
  834.         if (isset($item)) {
  835.             $item->set($propertyPathInstance);
  836.             $this->cacheItemPool->save($item);
  837.         }
  839.         return $this->propertyPathCache[$propertyPath] = $propertyPathInstance;
  840.     }
  842.     /**
  843.      * Creates the APCu adapter if applicable.
  844.      *
  845.      * @param string $namespace
  846.      * @param int    $defaultLifetime
  847.      * @param string $version
  848.      *
  849.      * @return AdapterInterface
  850.      *
  851.      * @throws \LogicException When the Cache Component isn't available
  852.      */
  853.     public static function createCache($namespace, $defaultLifetime, $version, LoggerInterface $logger = null)
  854.     {
  855.         if (null === $defaultLifetime) {
  856.             @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);
  857.         }
  859.         if (!class_exists('Symfony\Component\Cache\Adapter\ApcuAdapter')) {
  860.             throw new \LogicException(sprintf('The Symfony Cache component must be installed to use %s().', __METHOD__));
  861.         }
  863.         if (!ApcuAdapter::isSupported()) {
  864.             return new NullAdapter();
  865.         }
  867.         $apcu = new ApcuAdapter($namespace, $defaultLifetime / 5, $version);
  868.         if ('cli' === \PHP_SAPI && !filter_var(ini_get('apc.enable_cli'), FILTER_VALIDATE_BOOLEAN)) {
  869.             $apcu->setLogger(new NullLogger());
  870.         } elseif (null !== $logger) {
  871.             $apcu->setLogger($logger);
  872.         }
  874.         return $apcu;
  875.     }
  876. }