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

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.     private $classLoader;
  104.     private $isFinder;
  105.     private $loaded = [];
  106.     private $patchTypes;
  108.     private static $caseCheck;
  109.     private static $checkedClasses = [];
  110.     private static $final = [];
  111.     private static $finalMethods = [];
  112.     private static $deprecated = [];
  113.     private static $internal = [];
  114.     private static $internalMethods = [];
  115.     private static $annotatedParameters = [];
  116.     private static $darwinCache = ['/' => ['/', []]];
  117.     private static $method = [];
  118.     private static $returnTypes = [];
  119.     private static $methodTraits = [];
  120.     private static $fileOffsets = [];
  122.     public function __construct(callable $classLoader)
  123.     {
  124.         $this->classLoader = $classLoader;
  125.         $this->isFinder = \is_array($classLoader) && method_exists($classLoader[0], 'findFile');
  126.         parse_str(getenv('SYMFONY_PATCH_TYPE_DECLARATIONS') ?: '', $this->patchTypes);
  127.         $this->patchTypes += [
  128.             'force' => null,
  129.             'php' => \PHP_MAJOR_VERSION.'.'.\PHP_MINOR_VERSION,
  130.             'deprecations' => \PHP_VERSION_ID >= 70400,
  131.         ];
  133.         if ('phpdoc' === $this->patchTypes['force']) {
  134.             $this->patchTypes['force'] = 'docblock';
  135.         }
  137.         if (!isset(self::$caseCheck)) {
  138.             $file = is_file(__FILE__) ? __FILE__ : rtrim(realpath('.'), \DIRECTORY_SEPARATOR);
  139.             $i = strrpos($file, \DIRECTORY_SEPARATOR);
  140.             $dir = substr($file, 0, 1 + $i);
  141.             $file = substr($file, 1 + $i);
  142.             $test = strtoupper($file) === $file ? strtolower($file) : strtoupper($file);
  143.             $test = realpath($dir.$test);
  145.             if (false === $test || false === $i) {
  146.                 // filesystem is case sensitive
  147.                 self::$caseCheck = 0;
  148.             } elseif (substr($test, -\strlen($file)) === $file) {
  149.                 // filesystem is case insensitive and realpath() normalizes the case of characters
  150.                 self::$caseCheck = 1;
  151.             } elseif ('Darwin' === \PHP_OS_FAMILY) {
  152.                 // on MacOSX, HFS+ is case insensitive but realpath() doesn't normalize the case of characters
  153.                 self::$caseCheck = 2;
  154.             } else {
  155.                 // filesystem case checks failed, fallback to disabling them
  156.                 self::$caseCheck = 0;
  157.             }
  158.         }
  159.     }
  161.     public function getClassLoader(): callable
  162.     {
  163.         return $this->classLoader;
  164.     }
  166.     /**
  167.      * Wraps all autoloaders.
  168.      */
  169.     public static function enable(): void
  170.     {
  171.         // Ensures we don't hit https://bugs.php.net/42098
  172.         class_exists(\Symfony\Component\ErrorHandler\ErrorHandler::class);
  173.         class_exists(\Psr\Log\LogLevel::class);
  175.         if (!\is_array($functions = spl_autoload_functions())) {
  176.             return;
  177.         }
  179.         foreach ($functions as $function) {
  180.             spl_autoload_unregister($function);
  181.         }
  183.         foreach ($functions as $function) {
  184.             if (!\is_array($function) || !$function[0] instanceof self) {
  185.                 $function = [new static($function), 'loadClass'];
  186.             }
  188.             spl_autoload_register($function);
  189.         }
  190.     }
  192.     /**
  193.      * Disables the wrapping.
  194.      */
  195.     public static function disable(): void
  196.     {
  197.         if (!\is_array($functions = spl_autoload_functions())) {
  198.             return;
  199.         }
  201.         foreach ($functions as $function) {
  202.             spl_autoload_unregister($function);
  203.         }
  205.         foreach ($functions as $function) {
  206.             if (\is_array($function) && $function[0] instanceof self) {
  207.                 $function = $function[0]->getClassLoader();
  208.             }
  210.             spl_autoload_register($function);
  211.         }
  212.     }
  214.     public static function checkClasses(): bool
  215.     {
  216.         if (!\is_array($functions = spl_autoload_functions())) {
  217.             return false;
  218.         }
  220.         $loader = null;
  222.         foreach ($functions as $function) {
  223.             if (\is_array($function) && $function[0] instanceof self) {
  224.                 $loader = $function[0];
  225.                 break;
  226.             }
  227.         }
  229.         if (null === $loader) {
  230.             return false;
  231.         }
  233.         static $offsets = [
  234.             'get_declared_interfaces' => 0,
  235.             'get_declared_traits' => 0,
  236.             'get_declared_classes' => 0,
  237.         ];
  239.         foreach ($offsets as $getSymbols => $i) {
  240.             $symbols = $getSymbols();
  242.             for (; $i < \count($symbols); ++$i) {
  243.                 if (!is_subclass_of($symbols[$i], MockObject::class)
  244.                     && !is_subclass_of($symbols[$i], ProphecySubjectInterface::class)
  245.                     && !is_subclass_of($symbols[$i], Proxy::class)
  246.                     && !is_subclass_of($symbols[$i], ProxyInterface::class)
  247.                     && !is_subclass_of($symbols[$i], LegacyProxy::class)
  248.                     && !is_subclass_of($symbols[$i], MockInterface::class)
  249.                     && !is_subclass_of($symbols[$i], IMock::class)
  250.                 ) {
  251.                     $loader->checkClass($symbols[$i]);
  252.                 }
  253.             }
  255.             $offsets[$getSymbols] = $i;
  256.         }
  258.         return true;
  259.     }
  261.     public function findFile(string $class): ?string
  262.     {
  263.         return $this->isFinder ? ($this->classLoader[0]->findFile($class) ?: null) : null;
  264.     }
  266.     /**
  267.      * Loads the given class or interface.
  268.      *
  269.      * @throws \RuntimeException
  270.      */
  271.     public function loadClass(string $class): void
  272.     {
  273.         $e = error_reporting(error_reporting() | \E_PARSE | \E_ERROR | \E_CORE_ERROR | \E_COMPILE_ERROR);
  275.         try {
  276.             if ($this->isFinder && !isset($this->loaded[$class])) {
  277.                 $this->loaded[$class] = true;
  278.                 if (!$file = $this->classLoader[0]->findFile($class) ?: '') {
  279.                     // no-op
  280.                 } elseif (\function_exists('opcache_is_script_cached') && @opcache_is_script_cached($file)) {
  281.                     include $file;
  283.                     return;
  284.                 } elseif (false === include $file) {
  285.                     return;
  286.                 }
  287.             } else {
  288.                 ($this->classLoader)($class);
  289.                 $file = '';
  290.             }
  291.         } finally {
  292.             error_reporting($e);
  293.         }
  295.         $this->checkClass($class, $file);
  296.     }
  298.     private function checkClass(string $class, string $file = null): void
  299.     {
  300.         $exists = null === $file || class_exists($class, false) || interface_exists($class, false) || trait_exists($class, false);
  302.         if (null !== $file && $class && '\\' === $class[0]) {
  303.             $class = substr($class, 1);
  304.         }
  306.         if ($exists) {
  307.             if (isset(self::$checkedClasses[$class])) {
  308.                 return;
  309.             }
  310.             self::$checkedClasses[$class] = true;
  312.             $refl = new \ReflectionClass($class);
  313.             if (null === $file && $refl->isInternal()) {
  314.                 return;
  315.             }
  316.             $name = $refl->getName();
  318.             if ($name !== $class && 0 === strcasecmp($name, $class)) {
  319.                 throw new \RuntimeException(sprintf('Case mismatch between loaded and declared class names: "%s" vs "%s".', $class, $name));
  320.             }
  322.             $deprecations = $this->checkAnnotations($refl, $name);
  324.             foreach ($deprecations as $message) {
  325.                 @trigger_error($message, \E_USER_DEPRECATED);
  326.             }
  327.         }
  329.         if (!$file) {
  330.             return;
  331.         }
  333.         if (!$exists) {
  334.             if (false !== strpos($class, '/')) {
  335.                 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));
  336.             }
  338.             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));
  339.         }
  341.         if (self::$caseCheck && $message = $this->checkCase($refl, $file, $class)) {
  342.             throw new \RuntimeException(sprintf('Case mismatch between class and real file names: "%s" vs "%s" in "%s".', $message[0], $message[1], $message[2]));
  343.         }
  344.     }
  346.     public function checkAnnotations(\ReflectionClass $refl, string $class): array
  347.     {
  348.         if (
  349.             'Symfony\Bridge\PhpUnit\Legacy\SymfonyTestsListenerForV7' === $class
  350.             || 'Symfony\Bridge\PhpUnit\Legacy\SymfonyTestsListenerForV6' === $class
  351.         ) {
  352.             return [];
  353.         }
  354.         $deprecations = [];
  356.         $className = false !== strpos($class, "@anonymous\0") ? (get_parent_class($class) ?: key(class_implements($class)) ?: 'class').'@anonymous' : $class;
  358.         // Don't trigger deprecations for classes in the same vendor
  359.         if ($class !== $className) {
  360.             $vendor = preg_match('/^namespace ([^;\\\\\s]++)[;\\\\]/m', @file_get_contents($refl->getFileName()), $vendor) ? $vendor[1].'\\' : '';
  361.             $vendorLen = \strlen($vendor);
  362.         } elseif (2 > $vendorLen = 1 + (strpos($class, '\\') ?: strpos($class, '_'))) {
  363.             $vendorLen = 0;
  364.             $vendor = '';
  365.         } else {
  366.             $vendor = str_replace('_', '\\', substr($class, 0, $vendorLen));
  367.         }
  369.         $parent = get_parent_class($class) ?: null;
  370.         self::$returnTypes[$class] = [];
  372.         // Detect annotations on the class
  373.         if ($doc = $this->parsePhpDoc($refl)) {
  374.             foreach (['final', 'deprecated', 'internal'] as $annotation) {
  375.                 if (null !== $description = $doc[$annotation][0] ?? null) {
  376.                     self::${$annotation}[$class] = '' !== $description ? ' '.$description.(preg_match('/[.!]$/', $description) ? '' : '.') : '.';
  377.                 }
  378.             }
  380.             if ($refl->isInterface() && isset($doc['method'])) {
  381.                 foreach ($doc['method'] as $name => [$static, $returnType, $signature, $description]) {
  382.                     self::$method[$class][] = [$class, $static, $returnType, $name.$signature, $description];
  384.                     if ('' !== $returnType) {
  385.                         $this->setReturnType($returnType, $refl->name, $name, $refl->getFileName(), $parent);
  386.                     }
  387.                 }
  388.             }
  389.         }
  391.         $parentAndOwnInterfaces = $this->getOwnInterfaces($class, $parent);
  392.         if ($parent) {
  393.             $parentAndOwnInterfaces[$parent] = $parent;
  395.             if (!isset(self::$checkedClasses[$parent])) {
  396.                 $this->checkClass($parent);
  397.             }
  399.             if (isset(self::$final[$parent])) {
  400.                 $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);
  401.             }
  402.         }
  404.         // Detect if the parent is annotated
  405.         foreach ($parentAndOwnInterfaces + class_uses($class, false) as $use) {
  406.             if (!isset(self::$checkedClasses[$use])) {
  407.                 $this->checkClass($use);
  408.             }
  409.             if (isset(self::$deprecated[$use]) && strncmp($vendor, str_replace('_', '\\', $use), $vendorLen) && !isset(self::$deprecated[$class])) {
  410.                 $type = class_exists($class, false) ? 'class' : (interface_exists($class, false) ? 'interface' : 'trait');
  411.                 $verb = class_exists($use, false) || interface_exists($class, false) ? 'extends' : (interface_exists($use, false) ? 'implements' : 'uses');
  413.                 $deprecations[] = sprintf('The "%s" %s %s "%s" that is deprecated%s', $className, $type, $verb, $use, self::$deprecated[$use]);
  414.             }
  415.             if (isset(self::$internal[$use]) && strncmp($vendor, str_replace('_', '\\', $use), $vendorLen)) {
  416.                 $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);
  417.             }
  418.             if (isset(self::$method[$use])) {
  419.                 if ($refl->isAbstract()) {
  420.                     if (isset(self::$method[$class])) {
  421.                         self::$method[$class] = array_merge(self::$method[$class], self::$method[$use]);
  422.                     } else {
  423.                         self::$method[$class] = self::$method[$use];
  424.                     }
  425.                 } elseif (!$refl->isInterface()) {
  426.                     if (!strncmp($vendor, str_replace('_', '\\', $use), $vendorLen)
  427.                         && 0 === strpos($className, 'Symfony\\')
  428.                         && (!class_exists(InstalledVersions::class)
  429.                             || 'symfony/symfony' !== InstalledVersions::getRootPackage()['name'])
  430.                     ) {
  431.                         // skip "same vendor" @method deprecations for Symfony\* classes unless symfony/symfony is being tested
  432.                         continue;
  433.                     }
  434.                     $hasCall = $refl->hasMethod('__call');
  435.                     $hasStaticCall = $refl->hasMethod('__callStatic');
  436.                     foreach (self::$method[$use] as [$interface, $static, $returnType, $name, $description]) {
  437.                         if ($static ? $hasStaticCall : $hasCall) {
  438.                             continue;
  439.                         }
  440.                         $realName = substr($name, 0, strpos($name, '('));
  441.                         if (!$refl->hasMethod($realName) || !($methodRefl = $refl->getMethod($realName))->isPublic() || ($static && !$methodRefl->isStatic()) || (!$static && $methodRefl->isStatic())) {
  442.                             $deprecations[] = sprintf('Class "%s" should implement method "%s::%s%s"%s', $className, ($static ? 'static ' : '').$interface, $name, $returnType ? ': '.$returnType : '', null === $description ? '.' : ': '.$description);
  443.                         }
  444.                     }
  445.                 }
  446.             }
  447.         }
  449.         if (trait_exists($class)) {
  450.             $file = $refl->getFileName();
  452.             foreach ($refl->getMethods() as $method) {
  453.                 if ($method->getFileName() === $file) {
  454.                     self::$methodTraits[$file][$method->getStartLine()] = $class;
  455.                 }
  456.             }
  458.             return $deprecations;
  459.         }
  461.         // Inherit @final, @internal, @param and @return annotations for methods
  462.         self::$finalMethods[$class] = [];
  463.         self::$internalMethods[$class] = [];
  464.         self::$annotatedParameters[$class] = [];
  465.         foreach ($parentAndOwnInterfaces as $use) {
  466.             foreach (['finalMethods', 'internalMethods', 'annotatedParameters', 'returnTypes'] as $property) {
  467.                 if (isset(self::${$property}[$use])) {
  468.                     self::${$property}[$class] = self::${$property}[$class] ? self::${$property}[$use] + self::${$property}[$class] : self::${$property}[$use];
  469.                 }
  470.             }
  472.             if (null !== (TentativeTypes::RETURN_TYPES[$use] ?? null)) {
  473.                 foreach (TentativeTypes::RETURN_TYPES[$use] as $method => $returnType) {
  474.                     $returnType = explode('|', $returnType);
  475.                     foreach ($returnType as $i => $t) {
  476.                         if ('?' !== $t && !isset(self::BUILTIN_RETURN_TYPES[$t])) {
  477.                             $returnType[$i] = '\\'.$t;
  478.                         }
  479.                     }
  480.                     $returnType = implode('|', $returnType);
  482.                     self::$returnTypes[$class] += [$method => [$returnType, 0 === strpos($returnType, '?') ? substr($returnType, 1).'|null' : $returnType, $use, '']];
  483.                 }
  484.             }
  485.         }
  487.         foreach ($refl->getMethods() as $method) {
  488.             if ($method->class !== $class) {
  489.                 continue;
  490.             }
  492.             if (null === $ns = self::$methodTraits[$method->getFileName()][$method->getStartLine()] ?? null) {
  493.                 $ns = $vendor;
  494.                 $len = $vendorLen;
  495.             } elseif (2 > $len = 1 + (strpos($ns, '\\') ?: strpos($ns, '_'))) {
  496.                 $len = 0;
  497.                 $ns = '';
  498.             } else {
  499.                 $ns = str_replace('_', '\\', substr($ns, 0, $len));
  500.             }
  502.             if ($parent && isset(self::$finalMethods[$parent][$method->name])) {
  503.                 [$declaringClass, $message] = self::$finalMethods[$parent][$method->name];
  504.                 $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);
  505.             }
  507.             if (isset(self::$internalMethods[$class][$method->name])) {
  508.                 [$declaringClass, $message] = self::$internalMethods[$class][$method->name];
  509.                 if (strncmp($ns, $declaringClass, $len)) {
  510.                     $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);
  511.                 }
  512.             }
  514.             // To read method annotations
  515.             $doc = $this->parsePhpDoc($method);
  517.             if (isset(self::$annotatedParameters[$class][$method->name])) {
  518.                 $definedParameters = [];
  519.                 foreach ($method->getParameters() as $parameter) {
  520.                     $definedParameters[$parameter->name] = true;
  521.                 }
  523.                 foreach (self::$annotatedParameters[$class][$method->name] as $parameterName => $deprecation) {
  524.                     if (!isset($definedParameters[$parameterName]) && !isset($doc['param'][$parameterName])) {
  525.                         $deprecations[] = sprintf($deprecation, $className);
  526.                     }
  527.                 }
  528.             }
  530.             $forcePatchTypes = $this->patchTypes['force'];
  532.             if ($canAddReturnType = null !== $forcePatchTypes && false === strpos($method->getFileName(), \DIRECTORY_SEPARATOR.'vendor'.\DIRECTORY_SEPARATOR)) {
  533.                 if ('void' !== (self::MAGIC_METHODS[$method->name] ?? 'void')) {
  534.                     $this->patchTypes['force'] = $forcePatchTypes ?: 'docblock';
  535.                 }
  537.                 $canAddReturnType = 2 === (int) $forcePatchTypes
  538.                     || false !== stripos($method->getFileName(), \DIRECTORY_SEPARATOR.'Tests'.\DIRECTORY_SEPARATOR)
  539.                     || $refl->isFinal()
  540.                     || $method->isFinal()
  541.                     || $method->isPrivate()
  542.                     || ('.' === (self::$internal[$class] ?? null) && !$refl->isAbstract())
  543.                     || '.' === (self::$final[$class] ?? null)
  544.                     || '' === ($doc['final'][0] ?? null)
  545.                     || '' === ($doc['internal'][0] ?? null)
  546.                 ;
  547.             }
  549.             if (null !== ($returnType = self::$returnTypes[$class][$method->name] ?? null) && 'docblock' === $this->patchTypes['force'] && !$method->hasReturnType() && isset(TentativeTypes::RETURN_TYPES[$returnType[2]][$method->name])) {
  550.                 $this->patchReturnTypeWillChange($method);
  551.             }
  553.             if (null !== ($returnType ?? $returnType = self::MAGIC_METHODS[$method->name] ?? null) && !$method->hasReturnType() && !isset($doc['return'])) {
  554.                 [$normalizedType, $returnType, $declaringClass, $declaringFile] = \is_string($returnType) ? [$returnType, $returnType, '', ''] : $returnType;
  556.                 if ($canAddReturnType && 'docblock' !== $this->patchTypes['force']) {
  557.                     $this->patchMethod($method, $returnType, $declaringFile, $normalizedType);
  558.                 }
  559.                 if (!isset($doc['deprecated']) && strncmp($ns, $declaringClass, $len)) {
  560.                     if ('docblock' === $this->patchTypes['force']) {
  561.                         $this->patchMethod($method, $returnType, $declaringFile, $normalizedType);
  562.                     } elseif ('' !== $declaringClass && $this->patchTypes['deprecations']) {
  563.                         $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);
  564.                     }
  565.                 }
  566.             }
  568.             if (!$doc) {
  569.                 $this->patchTypes['force'] = $forcePatchTypes;
  571.                 continue;
  572.             }
  574.             if (isset($doc['return']) || 'void' !== (self::MAGIC_METHODS[$method->name] ?? 'void')) {
  575.                 $this->setReturnType($doc['return'] ?? self::MAGIC_METHODS[$method->name], $method->class, $method->name, $method->getFileName(), $parent, $method->getReturnType());
  577.                 if (isset(self::$returnTypes[$class][$method->name][0]) && $canAddReturnType) {
  578.                     $this->fixReturnStatements($method, self::$returnTypes[$class][$method->name][0]);
  579.                 }
  581.                 if ($method->isPrivate()) {
  582.                     unset(self::$returnTypes[$class][$method->name]);
  583.                 }
  584.             }
  586.             $this->patchTypes['force'] = $forcePatchTypes;
  588.             if ($method->isPrivate()) {
  589.                 continue;
  590.             }
  592.             $finalOrInternal = false;
  594.             foreach (['final', 'internal'] as $annotation) {
  595.                 if (null !== $description = $doc[$annotation][0] ?? null) {
  596.                     self::${$annotation.'Methods'}[$class][$method->name] = [$class, '' !== $description ? ' '.$description.(preg_match('/[[:punct:]]$/', $description) ? '' : '.') : '.'];
  597.                     $finalOrInternal = true;
  598.                 }
  599.             }
  601.             if ($finalOrInternal || $method->isConstructor() || !isset($doc['param']) || StatelessInvocation::class === $class) {
  602.                 continue;
  603.             }
  604.             if (!isset(self::$annotatedParameters[$class][$method->name])) {
  605.                 $definedParameters = [];
  606.                 foreach ($method->getParameters() as $parameter) {
  607.                     $definedParameters[$parameter->name] = true;
  608.                 }
  609.             }
  610.             foreach ($doc['param'] as $parameterName => $parameterType) {
  611.                 if (!isset($definedParameters[$parameterName])) {
  612.                     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);
  613.                 }
  614.             }
  615.         }
  617.         return $deprecations;
  618.     }
  620.     public function checkCase(\ReflectionClass $refl, string $file, string $class): ?array
  621.     {
  622.         $real = explode('\\', $class.strrchr($file, '.'));
  623.         $tail = explode(\DIRECTORY_SEPARATOR, str_replace('/', \DIRECTORY_SEPARATOR, $file));
  625.         $i = \count($tail) - 1;
  626.         $j = \count($real) - 1;
  628.         while (isset($tail[$i], $real[$j]) && $tail[$i] === $real[$j]) {
  629.             --$i;
  630.             --$j;
  631.         }
  633.         array_splice($tail, 0, $i + 1);
  635.         if (!$tail) {
  636.             return null;
  637.         }
  639.         $tail = \DIRECTORY_SEPARATOR.implode(\DIRECTORY_SEPARATOR, $tail);
  640.         $tailLen = \strlen($tail);
  641.         $real = $refl->getFileName();
  643.         if (2 === self::$caseCheck) {
  644.             $real = $this->darwinRealpath($real);
  645.         }
  647.         if (0 === substr_compare($real, $tail, -$tailLen, $tailLen, true)
  648.             && 0 !== substr_compare($real, $tail, -$tailLen, $tailLen, false)
  649.         ) {
  650.             return [substr($tail, -$tailLen + 1), substr($real, -$tailLen + 1), substr($real, 0, -$tailLen + 1)];
  651.         }
  653.         return null;
  654.     }
  656.     /**
  657.      * `realpath` on MacOSX doesn't normalize the case of characters.
  658.      */
  659.     private function darwinRealpath(string $real): string
  660.     {
  661.         $i = 1 + strrpos($real, '/');
  662.         $file = substr($real, $i);
  663.         $real = substr($real, 0, $i);
  665.         if (isset(self::$darwinCache[$real])) {
  666.             $kDir = $real;
  667.         } else {
  668.             $kDir = strtolower($real);
  670.             if (isset(self::$darwinCache[$kDir])) {
  671.                 $real = self::$darwinCache[$kDir][0];
  672.             } else {
  673.                 $dir = getcwd();
  675.                 if (!@chdir($real)) {
  676.                     return $real.$file;
  677.                 }
  679.                 $real = getcwd().'/';
  680.                 chdir($dir);
  682.                 $dir = $real;
  683.                 $k = $kDir;
  684.                 $i = \strlen($dir) - 1;
  685.                 while (!isset(self::$darwinCache[$k])) {
  686.                     self::$darwinCache[$k] = [$dir, []];
  687.                     self::$darwinCache[$dir] = &self::$darwinCache[$k];
  689.                     while ('/' !== $dir[--$i]) {
  690.                     }
  691.                     $k = substr($k, 0, ++$i);
  692.                     $dir = substr($dir, 0, $i--);
  693.                 }
  694.             }
  695.         }
  697.         $dirFiles = self::$darwinCache[$kDir][1];
  699.         if (!isset($dirFiles[$file]) && ') : eval()\'d code' === substr($file, -17)) {
  700.             // Get the file name from "file_name.php(123) : eval()'d code"
  701.             $file = substr($file, 0, strrpos($file, '(', -17));
  702.         }
  704.         if (isset($dirFiles[$file])) {
  705.             return $real.$dirFiles[$file];
  706.         }
  708.         $kFile = strtolower($file);
  710.         if (!isset($dirFiles[$kFile])) {
  711.             foreach (scandir($real, 2) as $f) {
  712.                 if ('.' !== $f[0]) {
  713.                     $dirFiles[$f] = $f;
  714.                     if ($f === $file) {
  715.                         $kFile = $k = $file;
  716.                     } elseif ($f !== $k = strtolower($f)) {
  717.                         $dirFiles[$k] = $f;
  718.                     }
  719.                 }
  720.             }
  721.             self::$darwinCache[$kDir][1] = $dirFiles;
  722.         }
  724.         return $real.$dirFiles[$kFile];
  725.     }
  727.     /**
  728.      * `class_implements` includes interfaces from the parents so we have to manually exclude them.
  729.      *
  730.      * @return string[]
  731.      */
  732.     private function getOwnInterfaces(string $class, ?string $parent): array
  733.     {
  734.         $ownInterfaces = class_implements($class, false);
  736.         if ($parent) {
  737.             foreach (class_implements($parent, false) as $interface) {
  738.                 unset($ownInterfaces[$interface]);
  739.             }
  740.         }
  742.         foreach ($ownInterfaces as $interface) {
  743.             foreach (class_implements($interface) as $interface) {
  744.                 unset($ownInterfaces[$interface]);
  745.             }
  746.         }
  748.         return $ownInterfaces;
  749.     }
  751.     private function setReturnType(string $types, string $class, string $method, string $filename, ?string $parent, \ReflectionType $returnType = null): void
  752.     {
  753.         if ('__construct' === $method) {
  754.             return;
  755.         }
  757.         if ($nullable = 0 === strpos($types, 'null|')) {
  758.             $types = substr($types, 5);
  759.         } elseif ($nullable = '|null' === substr($types, -5)) {
  760.             $types = substr($types, 0, -5);
  761.         }
  762.         $arrayType = ['array' => 'array'];
  763.         $typesMap = [];
  764.         $glue = false !== strpos($types, '&') ? '&' : '|';
  765.         foreach (explode($glue, $types) as $t) {
  766.             $t = self::SPECIAL_RETURN_TYPES[strtolower($t)] ?? $t;
  767.             $typesMap[$this->normalizeType($t, $class, $parent, $returnType)][$t] = $t;
  768.         }
  770.         if (isset($typesMap['array'])) {
  771.             if (isset($typesMap['Traversable']) || isset($typesMap['\Traversable'])) {
  772.                 $typesMap['iterable'] = $arrayType !== $typesMap['array'] ? $typesMap['array'] : ['iterable'];
  773.                 unset($typesMap['array'], $typesMap['Traversable'], $typesMap['\Traversable']);
  774.             } elseif ($arrayType !== $typesMap['array'] && isset(self::$returnTypes[$class][$method]) && !$returnType) {
  775.                 return;
  776.             }
  777.         }
  779.         if (isset($typesMap['array']) && isset($typesMap['iterable'])) {
  780.             if ($arrayType !== $typesMap['array']) {
  781.                 $typesMap['iterable'] = $typesMap['array'];
  782.             }
  783.             unset($typesMap['array']);
  784.         }
  786.         $iterable = $object = true;
  787.         foreach ($typesMap as $n => $t) {
  788.             if ('null' !== $n) {
  789.                 $iterable = $iterable && (\in_array($n, ['array', 'iterable']) || false !== strpos($n, 'Iterator'));
  790.                 $object = $object && (\in_array($n, ['callable', 'object', '$this', 'static']) || !isset(self::SPECIAL_RETURN_TYPES[$n]));
  791.             }
  792.         }
  794.         $phpTypes = [];
  795.         $docTypes = [];
  797.         foreach ($typesMap as $n => $t) {
  798.             if ('null' === $n) {
  799.                 $nullable = true;
  800.                 continue;
  801.             }
  803.             $docTypes[] = $t;
  805.             if ('mixed' === $n || 'void' === $n) {
  806.                 $nullable = false;
  807.                 $phpTypes = ['' => $n];
  808.                 continue;
  809.             }
  811.             if ('resource' === $n) {
  812.                 // there is no native type for "resource"
  813.                 return;
  814.             }
  816.             if (!isset($phpTypes[''])) {
  817.                 $phpTypes[] = $n;
  818.             }
  819.         }
  820.         $docTypes = array_merge([], ...$docTypes);
  822.         if (!$phpTypes) {
  823.             return;
  824.         }
  826.         if (1 < \count($phpTypes)) {
  827.             if ($iterable && '8.0' > $this->patchTypes['php']) {
  828.                 $phpTypes = $docTypes = ['iterable'];
  829.             } elseif ($object && 'object' === $this->patchTypes['force']) {
  830.                 $phpTypes = $docTypes = ['object'];
  831.             } elseif ('8.0' > $this->patchTypes['php']) {
  832.                 // ignore multi-types return declarations
  833.                 return;
  834.             }
  835.         }
  837.         $phpType = sprintf($nullable ? (1 < \count($phpTypes) ? '%s|null' : '?%s') : '%s', implode($glue, $phpTypes));
  838.         $docType = sprintf($nullable ? '%s|null' : '%s', implode($glue, $docTypes));
  840.         self::$returnTypes[$class][$method] = [$phpType, $docType, $class, $filename];
  841.     }
  843.     private function normalizeType(string $type, string $class, ?string $parent, ?\ReflectionType $returnType): string
  844.     {
  845.         if (isset(self::SPECIAL_RETURN_TYPES[$lcType = strtolower($type)])) {
  846.             if ('parent' === $lcType = self::SPECIAL_RETURN_TYPES[$lcType]) {
  847.                 $lcType = null !== $parent ? '\\'.$parent : 'parent';
  848.             } elseif ('self' === $lcType) {
  849.                 $lcType = '\\'.$class;
  850.             }
  852.             return $lcType;
  853.         }
  855.         // We could resolve "use" statements to return the FQDN
  856.         // but this would be too expensive for a runtime checker
  858.         if ('[]' !== substr($type, -2)) {
  859.             return $type;
  860.         }
  862.         if ($returnType instanceof \ReflectionNamedType) {
  863.             $type = $returnType->getName();
  865.             if ('mixed' !== $type) {
  866.                 return isset(self::SPECIAL_RETURN_TYPES[$type]) ? $type : '\\'.$type;
  867.             }
  868.         }
  870.         return 'array';
  871.     }
  873.     /**
  874.      * Utility method to add #[ReturnTypeWillChange] where php triggers deprecations.
  875.      */
  876.     private function patchReturnTypeWillChange(\ReflectionMethod $method)
  877.     {
  878.         if (\PHP_VERSION_ID >= 80000 && \count($method->getAttributes(\ReturnTypeWillChange::class))) {
  879.             return;
  880.         }
  882.         if (!is_file($file = $method->getFileName())) {
  883.             return;
  884.         }
  886.         $fileOffset = self::$fileOffsets[$file] ?? 0;
  888.         $code = file($file);
  890.         $startLine = $method->getStartLine() + $fileOffset - 2;
  892.         if (false !== stripos($code[$startLine], 'ReturnTypeWillChange')) {
  893.             return;
  894.         }
  896.         $code[$startLine] .= "    #[\\ReturnTypeWillChange]\n";
  897.         self::$fileOffsets[$file] = 1 + $fileOffset;
  898.         file_put_contents($file, $code);
  899.     }
  901.     /**
  902.      * Utility method to add @return annotations to the Symfony code-base where it triggers self-deprecations.
  903.      */
  904.     private function patchMethod(\ReflectionMethod $method, string $returnType, string $declaringFile, string $normalizedType)
  905.     {
  906.         static $patchedMethods = [];
  907.         static $useStatements = [];
  909.         if (!is_file($file = $method->getFileName()) || isset($patchedMethods[$file][$startLine = $method->getStartLine()])) {
  910.             return;
  911.         }
  913.         $patchedMethods[$file][$startLine] = true;
  914.         $fileOffset = self::$fileOffsets[$file] ?? 0;
  915.         $startLine += $fileOffset - 2;
  916.         if ($nullable = '|null' === substr($returnType, -5)) {
  917.             $returnType = substr($returnType, 0, -5);
  918.         }
  919.         $glue = false !== strpos($returnType, '&') ? '&' : '|';
  920.         $returnType = explode($glue, $returnType);
  921.         $code = file($file);
  923.         foreach ($returnType as $i => $type) {
  924.             if (preg_match('/((?:\[\])+)$/', $type, $m)) {
  925.                 $type = substr($type, 0, -\strlen($m[1]));
  926.                 $format = '%s'.$m[1];
  927.             } else {
  928.                 $format = null;
  929.             }
  931.             if (isset(self::SPECIAL_RETURN_TYPES[$type]) || ('\\' === $type[0] && !$p = strrpos($type, '\\', 1))) {
  932.                 continue;
  933.             }
  935.             [$namespace, $useOffset, $useMap] = $useStatements[$file] ?? $useStatements[$file] = self::getUseStatements($file);
  937.             if ('\\' !== $type[0]) {
  938.                 [$declaringNamespace, , $declaringUseMap] = $useStatements[$declaringFile] ?? $useStatements[$declaringFile] = self::getUseStatements($declaringFile);
  940.                 $p = strpos($type, '\\', 1);
  941.                 $alias = $p ? substr($type, 0, $p) : $type;
  943.                 if (isset($declaringUseMap[$alias])) {
  944.                     $type = '\\'.$declaringUseMap[$alias].($p ? substr($type, $p) : '');
  945.                 } else {
  946.                     $type = '\\'.$declaringNamespace.$type;
  947.                 }
  949.                 $p = strrpos($type, '\\', 1);
  950.             }
  952.             $alias = substr($type, 1 + $p);
  953.             $type = substr($type, 1);
  955.             if (!isset($useMap[$alias]) && (class_exists($c = $namespace.$alias) || interface_exists($c) || trait_exists($c))) {
  956.                 $useMap[$alias] = $c;
  957.             }
  959.             if (!isset($useMap[$alias])) {
  960.                 $useStatements[$file][2][$alias] = $type;
  961.                 $code[$useOffset] = "use $type;\n".$code[$useOffset];
  962.                 ++$fileOffset;
  963.             } elseif ($useMap[$alias] !== $type) {
  964.                 $alias .= 'FIXME';
  965.                 $useStatements[$file][2][$alias] = $type;
  966.                 $code[$useOffset] = "use $type as $alias;\n".$code[$useOffset];
  967.                 ++$fileOffset;
  968.             }
  970.             $returnType[$i] = null !== $format ? sprintf($format, $alias) : $alias;
  971.         }
  973.         if ('docblock' === $this->patchTypes['force'] || ('object' === $normalizedType && '7.1' === $this->patchTypes['php'])) {
  974.             $returnType = implode($glue, $returnType).($nullable ? '|null' : '');
  976.             if (false !== strpos($code[$startLine], '#[')) {
  977.                 --$startLine;
  978.             }
  980.             if ($method->getDocComment()) {
  981.                 $code[$startLine] = "     * @return $returnType\n".$code[$startLine];
  982.             } else {
  983.                 $code[$startLine] .= <<<EOTXT
  984.     /**
  985.      * @return $returnType
  986.      */
  988. EOTXT;
  989.             }
  991.             $fileOffset += substr_count($code[$startLine], "\n") - 1;
  992.         }
  994.         self::$fileOffsets[$file] = $fileOffset;
  995.         file_put_contents($file, $code);
  997.         $this->fixReturnStatements($method, $normalizedType);
  998.     }
  1000.     private static function getUseStatements(string $file): array
  1001.     {
  1002.         $namespace = '';
  1003.         $useMap = [];
  1004.         $useOffset = 0;
  1006.         if (!is_file($file)) {
  1007.             return [$namespace, $useOffset, $useMap];
  1008.         }
  1010.         $file = file($file);
  1012.         for ($i = 0; $i < \count($file); ++$i) {
  1013.             if (preg_match('/^(class|interface|trait|abstract) /', $file[$i])) {
  1014.                 break;
  1015.             }
  1017.             if (0 === strpos($file[$i], 'namespace ')) {
  1018.                 $namespace = substr($file[$i], \strlen('namespace '), -2).'\\';
  1019.                 $useOffset = $i + 2;
  1020.             }
  1022.             if (0 === strpos($file[$i], 'use ')) {
  1023.                 $useOffset = $i;
  1025.                 for (; 0 === strpos($file[$i], 'use '); ++$i) {
  1026.                     $u = explode(' as ', substr($file[$i], 4, -2), 2);
  1028.                     if (1 === \count($u)) {
  1029.                         $p = strrpos($u[0], '\\');
  1030.                         $useMap[substr($u[0], false !== $p ? 1 + $p : 0)] = $u[0];
  1031.                     } else {
  1032.                         $useMap[$u[1]] = $u[0];
  1033.                     }
  1034.                 }
  1036.                 break;
  1037.             }
  1038.         }
  1040.         return [$namespace, $useOffset, $useMap];
  1041.     }
  1043.     private function fixReturnStatements(\ReflectionMethod $method, string $returnType)
  1044.     {
  1045.         if ('docblock' !== $this->patchTypes['force']) {
  1046.             if ('7.1' === $this->patchTypes['php'] && 'object' === ltrim($returnType, '?')) {
  1047.                 return;
  1048.             }
  1050.             if ('7.4' > $this->patchTypes['php'] && $method->hasReturnType()) {
  1051.                 return;
  1052.             }
  1054.             if ('8.0' > $this->patchTypes['php'] && (false !== strpos($returnType, '|') || \in_array($returnType, ['mixed', 'static'], true))) {
  1055.                 return;
  1056.             }
  1058.             if ('8.1' > $this->patchTypes['php'] && false !== strpos($returnType, '&')) {
  1059.                 return;
  1060.             }
  1061.         }
  1063.         if (!is_file($file = $method->getFileName())) {
  1064.             return;
  1065.         }
  1067.         $fixedCode = $code = file($file);
  1068.         $i = (self::$fileOffsets[$file] ?? 0) + $method->getStartLine();
  1070.         if ('?' !== $returnType && 'docblock' !== $this->patchTypes['force']) {
  1071.             $fixedCode[$i - 1] = preg_replace('/\)(?::[^;\n]++)?(;?\n)/', "): $returnType\\1", $code[$i - 1]);
  1072.         }
  1074.         $end = $method->isGenerator() ? $i : $method->getEndLine();
  1075.         for (; $i < $end; ++$i) {
  1076.             if ('void' === $returnType) {
  1077.                 $fixedCode[$i] = str_replace('    return null;', '    return;', $code[$i]);
  1078.             } elseif ('mixed' === $returnType || '?' === $returnType[0]) {
  1079.                 $fixedCode[$i] = str_replace('    return;', '    return null;', $code[$i]);
  1080.             } else {
  1081.                 $fixedCode[$i] = str_replace('    return;', "    return $returnType!?;", $code[$i]);
  1082.             }
  1083.         }
  1085.         if ($fixedCode !== $code) {
  1086.             file_put_contents($file, $fixedCode);
  1087.         }
  1088.     }
  1090.     /**
  1091.      * @param \ReflectionClass|\ReflectionMethod|\ReflectionProperty $reflector
  1092.      */
  1093.     private function parsePhpDoc(\Reflector $reflector): array
  1094.     {
  1095.         if (!$doc = $reflector->getDocComment()) {
  1096.             return [];
  1097.         }
  1099.         $tagName = '';
  1100.         $tagContent = '';
  1102.         $tags = [];
  1104.         foreach (explode("\n", substr($doc, 3, -2)) as $line) {
  1105.             $line = ltrim($line);
  1106.             $line = ltrim($line, '*');
  1108.             if ('' === $line = trim($line)) {
  1109.                 if ('' !== $tagName) {
  1110.                     $tags[$tagName][] = $tagContent;
  1111.                 }
  1112.                 $tagName = $tagContent = '';
  1113.                 continue;
  1114.             }
  1116.             if ('@' === $line[0]) {
  1117.                 if ('' !== $tagName) {
  1118.                     $tags[$tagName][] = $tagContent;
  1119.                     $tagContent = '';
  1120.                 }
  1122.                 if (preg_match('{^@([-a-zA-Z0-9_:]++)(\s|$)}', $line, $m)) {
  1123.                     $tagName = $m[1];
  1124.                     $tagContent = str_replace("\t", ' ', ltrim(substr($line, 2 + \strlen($tagName))));
  1125.                 } else {
  1126.                     $tagName = '';
  1127.                 }
  1128.             } elseif ('' !== $tagName) {
  1129.                 $tagContent .= ' '.str_replace("\t", ' ', $line);
  1130.             }
  1131.         }
  1133.         if ('' !== $tagName) {
  1134.             $tags[$tagName][] = $tagContent;
  1135.         }
  1137.         foreach ($tags['method'] ?? [] as $i => $method) {
  1138.             unset($tags['method'][$i]);
  1140.             $parts = preg_split('{(\s++|\((?:[^()]*+|(?R))*\)(?: *: *[^ ]++)?|<(?:[^<>]*+|(?R))*>|\{(?:[^{}]*+|(?R))*\})}', $method, -1, \PREG_SPLIT_DELIM_CAPTURE);
  1141.             $returnType = '';
  1142.             $static = 'static' === $parts[0];
  1144.             for ($i = $static ? 2 : 0; null !== $p = $parts[$i] ?? null; $i += 2) {
  1145.                 if (\in_array($p, ['', '|', '&', 'callable'], true) || \in_array(substr($returnType, -1), ['|', '&'], true)) {
  1146.                     $returnType .= trim($parts[$i - 1] ?? '').$p;
  1147.                     continue;
  1148.                 }
  1150.                 $signature = '(' === ($parts[$i + 1][0] ?? '(') ? $parts[$i + 1] ?? '()' : null;
  1152.                 if (null === $signature && '' === $returnType) {
  1153.                     $returnType = $p;
  1154.                     continue;
  1155.                 }
  1157.                 if ($static && 2 === $i) {
  1158.                     $static = false;
  1159.                     $returnType = 'static';
  1160.                 }
  1162.                 if (\in_array($description = trim(implode('', \array_slice($parts, 2 + $i))), ['', '.'], true)) {
  1163.                     $description = null;
  1164.                 } elseif (!preg_match('/[.!]$/', $description)) {
  1165.                     $description .= '.';
  1166.                 }
  1168.                 $tags['method'][$p] = [$static, $returnType, $signature ?? '()', $description];
  1169.                 break;
  1170.             }
  1171.         }
  1173.         foreach ($tags['param'] ?? [] as $i => $param) {
  1174.             unset($tags['param'][$i]);
  1176.             if (\strlen($param) !== strcspn($param, '<{(')) {
  1177.                 $param = preg_replace('{\(([^()]*+|(?R))*\)(?: *: *[^ ]++)?|<([^<>]*+|(?R))*>|\{([^{}]*+|(?R))*\}}', '', $param);
  1178.             }
  1180.             if (false === $i = strpos($param, '$')) {
  1181.                 continue;
  1182.             }
  1184.             $type = 0 === $i ? '' : rtrim(substr($param, 0, $i), ' &');
  1185.             $param = substr($param, 1 + $i, (strpos($param, ' ', $i) ?: (1 + $i + \strlen($param))) - $i - 1);
  1187.             $tags['param'][$param] = $type;
  1188.         }
  1190.         foreach (['var', 'return'] as $k) {
  1191.             if (null === $v = $tags[$k][0] ?? null) {
  1192.                 continue;
  1193.             }
  1194.             if (\strlen($v) !== strcspn($v, '<{(')) {
  1195.                 $v = preg_replace('{\(([^()]*+|(?R))*\)(?: *: *[^ ]++)?|<([^<>]*+|(?R))*>|\{([^{}]*+|(?R))*\}}', '', $v);
  1196.             }
  1198.             $tags[$k] = substr($v, 0, strpos($v, ' ') ?: \strlen($v)) ?: null;
  1199.         }
  1201.         return $tags;
  1202.     }
  1203. }