vendor/symfony/property-info/Extractor/ReflectionExtractor.php line 86

  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\PropertyInfo\Extractor;
  14. use Symfony\Component\PropertyInfo\PropertyAccessExtractorInterface;
  15. use Symfony\Component\PropertyInfo\PropertyInitializableExtractorInterface;
  16. use Symfony\Component\PropertyInfo\PropertyListExtractorInterface;
  17. use Symfony\Component\PropertyInfo\PropertyReadInfo;
  18. use Symfony\Component\PropertyInfo\PropertyReadInfoExtractorInterface;
  19. use Symfony\Component\PropertyInfo\PropertyTypeExtractorInterface;
  20. use Symfony\Component\PropertyInfo\PropertyWriteInfo;
  21. use Symfony\Component\PropertyInfo\PropertyWriteInfoExtractorInterface;
  22. use Symfony\Component\PropertyInfo\Type;
  23. use Symfony\Component\String\Inflector\EnglishInflector;
  24. use Symfony\Component\String\Inflector\InflectorInterface;
  26. /**
  27.  * Extracts data using the reflection API.
  28.  *
  29.  * @author Kévin Dunglas <dunglas@gmail.com>
  30.  *
  31.  * @final
  32.  */
  33. class ReflectionExtractor implements PropertyListExtractorInterface, PropertyTypeExtractorInterface, PropertyAccessExtractorInterface, PropertyInitializableExtractorInterface, PropertyReadInfoExtractorInterface, PropertyWriteInfoExtractorInterface, ConstructorArgumentTypeExtractorInterface
  34. {
  35.     /**
  36.      * @internal
  37.      */
  38.     public static array $defaultMutatorPrefixes = ['add', 'remove', 'set'];
  40.     /**
  41.      * @internal
  42.      */
  43.     public static array $defaultAccessorPrefixes = ['get', 'is', 'has', 'can'];
  45.     /**
  46.      * @internal
  47.      */
  48.     public static array $defaultArrayMutatorPrefixes = ['add', 'remove'];
  50.     public const ALLOW_PRIVATE = 1;
  51.     public const ALLOW_PROTECTED = 2;
  52.     public const ALLOW_PUBLIC = 4;
  54.     /** @var int Allow none of the magic methods */
  55.     public const DISALLOW_MAGIC_METHODS = 0;
  56.     /** @var int Allow magic __get methods */
  57.     public const ALLOW_MAGIC_GET = 1 << 0;
  58.     /** @var int Allow magic __set methods */
  59.     public const ALLOW_MAGIC_SET = 1 << 1;
  60.     /** @var int Allow magic __call methods */
  61.     public const ALLOW_MAGIC_CALL = 1 << 2;
  63.     private const MAP_TYPES = [
  64.         'integer' => Type::BUILTIN_TYPE_INT,
  65.         'boolean' => Type::BUILTIN_TYPE_BOOL,
  66.         'double' => Type::BUILTIN_TYPE_FLOAT,
  67.     ];
  69.     private $mutatorPrefixes;
  70.     private $accessorPrefixes;
  71.     private $arrayMutatorPrefixes;
  72.     private $enableConstructorExtraction;
  73.     private $methodReflectionFlags;
  74.     private $magicMethodsFlags;
  75.     private $propertyReflectionFlags;
  76.     private $inflector;
  78.     private $arrayMutatorPrefixesFirst;
  79.     private $arrayMutatorPrefixesLast;
  81.     /**
  82.      * @param string[]|null $mutatorPrefixes
  83.      * @param string[]|null $accessorPrefixes
  84.      * @param string[]|null $arrayMutatorPrefixes
  85.      */
  86.     public function __construct(array $mutatorPrefixes = null, array $accessorPrefixes = null, array $arrayMutatorPrefixes = null, bool $enableConstructorExtraction = true, int $accessFlags = self::ALLOW_PUBLIC, InflectorInterface $inflector = null, int $magicMethodsFlags = self::ALLOW_MAGIC_GET | self::ALLOW_MAGIC_SET)
  87.     {
  88.         $this->mutatorPrefixes = $mutatorPrefixes ?? self::$defaultMutatorPrefixes;
  89.         $this->accessorPrefixes = $accessorPrefixes ?? self::$defaultAccessorPrefixes;
  90.         $this->arrayMutatorPrefixes = $arrayMutatorPrefixes ?? self::$defaultArrayMutatorPrefixes;
  91.         $this->enableConstructorExtraction = $enableConstructorExtraction;
  92.         $this->methodReflectionFlags = $this->getMethodsFlags($accessFlags);
  93.         $this->propertyReflectionFlags = $this->getPropertyFlags($accessFlags);
  94.         $this->magicMethodsFlags = $magicMethodsFlags;
  95.         $this->inflector = $inflector ?? new EnglishInflector();
  97.         $this->arrayMutatorPrefixesFirst = array_merge($this->arrayMutatorPrefixes, array_diff($this->mutatorPrefixes, $this->arrayMutatorPrefixes));
  98.         $this->arrayMutatorPrefixesLast = array_reverse($this->arrayMutatorPrefixesFirst);
  99.     }
  101.     public function getProperties(string $class, array $context = []): ?array
  102.     {
  103.         try {
  104.             $reflectionClass = new \ReflectionClass($class);
  105.         } catch (\ReflectionException) {
  106.             return null;
  107.         }
  109.         $reflectionProperties = $reflectionClass->getProperties();
  111.         $properties = [];
  112.         foreach ($reflectionProperties as $reflectionProperty) {
  113.             if ($reflectionProperty->getModifiers() & $this->propertyReflectionFlags) {
  114.                 $properties[$reflectionProperty->name] = $reflectionProperty->name;
  115.             }
  116.         }
  118.         foreach ($reflectionClass->getMethods($this->methodReflectionFlags) as $reflectionMethod) {
  119.             if ($reflectionMethod->isStatic()) {
  120.                 continue;
  121.             }
  123.             $propertyName = $this->getPropertyName($reflectionMethod->name, $reflectionProperties);
  124.             if (!$propertyName || isset($properties[$propertyName])) {
  125.                 continue;
  126.             }
  127.             if ($reflectionClass->hasProperty($lowerCasedPropertyName = lcfirst($propertyName)) || (!$reflectionClass->hasProperty($propertyName) && !preg_match('/^[A-Z]{2,}/', $propertyName))) {
  128.                 $propertyName = $lowerCasedPropertyName;
  129.             }
  130.             $properties[$propertyName] = $propertyName;
  131.         }
  133.         return $properties ? array_values($properties) : null;
  134.     }
  136.     public function getTypes(string $class, string $property, array $context = []): ?array
  137.     {
  138.         if ($fromMutator = $this->extractFromMutator($class, $property)) {
  139.             return $fromMutator;
  140.         }
  142.         if ($fromAccessor = $this->extractFromAccessor($class, $property)) {
  143.             return $fromAccessor;
  144.         }
  146.         if (
  147.             ($context['enable_constructor_extraction'] ?? $this->enableConstructorExtraction) &&
  148.             $fromConstructor = $this->extractFromConstructor($class, $property)
  149.         ) {
  150.             return $fromConstructor;
  151.         }
  153.         if ($fromPropertyDeclaration = $this->extractFromPropertyDeclaration($class, $property)) {
  154.             return $fromPropertyDeclaration;
  155.         }
  157.         return null;
  158.     }
  160.     public function getTypesFromConstructor(string $class, string $property): ?array
  161.     {
  162.         try {
  163.             $reflection = new \ReflectionClass($class);
  164.         } catch (\ReflectionException) {
  165.             return null;
  166.         }
  167.         if (!$reflectionConstructor = $reflection->getConstructor()) {
  168.             return null;
  169.         }
  170.         if (!$reflectionParameter = $this->getReflectionParameterFromConstructor($property, $reflectionConstructor)) {
  171.             return null;
  172.         }
  173.         if (!$reflectionType = $reflectionParameter->getType()) {
  174.             return null;
  175.         }
  176.         if (!$types = $this->extractFromReflectionType($reflectionType, $reflectionConstructor->getDeclaringClass())) {
  177.             return null;
  178.         }
  180.         return $types;
  181.     }
  183.     private function getReflectionParameterFromConstructor(string $property, \ReflectionMethod $reflectionConstructor): ?\ReflectionParameter
  184.     {
  185.         $reflectionParameter = null;
  186.         foreach ($reflectionConstructor->getParameters() as $reflectionParameter) {
  187.             if ($reflectionParameter->getName() === $property) {
  188.                 return $reflectionParameter;
  189.             }
  190.         }
  192.         return null;
  193.     }
  195.     public function isReadable(string $class, string $property, array $context = []): ?bool
  196.     {
  197.         if ($this->isAllowedProperty($class, $property)) {
  198.             return true;
  199.         }
  201.         return null !== $this->getReadInfo($class, $property, $context);
  202.     }
  204.     public function isWritable(string $class, string $property, array $context = []): ?bool
  205.     {
  206.         if ($this->isAllowedProperty($class, $property, true)) {
  207.             return true;
  208.         }
  210.         [$reflectionMethod] = $this->getMutatorMethod($class, $property);
  212.         return null !== $reflectionMethod;
  213.     }
  215.     public function isInitializable(string $class, string $property, array $context = []): ?bool
  216.     {
  217.         try {
  218.             $reflectionClass = new \ReflectionClass($class);
  219.         } catch (\ReflectionException) {
  220.             return null;
  221.         }
  223.         if (!$reflectionClass->isInstantiable()) {
  224.             return false;
  225.         }
  227.         if ($constructor = $reflectionClass->getConstructor()) {
  228.             foreach ($constructor->getParameters() as $parameter) {
  229.                 if ($property === $parameter->name) {
  230.                     return true;
  231.                 }
  232.             }
  233.         } elseif ($parentClass = $reflectionClass->getParentClass()) {
  234.             return $this->isInitializable($parentClass->getName(), $property);
  235.         }
  237.         return false;
  238.     }
  240.     public function getReadInfo(string $class, string $property, array $context = []): ?PropertyReadInfo
  241.     {
  242.         try {
  243.             $reflClass = new \ReflectionClass($class);
  244.         } catch (\ReflectionException) {
  245.             return null;
  246.         }
  248.         $allowGetterSetter = $context['enable_getter_setter_extraction'] ?? false;
  249.         $magicMethods = $context['enable_magic_methods_extraction'] ?? $this->magicMethodsFlags;
  250.         $allowMagicCall = (bool) ($magicMethods & self::ALLOW_MAGIC_CALL);
  251.         $allowMagicGet = (bool) ($magicMethods & self::ALLOW_MAGIC_GET);
  252.         $hasProperty = $reflClass->hasProperty($property);
  253.         $camelProp = $this->camelize($property);
  254.         $getsetter = lcfirst($camelProp); // jQuery style, e.g. read: last(), write: last($item)
  256.         foreach ($this->accessorPrefixes as $prefix) {
  257.             $methodName = $prefix.$camelProp;
  259.             if ($reflClass->hasMethod($methodName) && $reflClass->getMethod($methodName)->getModifiers() & $this->methodReflectionFlags && !$reflClass->getMethod($methodName)->getNumberOfRequiredParameters()) {
  260.                 $method = $reflClass->getMethod($methodName);
  262.                 return new PropertyReadInfo(PropertyReadInfo::TYPE_METHOD, $methodName, $this->getReadVisiblityForMethod($method), $method->isStatic(), false);
  263.             }
  264.         }
  266.         if ($allowGetterSetter && $reflClass->hasMethod($getsetter) && ($reflClass->getMethod($getsetter)->getModifiers() & $this->methodReflectionFlags)) {
  267.             $method = $reflClass->getMethod($getsetter);
  269.             return new PropertyReadInfo(PropertyReadInfo::TYPE_METHOD, $getsetter, $this->getReadVisiblityForMethod($method), $method->isStatic(), false);
  270.         }
  272.         if ($allowMagicGet && $reflClass->hasMethod('__get') && ($reflClass->getMethod('__get')->getModifiers() & $this->methodReflectionFlags)) {
  273.             return new PropertyReadInfo(PropertyReadInfo::TYPE_PROPERTY, $property, PropertyReadInfo::VISIBILITY_PUBLIC, false, false);
  274.         }
  276.         if ($hasProperty && ($reflClass->getProperty($property)->getModifiers() & $this->propertyReflectionFlags)) {
  277.             $reflProperty = $reflClass->getProperty($property);
  279.             return new PropertyReadInfo(PropertyReadInfo::TYPE_PROPERTY, $property, $this->getReadVisiblityForProperty($reflProperty), $reflProperty->isStatic(), true);
  280.         }
  282.         if ($allowMagicCall && $reflClass->hasMethod('__call') && ($reflClass->getMethod('__call')->getModifiers() & $this->methodReflectionFlags)) {
  283.             return new PropertyReadInfo(PropertyReadInfo::TYPE_METHOD, 'get'.$camelProp, PropertyReadInfo::VISIBILITY_PUBLIC, false, false);
  284.         }
  286.         return null;
  287.     }
  289.     public function getWriteInfo(string $class, string $property, array $context = []): ?PropertyWriteInfo
  290.     {
  291.         try {
  292.             $reflClass = new \ReflectionClass($class);
  293.         } catch (\ReflectionException) {
  294.             return null;
  295.         }
  297.         $allowGetterSetter = $context['enable_getter_setter_extraction'] ?? false;
  298.         $magicMethods = $context['enable_magic_methods_extraction'] ?? $this->magicMethodsFlags;
  299.         $allowMagicCall = (bool) ($magicMethods & self::ALLOW_MAGIC_CALL);
  300.         $allowMagicSet = (bool) ($magicMethods & self::ALLOW_MAGIC_SET);
  301.         $allowConstruct = $context['enable_constructor_extraction'] ?? $this->enableConstructorExtraction;
  302.         $allowAdderRemover = $context['enable_adder_remover_extraction'] ?? true;
  304.         $camelized = $this->camelize($property);
  305.         $constructor = $reflClass->getConstructor();
  306.         $singulars = $this->inflector->singularize($camelized);
  307.         $errors = [];
  309.         if (null !== $constructor && $allowConstruct) {
  310.             foreach ($constructor->getParameters() as $parameter) {
  311.                 if ($parameter->getName() === $property) {
  312.                     return new PropertyWriteInfo(PropertyWriteInfo::TYPE_CONSTRUCTOR, $property);
  313.                 }
  314.             }
  315.         }
  317.         [$adderAccessName, $removerAccessName, $adderAndRemoverErrors] = $this->findAdderAndRemover($reflClass, $singulars);
  318.         if ($allowAdderRemover && null !== $adderAccessName && null !== $removerAccessName) {
  319.             $adderMethod = $reflClass->getMethod($adderAccessName);
  320.             $removerMethod = $reflClass->getMethod($removerAccessName);
  322.             $mutator = new PropertyWriteInfo(PropertyWriteInfo::TYPE_ADDER_AND_REMOVER);
  323.             $mutator->setAdderInfo(new PropertyWriteInfo(PropertyWriteInfo::TYPE_METHOD, $adderAccessName, $this->getWriteVisiblityForMethod($adderMethod), $adderMethod->isStatic()));
  324.             $mutator->setRemoverInfo(new PropertyWriteInfo(PropertyWriteInfo::TYPE_METHOD, $removerAccessName, $this->getWriteVisiblityForMethod($removerMethod), $removerMethod->isStatic()));
  326.             return $mutator;
  327.         }
  329.         $errors[] = $adderAndRemoverErrors;
  331.         foreach ($this->mutatorPrefixes as $mutatorPrefix) {
  332.             $methodName = $mutatorPrefix.$camelized;
  334.             [$accessible, $methodAccessibleErrors] = $this->isMethodAccessible($reflClass, $methodName, 1);
  335.             if (!$accessible) {
  336.                 $errors[] = $methodAccessibleErrors;
  337.                 continue;
  338.             }
  340.             $method = $reflClass->getMethod($methodName);
  342.             if (!\in_array($mutatorPrefix, $this->arrayMutatorPrefixes, true)) {
  343.                 return new PropertyWriteInfo(PropertyWriteInfo::TYPE_METHOD, $methodName, $this->getWriteVisiblityForMethod($method), $method->isStatic());
  344.             }
  345.         }
  347.         $getsetter = lcfirst($camelized);
  349.         if ($allowGetterSetter) {
  350.             [$accessible, $methodAccessibleErrors] = $this->isMethodAccessible($reflClass, $getsetter, 1);
  351.             if ($accessible) {
  352.                 $method = $reflClass->getMethod($getsetter);
  354.                 return new PropertyWriteInfo(PropertyWriteInfo::TYPE_METHOD, $getsetter, $this->getWriteVisiblityForMethod($method), $method->isStatic());
  355.             }
  357.             $errors[] = $methodAccessibleErrors;
  358.         }
  360.         if ($reflClass->hasProperty($property) && ($reflClass->getProperty($property)->getModifiers() & $this->propertyReflectionFlags)) {
  361.             $reflProperty = $reflClass->getProperty($property);
  362.             if (\PHP_VERSION_ID < 80100 || !$reflProperty->isReadOnly()) {
  363.                 return new PropertyWriteInfo(PropertyWriteInfo::TYPE_PROPERTY, $property, $this->getWriteVisiblityForProperty($reflProperty), $reflProperty->isStatic());
  364.             }
  366.             $errors[] = [sprintf('The property "%s" in class "%s" is a promoted readonly property.', $property, $reflClass->getName())];
  367.             $allowMagicSet = $allowMagicCall = false;
  368.         }
  370.         if ($allowMagicSet) {
  371.             [$accessible, $methodAccessibleErrors] = $this->isMethodAccessible($reflClass, '__set', 2);
  372.             if ($accessible) {
  373.                 return new PropertyWriteInfo(PropertyWriteInfo::TYPE_PROPERTY, $property, PropertyWriteInfo::VISIBILITY_PUBLIC, false);
  374.             }
  376.             $errors[] = $methodAccessibleErrors;
  377.         }
  379.         if ($allowMagicCall) {
  380.             [$accessible, $methodAccessibleErrors] = $this->isMethodAccessible($reflClass, '__call', 2);
  381.             if ($accessible) {
  382.                 return new PropertyWriteInfo(PropertyWriteInfo::TYPE_METHOD, 'set'.$camelized, PropertyWriteInfo::VISIBILITY_PUBLIC, false);
  383.             }
  385.             $errors[] = $methodAccessibleErrors;
  386.         }
  388.         if (!$allowAdderRemover && null !== $adderAccessName && null !== $removerAccessName) {
  389.             $errors[] = [sprintf(
  390.                 'The property "%s" in class "%s" can be defined with the methods "%s()" but '.
  391.                 'the new value must be an array or an instance of \Traversable',
  392.                 $property,
  393.                 $reflClass->getName(),
  394.                 implode('()", "', [$adderAccessName, $removerAccessName])
  395.             )];
  396.         }
  398.         $noneProperty = new PropertyWriteInfo();
  399.         $noneProperty->setErrors(array_merge([], ...$errors));
  401.         return $noneProperty;
  402.     }
  404.     /**
  405.      * @return Type[]|null
  406.      */
  407.     private function extractFromMutator(string $class, string $property): ?array
  408.     {
  409.         [$reflectionMethod, $prefix] = $this->getMutatorMethod($class, $property);
  410.         if (null === $reflectionMethod) {
  411.             return null;
  412.         }
  414.         $reflectionParameters = $reflectionMethod->getParameters();
  415.         $reflectionParameter = $reflectionParameters[0];
  417.         if (!$reflectionType = $reflectionParameter->getType()) {
  418.             return null;
  419.         }
  420.         $type = $this->extractFromReflectionType($reflectionType, $reflectionMethod->getDeclaringClass());
  422.         if (1 === \count($type) && \in_array($prefix, $this->arrayMutatorPrefixes)) {
  423.             $type = [new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true, new Type(Type::BUILTIN_TYPE_INT), $type[0])];
  424.         }
  426.         return $type;
  427.     }
  429.     /**
  430.      * Tries to extract type information from accessors.
  431.      *
  432.      * @return Type[]|null
  433.      */
  434.     private function extractFromAccessor(string $class, string $property): ?array
  435.     {
  436.         [$reflectionMethod, $prefix] = $this->getAccessorMethod($class, $property);
  437.         if (null === $reflectionMethod) {
  438.             return null;
  439.         }
  441.         if ($reflectionType = $reflectionMethod->getReturnType()) {
  442.             return $this->extractFromReflectionType($reflectionType, $reflectionMethod->getDeclaringClass());
  443.         }
  445.         if (\in_array($prefix, ['is', 'can', 'has'])) {
  446.             return [new Type(Type::BUILTIN_TYPE_BOOL)];
  447.         }
  449.         return null;
  450.     }
  452.     /**
  453.      * Tries to extract type information from constructor.
  454.      *
  455.      * @return Type[]|null
  456.      */
  457.     private function extractFromConstructor(string $class, string $property): ?array
  458.     {
  459.         try {
  460.             $reflectionClass = new \ReflectionClass($class);
  461.         } catch (\ReflectionException) {
  462.             return null;
  463.         }
  465.         $constructor = $reflectionClass->getConstructor();
  467.         if (!$constructor) {
  468.             return null;
  469.         }
  471.         foreach ($constructor->getParameters() as $parameter) {
  472.             if ($property !== $parameter->name) {
  473.                 continue;
  474.             }
  475.             $reflectionType = $parameter->getType();
  477.             return $reflectionType ? $this->extractFromReflectionType($reflectionType, $constructor->getDeclaringClass()) : null;
  478.         }
  480.         if ($parentClass = $reflectionClass->getParentClass()) {
  481.             return $this->extractFromConstructor($parentClass->getName(), $property);
  482.         }
  484.         return null;
  485.     }
  487.     private function extractFromPropertyDeclaration(string $class, string $property): ?array
  488.     {
  489.         try {
  490.             $reflectionClass = new \ReflectionClass($class);
  492.             $reflectionProperty = $reflectionClass->getProperty($property);
  493.             $reflectionPropertyType = $reflectionProperty->getType();
  495.             if (null !== $reflectionPropertyType && $types = $this->extractFromReflectionType($reflectionPropertyType, $reflectionProperty->getDeclaringClass())) {
  496.                 return $types;
  497.             }
  498.         } catch (\ReflectionException) {
  499.             return null;
  500.         }
  502.         $defaultValue = $reflectionClass->getDefaultProperties()[$property] ?? null;
  504.         if (null === $defaultValue) {
  505.             return null;
  506.         }
  508.         $type = \gettype($defaultValue);
  509.         $type = static::MAP_TYPES[$type] ?? $type;
  511.         return [new Type($type, $this->isNullableProperty($class, $property), null, Type::BUILTIN_TYPE_ARRAY === $type)];
  512.     }
  514.     private function extractFromReflectionType(\ReflectionType $reflectionType, \ReflectionClass $declaringClass): array
  515.     {
  516.         $types = [];
  517.         $nullable = $reflectionType->allowsNull();
  519.         foreach (($reflectionType instanceof \ReflectionUnionType || $reflectionType instanceof \ReflectionIntersectionType) ? $reflectionType->getTypes() : [$reflectionType] as $type) {
  520.             if (!$type instanceof \ReflectionNamedType) {
  521.                 // Nested composite types are not supported yet.
  522.                 return [];
  523.             }
  525.             $phpTypeOrClass = $type->getName();
  526.             if ('null' === $phpTypeOrClass || 'mixed' === $phpTypeOrClass || 'never' === $phpTypeOrClass) {
  527.                 continue;
  528.             }
  530.             if (Type::BUILTIN_TYPE_ARRAY === $phpTypeOrClass) {
  531.                 $types[] = new Type(Type::BUILTIN_TYPE_ARRAY, $nullable, null, true);
  532.             } elseif ('void' === $phpTypeOrClass) {
  533.                 $types[] = new Type(Type::BUILTIN_TYPE_NULL, $nullable);
  534.             } elseif ($type->isBuiltin()) {
  535.                 $types[] = new Type($phpTypeOrClass, $nullable);
  536.             } else {
  537.                 $types[] = new Type(Type::BUILTIN_TYPE_OBJECT, $nullable, $this->resolveTypeName($phpTypeOrClass, $declaringClass));
  538.             }
  539.         }
  541.         return $types;
  542.     }
  544.     private function resolveTypeName(string $name, \ReflectionClass $declaringClass): string
  545.     {
  546.         if ('self' === $lcName = strtolower($name)) {
  547.             return $declaringClass->name;
  548.         }
  549.         if ('parent' === $lcName && $parent = $declaringClass->getParentClass()) {
  550.             return $parent->name;
  551.         }
  553.         return $name;
  554.     }
  556.     private function isNullableProperty(string $class, string $property): bool
  557.     {
  558.         try {
  559.             $reflectionProperty = new \ReflectionProperty($class, $property);
  561.             $reflectionPropertyType = $reflectionProperty->getType();
  563.             return null !== $reflectionPropertyType && $reflectionPropertyType->allowsNull();
  564.         } catch (\ReflectionException) {
  565.             // Return false if the property doesn't exist
  566.         }
  568.         return false;
  569.     }
  571.     private function isAllowedProperty(string $class, string $property, bool $writeAccessRequired = false): bool
  572.     {
  573.         try {
  574.             $reflectionProperty = new \ReflectionProperty($class, $property);
  576.             if (\PHP_VERSION_ID >= 80100 && $writeAccessRequired && $reflectionProperty->isReadOnly()) {
  577.                 return false;
  578.             }
  580.             return (bool) ($reflectionProperty->getModifiers() & $this->propertyReflectionFlags);
  581.         } catch (\ReflectionException) {
  582.             // Return false if the property doesn't exist
  583.         }
  585.         return false;
  586.     }
  588.     /**
  589.      * Gets the accessor method.
  590.      *
  591.      * Returns an array with a the instance of \ReflectionMethod as first key
  592.      * and the prefix of the method as second or null if not found.
  593.      */
  594.     private function getAccessorMethod(string $class, string $property): ?array
  595.     {
  596.         $ucProperty = ucfirst($property);
  598.         foreach ($this->accessorPrefixes as $prefix) {
  599.             try {
  600.                 $reflectionMethod = new \ReflectionMethod($class, $prefix.$ucProperty);
  601.                 if ($reflectionMethod->isStatic()) {
  602.                     continue;
  603.                 }
  605.                 if (0 === $reflectionMethod->getNumberOfRequiredParameters()) {
  606.                     return [$reflectionMethod, $prefix];
  607.                 }
  608.             } catch (\ReflectionException) {
  609.                 // Return null if the property doesn't exist
  610.             }
  611.         }
  613.         return null;
  614.     }
  616.     /**
  617.      * Returns an array with a the instance of \ReflectionMethod as first key
  618.      * and the prefix of the method as second or null if not found.
  619.      */
  620.     private function getMutatorMethod(string $class, string $property): ?array
  621.     {
  622.         $ucProperty = ucfirst($property);
  623.         $ucSingulars = $this->inflector->singularize($ucProperty);
  625.         $mutatorPrefixes = \in_array($ucProperty, $ucSingulars, true) ? $this->arrayMutatorPrefixesLast : $this->arrayMutatorPrefixesFirst;
  627.         foreach ($mutatorPrefixes as $prefix) {
  628.             $names = [$ucProperty];
  629.             if (\in_array($prefix, $this->arrayMutatorPrefixes)) {
  630.                 $names = array_merge($names, $ucSingulars);
  631.             }
  633.             foreach ($names as $name) {
  634.                 try {
  635.                     $reflectionMethod = new \ReflectionMethod($class, $prefix.$name);
  636.                     if ($reflectionMethod->isStatic()) {
  637.                         continue;
  638.                     }
  640.                     // Parameter can be optional to allow things like: method(array $foo = null)
  641.                     if ($reflectionMethod->getNumberOfParameters() >= 1) {
  642.                         return [$reflectionMethod, $prefix];
  643.                     }
  644.                 } catch (\ReflectionException) {
  645.                     // Try the next prefix if the method doesn't exist
  646.                 }
  647.             }
  648.         }
  650.         return null;
  651.     }
  653.     private function getPropertyName(string $methodName, array $reflectionProperties): ?string
  654.     {
  655.         $pattern = implode('|', array_merge($this->accessorPrefixes, $this->mutatorPrefixes));
  657.         if ('' !== $pattern && preg_match('/^('.$pattern.')(.+)$/i', $methodName, $matches)) {
  658.             if (!\in_array($matches[1], $this->arrayMutatorPrefixes)) {
  659.                 return $matches[2];
  660.             }
  662.             foreach ($reflectionProperties as $reflectionProperty) {
  663.                 foreach ($this->inflector->singularize($reflectionProperty->name) as $name) {
  664.                     if (strtolower($name) === strtolower($matches[2])) {
  665.                         return $reflectionProperty->name;
  666.                     }
  667.                 }
  668.             }
  670.             return $matches[2];
  671.         }
  673.         return null;
  674.     }
  676.     /**
  677.      * Searches for add and remove methods.
  678.      *
  679.      * @param \ReflectionClass $reflClass The reflection class for the given object
  680.      * @param array            $singulars The singular form of the property name or null
  681.      *
  682.      * @return array An array containing the adder and remover when found and errors
  683.      */
  684.     private function findAdderAndRemover(\ReflectionClass $reflClass, array $singulars): array
  685.     {
  686.         if (!\is_array($this->arrayMutatorPrefixes) && 2 !== \count($this->arrayMutatorPrefixes)) {
  687.             return [null, null, []];
  688.         }
  690.         [$addPrefix, $removePrefix] = $this->arrayMutatorPrefixes;
  691.         $errors = [];
  693.         foreach ($singulars as $singular) {
  694.             $addMethod = $addPrefix.$singular;
  695.             $removeMethod = $removePrefix.$singular;
  697.             [$addMethodFound, $addMethodAccessibleErrors] = $this->isMethodAccessible($reflClass, $addMethod, 1);
  698.             [$removeMethodFound, $removeMethodAccessibleErrors] = $this->isMethodAccessible($reflClass, $removeMethod, 1);
  699.             $errors[] = $addMethodAccessibleErrors;
  700.             $errors[] = $removeMethodAccessibleErrors;
  702.             if ($addMethodFound && $removeMethodFound) {
  703.                 return [$addMethod, $removeMethod, []];
  704.             }
  706.             if ($addMethodFound && !$removeMethodFound) {
  707.                 $errors[] = [sprintf('The add method "%s" in class "%s" was found, but the corresponding remove method "%s" was not found', $addMethod, $reflClass->getName(), $removeMethod)];
  708.             } elseif (!$addMethodFound && $removeMethodFound) {
  709.                 $errors[] = [sprintf('The remove method "%s" in class "%s" was found, but the corresponding add method "%s" was not found', $removeMethod, $reflClass->getName(), $addMethod)];
  710.             }
  711.         }
  713.         return [null, null, array_merge([], ...$errors)];
  714.     }
  716.     /**
  717.      * Returns whether a method is public and has the number of required parameters and errors.
  718.      */
  719.     private function isMethodAccessible(\ReflectionClass $class, string $methodName, int $parameters): array
  720.     {
  721.         $errors = [];
  723.         if ($class->hasMethod($methodName)) {
  724.             $method = $class->getMethod($methodName);
  726.             if (\ReflectionMethod::IS_PUBLIC === $this->methodReflectionFlags && !$method->isPublic()) {
  727.                 $errors[] = sprintf('The method "%s" in class "%s" was found but does not have public access.', $methodName, $class->getName());
  728.             } elseif ($method->getNumberOfRequiredParameters() > $parameters || $method->getNumberOfParameters() < $parameters) {
  729.                 $errors[] = sprintf('The method "%s" in class "%s" requires %d arguments, but should accept only %d.', $methodName, $class->getName(), $method->getNumberOfRequiredParameters(), $parameters);
  730.             } else {
  731.                 return [true, $errors];
  732.             }
  733.         }
  735.         return [false, $errors];
  736.     }
  738.     /**
  739.      * Camelizes a given string.
  740.      */
  741.     private function camelize(string $string): string
  742.     {
  743.         return str_replace(' ', '', ucwords(str_replace('_', ' ', $string)));
  744.     }
  746.     /**
  747.      * Return allowed reflection method flags.
  748.      */
  749.     private function getMethodsFlags(int $accessFlags): int
  750.     {
  751.         $methodFlags = 0;
  753.         if ($accessFlags & self::ALLOW_PUBLIC) {
  754.             $methodFlags |= \ReflectionMethod::IS_PUBLIC;
  755.         }
  757.         if ($accessFlags & self::ALLOW_PRIVATE) {
  758.             $methodFlags |= \ReflectionMethod::IS_PRIVATE;
  759.         }
  761.         if ($accessFlags & self::ALLOW_PROTECTED) {
  762.             $methodFlags |= \ReflectionMethod::IS_PROTECTED;
  763.         }
  765.         return $methodFlags;
  766.     }
  768.     /**
  769.      * Return allowed reflection property flags.
  770.      */
  771.     private function getPropertyFlags(int $accessFlags): int
  772.     {
  773.         $propertyFlags = 0;
  775.         if ($accessFlags & self::ALLOW_PUBLIC) {
  776.             $propertyFlags |= \ReflectionProperty::IS_PUBLIC;
  777.         }
  779.         if ($accessFlags & self::ALLOW_PRIVATE) {
  780.             $propertyFlags |= \ReflectionProperty::IS_PRIVATE;
  781.         }
  783.         if ($accessFlags & self::ALLOW_PROTECTED) {
  784.             $propertyFlags |= \ReflectionProperty::IS_PROTECTED;
  785.         }
  787.         return $propertyFlags;
  788.     }
  790.     private function getReadVisiblityForProperty(\ReflectionProperty $reflectionProperty): string
  791.     {
  792.         if ($reflectionProperty->isPrivate()) {
  793.             return PropertyReadInfo::VISIBILITY_PRIVATE;
  794.         }
  796.         if ($reflectionProperty->isProtected()) {
  797.             return PropertyReadInfo::VISIBILITY_PROTECTED;
  798.         }
  800.         return PropertyReadInfo::VISIBILITY_PUBLIC;
  801.     }
  803.     private function getReadVisiblityForMethod(\ReflectionMethod $reflectionMethod): string
  804.     {
  805.         if ($reflectionMethod->isPrivate()) {
  806.             return PropertyReadInfo::VISIBILITY_PRIVATE;
  807.         }
  809.         if ($reflectionMethod->isProtected()) {
  810.             return PropertyReadInfo::VISIBILITY_PROTECTED;
  811.         }
  813.         return PropertyReadInfo::VISIBILITY_PUBLIC;
  814.     }
  816.     private function getWriteVisiblityForProperty(\ReflectionProperty $reflectionProperty): string
  817.     {
  818.         if ($reflectionProperty->isPrivate()) {
  819.             return PropertyWriteInfo::VISIBILITY_PRIVATE;
  820.         }
  822.         if ($reflectionProperty->isProtected()) {
  823.             return PropertyWriteInfo::VISIBILITY_PROTECTED;
  824.         }
  826.         return PropertyWriteInfo::VISIBILITY_PUBLIC;
  827.     }
  829.     private function getWriteVisiblityForMethod(\ReflectionMethod $reflectionMethod): string
  830.     {
  831.         if ($reflectionMethod->isPrivate()) {
  832.             return PropertyWriteInfo::VISIBILITY_PRIVATE;
  833.         }
  835.         if ($reflectionMethod->isProtected()) {
  836.             return PropertyWriteInfo::VISIBILITY_PROTECTED;
  837.         }
  839.         return PropertyWriteInfo::VISIBILITY_PUBLIC;
  840.     }
  841. }