vendor/symfony/error-handler/DebugClassLoader.php line 331

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the Symfony package.
  4.  *
  5.  * (c) Fabien Potencier <fabien@symfony.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. namespace Symfony\Component\ErrorHandler;
  11. use Composer\InstalledVersions;
  12. use Doctrine\Common\Persistence\Proxy as LegacyProxy;
  13. use Doctrine\Persistence\Proxy;
  14. use Mockery\MockInterface;
  15. use Phake\IMock;
  16. use PHPUnit\Framework\MockObject\Matcher\StatelessInvocation;
  17. use PHPUnit\Framework\MockObject\MockObject;
  18. use Prophecy\Prophecy\ProphecySubjectInterface;
  19. use ProxyManager\Proxy\ProxyInterface;
  20. use Symfony\Component\ErrorHandler\Internal\TentativeTypes;
  21. /**
  22.  * Autoloader checking if the class is really defined in the file found.
  23.  *
  24.  * The ClassLoader will wrap all registered autoloaders
  25.  * and will throw an exception if a file is found but does
  26.  * not declare the class.
  27.  *
  28.  * It can also patch classes to turn docblocks into actual return types.
  29.  * This behavior is controlled by the SYMFONY_PATCH_TYPE_DECLARATIONS env var,
  30.  * which is a url-encoded array with the follow parameters:
  31.  *  - "force": any value enables deprecation notices - can be any of:
  32.  *      - "phpdoc" to patch only docblock annotations
  33.  *      - "2" to add all possible return types
  34.  *      - "1" to add return types but only to tests/final/internal/private methods
  35.  *  - "php": the target version of PHP - e.g. "7.1" doesn't generate "object" types
  36.  *  - "deprecations": "1" to trigger a deprecation notice when a child class misses a
  37.  *                    return type while the parent declares an "@return" annotation
  38.  *
  39.  * Note that patching doesn't care about any coding style so you'd better to run
  40.  * php-cs-fixer after, with rules "phpdoc_trim_consecutive_blank_line_separation"
  41.  * and "no_superfluous_phpdoc_tags" enabled typically.
  42.  *
  43.  * @author Fabien Potencier <fabien@symfony.com>
  44.  * @author Christophe Coevoet <stof@notk.org>
  45.  * @author Nicolas Grekas <p@tchwork.com>
  46.  * @author Guilhem Niot <guilhem.niot@gmail.com>
  47.  */
  48. class DebugClassLoader
  49. {
  50.     private const SPECIAL_RETURN_TYPES = [
  51.         'void' => 'void',
  52.         'null' => 'null',
  53.         'resource' => 'resource',
  54.         'boolean' => 'bool',
  55.         'true' => 'bool',
  56.         'false' => 'false',
  57.         'integer' => 'int',
  58.         'array' => 'array',
  59.         'bool' => 'bool',
  60.         'callable' => 'callable',
  61.         'float' => 'float',
  62.         'int' => 'int',
  63.         'iterable' => 'iterable',
  64.         'object' => 'object',
  65.         'string' => 'string',
  66.         'self' => 'self',
  67.         'parent' => 'parent',
  68.         'mixed' => 'mixed',
  69.         'static' => 'static',
  70.         '$this' => 'static',
  71.         'list' => 'array',
  72.         'class-string' => 'string',
  73.     ];
  74.     private const BUILTIN_RETURN_TYPES = [
  75.         'void' => true,
  76.         'array' => true,
  77.         'false' => true,
  78.         'bool' => true,
  79.         'callable' => true,
  80.         'float' => true,
  81.         'int' => true,
  82.         'iterable' => true,
  83.         'object' => true,
  84.         'string' => true,
  85.         'self' => true,
  86.         'parent' => true,
  87.         'mixed' => true,
  88.         'static' => true,
  89.     ];
  90.     private const MAGIC_METHODS = [
  91.         '__isset' => 'bool',
  92.         '__sleep' => 'array',
  93.         '__toString' => 'string',
  94.         '__debugInfo' => 'array',
  95.         '__serialize' => 'array',
  96.     ];
  97.     /**
  98.      * @var callable
  99.      */
  100.     private $classLoader;
  101.     private bool $isFinder;
  102.     private array $loaded = [];
  103.     private array $patchTypes = [];
  104.     private static int $caseCheck;
  105.     private static array $checkedClasses = [];
  106.     private static array $final = [];
  107.     private static array $finalMethods = [];
  108.     private static array $finalProperties = [];
  109.     private static array $finalConstants = [];
  110.     private static array $deprecated = [];
  111.     private static array $internal = [];
  112.     private static array $internalMethods = [];
  113.     private static array $annotatedParameters = [];
  114.     private static array $darwinCache = ['/' => ['/', []]];
  115.     private static array $method = [];
  116.     private static array $returnTypes = [];
  117.     private static array $methodTraits = [];
  118.     private static array $fileOffsets = [];
  119.     public function __construct(callable $classLoader)
  120.     {
  121.         $this->classLoader $classLoader;
  122.         $this->isFinder \is_array($classLoader) && method_exists($classLoader[0], 'findFile');
  123.         parse_str(getenv('SYMFONY_PATCH_TYPE_DECLARATIONS') ?: ''$this->patchTypes);
  124.         $this->patchTypes += [
  125.             'force' => null,
  126.             'php' => \PHP_MAJOR_VERSION.'.'.\PHP_MINOR_VERSION,
  127.             'deprecations' => true,
  128.         ];
  129.         if ('phpdoc' === $this->patchTypes['force']) {
  130.             $this->patchTypes['force'] = 'docblock';
  131.         }
  132.         if (!isset(self::$caseCheck)) {
  133.             $file is_file(__FILE__) ? __FILE__ rtrim(realpath('.'), \DIRECTORY_SEPARATOR);
  134.             $i strrpos($file\DIRECTORY_SEPARATOR);
  135.             $dir substr($file0$i);
  136.             $file substr($file$i);
  137.             $test strtoupper($file) === $file strtolower($file) : strtoupper($file);
  138.             $test realpath($dir.$test);
  139.             if (false === $test || false === $i) {
  140.                 // filesystem is case sensitive
  141.                 self::$caseCheck 0;
  142.             } elseif (str_ends_with($test$file)) {
  143.                 // filesystem is case insensitive and realpath() normalizes the case of characters
  144.                 self::$caseCheck 1;
  145.             } elseif ('Darwin' === \PHP_OS_FAMILY) {
  146.                 // on MacOSX, HFS+ is case insensitive but realpath() doesn't normalize the case of characters
  147.                 self::$caseCheck 2;
  148.             } else {
  149.                 // filesystem case checks failed, fallback to disabling them
  150.                 self::$caseCheck 0;
  151.             }
  152.         }
  153.     }
  154.     public function getClassLoader(): callable
  155.     {
  156.         return $this->classLoader;
  157.     }
  158.     /**
  159.      * Wraps all autoloaders.
  160.      */
  161.     public static function enable(): void
  162.     {
  163.         // Ensures we don't hit https://bugs.php.net/42098
  164.         class_exists(\Symfony\Component\ErrorHandler\ErrorHandler::class);
  165.         class_exists(\Psr\Log\LogLevel::class);
  166.         if (!\is_array($functions spl_autoload_functions())) {
  167.             return;
  168.         }
  169.         foreach ($functions as $function) {
  170.             spl_autoload_unregister($function);
  171.         }
  172.         foreach ($functions as $function) {
  173.             if (!\is_array($function) || !$function[0] instanceof self) {
  174.                 $function = [new static($function), 'loadClass'];
  175.             }
  176.             spl_autoload_register($function);
  177.         }
  178.     }
  179.     /**
  180.      * Disables the wrapping.
  181.      */
  182.     public static function disable(): void
  183.     {
  184.         if (!\is_array($functions spl_autoload_functions())) {
  185.             return;
  186.         }
  187.         foreach ($functions as $function) {
  188.             spl_autoload_unregister($function);
  189.         }
  190.         foreach ($functions as $function) {
  191.             if (\is_array($function) && $function[0] instanceof self) {
  192.                 $function $function[0]->getClassLoader();
  193.             }
  194.             spl_autoload_register($function);
  195.         }
  196.     }
  197.     public static function checkClasses(): bool
  198.     {
  199.         if (!\is_array($functions spl_autoload_functions())) {
  200.             return false;
  201.         }
  202.         $loader null;
  203.         foreach ($functions as $function) {
  204.             if (\is_array($function) && $function[0] instanceof self) {
  205.                 $loader $function[0];
  206.                 break;
  207.             }
  208.         }
  209.         if (null === $loader) {
  210.             return false;
  211.         }
  212.         static $offsets = [
  213.             'get_declared_interfaces' => 0,
  214.             'get_declared_traits' => 0,
  215.             'get_declared_classes' => 0,
  216.         ];
  217.         foreach ($offsets as $getSymbols => $i) {
  218.             $symbols $getSymbols();
  219.             for (; $i \count($symbols); ++$i) {
  220.                 if (!is_subclass_of($symbols[$i], MockObject::class)
  221.                     && !is_subclass_of($symbols[$i], ProphecySubjectInterface::class)
  222.                     && !is_subclass_of($symbols[$i], Proxy::class)
  223.                     && !is_subclass_of($symbols[$i], ProxyInterface::class)
  224.                     && !is_subclass_of($symbols[$i], LegacyProxy::class)
  225.                     && !is_subclass_of($symbols[$i], MockInterface::class)
  226.                     && !is_subclass_of($symbols[$i], IMock::class)
  227.                 ) {
  228.                     $loader->checkClass($symbols[$i]);
  229.                 }
  230.             }
  231.             $offsets[$getSymbols] = $i;
  232.         }
  233.         return true;
  234.     }
  235.     public function findFile(string $class): ?string
  236.     {
  237.         return $this->isFinder ? ($this->classLoader[0]->findFile($class) ?: null) : null;
  238.     }
  239.     /**
  240.      * Loads the given class or interface.
  241.      *
  242.      * @throws \RuntimeException
  243.      */
  244.     public function loadClass(string $class): void
  245.     {
  246.         $e error_reporting(error_reporting() | \E_PARSE \E_ERROR \E_CORE_ERROR \E_COMPILE_ERROR);
  247.         try {
  248.             if ($this->isFinder && !isset($this->loaded[$class])) {
  249.                 $this->loaded[$class] = true;
  250.                 if (!$file $this->classLoader[0]->findFile($class) ?: '') {
  251.                     // no-op
  252.                 } elseif (\function_exists('opcache_is_script_cached') && @opcache_is_script_cached($file)) {
  253.                     include $file;
  254.                     return;
  255.                 } elseif (false === include $file) {
  256.                     return;
  257.                 }
  258.             } else {
  259.                 ($this->classLoader)($class);
  260.                 $file '';
  261.             }
  262.         } finally {
  263.             error_reporting($e);
  264.         }
  265.         $this->checkClass($class$file);
  266.     }
  267.     private function checkClass(string $classstring $file null): void
  268.     {
  269.         $exists null === $file || class_exists($classfalse) || interface_exists($classfalse) || trait_exists($classfalse);
  270.         if (null !== $file && $class && '\\' === $class[0]) {
  271.             $class substr($class1);
  272.         }
  273.         if ($exists) {
  274.             if (isset(self::$checkedClasses[$class])) {
  275.                 return;
  276.             }
  277.             self::$checkedClasses[$class] = true;
  278.             $refl = new \ReflectionClass($class);
  279.             if (null === $file && $refl->isInternal()) {
  280.                 return;
  281.             }
  282.             $name $refl->getName();
  283.             if ($name !== $class && === strcasecmp($name$class)) {
  284.                 throw new \RuntimeException(sprintf('Case mismatch between loaded and declared class names: "%s" vs "%s".'$class$name));
  285.             }
  286.             $deprecations $this->checkAnnotations($refl$name);
  287.             foreach ($deprecations as $message) {
  288.                 @trigger_error($message\E_USER_DEPRECATED);
  289.             }
  290.         }
  291.         if (!$file) {
  292.             return;
  293.         }
  294.         if (!$exists) {
  295.             if (str_contains($class'/')) {
  296.                 throw new \RuntimeException(sprintf('Trying to autoload a class with an invalid name "%s". Be careful that the namespace separator is "\" in PHP, not "/".'$class));
  297.             }
  298.             throw new \RuntimeException(sprintf('The autoloader expected class "%s" to be defined in file "%s". The file was found but the class was not in it, the class name or namespace probably has a typo.'$class$file));
  299.         }
  300.         if (self::$caseCheck && $message $this->checkCase($refl$file$class)) {
  301.             throw new \RuntimeException(sprintf('Case mismatch between class and real file names: "%s" vs "%s" in "%s".'$message[0], $message[1], $message[2]));
  302.         }
  303.     }
  304.     public function checkAnnotations(\ReflectionClass $reflstring $class): array
  305.     {
  306.         if (
  307.             'Symfony\Bridge\PhpUnit\Legacy\SymfonyTestsListenerForV7' === $class
  308.             || 'Symfony\Bridge\PhpUnit\Legacy\SymfonyTestsListenerForV6' === $class
  309.         ) {
  310.             return [];
  311.         }
  312.         $deprecations = [];
  313.         $className str_contains($class"@anonymous\0") ? (get_parent_class($class) ?: key(class_implements($class)) ?: 'class').'@anonymous' $class;
  314.         // Don't trigger deprecations for classes in the same vendor
  315.         if ($class !== $className) {
  316.             $vendor preg_match('/^namespace ([^;\\\\\s]++)[;\\\\]/m', @file_get_contents($refl->getFileName()), $vendor) ? $vendor[1].'\\' '';
  317.             $vendorLen \strlen($vendor);
  318.         } elseif ($vendorLen + (strpos($class'\\') ?: strpos($class'_'))) {
  319.             $vendorLen 0;
  320.             $vendor '';
  321.         } else {
  322.             $vendor str_replace('_''\\'substr($class0$vendorLen));
  323.         }
  324.         $parent get_parent_class($class) ?: null;
  325.         self::$returnTypes[$class] = [];
  326.         $classIsTemplate false;
  327.         // Detect annotations on the class
  328.         if ($doc $this->parsePhpDoc($refl)) {
  329.             $classIsTemplate = isset($doc['template']);
  330.             foreach (['final''deprecated''internal'] as $annotation) {
  331.                 if (null !== $description $doc[$annotation][0] ?? null) {
  332.                     self::${$annotation}[$class] = '' !== $description ' '.$description.(preg_match('/[.!]$/'$description) ? '' '.') : '.';
  333.                 }
  334.             }
  335.             if ($refl->isInterface() && isset($doc['method'])) {
  336.                 foreach ($doc['method'] as $name => [$static$returnType$signature$description]) {
  337.                     self::$method[$class][] = [$class$static$returnType$name.$signature$description];
  338.                     if ('' !== $returnType) {
  339.                         $this->setReturnType($returnType$refl->name$name$refl->getFileName(), $parent);
  340.                     }
  341.                 }
  342.             }
  343.         }
  344.         $parentAndOwnInterfaces $this->getOwnInterfaces($class$parent);
  345.         if ($parent) {
  346.             $parentAndOwnInterfaces[$parent] = $parent;
  347.             if (!isset(self::$checkedClasses[$parent])) {
  348.                 $this->checkClass($parent);
  349.             }
  350.             if (isset(self::$final[$parent])) {
  351.                 $deprecations[] = sprintf('The "%s" class is considered final%s It may change without further notice as of its next major version. You should not extend it from "%s".'$parentself::$final[$parent], $className);
  352.             }
  353.         }
  354.         // Detect if the parent is annotated
  355.         foreach ($parentAndOwnInterfaces class_uses($classfalse) as $use) {
  356.             if (!isset(self::$checkedClasses[$use])) {
  357.                 $this->checkClass($use);
  358.             }
  359.             if (isset(self::$deprecated[$use]) && strncmp($vendorstr_replace('_''\\'$use), $vendorLen) && !isset(self::$deprecated[$class])) {
  360.                 $type class_exists($classfalse) ? 'class' : (interface_exists($classfalse) ? 'interface' 'trait');
  361.                 $verb class_exists($usefalse) || interface_exists($classfalse) ? 'extends' : (interface_exists($usefalse) ? 'implements' 'uses');
  362.                 $deprecations[] = sprintf('The "%s" %s %s "%s" that is deprecated%s'$className$type$verb$useself::$deprecated[$use]);
  363.             }
  364.             if (isset(self::$internal[$use]) && strncmp($vendorstr_replace('_''\\'$use), $vendorLen)) {
  365.                 $deprecations[] = sprintf('The "%s" %s is considered internal%s It may change without further notice. You should not use it from "%s".'$useclass_exists($usefalse) ? 'class' : (interface_exists($usefalse) ? 'interface' 'trait'), self::$internal[$use], $className);
  366.             }
  367.             if (isset(self::$method[$use])) {
  368.                 if ($refl->isAbstract()) {
  369.                     if (isset(self::$method[$class])) {
  370.                         self::$method[$class] = array_merge(self::$method[$class], self::$method[$use]);
  371.                     } else {
  372.                         self::$method[$class] = self::$method[$use];
  373.                     }
  374.                 } elseif (!$refl->isInterface()) {
  375.                     if (!strncmp($vendorstr_replace('_''\\'$use), $vendorLen)
  376.                         && str_starts_with($className'Symfony\\')
  377.                         && (!class_exists(InstalledVersions::class)
  378.                             || 'symfony/symfony' !== InstalledVersions::getRootPackage()['name'])
  379.                     ) {
  380.                         // skip "same vendor" @method deprecations for Symfony\* classes unless symfony/symfony is being tested
  381.                         continue;
  382.                     }
  383.                     $hasCall $refl->hasMethod('__call');
  384.                     $hasStaticCall $refl->hasMethod('__callStatic');
  385.                     foreach (self::$method[$use] as [$interface$static$returnType$name$description]) {
  386.                         if ($static $hasStaticCall $hasCall) {
  387.                             continue;
  388.                         }
  389.                         $realName substr($name0strpos($name'('));
  390.                         if (!$refl->hasMethod($realName) || !($methodRefl $refl->getMethod($realName))->isPublic() || ($static && !$methodRefl->isStatic()) || (!$static && $methodRefl->isStatic())) {
  391.                             $deprecations[] = sprintf('Class "%s" should implement method "%s::%s%s"%s'$className, ($static 'static ' '').$interface$name$returnType ': '.$returnType ''null === $description '.' ': '.$description);
  392.                         }
  393.                     }
  394.                 }
  395.             }
  396.         }
  397.         if (trait_exists($class)) {
  398.             $file $refl->getFileName();
  399.             foreach ($refl->getMethods() as $method) {
  400.                 if ($method->getFileName() === $file) {
  401.                     self::$methodTraits[$file][$method->getStartLine()] = $class;
  402.                 }
  403.             }
  404.             return $deprecations;
  405.         }
  406.         // Inherit @final, @internal, @param and @return annotations for methods
  407.         self::$finalMethods[$class] = [];
  408.         self::$internalMethods[$class] = [];
  409.         self::$annotatedParameters[$class] = [];
  410.         self::$finalProperties[$class] = [];
  411.         self::$finalConstants[$class] = [];
  412.         foreach ($parentAndOwnInterfaces as $use) {
  413.             foreach (['finalMethods''internalMethods''annotatedParameters''returnTypes''finalProperties''finalConstants'] as $property) {
  414.                 if (isset(self::${$property}[$use])) {
  415.                     self::${$property}[$class] = self::${$property}[$class] ? self::${$property}[$use] + self::${$property}[$class] : self::${$property}[$use];
  416.                 }
  417.             }
  418.             if (null !== (TentativeTypes::RETURN_TYPES[$use] ?? null)) {
  419.                 foreach (TentativeTypes::RETURN_TYPES[$use] as $method => $returnType) {
  420.                     $returnType explode('|'$returnType);
  421.                     foreach ($returnType as $i => $t) {
  422.                         if ('?' !== $t && !isset(self::BUILTIN_RETURN_TYPES[$t])) {
  423.                             $returnType[$i] = '\\'.$t;
  424.                         }
  425.                     }
  426.                     $returnType implode('|'$returnType);
  427.                     self::$returnTypes[$class] += [$method => [$returnTypestr_starts_with($returnType'?') ? substr($returnType1).'|null' $returnType$use'']];
  428.                 }
  429.             }
  430.         }
  431.         foreach ($refl->getMethods() as $method) {
  432.             if ($method->class !== $class) {
  433.                 continue;
  434.             }
  435.             if (null === $ns self::$methodTraits[$method->getFileName()][$method->getStartLine()] ?? null) {
  436.                 $ns $vendor;
  437.                 $len $vendorLen;
  438.             } elseif ($len + (strpos($ns'\\') ?: strpos($ns'_'))) {
  439.                 $len 0;
  440.                 $ns '';
  441.             } else {
  442.                 $ns str_replace('_''\\'substr($ns0$len));
  443.             }
  444.             if ($parent && isset(self::$finalMethods[$parent][$method->name])) {
  445.                 [$declaringClass$message] = self::$finalMethods[$parent][$method->name];
  446.                 $deprecations[] = sprintf('The "%s::%s()" method is considered final%s It may change without further notice as of its next major version. You should not extend it from "%s".'$declaringClass$method->name$message$className);
  447.             }
  448.             if (isset(self::$internalMethods[$class][$method->name])) {
  449.                 [$declaringClass$message] = self::$internalMethods[$class][$method->name];
  450.                 if (strncmp($ns$declaringClass$len)) {
  451.                     $deprecations[] = sprintf('The "%s::%s()" method is considered internal%s It may change without further notice. You should not extend it from "%s".'$declaringClass$method->name$message$className);
  452.                 }
  453.             }
  454.             // To read method annotations
  455.             $doc $this->parsePhpDoc($method);
  456.             if (($classIsTemplate || isset($doc['template'])) && $method->hasReturnType()) {
  457.                 unset($doc['return']);
  458.             }
  459.             if (isset(self::$annotatedParameters[$class][$method->name])) {
  460.                 $definedParameters = [];
  461.                 foreach ($method->getParameters() as $parameter) {
  462.                     $definedParameters[$parameter->name] = true;
  463.                 }
  464.                 foreach (self::$annotatedParameters[$class][$method->name] as $parameterName => $deprecation) {
  465.                     if (!isset($definedParameters[$parameterName]) && !isset($doc['param'][$parameterName])) {
  466.                         $deprecations[] = sprintf($deprecation$className);
  467.                     }
  468.                 }
  469.             }
  470.             $forcePatchTypes $this->patchTypes['force'];
  471.             if ($canAddReturnType null !== $forcePatchTypes && !str_contains($method->getFileName(), \DIRECTORY_SEPARATOR.'vendor'.\DIRECTORY_SEPARATOR)) {
  472.                 if ('void' !== (self::MAGIC_METHODS[$method->name] ?? 'void')) {
  473.                     $this->patchTypes['force'] = $forcePatchTypes ?: 'docblock';
  474.                 }
  475.                 $canAddReturnType === (int) $forcePatchTypes
  476.                     || false !== stripos($method->getFileName(), \DIRECTORY_SEPARATOR.'Tests'.\DIRECTORY_SEPARATOR)
  477.                     || $refl->isFinal()
  478.                     || $method->isFinal()
  479.                     || $method->isPrivate()
  480.                     || ('.' === (self::$internal[$class] ?? null) && !$refl->isAbstract())
  481.                     || '.' === (self::$final[$class] ?? null)
  482.                     || '' === ($doc['final'][0] ?? null)
  483.                     || '' === ($doc['internal'][0] ?? null)
  484.                 ;
  485.             }
  486.             if (null !== ($returnType self::$returnTypes[$class][$method->name] ?? null) && 'docblock' === $this->patchTypes['force'] && !$method->hasReturnType() && isset(TentativeTypes::RETURN_TYPES[$returnType[2]][$method->name])) {
  487.                 $this->patchReturnTypeWillChange($method);
  488.             }
  489.             if (null !== ($returnType ??= self::MAGIC_METHODS[$method->name] ?? null) && !$method->hasReturnType() && !isset($doc['return'])) {
  490.                 [$normalizedType$returnType$declaringClass$declaringFile] = \is_string($returnType) ? [$returnType$returnType''''] : $returnType;
  491.                 if ($canAddReturnType && 'docblock' !== $this->patchTypes['force']) {
  492.                     $this->patchMethod($method$returnType$declaringFile$normalizedType);
  493.                 }
  494.                 if (!isset($doc['deprecated']) && strncmp($ns$declaringClass$len)) {
  495.                     if ('docblock' === $this->patchTypes['force']) {
  496.                         $this->patchMethod($method$returnType$declaringFile$normalizedType);
  497.                     } elseif ('' !== $declaringClass && $this->patchTypes['deprecations']) {
  498.                         $deprecations[] = sprintf('Method "%s::%s()" might add "%s" as a native return type declaration in the future. Do the same in %s "%s" now to avoid errors or add an explicit @return annotation to suppress this message.'$declaringClass$method->name$normalizedTypeinterface_exists($declaringClass) ? 'implementation' 'child class'$className);
  499.                     }
  500.                 }
  501.             }
  502.             if (!$doc) {
  503.                 $this->patchTypes['force'] = $forcePatchTypes;
  504.                 continue;
  505.             }
  506.             if (isset($doc['return']) || 'void' !== (self::MAGIC_METHODS[$method->name] ?? 'void')) {
  507.                 $this->setReturnType($doc['return'] ?? self::MAGIC_METHODS[$method->name], $method->class$method->name$method->getFileName(), $parent$method->getReturnType());
  508.                 if (isset(self::$returnTypes[$class][$method->name][0]) && $canAddReturnType) {
  509.                     $this->fixReturnStatements($methodself::$returnTypes[$class][$method->name][0]);
  510.                 }
  511.                 if ($method->isPrivate()) {
  512.                     unset(self::$returnTypes[$class][$method->name]);
  513.                 }
  514.             }
  515.             $this->patchTypes['force'] = $forcePatchTypes;
  516.             if ($method->isPrivate()) {
  517.                 continue;
  518.             }
  519.             $finalOrInternal false;
  520.             foreach (['final''internal'] as $annotation) {
  521.                 if (null !== $description $doc[$annotation][0] ?? null) {
  522.                     self::${$annotation.'Methods'}[$class][$method->name] = [$class'' !== $description ' '.$description.(preg_match('/[[:punct:]]$/'$description) ? '' '.') : '.'];
  523.                     $finalOrInternal true;
  524.                 }
  525.             }
  526.             if ($finalOrInternal || $method->isConstructor() || !isset($doc['param']) || StatelessInvocation::class === $class) {
  527.                 continue;
  528.             }
  529.             if (!isset(self::$annotatedParameters[$class][$method->name])) {
  530.                 $definedParameters = [];
  531.                 foreach ($method->getParameters() as $parameter) {
  532.                     $definedParameters[$parameter->name] = true;
  533.                 }
  534.             }
  535.             foreach ($doc['param'] as $parameterName => $parameterType) {
  536.                 if (!isset($definedParameters[$parameterName])) {
  537.                     self::$annotatedParameters[$class][$method->name][$parameterName] = sprintf('The "%%s::%s()" method will require a new "%s$%s" argument in the next major version of its %s "%s", not defining it is deprecated.'$method->name$parameterType $parameterType.' ' ''$parameterNameinterface_exists($className) ? 'interface' 'parent class'$className);
  538.                 }
  539.             }
  540.         }
  541.         $finals = isset(self::$final[$class]) || $refl->isFinal() ? [] : [
  542.             'finalConstants' => $refl->getReflectionConstants(\ReflectionClassConstant::IS_PUBLIC \ReflectionClassConstant::IS_PROTECTED),
  543.             'finalProperties' => $refl->getProperties(\ReflectionProperty::IS_PUBLIC \ReflectionProperty::IS_PROTECTED),
  544.         ];
  545.         foreach ($finals as $type => $reflectors) {
  546.             foreach ($reflectors as $r) {
  547.                 if ($r->class !== $class) {
  548.                     continue;
  549.                 }
  550.                 $doc $this->parsePhpDoc($r);
  551.                 foreach ($parentAndOwnInterfaces as $use) {
  552.                     if (isset(self::${$type}[$use][$r->name]) && !isset($doc['deprecated']) && ('finalConstants' === $type || substr($use0strrpos($use'\\')) !== substr($use0strrpos($class'\\')))) {
  553.                         $msg 'finalConstants' === $type '%s" constant' '$%s" property';
  554.                         $deprecations[] = sprintf('The "%s::'.$msg.' is considered final. You should not override it in "%s".'self::${$type}[$use][$r->name], $r->name$class);
  555.                     }
  556.                 }
  557.                 if (isset($doc['final']) || ('finalProperties' === $type && str_starts_with($class'Symfony\\') && !$r->hasType())) {
  558.                     self::${$type}[$class][$r->name] = $class;
  559.                 }
  560.             }
  561.         }
  562.         return $deprecations;
  563.     }
  564.     public function checkCase(\ReflectionClass $reflstring $filestring $class): ?array
  565.     {
  566.         $real explode('\\'$class.strrchr($file'.'));
  567.         $tail explode(\DIRECTORY_SEPARATORstr_replace('/'\DIRECTORY_SEPARATOR$file));
  568.         $i \count($tail) - 1;
  569.         $j \count($real) - 1;
  570.         while (isset($tail[$i], $real[$j]) && $tail[$i] === $real[$j]) {
  571.             --$i;
  572.             --$j;
  573.         }
  574.         array_splice($tail0$i 1);
  575.         if (!$tail) {
  576.             return null;
  577.         }
  578.         $tail \DIRECTORY_SEPARATOR.implode(\DIRECTORY_SEPARATOR$tail);
  579.         $tailLen \strlen($tail);
  580.         $real $refl->getFileName();
  581.         if (=== self::$caseCheck) {
  582.             $real $this->darwinRealpath($real);
  583.         }
  584.         if (=== substr_compare($real$tail, -$tailLen$tailLentrue)
  585.             && !== substr_compare($real$tail, -$tailLen$tailLenfalse)
  586.         ) {
  587.             return [substr($tail, -$tailLen 1), substr($real, -$tailLen 1), substr($real0, -$tailLen 1)];
  588.         }
  589.         return null;
  590.     }
  591.     /**
  592.      * `realpath` on MacOSX doesn't normalize the case of characters.
  593.      */
  594.     private function darwinRealpath(string $real): string
  595.     {
  596.         $i strrpos($real'/');
  597.         $file substr($real$i);
  598.         $real substr($real0$i);
  599.         if (isset(self::$darwinCache[$real])) {
  600.             $kDir $real;
  601.         } else {
  602.             $kDir strtolower($real);
  603.             if (isset(self::$darwinCache[$kDir])) {
  604.                 $real self::$darwinCache[$kDir][0];
  605.             } else {
  606.                 $dir getcwd();
  607.                 if (!@chdir($real)) {
  608.                     return $real.$file;
  609.                 }
  610.                 $real getcwd().'/';
  611.                 chdir($dir);
  612.                 $dir $real;
  613.                 $k $kDir;
  614.                 $i \strlen($dir) - 1;
  615.                 while (!isset(self::$darwinCache[$k])) {
  616.                     self::$darwinCache[$k] = [$dir, []];
  617.                     self::$darwinCache[$dir] = &self::$darwinCache[$k];
  618.                     while ('/' !== $dir[--$i]) {
  619.                     }
  620.                     $k substr($k0, ++$i);
  621.                     $dir substr($dir0$i--);
  622.                 }
  623.             }
  624.         }
  625.         $dirFiles self::$darwinCache[$kDir][1];
  626.         if (!isset($dirFiles[$file]) && str_ends_with($file') : eval()\'d code')) {
  627.             // Get the file name from "file_name.php(123) : eval()'d code"
  628.             $file substr($file0strrpos($file'(', -17));
  629.         }
  630.         if (isset($dirFiles[$file])) {
  631.             return $real.$dirFiles[$file];
  632.         }
  633.         $kFile strtolower($file);
  634.         if (!isset($dirFiles[$kFile])) {
  635.             foreach (scandir($real2) as $f) {
  636.                 if ('.' !== $f[0]) {
  637.                     $dirFiles[$f] = $f;
  638.                     if ($f === $file) {
  639.                         $kFile $k $file;
  640.                     } elseif ($f !== $k strtolower($f)) {
  641.                         $dirFiles[$k] = $f;
  642.                     }
  643.                 }
  644.             }
  645.             self::$darwinCache[$kDir][1] = $dirFiles;
  646.         }
  647.         return $real.$dirFiles[$kFile];
  648.     }
  649.     /**
  650.      * `class_implements` includes interfaces from the parents so we have to manually exclude them.
  651.      *
  652.      * @return string[]
  653.      */
  654.     private function getOwnInterfaces(string $class, ?string $parent): array
  655.     {
  656.         $ownInterfaces class_implements($classfalse);
  657.         if ($parent) {
  658.             foreach (class_implements($parentfalse) as $interface) {
  659.                 unset($ownInterfaces[$interface]);
  660.             }
  661.         }
  662.         foreach ($ownInterfaces as $interface) {
  663.             foreach (class_implements($interface) as $interface) {
  664.                 unset($ownInterfaces[$interface]);
  665.             }
  666.         }
  667.         return $ownInterfaces;
  668.     }
  669.     private function setReturnType(string $typesstring $classstring $methodstring $filename, ?string $parent\ReflectionType $returnType null): void
  670.     {
  671.         if ('__construct' === $method) {
  672.             return;
  673.         }
  674.         if ($nullable str_starts_with($types'null|')) {
  675.             $types substr($types5);
  676.         } elseif ($nullable str_ends_with($types'|null')) {
  677.             $types substr($types0, -5);
  678.         }
  679.         $arrayType = ['array' => 'array'];
  680.         $typesMap = [];
  681.         $glue str_contains($types'&') ? '&' '|';
  682.         foreach (explode($glue$types) as $t) {
  683.             $t self::SPECIAL_RETURN_TYPES[strtolower($t)] ?? $t;
  684.             $typesMap[$this->normalizeType($t$class$parent$returnType)][$t] = $t;
  685.         }
  686.         if (isset($typesMap['array'])) {
  687.             if (isset($typesMap['Traversable']) || isset($typesMap['\Traversable'])) {
  688.                 $typesMap['iterable'] = $arrayType !== $typesMap['array'] ? $typesMap['array'] : ['iterable'];
  689.                 unset($typesMap['array'], $typesMap['Traversable'], $typesMap['\Traversable']);
  690.             } elseif ($arrayType !== $typesMap['array'] && isset(self::$returnTypes[$class][$method]) && !$returnType) {
  691.                 return;
  692.             }
  693.         }
  694.         if (isset($typesMap['array']) && isset($typesMap['iterable'])) {
  695.             if ($arrayType !== $typesMap['array']) {
  696.                 $typesMap['iterable'] = $typesMap['array'];
  697.             }
  698.             unset($typesMap['array']);
  699.         }
  700.         $iterable $object true;
  701.         foreach ($typesMap as $n => $t) {
  702.             if ('null' !== $n) {
  703.                 $iterable $iterable && (\in_array($n, ['array''iterable']) || str_contains($n'Iterator'));
  704.                 $object $object && (\in_array($n, ['callable''object''$this''static']) || !isset(self::SPECIAL_RETURN_TYPES[$n]));
  705.             }
  706.         }
  707.         $phpTypes = [];
  708.         $docTypes = [];
  709.         foreach ($typesMap as $n => $t) {
  710.             if ('null' === $n) {
  711.                 $nullable true;
  712.                 continue;
  713.             }
  714.             $docTypes[] = $t;
  715.             if ('mixed' === $n || 'void' === $n) {
  716.                 $nullable false;
  717.                 $phpTypes = ['' => $n];
  718.                 continue;
  719.             }
  720.             if ('resource' === $n) {
  721.                 // there is no native type for "resource"
  722.                 return;
  723.             }
  724.             if (!isset($phpTypes[''])) {
  725.                 $phpTypes[] = $n;
  726.             }
  727.         }
  728.         $docTypes array_merge([], ...$docTypes);
  729.         if (!$phpTypes) {
  730.             return;
  731.         }
  732.         if (\count($phpTypes)) {
  733.             if ($iterable && '8.0' $this->patchTypes['php']) {
  734.                 $phpTypes $docTypes = ['iterable'];
  735.             } elseif ($object && 'object' === $this->patchTypes['force']) {
  736.                 $phpTypes $docTypes = ['object'];
  737.             } elseif ('8.0' $this->patchTypes['php']) {
  738.                 // ignore multi-types return declarations
  739.                 return;
  740.             }
  741.         }
  742.         $phpType sprintf($nullable ? (\count($phpTypes) ? '%s|null' '?%s') : '%s'implode($glue$phpTypes));
  743.         $docType sprintf($nullable '%s|null' '%s'implode($glue$docTypes));
  744.         self::$returnTypes[$class][$method] = [$phpType$docType$class$filename];
  745.     }
  746.     private function normalizeType(string $typestring $class, ?string $parent, ?\ReflectionType $returnType): string
  747.     {
  748.         if (isset(self::SPECIAL_RETURN_TYPES[$lcType strtolower($type)])) {
  749.             if ('parent' === $lcType self::SPECIAL_RETURN_TYPES[$lcType]) {
  750.                 $lcType null !== $parent '\\'.$parent 'parent';
  751.             } elseif ('self' === $lcType) {
  752.                 $lcType '\\'.$class;
  753.             }
  754.             return $lcType;
  755.         }
  756.         // We could resolve "use" statements to return the FQDN
  757.         // but this would be too expensive for a runtime checker
  758.         if (!str_ends_with($type'[]')) {
  759.             return $type;
  760.         }
  761.         if ($returnType instanceof \ReflectionNamedType) {
  762.             $type $returnType->getName();
  763.             if ('mixed' !== $type) {
  764.                 return isset(self::SPECIAL_RETURN_TYPES[$type]) ? $type '\\'.$type;
  765.             }
  766.         }
  767.         return 'array';
  768.     }
  769.     /**
  770.      * Utility method to add #[ReturnTypeWillChange] where php triggers deprecations.
  771.      */
  772.     private function patchReturnTypeWillChange(\ReflectionMethod $method)
  773.     {
  774.         if (\count($method->getAttributes(\ReturnTypeWillChange::class))) {
  775.             return;
  776.         }
  777.         if (!is_file($file $method->getFileName())) {
  778.             return;
  779.         }
  780.         $fileOffset self::$fileOffsets[$file] ?? 0;
  781.         $code file($file);
  782.         $startLine $method->getStartLine() + $fileOffset 2;
  783.         if (false !== stripos($code[$startLine], 'ReturnTypeWillChange')) {
  784.             return;
  785.         }
  786.         $code[$startLine] .= "    #[\\ReturnTypeWillChange]\n";
  787.         self::$fileOffsets[$file] = $fileOffset;
  788.         file_put_contents($file$code);
  789.     }
  790.     /**
  791.      * Utility method to add @return annotations to the Symfony code-base where it triggers self-deprecations.
  792.      */
  793.     private function patchMethod(\ReflectionMethod $methodstring $returnTypestring $declaringFilestring $normalizedType)
  794.     {
  795.         static $patchedMethods = [];
  796.         static $useStatements = [];
  797.         if (!is_file($file $method->getFileName()) || isset($patchedMethods[$file][$startLine $method->getStartLine()])) {
  798.             return;
  799.         }
  800.         $patchedMethods[$file][$startLine] = true;
  801.         $fileOffset self::$fileOffsets[$file] ?? 0;
  802.         $startLine += $fileOffset 2;
  803.         if ($nullable str_ends_with($returnType'|null')) {
  804.             $returnType substr($returnType0, -5);
  805.         }
  806.         $glue str_contains($returnType'&') ? '&' '|';
  807.         $returnType explode($glue$returnType);
  808.         $code file($file);
  809.         foreach ($returnType as $i => $type) {
  810.             if (preg_match('/((?:\[\])+)$/'$type$m)) {
  811.                 $type substr($type0, -\strlen($m[1]));
  812.                 $format '%s'.$m[1];
  813.             } else {
  814.                 $format null;
  815.             }
  816.             if (isset(self::SPECIAL_RETURN_TYPES[$type]) || ('\\' === $type[0] && !$p strrpos($type'\\'1))) {
  817.                 continue;
  818.             }
  819.             [$namespace$useOffset$useMap] = $useStatements[$file] ??= self::getUseStatements($file);
  820.             if ('\\' !== $type[0]) {
  821.                 [$declaringNamespace, , $declaringUseMap] = $useStatements[$declaringFile] ??= self::getUseStatements($declaringFile);
  822.                 $p strpos($type'\\'1);
  823.                 $alias $p substr($type0$p) : $type;
  824.                 if (isset($declaringUseMap[$alias])) {
  825.                     $type '\\'.$declaringUseMap[$alias].($p substr($type$p) : '');
  826.                 } else {
  827.                     $type '\\'.$declaringNamespace.$type;
  828.                 }
  829.                 $p strrpos($type'\\'1);
  830.             }
  831.             $alias substr($type$p);
  832.             $type substr($type1);
  833.             if (!isset($useMap[$alias]) && (class_exists($c $namespace.$alias) || interface_exists($c) || trait_exists($c))) {
  834.                 $useMap[$alias] = $c;
  835.             }
  836.             if (!isset($useMap[$alias])) {
  837.                 $useStatements[$file][2][$alias] = $type;
  838.                 $code[$useOffset] = "use $type;\n".$code[$useOffset];
  839.                 ++$fileOffset;
  840.             } elseif ($useMap[$alias] !== $type) {
  841.                 $alias .= 'FIXME';
  842.                 $useStatements[$file][2][$alias] = $type;
  843.                 $code[$useOffset] = "use $type as $alias;\n".$code[$useOffset];
  844.                 ++$fileOffset;
  845.             }
  846.             $returnType[$i] = null !== $format sprintf($format$alias) : $alias;
  847.         }
  848.         if ('docblock' === $this->patchTypes['force'] || ('object' === $normalizedType && '7.1' === $this->patchTypes['php'])) {
  849.             $returnType implode($glue$returnType).($nullable '|null' '');
  850.             if (str_contains($code[$startLine], '#[')) {
  851.                 --$startLine;
  852.             }
  853.             if ($method->getDocComment()) {
  854.                 $code[$startLine] = "     * @return $returnType\n".$code[$startLine];
  855.             } else {
  856.                 $code[$startLine] .= <<<EOTXT
  857.     /**
  858.      * @return $returnType
  859.      */
  860. EOTXT;
  861.             }
  862.             $fileOffset += substr_count($code[$startLine], "\n") - 1;
  863.         }
  864.         self::$fileOffsets[$file] = $fileOffset;
  865.         file_put_contents($file$code);
  866.         $this->fixReturnStatements($method$normalizedType);
  867.     }
  868.     private static function getUseStatements(string $file): array
  869.     {
  870.         $namespace '';
  871.         $useMap = [];
  872.         $useOffset 0;
  873.         if (!is_file($file)) {
  874.             return [$namespace$useOffset$useMap];
  875.         }
  876.         $file file($file);
  877.         for ($i 0$i \count($file); ++$i) {
  878.             if (preg_match('/^(class|interface|trait|abstract) /'$file[$i])) {
  879.                 break;
  880.             }
  881.             if (str_starts_with($file[$i], 'namespace ')) {
  882.                 $namespace substr($file[$i], \strlen('namespace '), -2).'\\';
  883.                 $useOffset $i 2;
  884.             }
  885.             if (str_starts_with($file[$i], 'use ')) {
  886.                 $useOffset $i;
  887.                 for (; str_starts_with($file[$i], 'use '); ++$i) {
  888.                     $u explode(' as 'substr($file[$i], 4, -2), 2);
  889.                     if (=== \count($u)) {
  890.                         $p strrpos($u[0], '\\');
  891.                         $useMap[substr($u[0], false !== $p $p 0)] = $u[0];
  892.                     } else {
  893.                         $useMap[$u[1]] = $u[0];
  894.                     }
  895.                 }
  896.                 break;
  897.             }
  898.         }
  899.         return [$namespace$useOffset$useMap];
  900.     }
  901.     private function fixReturnStatements(\ReflectionMethod $methodstring $returnType)
  902.     {
  903.         if ('docblock' !== $this->patchTypes['force']) {
  904.             if ('7.1' === $this->patchTypes['php'] && 'object' === ltrim($returnType'?')) {
  905.                 return;
  906.             }
  907.             if ('7.4' $this->patchTypes['php'] && $method->hasReturnType()) {
  908.                 return;
  909.             }
  910.             if ('8.0' $this->patchTypes['php'] && (str_contains($returnType'|') || \in_array($returnType, ['mixed''static'], true))) {
  911.                 return;
  912.             }
  913.             if ('8.1' $this->patchTypes['php'] && str_contains($returnType'&')) {
  914.                 return;
  915.             }
  916.         }
  917.         if (!is_file($file $method->getFileName())) {
  918.             return;
  919.         }
  920.         $fixedCode $code file($file);
  921.         $i = (self::$fileOffsets[$file] ?? 0) + $method->getStartLine();
  922.         if ('?' !== $returnType && 'docblock' !== $this->patchTypes['force']) {
  923.             $fixedCode[$i 1] = preg_replace('/\)(?::[^;\n]++)?(;?\n)/'"): $returnType\\1"$code[$i 1]);
  924.         }
  925.         $end $method->isGenerator() ? $i $method->getEndLine();
  926.         for (; $i $end; ++$i) {
  927.             if ('void' === $returnType) {
  928.                 $fixedCode[$i] = str_replace('    return null;''    return;'$code[$i]);
  929.             } elseif ('mixed' === $returnType || '?' === $returnType[0]) {
  930.                 $fixedCode[$i] = str_replace('    return;''    return null;'$code[$i]);
  931.             } else {
  932.                 $fixedCode[$i] = str_replace('    return;'"    return $returnType!?;"$code[$i]);
  933.             }
  934.         }
  935.         if ($fixedCode !== $code) {
  936.             file_put_contents($file$fixedCode);
  937.         }
  938.     }
  939.     /**
  940.      * @param \ReflectionClass|\ReflectionMethod|\ReflectionProperty $reflector
  941.      */
  942.     private function parsePhpDoc(\Reflector $reflector): array
  943.     {
  944.         if (!$doc $reflector->getDocComment()) {
  945.             return [];
  946.         }
  947.         $tagName '';
  948.         $tagContent '';
  949.         $tags = [];
  950.         foreach (explode("\n"substr($doc3, -2)) as $line) {
  951.             $line ltrim($line);
  952.             $line ltrim($line'*');
  953.             if ('' === $line trim($line)) {
  954.                 if ('' !== $tagName) {
  955.                     $tags[$tagName][] = $tagContent;
  956.                 }
  957.                 $tagName $tagContent '';
  958.                 continue;
  959.             }
  960.             if ('@' === $line[0]) {
  961.                 if ('' !== $tagName) {
  962.                     $tags[$tagName][] = $tagContent;
  963.                     $tagContent '';
  964.                 }
  965.                 if (preg_match('{^@([-a-zA-Z0-9_:]++)(\s|$)}'$line$m)) {
  966.                     $tagName $m[1];
  967.                     $tagContent str_replace("\t"' 'ltrim(substr($line\strlen($tagName))));
  968.                 } else {
  969.                     $tagName '';
  970.                 }
  971.             } elseif ('' !== $tagName) {
  972.                 $tagContent .= ' '.str_replace("\t"' '$line);
  973.             }
  974.         }
  975.         if ('' !== $tagName) {
  976.             $tags[$tagName][] = $tagContent;
  977.         }
  978.         foreach ($tags['method'] ?? [] as $i => $method) {
  979.             unset($tags['method'][$i]);
  980.             $parts preg_split('{(\s++|\((?:[^()]*+|(?R))*\)(?: *: *[^ ]++)?|<(?:[^<>]*+|(?R))*>|\{(?:[^{}]*+|(?R))*\})}'$method, -1\PREG_SPLIT_DELIM_CAPTURE);
  981.             $returnType '';
  982.             $static 'static' === $parts[0];
  983.             for ($i $static 0null !== $p $parts[$i] ?? null$i += 2) {
  984.                 if (\in_array($p, ['''|''&''callable'], true) || \in_array(substr($returnType, -1), ['|''&'], true)) {
  985.                     $returnType .= trim($parts[$i 1] ?? '').$p;
  986.                     continue;
  987.                 }
  988.                 $signature '(' === ($parts[$i 1][0] ?? '(') ? $parts[$i 1] ?? '()' null;
  989.                 if (null === $signature && '' === $returnType) {
  990.                     $returnType $p;
  991.                     continue;
  992.                 }
  993.                 if ($static && === $i) {
  994.                     $static false;
  995.                     $returnType 'static';
  996.                 }
  997.                 if (\in_array($description trim(implode(''\array_slice($parts$i))), ['''.'], true)) {
  998.                     $description null;
  999.                 } elseif (!preg_match('/[.!]$/'$description)) {
  1000.                     $description .= '.';
  1001.                 }
  1002.                 $tags['method'][$p] = [$static$returnType$signature ?? '()'$description];
  1003.                 break;
  1004.             }
  1005.         }
  1006.         foreach ($tags['param'] ?? [] as $i => $param) {
  1007.             unset($tags['param'][$i]);
  1008.             if (\strlen($param) !== strcspn($param'<{(')) {
  1009.                 $param preg_replace('{\(([^()]*+|(?R))*\)(?: *: *[^ ]++)?|<([^<>]*+|(?R))*>|\{([^{}]*+|(?R))*\}}'''$param);
  1010.             }
  1011.             if (false === $i strpos($param'$')) {
  1012.                 continue;
  1013.             }
  1014.             $type === $i '' rtrim(substr($param0$i), ' &');
  1015.             $param substr($param$i, (strpos($param' '$i) ?: ($i \strlen($param))) - $i 1);
  1016.             $tags['param'][$param] = $type;
  1017.         }
  1018.         foreach (['var''return'] as $k) {
  1019.             if (null === $v $tags[$k][0] ?? null) {
  1020.                 continue;
  1021.             }
  1022.             if (\strlen($v) !== strcspn($v'<{(')) {
  1023.                 $v preg_replace('{\(([^()]*+|(?R))*\)(?: *: *[^ ]++)?|<([^<>]*+|(?R))*>|\{([^{}]*+|(?R))*\}}'''$v);
  1024.             }
  1025.             $tags[$k] = substr($v0strpos($v' ') ?: \strlen($v)) ?: null;
  1026.         }
  1027.         return $tags;
  1028.     }
  1029. }