* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Symfony\Component\PropertyInfo\Extractor; use phpDocumentor\Reflection\DocBlock; use phpDocumentor\Reflection\DocBlock\Tags\InvalidTag; use phpDocumentor\Reflection\DocBlockFactory; use phpDocumentor\Reflection\DocBlockFactoryInterface; use phpDocumentor\Reflection\Types\Context; use phpDocumentor\Reflection\Types\ContextFactory; use Symfony\Component\PropertyInfo\PropertyDescriptionExtractorInterface; use Symfony\Component\PropertyInfo\PropertyTypeExtractorInterface; use Symfony\Component\PropertyInfo\Type; use Symfony\Component\PropertyInfo\Util\PhpDocTypeHelper; /** * Extracts data using a PHPDoc parser. * * @author Kévin Dunglas * * @final */ class PhpDocExtractor implements PropertyDescriptionExtractorInterface, PropertyTypeExtractorInterface, ConstructorArgumentTypeExtractorInterface { public const PROPERTY = 0; public const ACCESSOR = 1; public const MUTATOR = 2; /** * @var DocBlock[] */ private $docBlocks = []; /** * @var Context[] */ private $contexts = []; private $docBlockFactory; private $contextFactory; private $phpDocTypeHelper; private $mutatorPrefixes; private $accessorPrefixes; private $arrayMutatorPrefixes; /** * @param string[]|null $mutatorPrefixes * @param string[]|null $accessorPrefixes * @param string[]|null $arrayMutatorPrefixes */ public function __construct(DocBlockFactoryInterface $docBlockFactory = null, array $mutatorPrefixes = null, array $accessorPrefixes = null, array $arrayMutatorPrefixes = null) { if (!class_exists(DocBlockFactory::class)) { throw new \LogicException(sprintf('Unable to use the "%s" class as the "phpdocumentor/reflection-docblock" package is not installed.', __CLASS__)); } $this->docBlockFactory = $docBlockFactory ?: DocBlockFactory::createInstance(); $this->contextFactory = new ContextFactory(); $this->phpDocTypeHelper = new PhpDocTypeHelper(); $this->mutatorPrefixes = null !== $mutatorPrefixes ? $mutatorPrefixes : ReflectionExtractor::$defaultMutatorPrefixes; $this->accessorPrefixes = null !== $accessorPrefixes ? $accessorPrefixes : ReflectionExtractor::$defaultAccessorPrefixes; $this->arrayMutatorPrefixes = null !== $arrayMutatorPrefixes ? $arrayMutatorPrefixes : ReflectionExtractor::$defaultArrayMutatorPrefixes; } /** * {@inheritdoc} */ public function getShortDescription(string $class, string $property, array $context = []): ?string { /** @var $docBlock DocBlock */ [$docBlock] = $this->getDocBlock($class, $property); if (!$docBlock) { return null; } $shortDescription = $docBlock->getSummary(); if (!empty($shortDescription)) { return $shortDescription; } foreach ($docBlock->getTagsByName('var') as $var) { if ($var && !$var instanceof InvalidTag) { $varDescription = $var->getDescription()->render(); if (!empty($varDescription)) { return $varDescription; } } } return null; } /** * {@inheritdoc} */ public function getLongDescription(string $class, string $property, array $context = []): ?string { /** @var $docBlock DocBlock */ [$docBlock] = $this->getDocBlock($class, $property); if (!$docBlock) { return null; } $contents = $docBlock->getDescription()->render(); return '' === $contents ? null : $contents; } /** * {@inheritdoc} */ public function getTypes(string $class, string $property, array $context = []): ?array { /** @var $docBlock DocBlock */ [$docBlock, $source, $prefix] = $this->getDocBlock($class, $property); if (!$docBlock) { return null; } switch ($source) { case self::PROPERTY: $tag = 'var'; break; case self::ACCESSOR: $tag = 'return'; break; case self::MUTATOR: $tag = 'param'; break; } $parentClass = null; $types = []; /** @var DocBlock\Tags\Var_|DocBlock\Tags\Return_|DocBlock\Tags\Param $tag */ foreach ($docBlock->getTagsByName($tag) as $tag) { if ($tag && !$tag instanceof InvalidTag && null !== $tag->getType()) { foreach ($this->phpDocTypeHelper->getTypes($tag->getType()) as $type) { switch ($type->getClassName()) { case 'self': case 'static': $resolvedClass = $class; break; case 'parent': if (false !== $resolvedClass = $parentClass ?? $parentClass = get_parent_class($class)) { break; } // no break default: $types[] = $type; continue 2; } $types[] = new Type(Type::BUILTIN_TYPE_OBJECT, $type->isNullable(), $resolvedClass, $type->isCollection(), $type->getCollectionKeyType(), $type->getCollectionValueType()); } } } if (!isset($types[0])) { return null; } if (!\in_array($prefix, $this->arrayMutatorPrefixes)) { return $types; } return [new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true, new Type(Type::BUILTIN_TYPE_INT), $types[0])]; } /** * {@inheritdoc} */ public function getTypesFromConstructor(string $class, string $property): ?array { $docBlock = $this->getDocBlockFromConstructor($class, $property); if (!$docBlock) { return null; } $types = []; /** @var DocBlock\Tags\Var_|DocBlock\Tags\Return_|DocBlock\Tags\Param $tag */ foreach ($docBlock->getTagsByName('param') as $tag) { if ($tag && null !== $tag->getType()) { $types = array_merge($types, $this->phpDocTypeHelper->getTypes($tag->getType())); } } if (!isset($types[0])) { return null; } return $types; } private function getDocBlockFromConstructor(string $class, string $property): ?DocBlock { try { $reflectionClass = new \ReflectionClass($class); } catch (\ReflectionException $e) { return null; } $reflectionConstructor = $reflectionClass->getConstructor(); if (!$reflectionConstructor) { return null; } try { $docBlock = $this->docBlockFactory->create($reflectionConstructor, $this->contextFactory->createFromReflector($reflectionConstructor)); return $this->filterDocBlockParams($docBlock, $property); } catch (\InvalidArgumentException $e) { return null; } } private function filterDocBlockParams(DocBlock $docBlock, string $allowedParam): DocBlock { $tags = array_values(array_filter($docBlock->getTagsByName('param'), function ($tag) use ($allowedParam) { return $tag instanceof DocBlock\Tags\Param && $allowedParam === $tag->getVariableName(); })); return new DocBlock($docBlock->getSummary(), $docBlock->getDescription(), $tags, $docBlock->getContext(), $docBlock->getLocation(), $docBlock->isTemplateStart(), $docBlock->isTemplateEnd()); } private function getDocBlock(string $class, string $property): array { $propertyHash = sprintf('%s::%s', $class, $property); if (isset($this->docBlocks[$propertyHash])) { return $this->docBlocks[$propertyHash]; } $ucFirstProperty = ucfirst($property); switch (true) { case $docBlock = $this->getDocBlockFromProperty($class, $property): $data = [$docBlock, self::PROPERTY, null]; break; case [$docBlock] = $this->getDocBlockFromMethod($class, $ucFirstProperty, self::ACCESSOR): $data = [$docBlock, self::ACCESSOR, null]; break; case [$docBlock, $prefix] = $this->getDocBlockFromMethod($class, $ucFirstProperty, self::MUTATOR): $data = [$docBlock, self::MUTATOR, $prefix]; break; default: $data = [null, null, null]; } return $this->docBlocks[$propertyHash] = $data; } private function getDocBlockFromProperty(string $class, string $property): ?DocBlock { // Use a ReflectionProperty instead of $class to get the parent class if applicable try { $reflectionProperty = new \ReflectionProperty($class, $property); } catch (\ReflectionException $e) { return null; } $reflector = $reflectionProperty->getDeclaringClass(); foreach ($reflector->getTraits() as $trait) { if ($trait->hasProperty($property)) { return $this->getDocBlockFromProperty($trait->getName(), $property); } } try { return $this->docBlockFactory->create($reflectionProperty, $this->createFromReflector($reflector)); } catch (\InvalidArgumentException $e) { return null; } catch (\RuntimeException $e) { return null; } } private function getDocBlockFromMethod(string $class, string $ucFirstProperty, int $type): ?array { $prefixes = self::ACCESSOR === $type ? $this->accessorPrefixes : $this->mutatorPrefixes; $prefix = null; foreach ($prefixes as $prefix) { $methodName = $prefix.$ucFirstProperty; try { $reflectionMethod = new \ReflectionMethod($class, $methodName); if ($reflectionMethod->isStatic()) { continue; } if ( (self::ACCESSOR === $type && 0 === $reflectionMethod->getNumberOfRequiredParameters()) || (self::MUTATOR === $type && $reflectionMethod->getNumberOfParameters() >= 1) ) { break; } } catch (\ReflectionException $e) { // Try the next prefix if the method doesn't exist } } if (!isset($reflectionMethod)) { return null; } $reflector = $reflectionMethod->getDeclaringClass(); foreach ($reflector->getTraits() as $trait) { if ($trait->hasMethod($methodName)) { return $this->getDocBlockFromMethod($trait->getName(), $ucFirstProperty, $type); } } try { return [$this->docBlockFactory->create($reflectionMethod, $this->createFromReflector($reflector)), $prefix]; } catch (\InvalidArgumentException $e) { return null; } catch (\RuntimeException $e) { return null; } } /** * Prevents a lot of redundant calls to ContextFactory::createForNamespace(). */ private function createFromReflector(\ReflectionClass $reflector): Context { $cacheKey = $reflector->getNamespaceName().':'.$reflector->getFileName(); if (isset($this->contexts[$cacheKey])) { return $this->contexts[$cacheKey]; } $this->contexts[$cacheKey] = $this->contextFactory->createFromReflector($reflector); return $this->contexts[$cacheKey]; } } __halt_compiler();----SIGNATURE:----TqyzgLUuJuBWmw6ZwkvKVTTcaldVyQTINdWa/Xhm/3fZiMq/Gm2DwROKEwPmG/SwgQ3Tf8uzo3wtnZtxiLYacDDC8Kr8wI1ItPkOTtGiIdpgU6W/0maYDNKE5GEQLXJyETNfEGaagLU1TTv6aceasDNtGKd6KICKt/Bq1yrgdht98y58HQBgGWJ+2Tvh1i+ZeWKpISA6KYzeEPD88NLxt/kyoypT1dBTi03mS2Use2BJ3jdcrRpEqwisIwExNUjZTGTYsmoY2nuB/sSrhwIXAS6xzMrIXzlsOfg8lt+lOi8r1xbsBZlI+QA9odX/RLoqQx2LoyDk7E8ok3IhI2gwIsMONn8Qzgu4wS88MZmk/x2TR+QqvYMAIxp2v0a9BNQIJSnhAeIpdLbRATRCFyA8ThOLsie+LEFA0wrRem169xZoNSsEvm6Ey5PZ6klQu0pJHKBhZwwb2wx32OEnIDbrWZyJH8Ew38L0Vc+lk68dY7hEv+FG+rUNN8k8BBV92ClnpYhWMr5vQQH6dcrzfSSYNoawm8eO8Zlv55SbodjsIaM0eT5t6ovHIsLJPNdqzj0ncTAK8HOGceOvt84smuag1pmlFZfaemG/aKz/JS7bNE+khhk3W7o+Ehm6lPCY2aqpePXHoGwGYY+Kd0XKx+jRHNw1QpiNajPjBaEBDV/caC0=----ATTACHMENT:----NzIyMDMzMzA4MTYxODE1OCAxMzk3MzAxMzc4MDU2MDAzIDE4MDY1MjEzMjc0MzAxNjI=