vendor/symfony/property-info/Extractor/ReflectionExtractor.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\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.     /**
  102.      * {@inheritdoc}
  103.      */
  104.     public function getProperties(string $class, array $context = []): ?array
  105.     {
  106.         try {
  107.             $reflectionClass = new \ReflectionClass($class);
  108.         } catch (\ReflectionException) {
  109.             return null;
  110.         }
  112.         $reflectionProperties = $reflectionClass->getProperties();
  114.         $properties = [];
  115.         foreach ($reflectionProperties as $reflectionProperty) {
  116.             if ($reflectionProperty->getModifiers() & $this->propertyReflectionFlags) {
  117.                 $properties[$reflectionProperty->name] = $reflectionProperty->name;
  118.             }
  119.         }
  121.         foreach ($reflectionClass->getMethods($this->methodReflectionFlags) as $reflectionMethod) {
  122.             if ($reflectionMethod->isStatic()) {
  123.                 continue;
  124.             }
  126.             $propertyName = $this->getPropertyName($reflectionMethod->name, $reflectionProperties);
  127.             if (!$propertyName || isset($properties[$propertyName])) {
  128.                 continue;
  129.             }
  130.             if ($reflectionClass->hasProperty($lowerCasedPropertyName = lcfirst($propertyName)) || (!$reflectionClass->hasProperty($propertyName) && !preg_match('/^[A-Z]{2,}/', $propertyName))) {
  131.                 $propertyName = $lowerCasedPropertyName;
  132.             }
  133.             $properties[$propertyName] = $propertyName;
  134.         }
  136.         return $properties ? array_values($properties) : null;
  137.     }
  139.     /**
  140.      * {@inheritdoc}
  141.      */
  142.     public function getTypes(string $class, string $property, array $context = []): ?array
  143.     {
  144.         if ($fromMutator = $this->extractFromMutator($class, $property)) {
  145.             return $fromMutator;
  146.         }
  148.         if ($fromAccessor = $this->extractFromAccessor($class, $property)) {
  149.             return $fromAccessor;
  150.         }
  152.         if (
  153.             ($context['enable_constructor_extraction'] ?? $this->enableConstructorExtraction) &&
  154.             $fromConstructor = $this->extractFromConstructor($class, $property)
  155.         ) {
  156.             return $fromConstructor;
  157.         }
  159.         if ($fromPropertyDeclaration = $this->extractFromPropertyDeclaration($class, $property)) {
  160.             return $fromPropertyDeclaration;
  161.         }
  163.         return null;
  164.     }
  166.     /**
  167.      * {@inheritdoc}
  168.      */
  169.     public function getTypesFromConstructor(string $class, string $property): ?array
  170.     {
  171.         try {
  172.             $reflection = new \ReflectionClass($class);
  173.         } catch (\ReflectionException) {
  174.             return null;
  175.         }
  176.         if (!$reflectionConstructor = $reflection->getConstructor()) {
  177.             return null;
  178.         }
  179.         if (!$reflectionParameter = $this->getReflectionParameterFromConstructor($property, $reflectionConstructor)) {
  180.             return null;
  181.         }
  182.         if (!$reflectionType = $reflectionParameter->getType()) {
  183.             return null;
  184.         }
  185.         if (!$types = $this->extractFromReflectionType($reflectionType, $reflectionConstructor->getDeclaringClass())) {
  186.             return null;
  187.         }
  189.         return $types;
  190.     }
  192.     private function getReflectionParameterFromConstructor(string $property, \ReflectionMethod $reflectionConstructor): ?\ReflectionParameter
  193.     {
  194.         $reflectionParameter = null;
  195.         foreach ($reflectionConstructor->getParameters() as $reflectionParameter) {
  196.             if ($reflectionParameter->getName() === $property) {
  197.                 return $reflectionParameter;
  198.             }
  199.         }
  201.         return null;
  202.     }
  204.     /**
  205.      * {@inheritdoc}
  206.      */
  207.     public function isReadable(string $class, string $property, array $context = []): ?bool
  208.     {
  209.         if ($this->isAllowedProperty($class, $property)) {
  210.             return true;
  211.         }
  213.         return null !== $this->getReadInfo($class, $property, $context);
  214.     }
  216.     /**
  217.      * {@inheritdoc}
  218.      */
  219.     public function isWritable(string $class, string $property, array $context = []): ?bool
  220.     {
  221.         if ($this->isAllowedProperty($class, $property, true)) {
  222.             return true;
  223.         }
  225.         [$reflectionMethod] = $this->getMutatorMethod($class, $property);
  227.         return null !== $reflectionMethod;
  228.     }
  230.     /**
  231.      * {@inheritdoc}
  232.      */
  233.     public function isInitializable(string $class, string $property, array $context = []): ?bool
  234.     {
  235.         try {
  236.             $reflectionClass = new \ReflectionClass($class);
  237.         } catch (\ReflectionException) {
  238.             return null;
  239.         }
  241.         if (!$reflectionClass->isInstantiable()) {
  242.             return false;
  243.         }
  245.         if ($constructor = $reflectionClass->getConstructor()) {
  246.             foreach ($constructor->getParameters() as $parameter) {
  247.                 if ($property === $parameter->name) {
  248.                     return true;
  249.                 }
  250.             }
  251.         } elseif ($parentClass = $reflectionClass->getParentClass()) {
  252.             return $this->isInitializable($parentClass->getName(), $property);
  253.         }
  255.         return false;
  256.     }
  258.     /**
  259.      * {@inheritdoc}
  260.      */
  261.     public function getReadInfo(string $class, string $property, array $context = []): ?PropertyReadInfo
  262.     {
  263.         try {
  264.             $reflClass = new \ReflectionClass($class);
  265.         } catch (\ReflectionException) {
  266.             return null;
  267.         }
  269.         $allowGetterSetter = $context['enable_getter_setter_extraction'] ?? false;
  270.         $magicMethods = $context['enable_magic_methods_extraction'] ?? $this->magicMethodsFlags;
  271.         $allowMagicCall = (bool) ($magicMethods & self::ALLOW_MAGIC_CALL);
  272.         $allowMagicGet = (bool) ($magicMethods & self::ALLOW_MAGIC_GET);
  273.         $hasProperty = $reflClass->hasProperty($property);
  274.         $camelProp = $this->camelize($property);
  275.         $getsetter = lcfirst($camelProp); // jQuery style, e.g. read: last(), write: last($item)
  277.         foreach ($this->accessorPrefixes as $prefix) {
  278.             $methodName = $prefix.$camelProp;
  280.             if ($reflClass->hasMethod($methodName) && $reflClass->getMethod($methodName)->getModifiers() & $this->methodReflectionFlags && !$reflClass->getMethod($methodName)->getNumberOfRequiredParameters()) {
  281.                 $method = $reflClass->getMethod($methodName);
  283.                 return new PropertyReadInfo(PropertyReadInfo::TYPE_METHOD, $methodName, $this->getReadVisiblityForMethod($method), $method->isStatic(), false);
  284.             }
  285.         }
  287.         if ($allowGetterSetter && $reflClass->hasMethod($getsetter) && ($reflClass->getMethod($getsetter)->getModifiers() & $this->methodReflectionFlags)) {
  288.             $method = $reflClass->getMethod($getsetter);
  290.             return new PropertyReadInfo(PropertyReadInfo::TYPE_METHOD, $getsetter, $this->getReadVisiblityForMethod($method), $method->isStatic(), false);
  291.         }
  293.         if ($allowMagicGet && $reflClass->hasMethod('__get') && ($reflClass->getMethod('__get')->getModifiers() & $this->methodReflectionFlags)) {
  294.             return new PropertyReadInfo(PropertyReadInfo::TYPE_PROPERTY, $property, PropertyReadInfo::VISIBILITY_PUBLIC, false, false);
  295.         }
  297.         if ($hasProperty && ($reflClass->getProperty($property)->getModifiers() & $this->propertyReflectionFlags)) {
  298.             $reflProperty = $reflClass->getProperty($property);
  300.             return new PropertyReadInfo(PropertyReadInfo::TYPE_PROPERTY, $property, $this->getReadVisiblityForProperty($reflProperty), $reflProperty->isStatic(), true);
  301.         }
  303.         if ($allowMagicCall && $reflClass->hasMethod('__call') && ($reflClass->getMethod('__call')->getModifiers() & $this->methodReflectionFlags)) {
  304.             return new PropertyReadInfo(PropertyReadInfo::TYPE_METHOD, 'get'.$camelProp, PropertyReadInfo::VISIBILITY_PUBLIC, false, false);
  305.         }
  307.         return null;
  308.     }
  310.     /**
  311.      * {@inheritdoc}
  312.      */
  313.     public function getWriteInfo(string $class, string $property, array $context = []): ?PropertyWriteInfo
  314.     {
  315.         try {
  316.             $reflClass = new \ReflectionClass($class);
  317.         } catch (\ReflectionException) {
  318.             return null;
  319.         }
  321.         $allowGetterSetter = $context['enable_getter_setter_extraction'] ?? false;
  322.         $magicMethods = $context['enable_magic_methods_extraction'] ?? $this->magicMethodsFlags;
  323.         $allowMagicCall = (bool) ($magicMethods & self::ALLOW_MAGIC_CALL);
  324.         $allowMagicSet = (bool) ($magicMethods & self::ALLOW_MAGIC_SET);
  325.         $allowConstruct = $context['enable_constructor_extraction'] ?? $this->enableConstructorExtraction;
  326.         $allowAdderRemover = $context['enable_adder_remover_extraction'] ?? true;
  328.         $camelized = $this->camelize($property);
  329.         $constructor = $reflClass->getConstructor();
  330.         $singulars = $this->inflector->singularize($camelized);
  331.         $errors = [];
  333.         if (null !== $constructor && $allowConstruct) {
  334.             foreach ($constructor->getParameters() as $parameter) {
  335.                 if ($parameter->getName() === $property) {
  336.                     return new PropertyWriteInfo(PropertyWriteInfo::TYPE_CONSTRUCTOR, $property);
  337.                 }
  338.             }
  339.         }
  341.         [$adderAccessName, $removerAccessName, $adderAndRemoverErrors] = $this->findAdderAndRemover($reflClass, $singulars);
  342.         if ($allowAdderRemover && null !== $adderAccessName && null !== $removerAccessName) {
  343.             $adderMethod = $reflClass->getMethod($adderAccessName);
  344.             $removerMethod = $reflClass->getMethod($removerAccessName);
  346.             $mutator = new PropertyWriteInfo(PropertyWriteInfo::TYPE_ADDER_AND_REMOVER);
  347.             $mutator->setAdderInfo(new PropertyWriteInfo(PropertyWriteInfo::TYPE_METHOD, $adderAccessName, $this->getWriteVisiblityForMethod($adderMethod), $adderMethod->isStatic()));
  348.             $mutator->setRemoverInfo(new PropertyWriteInfo(PropertyWriteInfo::TYPE_METHOD, $removerAccessName, $this->getWriteVisiblityForMethod($removerMethod), $removerMethod->isStatic()));
  350.             return $mutator;
  351.         }
  353.         $errors[] = $adderAndRemoverErrors;
  355.         foreach ($this->mutatorPrefixes as $mutatorPrefix) {
  356.             $methodName = $mutatorPrefix.$camelized;
  358.             [$accessible, $methodAccessibleErrors] = $this->isMethodAccessible($reflClass, $methodName, 1);
  359.             if (!$accessible) {
  360.                 $errors[] = $methodAccessibleErrors;
  361.                 continue;
  362.             }
  364.             $method = $reflClass->getMethod($methodName);
  366.             if (!\in_array($mutatorPrefix, $this->arrayMutatorPrefixes, true)) {
  367.                 return new PropertyWriteInfo(PropertyWriteInfo::TYPE_METHOD, $methodName, $this->getWriteVisiblityForMethod($method), $method->isStatic());
  368.             }
  369.         }
  371.         $getsetter = lcfirst($camelized);
  373.         if ($allowGetterSetter) {
  374.             [$accessible, $methodAccessibleErrors] = $this->isMethodAccessible($reflClass, $getsetter, 1);
  375.             if ($accessible) {
  376.                 $method = $reflClass->getMethod($getsetter);
  378.                 return new PropertyWriteInfo(PropertyWriteInfo::TYPE_METHOD, $getsetter, $this->getWriteVisiblityForMethod($method), $method->isStatic());
  379.             }
  381.             $errors[] = $methodAccessibleErrors;
  382.         }
  384.         if ($reflClass->hasProperty($property) && ($reflClass->getProperty($property)->getModifiers() & $this->propertyReflectionFlags)) {
  385.             $reflProperty = $reflClass->getProperty($property);
  387.             return new PropertyWriteInfo(PropertyWriteInfo::TYPE_PROPERTY, $property, $this->getWriteVisiblityForProperty($reflProperty), $reflProperty->isStatic());
  388.         }
  390.         if ($allowMagicSet) {
  391.             [$accessible, $methodAccessibleErrors] = $this->isMethodAccessible($reflClass, '__set', 2);
  392.             if ($accessible) {
  393.                 return new PropertyWriteInfo(PropertyWriteInfo::TYPE_PROPERTY, $property, PropertyWriteInfo::VISIBILITY_PUBLIC, false);
  394.             }
  396.             $errors[] = $methodAccessibleErrors;
  397.         }
  399.         if ($allowMagicCall) {
  400.             [$accessible, $methodAccessibleErrors] = $this->isMethodAccessible($reflClass, '__call', 2);
  401.             if ($accessible) {
  402.                 return new PropertyWriteInfo(PropertyWriteInfo::TYPE_METHOD, 'set'.$camelized, PropertyWriteInfo::VISIBILITY_PUBLIC, false);
  403.             }
  405.             $errors[] = $methodAccessibleErrors;
  406.         }
  408.         if (!$allowAdderRemover && null !== $adderAccessName && null !== $removerAccessName) {
  409.             $errors[] = [sprintf(
  410.                 'The property "%s" in class "%s" can be defined with the methods "%s()" but '.
  411.                 'the new value must be an array or an instance of \Traversable',
  412.                 $property,
  413.                 $reflClass->getName(),
  414.                 implode('()", "', [$adderAccessName, $removerAccessName])
  415.             )];
  416.         }
  418.         $noneProperty = new PropertyWriteInfo();
  419.         $noneProperty->setErrors(array_merge([], ...$errors));
  421.         return $noneProperty;
  422.     }
  424.     /**
  425.      * @return Type[]|null
  426.      */
  427.     private function extractFromMutator(string $class, string $property): ?array
  428.     {
  429.         [$reflectionMethod, $prefix] = $this->getMutatorMethod($class, $property);
  430.         if (null === $reflectionMethod) {
  431.             return null;
  432.         }
  434.         $reflectionParameters = $reflectionMethod->getParameters();
  435.         $reflectionParameter = $reflectionParameters[0];
  437.         if (!$reflectionType = $reflectionParameter->getType()) {
  438.             return null;
  439.         }
  440.         $type = $this->extractFromReflectionType($reflectionType, $reflectionMethod->getDeclaringClass());
  442.         if (1 === \count($type) && \in_array($prefix, $this->arrayMutatorPrefixes)) {
  443.             $type = [new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true, new Type(Type::BUILTIN_TYPE_INT), $type[0])];
  444.         }
  446.         return $type;
  447.     }
  449.     /**
  450.      * Tries to extract type information from accessors.
  451.      *
  452.      * @return Type[]|null
  453.      */
  454.     private function extractFromAccessor(string $class, string $property): ?array
  455.     {
  456.         [$reflectionMethod, $prefix] = $this->getAccessorMethod($class, $property);
  457.         if (null === $reflectionMethod) {
  458.             return null;
  459.         }
  461.         if ($reflectionType = $reflectionMethod->getReturnType()) {
  462.             return $this->extractFromReflectionType($reflectionType, $reflectionMethod->getDeclaringClass());
  463.         }
  465.         if (\in_array($prefix, ['is', 'can', 'has'])) {
  466.             return [new Type(Type::BUILTIN_TYPE_BOOL)];
  467.         }
  469.         return null;
  470.     }
  472.     /**
  473.      * Tries to extract type information from constructor.
  474.      *
  475.      * @return Type[]|null
  476.      */
  477.     private function extractFromConstructor(string $class, string $property): ?array
  478.     {
  479.         try {
  480.             $reflectionClass = new \ReflectionClass($class);
  481.         } catch (\ReflectionException) {
  482.             return null;
  483.         }
  485.         $constructor = $reflectionClass->getConstructor();
  487.         if (!$constructor) {
  488.             return null;
  489.         }
  491.         foreach ($constructor->getParameters() as $parameter) {
  492.             if ($property !== $parameter->name) {
  493.                 continue;
  494.             }
  495.             $reflectionType = $parameter->getType();
  497.             return $reflectionType ? $this->extractFromReflectionType($reflectionType, $constructor->getDeclaringClass()) : null;
  498.         }
  500.         if ($parentClass = $reflectionClass->getParentClass()) {
  501.             return $this->extractFromConstructor($parentClass->getName(), $property);
  502.         }
  504.         return null;
  505.     }
  507.     private function extractFromPropertyDeclaration(string $class, string $property): ?array
  508.     {
  509.         try {
  510.             $reflectionClass = new \ReflectionClass($class);
  512.             $reflectionProperty = $reflectionClass->getProperty($property);
  513.             $reflectionPropertyType = $reflectionProperty->getType();
  515.             if (null !== $reflectionPropertyType && $types = $this->extractFromReflectionType($reflectionPropertyType, $reflectionProperty->getDeclaringClass())) {
  516.                 return $types;
  517.             }
  518.         } catch (\ReflectionException) {
  519.             return null;
  520.         }
  522.         $defaultValue = $reflectionClass->getDefaultProperties()[$property] ?? null;
  524.         if (null === $defaultValue) {
  525.             return null;
  526.         }
  528.         $type = \gettype($defaultValue);
  529.         $type = static::MAP_TYPES[$type] ?? $type;
  531.         return [new Type($type, $this->isNullableProperty($class, $property), null, Type::BUILTIN_TYPE_ARRAY === $type)];
  532.     }
  534.     private function extractFromReflectionType(\ReflectionType $reflectionType, \ReflectionClass $declaringClass): array
  535.     {
  536.         $types = [];
  537.         $nullable = $reflectionType->allowsNull();
  539.         foreach (($reflectionType instanceof \ReflectionUnionType || $reflectionType instanceof \ReflectionIntersectionType) ? $reflectionType->getTypes() : [$reflectionType] as $type) {
  540.             if (!$type instanceof \ReflectionNamedType) {
  541.                 // Nested composite types are not supported yet.
  542.                 return [];
  543.             }
  545.             $phpTypeOrClass = $type->getName();
  546.             if ('null' === $phpTypeOrClass || 'mixed' === $phpTypeOrClass || 'never' === $phpTypeOrClass) {
  547.                 continue;
  548.             }
  550.             if (Type::BUILTIN_TYPE_ARRAY === $phpTypeOrClass) {
  551.                 $types[] = new Type(Type::BUILTIN_TYPE_ARRAY, $nullable, null, true);
  552.             } elseif ('void' === $phpTypeOrClass) {
  553.                 $types[] = new Type(Type::BUILTIN_TYPE_NULL, $nullable);
  554.             } elseif ($type->isBuiltin()) {
  555.                 $types[] = new Type($phpTypeOrClass, $nullable);
  556.             } else {
  557.                 $types[] = new Type(Type::BUILTIN_TYPE_OBJECT, $nullable, $this->resolveTypeName($phpTypeOrClass, $declaringClass));
  558.             }
  559.         }
  561.         return $types;
  562.     }
  564.     private function resolveTypeName(string $name, \ReflectionClass $declaringClass): string
  565.     {
  566.         if ('self' === $lcName = strtolower($name)) {
  567.             return $declaringClass->name;
  568.         }
  569.         if ('parent' === $lcName && $parent = $declaringClass->getParentClass()) {
  570.             return $parent->name;
  571.         }
  573.         return $name;
  574.     }
  576.     private function isNullableProperty(string $class, string $property): bool
  577.     {
  578.         try {
  579.             $reflectionProperty = new \ReflectionProperty($class, $property);
  581.             $reflectionPropertyType = $reflectionProperty->getType();
  583.             return null !== $reflectionPropertyType && $reflectionPropertyType->allowsNull();
  584.         } catch (\ReflectionException) {
  585.             // Return false if the property doesn't exist
  586.         }
  588.         return false;
  589.     }
  591.     private function isAllowedProperty(string $class, string $property, bool $writeAccessRequired = false): bool
  592.     {
  593.         try {
  594.             $reflectionProperty = new \ReflectionProperty($class, $property);
  596.             if (\PHP_VERSION_ID >= 80100 && $writeAccessRequired && $reflectionProperty->isReadOnly()) {
  597.                 return false;
  598.             }
  600.             return (bool) ($reflectionProperty->getModifiers() & $this->propertyReflectionFlags);
  601.         } catch (\ReflectionException) {
  602.             // Return false if the property doesn't exist
  603.         }
  605.         return false;
  606.     }
  608.     /**
  609.      * Gets the accessor method.
  610.      *
  611.      * Returns an array with a the instance of \ReflectionMethod as first key
  612.      * and the prefix of the method as second or null if not found.
  613.      */
  614.     private function getAccessorMethod(string $class, string $property): ?array
  615.     {
  616.         $ucProperty = ucfirst($property);
  618.         foreach ($this->accessorPrefixes as $prefix) {
  619.             try {
  620.                 $reflectionMethod = new \ReflectionMethod($class, $prefix.$ucProperty);
  621.                 if ($reflectionMethod->isStatic()) {
  622.                     continue;
  623.                 }
  625.                 if (0 === $reflectionMethod->getNumberOfRequiredParameters()) {
  626.                     return [$reflectionMethod, $prefix];
  627.                 }
  628.             } catch (\ReflectionException) {
  629.                 // Return null if the property doesn't exist
  630.             }
  631.         }
  633.         return null;
  634.     }
  636.     /**
  637.      * Returns an array with a the instance of \ReflectionMethod as first key
  638.      * and the prefix of the method as second or null if not found.
  639.      */
  640.     private function getMutatorMethod(string $class, string $property): ?array
  641.     {
  642.         $ucProperty = ucfirst($property);
  643.         $ucSingulars = $this->inflector->singularize($ucProperty);
  645.         $mutatorPrefixes = \in_array($ucProperty, $ucSingulars, true) ? $this->arrayMutatorPrefixesLast : $this->arrayMutatorPrefixesFirst;
  647.         foreach ($mutatorPrefixes as $prefix) {
  648.             $names = [$ucProperty];
  649.             if (\in_array($prefix, $this->arrayMutatorPrefixes)) {
  650.                 $names = array_merge($names, $ucSingulars);
  651.             }
  653.             foreach ($names as $name) {
  654.                 try {
  655.                     $reflectionMethod = new \ReflectionMethod($class, $prefix.$name);
  656.                     if ($reflectionMethod->isStatic()) {
  657.                         continue;
  658.                     }
  660.                     // Parameter can be optional to allow things like: method(array $foo = null)
  661.                     if ($reflectionMethod->getNumberOfParameters() >= 1) {
  662.                         return [$reflectionMethod, $prefix];
  663.                     }
  664.                 } catch (\ReflectionException) {
  665.                     // Try the next prefix if the method doesn't exist
  666.                 }
  667.             }
  668.         }
  670.         return null;
  671.     }
  673.     private function getPropertyName(string $methodName, array $reflectionProperties): ?string
  674.     {
  675.         $pattern = implode('|', array_merge($this->accessorPrefixes, $this->mutatorPrefixes));
  677.         if ('' !== $pattern && preg_match('/^('.$pattern.')(.+)$/i', $methodName, $matches)) {
  678.             if (!\in_array($matches[1], $this->arrayMutatorPrefixes)) {
  679.                 return $matches[2];
  680.             }
  682.             foreach ($reflectionProperties as $reflectionProperty) {
  683.                 foreach ($this->inflector->singularize($reflectionProperty->name) as $name) {
  684.                     if (strtolower($name) === strtolower($matches[2])) {
  685.                         return $reflectionProperty->name;
  686.                     }
  687.                 }
  688.             }
  690.             return $matches[2];
  691.         }
  693.         return null;
  694.     }
  696.     /**
  697.      * Searches for add and remove methods.
  698.      *
  699.      * @param \ReflectionClass $reflClass The reflection class for the given object
  700.      * @param array            $singulars The singular form of the property name or null
  701.      *
  702.      * @return array An array containing the adder and remover when found and errors
  703.      */
  704.     private function findAdderAndRemover(\ReflectionClass $reflClass, array $singulars): array
  705.     {
  706.         if (!\is_array($this->arrayMutatorPrefixes) && 2 !== \count($this->arrayMutatorPrefixes)) {
  707.             return [null, null, []];
  708.         }
  710.         [$addPrefix, $removePrefix] = $this->arrayMutatorPrefixes;
  711.         $errors = [];
  713.         foreach ($singulars as $singular) {
  714.             $addMethod = $addPrefix.$singular;
  715.             $removeMethod = $removePrefix.$singular;
  717.             [$addMethodFound, $addMethodAccessibleErrors] = $this->isMethodAccessible($reflClass, $addMethod, 1);
  718.             [$removeMethodFound, $removeMethodAccessibleErrors] = $this->isMethodAccessible($reflClass, $removeMethod, 1);
  719.             $errors[] = $addMethodAccessibleErrors;
  720.             $errors[] = $removeMethodAccessibleErrors;
  722.             if ($addMethodFound && $removeMethodFound) {
  723.                 return [$addMethod, $removeMethod, []];
  724.             }
  726.             if ($addMethodFound && !$removeMethodFound) {
  727.                 $errors[] = [sprintf('The add method "%s" in class "%s" was found, but the corresponding remove method "%s" was not found', $addMethod, $reflClass->getName(), $removeMethod)];
  728.             } elseif (!$addMethodFound && $removeMethodFound) {
  729.                 $errors[] = [sprintf('The remove method "%s" in class "%s" was found, but the corresponding add method "%s" was not found', $removeMethod, $reflClass->getName(), $addMethod)];
  730.             }
  731.         }
  733.         return [null, null, array_merge([], ...$errors)];
  734.     }
  736.     /**
  737.      * Returns whether a method is public and has the number of required parameters and errors.
  738.      */
  739.     private function isMethodAccessible(\ReflectionClass $class, string $methodName, int $parameters): array
  740.     {
  741.         $errors = [];
  743.         if ($class->hasMethod($methodName)) {
  744.             $method = $class->getMethod($methodName);
  746.             if (\ReflectionMethod::IS_PUBLIC === $this->methodReflectionFlags && !$method->isPublic()) {
  747.                 $errors[] = sprintf('The method "%s" in class "%s" was found but does not have public access.', $methodName, $class->getName());
  748.             } elseif ($method->getNumberOfRequiredParameters() > $parameters || $method->getNumberOfParameters() < $parameters) {
  749.                 $errors[] = sprintf('The method "%s" in class "%s" requires %d arguments, but should accept only %d.', $methodName, $class->getName(), $method->getNumberOfRequiredParameters(), $parameters);
  750.             } else {
  751.                 return [true, $errors];
  752.             }
  753.         }
  755.         return [false, $errors];
  756.     }
  758.     /**
  759.      * Camelizes a given string.
  760.      */
  761.     private function camelize(string $string): string
  762.     {
  763.         return str_replace(' ', '', ucwords(str_replace('_', ' ', $string)));
  764.     }
  766.     /**
  767.      * Return allowed reflection method flags.
  768.      */
  769.     private function getMethodsFlags(int $accessFlags): int
  770.     {
  771.         $methodFlags = 0;
  773.         if ($accessFlags & self::ALLOW_PUBLIC) {
  774.             $methodFlags |= \ReflectionMethod::IS_PUBLIC;
  775.         }
  777.         if ($accessFlags & self::ALLOW_PRIVATE) {
  778.             $methodFlags |= \ReflectionMethod::IS_PRIVATE;
  779.         }
  781.         if ($accessFlags & self::ALLOW_PROTECTED) {
  782.             $methodFlags |= \ReflectionMethod::IS_PROTECTED;
  783.         }
  785.         return $methodFlags;
  786.     }
  788.     /**
  789.      * Return allowed reflection property flags.
  790.      */
  791.     private function getPropertyFlags(int $accessFlags): int
  792.     {
  793.         $propertyFlags = 0;
  795.         if ($accessFlags & self::ALLOW_PUBLIC) {
  796.             $propertyFlags |= \ReflectionProperty::IS_PUBLIC;
  797.         }
  799.         if ($accessFlags & self::ALLOW_PRIVATE) {
  800.             $propertyFlags |= \ReflectionProperty::IS_PRIVATE;
  801.         }
  803.         if ($accessFlags & self::ALLOW_PROTECTED) {
  804.             $propertyFlags |= \ReflectionProperty::IS_PROTECTED;
  805.         }
  807.         return $propertyFlags;
  808.     }
  810.     private function getReadVisiblityForProperty(\ReflectionProperty $reflectionProperty): string
  811.     {
  812.         if ($reflectionProperty->isPrivate()) {
  813.             return PropertyReadInfo::VISIBILITY_PRIVATE;
  814.         }
  816.         if ($reflectionProperty->isProtected()) {
  817.             return PropertyReadInfo::VISIBILITY_PROTECTED;
  818.         }
  820.         return PropertyReadInfo::VISIBILITY_PUBLIC;
  821.     }
  823.     private function getReadVisiblityForMethod(\ReflectionMethod $reflectionMethod): string
  824.     {
  825.         if ($reflectionMethod->isPrivate()) {
  826.             return PropertyReadInfo::VISIBILITY_PRIVATE;
  827.         }
  829.         if ($reflectionMethod->isProtected()) {
  830.             return PropertyReadInfo::VISIBILITY_PROTECTED;
  831.         }
  833.         return PropertyReadInfo::VISIBILITY_PUBLIC;
  834.     }
  836.     private function getWriteVisiblityForProperty(\ReflectionProperty $reflectionProperty): string
  837.     {
  838.         if ($reflectionProperty->isPrivate()) {
  839.             return PropertyWriteInfo::VISIBILITY_PRIVATE;
  840.         }
  842.         if ($reflectionProperty->isProtected()) {
  843.             return PropertyWriteInfo::VISIBILITY_PROTECTED;
  844.         }
  846.         return PropertyWriteInfo::VISIBILITY_PUBLIC;
  847.     }
  849.     private function getWriteVisiblityForMethod(\ReflectionMethod $reflectionMethod): string
  850.     {
  851.         if ($reflectionMethod->isPrivate()) {
  852.             return PropertyWriteInfo::VISIBILITY_PRIVATE;
  853.         }
  855.         if ($reflectionMethod->isProtected()) {
  856.             return PropertyWriteInfo::VISIBILITY_PROTECTED;
  857.         }
  859.         return PropertyWriteInfo::VISIBILITY_PUBLIC;
  860.     }
  861. }