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

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\ErrorHandler;
  14. use Composer\InstalledVersions;
  15. use Doctrine\Common\Persistence\Proxy as LegacyProxy;
  16. use Doctrine\Persistence\Proxy;
  17. use Mockery\MockInterface;
  18. use Phake\IMock;
  19. use PHPUnit\Framework\MockObject\Matcher\StatelessInvocation;
  20. use PHPUnit\Framework\MockObject\MockObject;
  21. use Prophecy\Prophecy\ProphecySubjectInterface;
  22. use ProxyManager\Proxy\ProxyInterface;
  23. use Symfony\Component\ErrorHandler\Internal\TentativeTypes;
  25. /**
  26.  * Autoloader checking if the class is really defined in the file found.
  27.  *
  28.  * The ClassLoader will wrap all registered autoloaders
  29.  * and will throw an exception if a file is found but does
  30.  * not declare the class.
  31.  *
  32.  * It can also patch classes to turn docblocks into actual return types.
  33.  * This behavior is controlled by the SYMFONY_PATCH_TYPE_DECLARATIONS env var,
  34.  * which is a url-encoded array with the follow parameters:
  35.  *  - "force": any value enables deprecation notices - can be any of:
  36.  *      - "phpdoc" to patch only docblock annotations
  37.  *      - "2" to add all possible return types
  38.  *      - "1" to add return types but only to tests/final/internal/private methods
  39.  *  - "php": the target version of PHP - e.g. "7.1" doesn't generate "object" types
  40.  *  - "deprecations": "1" to trigger a deprecation notice when a child class misses a
  41.  *                    return type while the parent declares an "@return" annotation
  42.  *
  43.  * Note that patching doesn't care about any coding style so you'd better to run
  44.  * php-cs-fixer after, with rules "phpdoc_trim_consecutive_blank_line_separation"
  45.  * and "no_superfluous_phpdoc_tags" enabled typically.
  46.  *
  47.  * @author Fabien Potencier <fabien@symfony.com>
  48.  * @author Christophe Coevoet <stof@notk.org>
  49.  * @author Nicolas Grekas <p@tchwork.com>
  50.  * @author Guilhem Niot <guilhem.niot@gmail.com>
  51.  */
  52. class DebugClassLoader
  53. {
  54.     private const SPECIAL_RETURN_TYPES = [
  55.         'void' => 'void',
  56.         'null' => 'null',
  57.         'resource' => 'resource',
  58.         'boolean' => 'bool',
  59.         'true' => 'bool',
  60.         'false' => 'false',
  61.         'integer' => 'int',
  62.         'array' => 'array',
  63.         'bool' => 'bool',
  64.         'callable' => 'callable',
  65.         'float' => 'float',
  66.         'int' => 'int',
  67.         'iterable' => 'iterable',
  68.         'object' => 'object',
  69.         'string' => 'string',
  70.         'self' => 'self',
  71.         'parent' => 'parent',
  72.         'mixed' => 'mixed',
  73.         'static' => 'static',
  74.         '$this' => 'static',
  75.         'list' => 'array',
  76.     ];
  78.     private const BUILTIN_RETURN_TYPES = [
  79.         'void' => true,
  80.         'array' => true,
  81.         'false' => true,
  82.         'bool' => true,
  83.         'callable' => true,
  84.         'float' => true,
  85.         'int' => true,
  86.         'iterable' => true,
  87.         'object' => true,
  88.         'string' => true,
  89.         'self' => true,
  90.         'parent' => true,
  91.         'mixed' => true,
  92.         'static' => true,
  93.     ];
  95.     private const MAGIC_METHODS = [
  96.         '__isset' => 'bool',
  97.         '__sleep' => 'array',
  98.         '__toString' => 'string',
  99.         '__debugInfo' => 'array',
  100.         '__serialize' => 'array',
  101.     ];
  103.     /**
  104.      * @var callable
  105.      */
  106.     private $classLoader;
  107.     private bool $isFinder;
  108.     private array $loaded = [];
  109.     private array $patchTypes = [];
  111.     private static int $caseCheck;
  112.     private static array $checkedClasses = [];
  113.     private static array $final = [];
  114.     private static array $finalMethods = [];
  115.     private static array $deprecated = [];
  116.     private static array $internal = [];
  117.     private static array $internalMethods = [];
  118.     private static array $annotatedParameters = [];
  119.     private static array $darwinCache = ['/' => ['/', []]];
  120.     private static array $method = [];
  121.     private static array $returnTypes = [];
  122.     private static array $methodTraits = [];
  123.     private static array $fileOffsets = [];
  125.     public function __construct(callable $classLoader)
  126.     {
  127.         $this->classLoader = $classLoader;
  128.         $this->isFinder = \is_array($classLoader) && method_exists($classLoader[0], 'findFile');
  129.         parse_str(getenv('SYMFONY_PATCH_TYPE_DECLARATIONS') ?: '', $this->patchTypes);
  130.         $this->patchTypes += [
  131.             'force' => null,
  132.             'php' => \PHP_MAJOR_VERSION.'.'.\PHP_MINOR_VERSION,
  133.             'deprecations' => true,
  134.         ];
  136.         if ('phpdoc' === $this->patchTypes['force']) {
  137.             $this->patchTypes['force'] = 'docblock';
  138.         }
  140.         if (!isset(self::$caseCheck)) {
  141.             $file = is_file(__FILE__) ? __FILE__ : rtrim(realpath('.'), \DIRECTORY_SEPARATOR);
  142.             $i = strrpos($file, \DIRECTORY_SEPARATOR);
  143.             $dir = substr($file, 0, 1 + $i);
  144.             $file = substr($file, 1 + $i);
  145.             $test = strtoupper($file) === $file ? strtolower($file) : strtoupper($file);
  146.             $test = realpath($dir.$test);
  148.             if (false === $test || false === $i) {
  149.                 // filesystem is case sensitive
  150.                 self::$caseCheck = 0;
  151.             } elseif (str_ends_with($test, $file)) {
  152.                 // filesystem is case insensitive and realpath() normalizes the case of characters
  153.                 self::$caseCheck = 1;
  154.             } elseif ('Darwin' === \PHP_OS_FAMILY) {
  155.                 // on MacOSX, HFS+ is case insensitive but realpath() doesn't normalize the case of characters
  156.                 self::$caseCheck = 2;
  157.             } else {
  158.                 // filesystem case checks failed, fallback to disabling them
  159.                 self::$caseCheck = 0;
  160.             }
  161.         }
  162.     }
  164.     public function getClassLoader(): callable
  165.     {
  166.         return $this->classLoader;
  167.     }
  169.     /**
  170.      * Wraps all autoloaders.
  171.      */
  172.     public static function enable(): void
  173.     {
  174.         // Ensures we don't hit https://bugs.php.net/42098
  175.         class_exists(\Symfony\Component\ErrorHandler\ErrorHandler::class);
  176.         class_exists(\Psr\Log\LogLevel::class);
  178.         if (!\is_array($functions = spl_autoload_functions())) {
  179.             return;
  180.         }
  182.         foreach ($functions as $function) {
  183.             spl_autoload_unregister($function);
  184.         }
  186.         foreach ($functions as $function) {
  187.             if (!\is_array($function) || !$function[0] instanceof self) {
  188.                 $function = [new static($function), 'loadClass'];
  189.             }
  191.             spl_autoload_register($function);
  192.         }
  193.     }
  195.     /**
  196.      * Disables the wrapping.
  197.      */
  198.     public static function disable(): void
  199.     {
  200.         if (!\is_array($functions = spl_autoload_functions())) {
  201.             return;
  202.         }
  204.         foreach ($functions as $function) {
  205.             spl_autoload_unregister($function);
  206.         }
  208.         foreach ($functions as $function) {
  209.             if (\is_array($function) && $function[0] instanceof self) {
  210.                 $function = $function[0]->getClassLoader();
  211.             }
  213.             spl_autoload_register($function);
  214.         }
  215.     }
  217.     public static function checkClasses(): bool
  218.     {
  219.         if (!\is_array($functions = spl_autoload_functions())) {
  220.             return false;
  221.         }
  223.         $loader = null;
  225.         foreach ($functions as $function) {
  226.             if (\is_array($function) && $function[0] instanceof self) {
  227.                 $loader = $function[0];
  228.                 break;
  229.             }
  230.         }
  232.         if (null === $loader) {
  233.             return false;
  234.         }
  236.         static $offsets = [
  237.             'get_declared_interfaces' => 0,
  238.             'get_declared_traits' => 0,
  239.             'get_declared_classes' => 0,
  240.         ];
  242.         foreach ($offsets as $getSymbols => $i) {
  243.             $symbols = $getSymbols();
  245.             for (; $i < \count($symbols); ++$i) {
  246.                 if (!is_subclass_of($symbols[$i], MockObject::class)
  247.                     && !is_subclass_of($symbols[$i], ProphecySubjectInterface::class)
  248.                     && !is_subclass_of($symbols[$i], Proxy::class)
  249.                     && !is_subclass_of($symbols[$i], ProxyInterface::class)
  250.                     && !is_subclass_of($symbols[$i], LegacyProxy::class)
  251.                     && !is_subclass_of($symbols[$i], MockInterface::class)
  252.                     && !is_subclass_of($symbols[$i], IMock::class)
  253.                 ) {
  254.                     $loader->checkClass($symbols[$i]);
  255.                 }
  256.             }
  258.             $offsets[$getSymbols] = $i;
  259.         }
  261.         return true;
  262.     }
  264.     public function findFile(string $class): ?string
  265.     {
  266.         return $this->isFinder ? ($this->classLoader[0]->findFile($class) ?: null) : null;
  267.     }
  269.     /**
  270.      * Loads the given class or interface.
  271.      *
  272.      * @throws \RuntimeException
  273.      */
  274.     public function loadClass(string $class): void
  275.     {
  276.         $e = error_reporting(error_reporting() | \E_PARSE | \E_ERROR | \E_CORE_ERROR | \E_COMPILE_ERROR);
  278.         try {
  279.             if ($this->isFinder && !isset($this->loaded[$class])) {
  280.                 $this->loaded[$class] = true;
  281.                 if (!$file = $this->classLoader[0]->findFile($class) ?: '') {
  282.                     // no-op
  283.                 } elseif (\function_exists('opcache_is_script_cached') && @opcache_is_script_cached($file)) {
  284.                     include $file;
  286.                     return;
  287.                 } elseif (false === include $file) {
  288.                     return;
  289.                 }
  290.             } else {
  291.                 ($this->classLoader)($class);
  292.                 $file = '';
  293.             }
  294.         } finally {
  295.             error_reporting($e);
  296.         }
  298.         $this->checkClass($class, $file);
  299.     }
  301.     private function checkClass(string $class, string $file = null): void
  302.     {
  303.         $exists = null === $file || class_exists($class, false) || interface_exists($class, false) || trait_exists($class, false);
  305.         if (null !== $file && $class && '\\' === $class[0]) {
  306.             $class = substr($class, 1);
  307.         }
  309.         if ($exists) {
  310.             if (isset(self::$checkedClasses[$class])) {
  311.                 return;
  312.             }
  313.             self::$checkedClasses[$class] = true;
  315.             $refl = new \ReflectionClass($class);
  316.             if (null === $file && $refl->isInternal()) {
  317.                 return;
  318.             }
  319.             $name = $refl->getName();
  321.             if ($name !== $class && 0 === strcasecmp($name, $class)) {
  322.                 throw new \RuntimeException(sprintf('Case mismatch between loaded and declared class names: "%s" vs "%s".', $class, $name));
  323.             }
  325.             $deprecations = $this->checkAnnotations($refl, $name);
  327.             foreach ($deprecations as $message) {
  328.                 @trigger_error($message, \E_USER_DEPRECATED);
  329.             }
  330.         }
  332.         if (!$file) {
  333.             return;
  334.         }
  336.         if (!$exists) {
  337.             if (str_contains($class, '/')) {
  338.                 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));
  339.             }
  341.             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));
  342.         }
  344.         if (self::$caseCheck && $message = $this->checkCase($refl, $file, $class)) {
  345.             throw new \RuntimeException(sprintf('Case mismatch between class and real file names: "%s" vs "%s" in "%s".', $message[0], $message[1], $message[2]));
  346.         }
  347.     }
  349.     public function checkAnnotations(\ReflectionClass $refl, string $class): array
  350.     {
  351.         if (
  352.             'Symfony\Bridge\PhpUnit\Legacy\SymfonyTestsListenerForV7' === $class
  353.             || 'Symfony\Bridge\PhpUnit\Legacy\SymfonyTestsListenerForV6' === $class
  354.         ) {
  355.             return [];
  356.         }
  357.         $deprecations = [];
  359.         $className = str_contains($class, "@anonymous\0") ? (get_parent_class($class) ?: key(class_implements($class)) ?: 'class').'@anonymous' : $class;
  361.         // Don't trigger deprecations for classes in the same vendor
  362.         if ($class !== $className) {
  363.             $vendor = preg_match('/^namespace ([^;\\\\\s]++)[;\\\\]/m', @file_get_contents($refl->getFileName()), $vendor) ? $vendor[1].'\\' : '';
  364.             $vendorLen = \strlen($vendor);
  365.         } elseif (2 > $vendorLen = 1 + (strpos($class, '\\') ?: strpos($class, '_'))) {
  366.             $vendorLen = 0;
  367.             $vendor = '';
  368.         } else {
  369.             $vendor = str_replace('_', '\\', substr($class, 0, $vendorLen));
  370.         }
  372.         $parent = get_parent_class($class) ?: null;
  373.         self::$returnTypes[$class] = [];
  374.         $classIsTemplate = false;
  376.         // Detect annotations on the class
  377.         if ($doc = $this->parsePhpDoc($refl)) {
  378.             $classIsTemplate = isset($doc['template']);
  380.             foreach (['final', 'deprecated', 'internal'] as $annotation) {
  381.                 if (null !== $description = $doc[$annotation][0] ?? null) {
  382.                     self::${$annotation}[$class] = '' !== $description ? ' '.$description.(preg_match('/[.!]$/', $description) ? '' : '.') : '.';
  383.                 }
  384.             }
  386.             if ($refl->isInterface() && isset($doc['method'])) {
  387.                 foreach ($doc['method'] as $name => [$static, $returnType, $signature, $description]) {
  388.                     self::$method[$class][] = [$class, $static, $returnType, $name.$signature, $description];
  390.                     if ('' !== $returnType) {
  391.                         $this->setReturnType($returnType, $refl->name, $name, $refl->getFileName(), $parent);
  392.                     }
  393.                 }
  394.             }
  395.         }
  397.         $parentAndOwnInterfaces = $this->getOwnInterfaces($class, $parent);
  398.         if ($parent) {
  399.             $parentAndOwnInterfaces[$parent] = $parent;
  401.             if (!isset(self::$checkedClasses[$parent])) {
  402.                 $this->checkClass($parent);
  403.             }
  405.             if (isset(self::$final[$parent])) {
  406.                 $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".', $parent, self::$final[$parent], $className);
  407.             }
  408.         }
  410.         // Detect if the parent is annotated
  411.         foreach ($parentAndOwnInterfaces + class_uses($class, false) as $use) {
  412.             if (!isset(self::$checkedClasses[$use])) {
  413.                 $this->checkClass($use);
  414.             }
  415.             if (isset(self::$deprecated[$use]) && strncmp($vendor, str_replace('_', '\\', $use), $vendorLen) && !isset(self::$deprecated[$class])) {
  416.                 $type = class_exists($class, false) ? 'class' : (interface_exists($class, false) ? 'interface' : 'trait');
  417.                 $verb = class_exists($use, false) || interface_exists($class, false) ? 'extends' : (interface_exists($use, false) ? 'implements' : 'uses');
  419.                 $deprecations[] = sprintf('The "%s" %s %s "%s" that is deprecated%s', $className, $type, $verb, $use, self::$deprecated[$use]);
  420.             }
  421.             if (isset(self::$internal[$use]) && strncmp($vendor, str_replace('_', '\\', $use), $vendorLen)) {
  422.                 $deprecations[] = sprintf('The "%s" %s is considered internal%s It may change without further notice. You should not use it from "%s".', $use, class_exists($use, false) ? 'class' : (interface_exists($use, false) ? 'interface' : 'trait'), self::$internal[$use], $className);
  423.             }
  424.             if (isset(self::$method[$use])) {
  425.                 if ($refl->isAbstract()) {
  426.                     if (isset(self::$method[$class])) {
  427.                         self::$method[$class] = array_merge(self::$method[$class], self::$method[$use]);
  428.                     } else {
  429.                         self::$method[$class] = self::$method[$use];
  430.                     }
  431.                 } elseif (!$refl->isInterface()) {
  432.                     if (!strncmp($vendor, str_replace('_', '\\', $use), $vendorLen)
  433.                         && str_starts_with($className, 'Symfony\\')
  434.                         && (!class_exists(InstalledVersions::class)
  435.                             || 'symfony/symfony' !== InstalledVersions::getRootPackage()['name'])
  436.                     ) {
  437.                         // skip "same vendor" @method deprecations for Symfony\* classes unless symfony/symfony is being tested
  438.                         continue;
  439.                     }
  440.                     $hasCall = $refl->hasMethod('__call');
  441.                     $hasStaticCall = $refl->hasMethod('__callStatic');
  442.                     foreach (self::$method[$use] as [$interface, $static, $returnType, $name, $description]) {
  443.                         if ($static ? $hasStaticCall : $hasCall) {
  444.                             continue;
  445.                         }
  446.                         $realName = substr($name, 0, strpos($name, '('));
  447.                         if (!$refl->hasMethod($realName) || !($methodRefl = $refl->getMethod($realName))->isPublic() || ($static && !$methodRefl->isStatic()) || (!$static && $methodRefl->isStatic())) {
  448.                             $deprecations[] = sprintf('Class "%s" should implement method "%s::%s%s"%s', $className, ($static ? 'static ' : '').$interface, $name, $returnType ? ': '.$returnType : '', null === $description ? '.' : ': '.$description);
  449.                         }
  450.                     }
  451.                 }
  452.             }
  453.         }
  455.         if (trait_exists($class)) {
  456.             $file = $refl->getFileName();
  458.             foreach ($refl->getMethods() as $method) {
  459.                 if ($method->getFileName() === $file) {
  460.                     self::$methodTraits[$file][$method->getStartLine()] = $class;
  461.                 }
  462.             }
  464.             return $deprecations;
  465.         }
  467.         // Inherit @final, @internal, @param and @return annotations for methods
  468.         self::$finalMethods[$class] = [];
  469.         self::$internalMethods[$class] = [];
  470.         self::$annotatedParameters[$class] = [];
  471.         foreach ($parentAndOwnInterfaces as $use) {
  472.             foreach (['finalMethods', 'internalMethods', 'annotatedParameters', 'returnTypes'] as $property) {
  473.                 if (isset(self::${$property}[$use])) {
  474.                     self::${$property}[$class] = self::${$property}[$class] ? self::${$property}[$use] + self::${$property}[$class] : self::${$property}[$use];
  475.                 }
  476.             }
  478.             if (null !== (TentativeTypes::RETURN_TYPES[$use] ?? null)) {
  479.                 foreach (TentativeTypes::RETURN_TYPES[$use] as $method => $returnType) {
  480.                     $returnType = explode('|', $returnType);
  481.                     foreach ($returnType as $i => $t) {
  482.                         if ('?' !== $t && !isset(self::BUILTIN_RETURN_TYPES[$t])) {
  483.                             $returnType[$i] = '\\'.$t;
  484.                         }
  485.                     }
  486.                     $returnType = implode('|', $returnType);
  488.                     self::$returnTypes[$class] += [$method => [$returnType, 0 === strpos($returnType, '?') ? substr($returnType, 1).'|null' : $returnType, $use, '']];
  489.                 }
  490.             }
  491.         }
  493.         foreach ($refl->getMethods() as $method) {
  494.             if ($method->class !== $class) {
  495.                 continue;
  496.             }
  498.             if (null === $ns = self::$methodTraits[$method->getFileName()][$method->getStartLine()] ?? null) {
  499.                 $ns = $vendor;
  500.                 $len = $vendorLen;
  501.             } elseif (2 > $len = 1 + (strpos($ns, '\\') ?: strpos($ns, '_'))) {
  502.                 $len = 0;
  503.                 $ns = '';
  504.             } else {
  505.                 $ns = str_replace('_', '\\', substr($ns, 0, $len));
  506.             }
  508.             if ($parent && isset(self::$finalMethods[$parent][$method->name])) {
  509.                 [$declaringClass, $message] = self::$finalMethods[$parent][$method->name];
  510.                 $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);
  511.             }
  513.             if (isset(self::$internalMethods[$class][$method->name])) {
  514.                 [$declaringClass, $message] = self::$internalMethods[$class][$method->name];
  515.                 if (strncmp($ns, $declaringClass, $len)) {
  516.                     $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);
  517.                 }
  518.             }
  520.             // To read method annotations
  521.             $doc = $this->parsePhpDoc($method);
  523.             if (($classIsTemplate || isset($doc['template'])) && $method->hasReturnType()) {
  524.                 unset($doc['return']);
  525.             }
  527.             if (isset(self::$annotatedParameters[$class][$method->name])) {
  528.                 $definedParameters = [];
  529.                 foreach ($method->getParameters() as $parameter) {
  530.                     $definedParameters[$parameter->name] = true;
  531.                 }
  533.                 foreach (self::$annotatedParameters[$class][$method->name] as $parameterName => $deprecation) {
  534.                     if (!isset($definedParameters[$parameterName]) && !isset($doc['param'][$parameterName])) {
  535.                         $deprecations[] = sprintf($deprecation, $className);
  536.                     }
  537.                 }
  538.             }
  540.             $forcePatchTypes = $this->patchTypes['force'];
  542.             if ($canAddReturnType = null !== $forcePatchTypes && !str_contains($method->getFileName(), \DIRECTORY_SEPARATOR.'vendor'.\DIRECTORY_SEPARATOR)) {
  543.                 if ('void' !== (self::MAGIC_METHODS[$method->name] ?? 'void')) {
  544.                     $this->patchTypes['force'] = $forcePatchTypes ?: 'docblock';
  545.                 }
  547.                 $canAddReturnType = 2 === (int) $forcePatchTypes
  548.                     || false !== stripos($method->getFileName(), \DIRECTORY_SEPARATOR.'Tests'.\DIRECTORY_SEPARATOR)
  549.                     || $refl->isFinal()
  550.                     || $method->isFinal()
  551.                     || $method->isPrivate()
  552.                     || ('.' === (self::$internal[$class] ?? null) && !$refl->isAbstract())
  553.                     || '.' === (self::$final[$class] ?? null)
  554.                     || '' === ($doc['final'][0] ?? null)
  555.                     || '' === ($doc['internal'][0] ?? null)
  556.                 ;
  557.             }
  559.             if (null !== ($returnType = self::$returnTypes[$class][$method->name] ?? null) && 'docblock' === $this->patchTypes['force'] && !$method->hasReturnType() && isset(TentativeTypes::RETURN_TYPES[$returnType[2]][$method->name])) {
  560.                 $this->patchReturnTypeWillChange($method);
  561.             }
  563.             if (null !== ($returnType ?? $returnType = self::MAGIC_METHODS[$method->name] ?? null) && !$method->hasReturnType() && !isset($doc['return'])) {
  564.                 [$normalizedType, $returnType, $declaringClass, $declaringFile] = \is_string($returnType) ? [$returnType, $returnType, '', ''] : $returnType;
  566.                 if ($canAddReturnType && 'docblock' !== $this->patchTypes['force']) {
  567.                     $this->patchMethod($method, $returnType, $declaringFile, $normalizedType);
  568.                 }
  569.                 if (!isset($doc['deprecated']) && strncmp($ns, $declaringClass, $len)) {
  570.                     if ('docblock' === $this->patchTypes['force']) {
  571.                         $this->patchMethod($method, $returnType, $declaringFile, $normalizedType);
  572.                     } elseif ('' !== $declaringClass && $this->patchTypes['deprecations']) {
  573.                         $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, $normalizedType, interface_exists($declaringClass) ? 'implementation' : 'child class', $className);
  574.                     }
  575.                 }
  576.             }
  578.             if (!$doc) {
  579.                 $this->patchTypes['force'] = $forcePatchTypes;
  581.                 continue;
  582.             }
  584.             if (isset($doc['return']) || 'void' !== (self::MAGIC_METHODS[$method->name] ?? 'void')) {
  585.                 $this->setReturnType($doc['return'] ?? self::MAGIC_METHODS[$method->name], $method->class, $method->name, $method->getFileName(), $parent, $method->getReturnType());
  587.                 if (isset(self::$returnTypes[$class][$method->name][0]) && $canAddReturnType) {
  588.                     $this->fixReturnStatements($method, self::$returnTypes[$class][$method->name][0]);
  589.                 }
  591.                 if ($method->isPrivate()) {
  592.                     unset(self::$returnTypes[$class][$method->name]);
  593.                 }
  594.             }
  596.             $this->patchTypes['force'] = $forcePatchTypes;
  598.             if ($method->isPrivate()) {
  599.                 continue;
  600.             }
  602.             $finalOrInternal = false;
  604.             foreach (['final', 'internal'] as $annotation) {
  605.                 if (null !== $description = $doc[$annotation][0] ?? null) {
  606.                     self::${$annotation.'Methods'}[$class][$method->name] = [$class, '' !== $description ? ' '.$description.(preg_match('/[[:punct:]]$/', $description) ? '' : '.') : '.'];
  607.                     $finalOrInternal = true;
  608.                 }
  609.             }
  611.             if ($finalOrInternal || $method->isConstructor() || !isset($doc['param']) || StatelessInvocation::class === $class) {
  612.                 continue;
  613.             }
  614.             if (!isset(self::$annotatedParameters[$class][$method->name])) {
  615.                 $definedParameters = [];
  616.                 foreach ($method->getParameters() as $parameter) {
  617.                     $definedParameters[$parameter->name] = true;
  618.                 }
  619.             }
  620.             foreach ($doc['param'] as $parameterName => $parameterType) {
  621.                 if (!isset($definedParameters[$parameterName])) {
  622.                     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.' ' : '', $parameterName, interface_exists($className) ? 'interface' : 'parent class', $className);
  623.                 }
  624.             }
  625.         }
  627.         return $deprecations;
  628.     }
  630.     public function checkCase(\ReflectionClass $refl, string $file, string $class): ?array
  631.     {
  632.         $real = explode('\\', $class.strrchr($file, '.'));
  633.         $tail = explode(\DIRECTORY_SEPARATOR, str_replace('/', \DIRECTORY_SEPARATOR, $file));
  635.         $i = \count($tail) - 1;
  636.         $j = \count($real) - 1;
  638.         while (isset($tail[$i], $real[$j]) && $tail[$i] === $real[$j]) {
  639.             --$i;
  640.             --$j;
  641.         }
  643.         array_splice($tail, 0, $i + 1);
  645.         if (!$tail) {
  646.             return null;
  647.         }
  649.         $tail = \DIRECTORY_SEPARATOR.implode(\DIRECTORY_SEPARATOR, $tail);
  650.         $tailLen = \strlen($tail);
  651.         $real = $refl->getFileName();
  653.         if (2 === self::$caseCheck) {
  654.             $real = $this->darwinRealpath($real);
  655.         }
  657.         if (0 === substr_compare($real, $tail, -$tailLen, $tailLen, true)
  658.             && 0 !== substr_compare($real, $tail, -$tailLen, $tailLen, false)
  659.         ) {
  660.             return [substr($tail, -$tailLen + 1), substr($real, -$tailLen + 1), substr($real, 0, -$tailLen + 1)];
  661.         }
  663.         return null;
  664.     }
  666.     /**
  667.      * `realpath` on MacOSX doesn't normalize the case of characters.
  668.      */
  669.     private function darwinRealpath(string $real): string
  670.     {
  671.         $i = 1 + strrpos($real, '/');
  672.         $file = substr($real, $i);
  673.         $real = substr($real, 0, $i);
  675.         if (isset(self::$darwinCache[$real])) {
  676.             $kDir = $real;
  677.         } else {
  678.             $kDir = strtolower($real);
  680.             if (isset(self::$darwinCache[$kDir])) {
  681.                 $real = self::$darwinCache[$kDir][0];
  682.             } else {
  683.                 $dir = getcwd();
  685.                 if (!@chdir($real)) {
  686.                     return $real.$file;
  687.                 }
  689.                 $real = getcwd().'/';
  690.                 chdir($dir);
  692.                 $dir = $real;
  693.                 $k = $kDir;
  694.                 $i = \strlen($dir) - 1;
  695.                 while (!isset(self::$darwinCache[$k])) {
  696.                     self::$darwinCache[$k] = [$dir, []];
  697.                     self::$darwinCache[$dir] = &self::$darwinCache[$k];
  699.                     while ('/' !== $dir[--$i]) {
  700.                     }
  701.                     $k = substr($k, 0, ++$i);
  702.                     $dir = substr($dir, 0, $i--);
  703.                 }
  704.             }
  705.         }
  707.         $dirFiles = self::$darwinCache[$kDir][1];
  709.         if (!isset($dirFiles[$file]) && ') : eval()\'d code' === substr($file, -17)) {
  710.             // Get the file name from "file_name.php(123) : eval()'d code"
  711.             $file = substr($file, 0, strrpos($file, '(', -17));
  712.         }
  714.         if (isset($dirFiles[$file])) {
  715.             return $real.$dirFiles[$file];
  716.         }
  718.         $kFile = strtolower($file);
  720.         if (!isset($dirFiles[$kFile])) {
  721.             foreach (scandir($real, 2) as $f) {
  722.                 if ('.' !== $f[0]) {
  723.                     $dirFiles[$f] = $f;
  724.                     if ($f === $file) {
  725.                         $kFile = $k = $file;
  726.                     } elseif ($f !== $k = strtolower($f)) {
  727.                         $dirFiles[$k] = $f;
  728.                     }
  729.                 }
  730.             }
  731.             self::$darwinCache[$kDir][1] = $dirFiles;
  732.         }
  734.         return $real.$dirFiles[$kFile];
  735.     }
  737.     /**
  738.      * `class_implements` includes interfaces from the parents so we have to manually exclude them.
  739.      *
  740.      * @return string[]
  741.      */
  742.     private function getOwnInterfaces(string $class, ?string $parent): array
  743.     {
  744.         $ownInterfaces = class_implements($class, false);
  746.         if ($parent) {
  747.             foreach (class_implements($parent, false) as $interface) {
  748.                 unset($ownInterfaces[$interface]);
  749.             }
  750.         }
  752.         foreach ($ownInterfaces as $interface) {
  753.             foreach (class_implements($interface) as $interface) {
  754.                 unset($ownInterfaces[$interface]);
  755.             }
  756.         }
  758.         return $ownInterfaces;
  759.     }
  761.     private function setReturnType(string $types, string $class, string $method, string $filename, ?string $parent, \ReflectionType $returnType = null): void
  762.     {
  763.         if ('__construct' === $method) {
  764.             return;
  765.         }
  767.         if ($nullable = 0 === strpos($types, 'null|')) {
  768.             $types = substr($types, 5);
  769.         } elseif ($nullable = '|null' === substr($types, -5)) {
  770.             $types = substr($types, 0, -5);
  771.         }
  772.         $arrayType = ['array' => 'array'];
  773.         $typesMap = [];
  774.         $glue = false !== strpos($types, '&') ? '&' : '|';
  775.         foreach (explode($glue, $types) as $t) {
  776.             $t = self::SPECIAL_RETURN_TYPES[strtolower($t)] ?? $t;
  777.             $typesMap[$this->normalizeType($t, $class, $parent, $returnType)][$t] = $t;
  778.         }
  780.         if (isset($typesMap['array'])) {
  781.             if (isset($typesMap['Traversable']) || isset($typesMap['\Traversable'])) {
  782.                 $typesMap['iterable'] = $arrayType !== $typesMap['array'] ? $typesMap['array'] : ['iterable'];
  783.                 unset($typesMap['array'], $typesMap['Traversable'], $typesMap['\Traversable']);
  784.             } elseif ($arrayType !== $typesMap['array'] && isset(self::$returnTypes[$class][$method]) && !$returnType) {
  785.                 return;
  786.             }
  787.         }
  789.         if (isset($typesMap['array']) && isset($typesMap['iterable'])) {
  790.             if ($arrayType !== $typesMap['array']) {
  791.                 $typesMap['iterable'] = $typesMap['array'];
  792.             }
  793.             unset($typesMap['array']);
  794.         }
  796.         $iterable = $object = true;
  797.         foreach ($typesMap as $n => $t) {
  798.             if ('null' !== $n) {
  799.                 $iterable = $iterable && (\in_array($n, ['array', 'iterable']) || str_contains($n, 'Iterator'));
  800.                 $object = $object && (\in_array($n, ['callable', 'object', '$this', 'static']) || !isset(self::SPECIAL_RETURN_TYPES[$n]));
  801.             }
  802.         }
  804.         $phpTypes = [];
  805.         $docTypes = [];
  807.         foreach ($typesMap as $n => $t) {
  808.             if ('null' === $n) {
  809.                 $nullable = true;
  810.                 continue;
  811.             }
  813.             $docTypes[] = $t;
  815.             if ('mixed' === $n || 'void' === $n) {
  816.                 $nullable = false;
  817.                 $phpTypes = ['' => $n];
  818.                 continue;
  819.             }
  821.             if ('resource' === $n) {
  822.                 // there is no native type for "resource"
  823.                 return;
  824.             }
  826.             if (!isset($phpTypes[''])) {
  827.                 $phpTypes[] = $n;
  828.             }
  829.         }
  830.         $docTypes = array_merge([], ...$docTypes);
  832.         if (!$phpTypes) {
  833.             return;
  834.         }
  836.         if (1 < \count($phpTypes)) {
  837.             if ($iterable && '8.0' > $this->patchTypes['php']) {
  838.                 $phpTypes = $docTypes = ['iterable'];
  839.             } elseif ($object && 'object' === $this->patchTypes['force']) {
  840.                 $phpTypes = $docTypes = ['object'];
  841.             } elseif ('8.0' > $this->patchTypes['php']) {
  842.                 // ignore multi-types return declarations
  843.                 return;
  844.             }
  845.         }
  847.         $phpType = sprintf($nullable ? (1 < \count($phpTypes) ? '%s|null' : '?%s') : '%s', implode($glue, $phpTypes));
  848.         $docType = sprintf($nullable ? '%s|null' : '%s', implode($glue, $docTypes));
  850.         self::$returnTypes[$class][$method] = [$phpType, $docType, $class, $filename];
  851.     }
  853.     private function normalizeType(string $type, string $class, ?string $parent, ?\ReflectionType $returnType): string
  854.     {
  855.         if (isset(self::SPECIAL_RETURN_TYPES[$lcType = strtolower($type)])) {
  856.             if ('parent' === $lcType = self::SPECIAL_RETURN_TYPES[$lcType]) {
  857.                 $lcType = null !== $parent ? '\\'.$parent : 'parent';
  858.             } elseif ('self' === $lcType) {
  859.                 $lcType = '\\'.$class;
  860.             }
  862.             return $lcType;
  863.         }
  865.         // We could resolve "use" statements to return the FQDN
  866.         // but this would be too expensive for a runtime checker
  868.         if ('[]' !== substr($type, -2)) {
  869.             return $type;
  870.         }
  872.         if ($returnType instanceof \ReflectionNamedType) {
  873.             $type = $returnType->getName();
  875.             if ('mixed' !== $type) {
  876.                 return isset(self::SPECIAL_RETURN_TYPES[$type]) ? $type : '\\'.$type;
  877.             }
  878.         }
  880.         return 'array';
  881.     }
  883.     /**
  884.      * Utility method to add #[ReturnTypeWillChange] where php triggers deprecations.
  885.      */
  886.     private function patchReturnTypeWillChange(\ReflectionMethod $method)
  887.     {
  888.         if (\count($method->getAttributes(\ReturnTypeWillChange::class))) {
  889.             return;
  890.         }
  892.         if (!is_file($file = $method->getFileName())) {
  893.             return;
  894.         }
  896.         $fileOffset = self::$fileOffsets[$file] ?? 0;
  898.         $code = file($file);
  900.         $startLine = $method->getStartLine() + $fileOffset - 2;
  902.         if (false !== stripos($code[$startLine], 'ReturnTypeWillChange')) {
  903.             return;
  904.         }
  906.         $code[$startLine] .= "    #[\\ReturnTypeWillChange]\n";
  907.         self::$fileOffsets[$file] = 1 + $fileOffset;
  908.         file_put_contents($file, $code);
  909.     }
  911.     /**
  912.      * Utility method to add @return annotations to the Symfony code-base where it triggers self-deprecations.
  913.      */
  914.     private function patchMethod(\ReflectionMethod $method, string $returnType, string $declaringFile, string $normalizedType)
  915.     {
  916.         static $patchedMethods = [];
  917.         static $useStatements = [];
  919.         if (!is_file($file = $method->getFileName()) || isset($patchedMethods[$file][$startLine = $method->getStartLine()])) {
  920.             return;
  921.         }
  923.         $patchedMethods[$file][$startLine] = true;
  924.         $fileOffset = self::$fileOffsets[$file] ?? 0;
  925.         $startLine += $fileOffset - 2;
  926.         if ($nullable = '|null' === substr($returnType, -5)) {
  927.             $returnType = substr($returnType, 0, -5);
  928.         }
  929.         $glue = false !== strpos($returnType, '&') ? '&' : '|';
  930.         $returnType = explode($glue, $returnType);
  931.         $code = file($file);
  933.         foreach ($returnType as $i => $type) {
  934.             if (preg_match('/((?:\[\])+)$/', $type, $m)) {
  935.                 $type = substr($type, 0, -\strlen($m[1]));
  936.                 $format = '%s'.$m[1];
  937.             } else {
  938.                 $format = null;
  939.             }
  941.             if (isset(self::SPECIAL_RETURN_TYPES[$type]) || ('\\' === $type[0] && !$p = strrpos($type, '\\', 1))) {
  942.                 continue;
  943.             }
  945.             [$namespace, $useOffset, $useMap] = $useStatements[$file] ?? $useStatements[$file] = self::getUseStatements($file);
  947.             if ('\\' !== $type[0]) {
  948.                 [$declaringNamespace, , $declaringUseMap] = $useStatements[$declaringFile] ?? $useStatements[$declaringFile] = self::getUseStatements($declaringFile);
  950.                 $p = strpos($type, '\\', 1);
  951.                 $alias = $p ? substr($type, 0, $p) : $type;
  953.                 if (isset($declaringUseMap[$alias])) {
  954.                     $type = '\\'.$declaringUseMap[$alias].($p ? substr($type, $p) : '');
  955.                 } else {
  956.                     $type = '\\'.$declaringNamespace.$type;
  957.                 }
  959.                 $p = strrpos($type, '\\', 1);
  960.             }
  962.             $alias = substr($type, 1 + $p);
  963.             $type = substr($type, 1);
  965.             if (!isset($useMap[$alias]) && (class_exists($c = $namespace.$alias) || interface_exists($c) || trait_exists($c))) {
  966.                 $useMap[$alias] = $c;
  967.             }
  969.             if (!isset($useMap[$alias])) {
  970.                 $useStatements[$file][2][$alias] = $type;
  971.                 $code[$useOffset] = "use $type;\n".$code[$useOffset];
  972.                 ++$fileOffset;
  973.             } elseif ($useMap[$alias] !== $type) {
  974.                 $alias .= 'FIXME';
  975.                 $useStatements[$file][2][$alias] = $type;
  976.                 $code[$useOffset] = "use $type as $alias;\n".$code[$useOffset];
  977.                 ++$fileOffset;
  978.             }
  980.             $returnType[$i] = null !== $format ? sprintf($format, $alias) : $alias;
  981.         }
  983.         if ('docblock' === $this->patchTypes['force'] || ('object' === $normalizedType && '7.1' === $this->patchTypes['php'])) {
  984.             $returnType = implode($glue, $returnType).($nullable ? '|null' : '');
  986.             if (false !== strpos($code[$startLine], '#[')) {
  987.                 --$startLine;
  988.             }
  990.             if ($method->getDocComment()) {
  991.                 $code[$startLine] = "     * @return $returnType\n".$code[$startLine];
  992.             } else {
  993.                 $code[$startLine] .= <<<EOTXT
  994.     /**
  995.      * @return $returnType
  996.      */
  998. EOTXT;
  999.             }
  1001.             $fileOffset += substr_count($code[$startLine], "\n") - 1;
  1002.         }
  1004.         self::$fileOffsets[$file] = $fileOffset;
  1005.         file_put_contents($file, $code);
  1007.         $this->fixReturnStatements($method, $normalizedType);
  1008.     }
  1010.     private static function getUseStatements(string $file): array
  1011.     {
  1012.         $namespace = '';
  1013.         $useMap = [];
  1014.         $useOffset = 0;
  1016.         if (!is_file($file)) {
  1017.             return [$namespace, $useOffset, $useMap];
  1018.         }
  1020.         $file = file($file);
  1022.         for ($i = 0; $i < \count($file); ++$i) {
  1023.             if (preg_match('/^(class|interface|trait|abstract) /', $file[$i])) {
  1024.                 break;
  1025.             }
  1027.             if (str_starts_with($file[$i], 'namespace ')) {
  1028.                 $namespace = substr($file[$i], \strlen('namespace '), -2).'\\';
  1029.                 $useOffset = $i + 2;
  1030.             }
  1032.             if (str_starts_with($file[$i], 'use ')) {
  1033.                 $useOffset = $i;
  1035.                 for (; str_starts_with($file[$i], 'use '); ++$i) {
  1036.                     $u = explode(' as ', substr($file[$i], 4, -2), 2);
  1038.                     if (1 === \count($u)) {
  1039.                         $p = strrpos($u[0], '\\');
  1040.                         $useMap[substr($u[0], false !== $p ? 1 + $p : 0)] = $u[0];
  1041.                     } else {
  1042.                         $useMap[$u[1]] = $u[0];
  1043.                     }
  1044.                 }
  1046.                 break;
  1047.             }
  1048.         }
  1050.         return [$namespace, $useOffset, $useMap];
  1051.     }
  1053.     private function fixReturnStatements(\ReflectionMethod $method, string $returnType)
  1054.     {
  1055.         if ('docblock' !== $this->patchTypes['force']) {
  1056.             if ('7.1' === $this->patchTypes['php'] && 'object' === ltrim($returnType, '?')) {
  1057.                 return;
  1058.             }
  1060.             if ('7.4' > $this->patchTypes['php'] && $method->hasReturnType()) {
  1061.                 return;
  1062.             }
  1064.             if ('8.0' > $this->patchTypes['php'] && (false !== strpos($returnType, '|') || \in_array($returnType, ['mixed', 'static'], true))) {
  1065.                 return;
  1066.             }
  1068.             if ('8.1' > $this->patchTypes['php'] && false !== strpos($returnType, '&')) {
  1069.                 return;
  1070.             }
  1071.         }
  1073.         if (!is_file($file = $method->getFileName())) {
  1074.             return;
  1075.         }
  1077.         $fixedCode = $code = file($file);
  1078.         $i = (self::$fileOffsets[$file] ?? 0) + $method->getStartLine();
  1080.         if ('?' !== $returnType && 'docblock' !== $this->patchTypes['force']) {
  1081.             $fixedCode[$i - 1] = preg_replace('/\)(?::[^;\n]++)?(;?\n)/', "): $returnType\\1", $code[$i - 1]);
  1082.         }
  1084.         $end = $method->isGenerator() ? $i : $method->getEndLine();
  1085.         for (; $i < $end; ++$i) {
  1086.             if ('void' === $returnType) {
  1087.                 $fixedCode[$i] = str_replace('    return null;', '    return;', $code[$i]);
  1088.             } elseif ('mixed' === $returnType || '?' === $returnType[0]) {
  1089.                 $fixedCode[$i] = str_replace('    return;', '    return null;', $code[$i]);
  1090.             } else {
  1091.                 $fixedCode[$i] = str_replace('    return;', "    return $returnType!?;", $code[$i]);
  1092.             }
  1093.         }
  1095.         if ($fixedCode !== $code) {
  1096.             file_put_contents($file, $fixedCode);
  1097.         }
  1098.     }
  1100.     /**
  1101.      * @param \ReflectionClass|\ReflectionMethod|\ReflectionProperty $reflector
  1102.      */
  1103.     private function parsePhpDoc(\Reflector $reflector): array
  1104.     {
  1105.         if (!$doc = $reflector->getDocComment()) {
  1106.             return [];
  1107.         }
  1109.         $tagName = '';
  1110.         $tagContent = '';
  1112.         $tags = [];
  1114.         foreach (explode("\n", substr($doc, 3, -2)) as $line) {
  1115.             $line = ltrim($line);
  1116.             $line = ltrim($line, '*');
  1118.             if ('' === $line = trim($line)) {
  1119.                 if ('' !== $tagName) {
  1120.                     $tags[$tagName][] = $tagContent;
  1121.                 }
  1122.                 $tagName = $tagContent = '';
  1123.                 continue;
  1124.             }
  1126.             if ('@' === $line[0]) {
  1127.                 if ('' !== $tagName) {
  1128.                     $tags[$tagName][] = $tagContent;
  1129.                     $tagContent = '';
  1130.                 }
  1132.                 if (preg_match('{^@([-a-zA-Z0-9_:]++)(\s|$)}', $line, $m)) {
  1133.                     $tagName = $m[1];
  1134.                     $tagContent = str_replace("\t", ' ', ltrim(substr($line, 2 + \strlen($tagName))));
  1135.                 } else {
  1136.                     $tagName = '';
  1137.                 }
  1138.             } elseif ('' !== $tagName) {
  1139.                 $tagContent .= ' '.str_replace("\t", ' ', $line);
  1140.             }
  1141.         }
  1143.         if ('' !== $tagName) {
  1144.             $tags[$tagName][] = $tagContent;
  1145.         }
  1147.         foreach ($tags['method'] ?? [] as $i => $method) {
  1148.             unset($tags['method'][$i]);
  1150.             $parts = preg_split('{(\s++|\((?:[^()]*+|(?R))*\)(?: *: *[^ ]++)?|<(?:[^<>]*+|(?R))*>|\{(?:[^{}]*+|(?R))*\})}', $method, -1, \PREG_SPLIT_DELIM_CAPTURE);
  1151.             $returnType = '';
  1152.             $static = 'static' === $parts[0];
  1154.             for ($i = $static ? 2 : 0; null !== $p = $parts[$i] ?? null; $i += 2) {
  1155.                 if (\in_array($p, ['', '|', '&', 'callable'], true) || \in_array(substr($returnType, -1), ['|', '&'], true)) {
  1156.                     $returnType .= trim($parts[$i - 1] ?? '').$p;
  1157.                     continue;
  1158.                 }
  1160.                 $signature = '(' === ($parts[$i + 1][0] ?? '(') ? $parts[$i + 1] ?? '()' : null;
  1162.                 if (null === $signature && '' === $returnType) {
  1163.                     $returnType = $p;
  1164.                     continue;
  1165.                 }
  1167.                 if ($static && 2 === $i) {
  1168.                     $static = false;
  1169.                     $returnType = 'static';
  1170.                 }
  1172.                 if (\in_array($description = trim(implode('', \array_slice($parts, 2 + $i))), ['', '.'], true)) {
  1173.                     $description = null;
  1174.                 } elseif (!preg_match('/[.!]$/', $description)) {
  1175.                     $description .= '.';
  1176.                 }
  1178.                 $tags['method'][$p] = [$static, $returnType, $signature ?? '()', $description];
  1179.                 break;
  1180.             }
  1181.         }
  1183.         foreach ($tags['param'] ?? [] as $i => $param) {
  1184.             unset($tags['param'][$i]);
  1186.             if (\strlen($param) !== strcspn($param, '<{(')) {
  1187.                 $param = preg_replace('{\(([^()]*+|(?R))*\)(?: *: *[^ ]++)?|<([^<>]*+|(?R))*>|\{([^{}]*+|(?R))*\}}', '', $param);
  1188.             }
  1190.             if (false === $i = strpos($param, '$')) {
  1191.                 continue;
  1192.             }
  1194.             $type = 0 === $i ? '' : rtrim(substr($param, 0, $i), ' &');
  1195.             $param = substr($param, 1 + $i, (strpos($param, ' ', $i) ?: (1 + $i + \strlen($param))) - $i - 1);
  1197.             $tags['param'][$param] = $type;
  1198.         }
  1200.         foreach (['var', 'return'] as $k) {
  1201.             if (null === $v = $tags[$k][0] ?? null) {
  1202.                 continue;
  1203.             }
  1204.             if (\strlen($v) !== strcspn($v, '<{(')) {
  1205.                 $v = preg_replace('{\(([^()]*+|(?R))*\)(?: *: *[^ ]++)?|<([^<>]*+|(?R))*>|\{([^{}]*+|(?R))*\}}', '', $v);
  1206.             }
  1208.             $tags[$k] = substr($v, 0, strpos($v, ' ') ?: \strlen($v)) ?: null;
  1209.         }
  1211.         return $tags;
  1212.     }
  1213. }