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

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <[email protected]>
  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 <[email protected]>
  48.  * @author Christophe Coevoet <[email protected]>
  49.  * @author Nicolas Grekas <[email protected]>
  50.  * @author Guilhem Niot <[email protected]>
  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' => 'true',
  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.         'class-string' => 'string',
  77.         'never' => 'never',
  78.     ];
  80.     private const BUILTIN_RETURN_TYPES = [
  81.         'void' => true,
  82.         'array' => true,
  83.         'false' => true,
  84.         'bool' => true,
  85.         'callable' => true,
  86.         'float' => true,
  87.         'int' => true,
  88.         'iterable' => true,
  89.         'object' => true,
  90.         'string' => true,
  91.         'self' => true,
  92.         'parent' => true,
  93.         'mixed' => true,
  94.         'static' => true,
  95.         'null' => true,
  96.         'true' => true,
  97.         'never' => true,
  98.     ];
  100.     private const MAGIC_METHODS = [
  101.         '__isset' => 'bool',
  102.         '__sleep' => 'array',
  103.         '__toString' => 'string',
  104.         '__debugInfo' => 'array',
  105.         '__serialize' => 'array',
  106.     ];
  108.     /**
  109.      * @var callable
  110.      */
  111.     private $classLoader;
  112.     private bool $isFinder;
  113.     private array $loaded = [];
  114.     private array $patchTypes = [];
  116.     private static int $caseCheck;
  117.     private static array $checkedClasses = [];
  118.     private static array $final = [];
  119.     private static array $finalMethods = [];
  120.     private static array $finalProperties = [];
  121.     private static array $finalConstants = [];
  122.     private static array $deprecated = [];
  123.     private static array $internal = [];
  124.     private static array $internalMethods = [];
  125.     private static array $annotatedParameters = [];
  126.     private static array $darwinCache = ['/' => ['/', []]];
  127.     private static array $method = [];
  128.     private static array $returnTypes = [];
  129.     private static array $methodTraits = [];
  130.     private static array $fileOffsets = [];
  132.     public function __construct(callable $classLoader)
  133.     {
  134.         $this->classLoader = $classLoader;
  135.         $this->isFinder = \is_array($classLoader) && method_exists($classLoader[0], 'findFile');
  136.         parse_str(getenv('SYMFONY_PATCH_TYPE_DECLARATIONS') ?: '', $this->patchTypes);
  137.         $this->patchTypes += [
  138.             'force' => null,
  139.             'php' => \PHP_MAJOR_VERSION.'.'.\PHP_MINOR_VERSION,
  140.             'deprecations' => true,
  141.         ];
  143.         if ('phpdoc' === $this->patchTypes['force']) {
  144.             $this->patchTypes['force'] = 'docblock';
  145.         }
  147.         if (!isset(self::$caseCheck)) {
  148.             $file = is_file(__FILE__) ? __FILE__ : rtrim(realpath('.'), \DIRECTORY_SEPARATOR);
  149.             $i = strrpos($file, \DIRECTORY_SEPARATOR);
  150.             $dir = substr($file, 0, 1 + $i);
  151.             $file = substr($file, 1 + $i);
  152.             $test = strtoupper($file) === $file ? strtolower($file) : strtoupper($file);
  153.             $test = realpath($dir.$test);
  155.             if (false === $test || false === $i) {
  156.                 // filesystem is case sensitive
  157.                 self::$caseCheck = 0;
  158.             } elseif (str_ends_with($test, $file)) {
  159.                 // filesystem is case insensitive and realpath() normalizes the case of characters
  160.                 self::$caseCheck = 1;
  161.             } elseif ('Darwin' === \PHP_OS_FAMILY) {
  162.                 // on MacOSX, HFS+ is case insensitive but realpath() doesn't normalize the case of characters
  163.                 self::$caseCheck = 2;
  164.             } else {
  165.                 // filesystem case checks failed, fallback to disabling them
  166.                 self::$caseCheck = 0;
  167.             }
  168.         }
  169.     }
  171.     public function getClassLoader(): callable
  172.     {
  173.         return $this->classLoader;
  174.     }
  176.     /**
  177.      * Wraps all autoloaders.
  178.      */
  179.     public static function enable(): void
  180.     {
  181.         // Ensures we don't hit https://bugs.php.net/42098
  182.         class_exists(\Symfony\Component\ErrorHandler\ErrorHandler::class);
  183.         class_exists(\Psr\Log\LogLevel::class);
  185.         if (!\is_array($functions = spl_autoload_functions())) {
  186.             return;
  187.         }
  189.         foreach ($functions as $function) {
  190.             spl_autoload_unregister($function);
  191.         }
  193.         foreach ($functions as $function) {
  194.             if (!\is_array($function) || !$function[0] instanceof self) {
  195.                 $function = [new static($function), 'loadClass'];
  196.             }
  198.             spl_autoload_register($function);
  199.         }
  200.     }
  202.     /**
  203.      * Disables the wrapping.
  204.      */
  205.     public static function disable(): void
  206.     {
  207.         if (!\is_array($functions = spl_autoload_functions())) {
  208.             return;
  209.         }
  211.         foreach ($functions as $function) {
  212.             spl_autoload_unregister($function);
  213.         }
  215.         foreach ($functions as $function) {
  216.             if (\is_array($function) && $function[0] instanceof self) {
  217.                 $function = $function[0]->getClassLoader();
  218.             }
  220.             spl_autoload_register($function);
  221.         }
  222.     }
  224.     public static function checkClasses(): bool
  225.     {
  226.         if (!\is_array($functions = spl_autoload_functions())) {
  227.             return false;
  228.         }
  230.         $loader = null;
  232.         foreach ($functions as $function) {
  233.             if (\is_array($function) && $function[0] instanceof self) {
  234.                 $loader = $function[0];
  235.                 break;
  236.             }
  237.         }
  239.         if (null === $loader) {
  240.             return false;
  241.         }
  243.         static $offsets = [
  244.             'get_declared_interfaces' => 0,
  245.             'get_declared_traits' => 0,
  246.             'get_declared_classes' => 0,
  247.         ];
  249.         foreach ($offsets as $getSymbols => $i) {
  250.             $symbols = $getSymbols();
  252.             for (; $i < \count($symbols); ++$i) {
  253.                 if (!is_subclass_of($symbols[$i], MockObject::class)
  254.                     && !is_subclass_of($symbols[$i], ProphecySubjectInterface::class)
  255.                     && !is_subclass_of($symbols[$i], Proxy::class)
  256.                     && !is_subclass_of($symbols[$i], ProxyInterface::class)
  257.                     && !is_subclass_of($symbols[$i], LegacyProxy::class)
  258.                     && !is_subclass_of($symbols[$i], MockInterface::class)
  259.                     && !is_subclass_of($symbols[$i], IMock::class)
  260.                 ) {
  261.                     $loader->checkClass($symbols[$i]);
  262.                 }
  263.             }
  265.             $offsets[$getSymbols] = $i;
  266.         }
  268.         return true;
  269.     }
  271.     public function findFile(string $class): ?string
  272.     {
  273.         return $this->isFinder ? ($this->classLoader[0]->findFile($class) ?: null) : null;
  274.     }
  276.     /**
  277.      * Loads the given class or interface.
  278.      *
  279.      * @throws \RuntimeException
  280.      */
  281.     public function loadClass(string $class): void
  282.     {
  283.         $e = error_reporting(error_reporting() | \E_PARSE | \E_ERROR | \E_CORE_ERROR | \E_COMPILE_ERROR);
  285.         try {
  286.             if ($this->isFinder && !isset($this->loaded[$class])) {
  287.                 $this->loaded[$class] = true;
  288.                 if (!$file = $this->classLoader[0]->findFile($class) ?: '') {
  289.                     // no-op
  290.                 } elseif (\function_exists('opcache_is_script_cached') && @opcache_is_script_cached($file)) {
  291.                     include $file;
  293.                     return;
  294.                 } elseif (false === include $file) {
  295.                     return;
  296.                 }
  297.             } else {
  298.                 ($this->classLoader)($class);
  299.                 $file = '';
  300.             }
  301.         } finally {
  302.             error_reporting($e);
  303.         }
  305.         $this->checkClass($class, $file);
  306.     }
  308.     private function checkClass(string $class, string $file = null): void
  309.     {
  310.         $exists = null === $file || class_exists($class, false) || interface_exists($class, false) || trait_exists($class, false);
  312.         if (null !== $file && $class && '\\' === $class[0]) {
  313.             $class = substr($class, 1);
  314.         }
  316.         if ($exists) {
  317.             if (isset(self::$checkedClasses[$class])) {
  318.                 return;
  319.             }
  320.             self::$checkedClasses[$class] = true;
  322.             $refl = new \ReflectionClass($class);
  323.             if (null === $file && $refl->isInternal()) {
  324.                 return;
  325.             }
  326.             $name = $refl->getName();
  328.             if ($name !== $class && 0 === strcasecmp($name, $class)) {
  329.                 throw new \RuntimeException(sprintf('Case mismatch between loaded and declared class names: "%s" vs "%s".', $class, $name));
  330.             }
  332.             $deprecations = $this->checkAnnotations($refl, $name);
  334.             foreach ($deprecations as $message) {
  335.                 @trigger_error($message, \E_USER_DEPRECATED);
  336.             }
  337.         }
  339.         if (!$file) {
  340.             return;
  341.         }
  343.         if (!$exists) {
  344.             if (str_contains($class, '/')) {
  345.                 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));
  346.             }
  348.             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));
  349.         }
  351.         if (self::$caseCheck && $message = $this->checkCase($refl, $file, $class)) {
  352.             throw new \RuntimeException(sprintf('Case mismatch between class and real file names: "%s" vs "%s" in "%s".', $message[0], $message[1], $message[2]));
  353.         }
  354.     }
  356.     public function checkAnnotations(\ReflectionClass $refl, string $class): array
  357.     {
  358.         if (
  359.             'Symfony\Bridge\PhpUnit\Legacy\SymfonyTestsListenerForV7' === $class
  360.             || 'Symfony\Bridge\PhpUnit\Legacy\SymfonyTestsListenerForV6' === $class
  361.         ) {
  362.             return [];
  363.         }
  364.         $deprecations = [];
  366.         $className = str_contains($class, "@anonymous\0") ? (get_parent_class($class) ?: key(class_implements($class)) ?: 'class').'@anonymous' : $class;
  368.         // Don't trigger deprecations for classes in the same vendor
  369.         if ($class !== $className) {
  370.             $vendor = preg_match('/^namespace ([^;\\\\\s]++)[;\\\\]/m', @file_get_contents($refl->getFileName()), $vendor) ? $vendor[1].'\\' : '';
  371.             $vendorLen = \strlen($vendor);
  372.         } elseif (2 > $vendorLen = 1 + (strpos($class, '\\') ?: strpos($class, '_'))) {
  373.             $vendorLen = 0;
  374.             $vendor = '';
  375.         } else {
  376.             $vendor = str_replace('_', '\\', substr($class, 0, $vendorLen));
  377.         }
  379.         $parent = get_parent_class($class) ?: null;
  380.         self::$returnTypes[$class] = [];
  381.         $classIsTemplate = false;
  383.         // Detect annotations on the class
  384.         if ($doc = $this->parsePhpDoc($refl)) {
  385.             $classIsTemplate = isset($doc['template']);
  387.             foreach (['final', 'deprecated', 'internal'] as $annotation) {
  388.                 if (null !== $description = $doc[$annotation][0] ?? null) {
  389.                     self::${$annotation}[$class] = '' !== $description ? ' '.$description.(preg_match('/[.!]$/', $description) ? '' : '.') : '.';
  390.                 }
  391.             }
  393.             if ($refl->isInterface() && isset($doc['method'])) {
  394.                 foreach ($doc['method'] as $name => [$static, $returnType, $signature, $description]) {
  395.                     self::$method[$class][] = [$class, $static, $returnType, $name.$signature, $description];
  397.                     if ('' !== $returnType) {
  398.                         $this->setReturnType($returnType, $refl->name, $name, $refl->getFileName(), $parent);
  399.                     }
  400.                 }
  401.             }
  402.         }
  404.         $parentAndOwnInterfaces = $this->getOwnInterfaces($class, $parent);
  405.         if ($parent) {
  406.             $parentAndOwnInterfaces[$parent] = $parent;
  408.             if (!isset(self::$checkedClasses[$parent])) {
  409.                 $this->checkClass($parent);
  410.             }
  412.             if (isset(self::$final[$parent])) {
  413.                 $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);
  414.             }
  415.         }
  417.         // Detect if the parent is annotated
  418.         foreach ($parentAndOwnInterfaces + class_uses($class, false) as $use) {
  419.             if (!isset(self::$checkedClasses[$use])) {
  420.                 $this->checkClass($use);
  421.             }
  422.             if (isset(self::$deprecated[$use]) && strncmp($vendor, str_replace('_', '\\', $use), $vendorLen) && !isset(self::$deprecated[$class])) {
  423.                 $type = class_exists($class, false) ? 'class' : (interface_exists($class, false) ? 'interface' : 'trait');
  424.                 $verb = class_exists($use, false) || interface_exists($class, false) ? 'extends' : (interface_exists($use, false) ? 'implements' : 'uses');
  426.                 $deprecations[] = sprintf('The "%s" %s %s "%s" that is deprecated%s', $className, $type, $verb, $use, self::$deprecated[$use]);
  427.             }
  428.             if (isset(self::$internal[$use]) && strncmp($vendor, str_replace('_', '\\', $use), $vendorLen)) {
  429.                 $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);
  430.             }
  431.             if (isset(self::$method[$use])) {
  432.                 if ($refl->isAbstract()) {
  433.                     if (isset(self::$method[$class])) {
  434.                         self::$method[$class] = array_merge(self::$method[$class], self::$method[$use]);
  435.                     } else {
  436.                         self::$method[$class] = self::$method[$use];
  437.                     }
  438.                 } elseif (!$refl->isInterface()) {
  439.                     if (!strncmp($vendor, str_replace('_', '\\', $use), $vendorLen)
  440.                         && str_starts_with($className, 'Symfony\\')
  441.                         && (!class_exists(InstalledVersions::class)
  442.                             || 'symfony/symfony' !== InstalledVersions::getRootPackage()['name'])
  443.                     ) {
  444.                         // skip "same vendor" @method deprecations for Symfony\* classes unless symfony/symfony is being tested
  445.                         continue;
  446.                     }
  447.                     $hasCall = $refl->hasMethod('__call');
  448.                     $hasStaticCall = $refl->hasMethod('__callStatic');
  449.                     foreach (self::$method[$use] as [$interface, $static, $returnType, $name, $description]) {
  450.                         if ($static ? $hasStaticCall : $hasCall) {
  451.                             continue;
  452.                         }
  453.                         $realName = substr($name, 0, strpos($name, '('));
  454.                         if (!$refl->hasMethod($realName) || !($methodRefl = $refl->getMethod($realName))->isPublic() || ($static && !$methodRefl->isStatic()) || (!$static && $methodRefl->isStatic())) {
  455.                             $deprecations[] = sprintf('Class "%s" should implement method "%s::%s%s"%s', $className, ($static ? 'static ' : '').$interface, $name, $returnType ? ': '.$returnType : '', null === $description ? '.' : ': '.$description);
  456.                         }
  457.                     }
  458.                 }
  459.             }
  460.         }
  462.         if (trait_exists($class)) {
  463.             $file = $refl->getFileName();
  465.             foreach ($refl->getMethods() as $method) {
  466.                 if ($method->getFileName() === $file) {
  467.                     self::$methodTraits[$file][$method->getStartLine()] = $class;
  468.                 }
  469.             }
  471.             return $deprecations;
  472.         }
  474.         // Inherit @final, @internal, @param and @return annotations for methods
  475.         self::$finalMethods[$class] = [];
  476.         self::$internalMethods[$class] = [];
  477.         self::$annotatedParameters[$class] = [];
  478.         self::$finalProperties[$class] = [];
  479.         self::$finalConstants[$class] = [];
  480.         foreach ($parentAndOwnInterfaces as $use) {
  481.             foreach (['finalMethods', 'internalMethods', 'annotatedParameters', 'returnTypes', 'finalProperties', 'finalConstants'] as $property) {
  482.                 if (isset(self::${$property}[$use])) {
  483.                     self::${$property}[$class] = self::${$property}[$class] ? self::${$property}[$use] + self::${$property}[$class] : self::${$property}[$use];
  484.                 }
  485.             }
  487.             if (null !== (TentativeTypes::RETURN_TYPES[$use] ?? null)) {
  488.                 foreach (TentativeTypes::RETURN_TYPES[$use] as $method => $returnType) {
  489.                     $returnType = explode('|', $returnType);
  490.                     foreach ($returnType as $i => $t) {
  491.                         if ('?' !== $t && !isset(self::BUILTIN_RETURN_TYPES[$t])) {
  492.                             $returnType[$i] = '\\'.$t;
  493.                         }
  494.                     }
  495.                     $returnType = implode('|', $returnType);
  497.                     self::$returnTypes[$class] += [$method => [$returnType, str_starts_with($returnType, '?') ? substr($returnType, 1).'|null' : $returnType, $use, '']];
  498.                 }
  499.             }
  500.         }
  502.         foreach ($refl->getMethods() as $method) {
  503.             if ($method->class !== $class) {
  504.                 continue;
  505.             }
  507.             if (null === $ns = self::$methodTraits[$method->getFileName()][$method->getStartLine()] ?? null) {
  508.                 $ns = $vendor;
  509.                 $len = $vendorLen;
  510.             } elseif (2 > $len = 1 + (strpos($ns, '\\') ?: strpos($ns, '_'))) {
  511.                 $len = 0;
  512.                 $ns = '';
  513.             } else {
  514.                 $ns = str_replace('_', '\\', substr($ns, 0, $len));
  515.             }
  517.             if ($parent && isset(self::$finalMethods[$parent][$method->name])) {
  518.                 [$declaringClass, $message] = self::$finalMethods[$parent][$method->name];
  519.                 $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);
  520.             }
  522.             if (isset(self::$internalMethods[$class][$method->name])) {
  523.                 [$declaringClass, $message] = self::$internalMethods[$class][$method->name];
  524.                 if (strncmp($ns, $declaringClass, $len)) {
  525.                     $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);
  526.                 }
  527.             }
  529.             // To read method annotations
  530.             $doc = $this->parsePhpDoc($method);
  532.             if (($classIsTemplate || isset($doc['template'])) && $method->hasReturnType()) {
  533.                 unset($doc['return']);
  534.             }
  536.             if (isset(self::$annotatedParameters[$class][$method->name])) {
  537.                 $definedParameters = [];
  538.                 foreach ($method->getParameters() as $parameter) {
  539.                     $definedParameters[$parameter->name] = true;
  540.                 }
  542.                 foreach (self::$annotatedParameters[$class][$method->name] as $parameterName => $deprecation) {
  543.                     if (!isset($definedParameters[$parameterName]) && !isset($doc['param'][$parameterName])) {
  544.                         $deprecations[] = sprintf($deprecation, $className);
  545.                     }
  546.                 }
  547.             }
  549.             $forcePatchTypes = $this->patchTypes['force'];
  551.             if ($canAddReturnType = null !== $forcePatchTypes && !str_contains($method->getFileName(), \DIRECTORY_SEPARATOR.'vendor'.\DIRECTORY_SEPARATOR)) {
  552.                 if ('void' !== (self::MAGIC_METHODS[$method->name] ?? 'void')) {
  553.                     $this->patchTypes['force'] = $forcePatchTypes ?: 'docblock';
  554.                 }
  556.                 $canAddReturnType = 2 === (int) $forcePatchTypes
  557.                     || false !== stripos($method->getFileName(), \DIRECTORY_SEPARATOR.'Tests'.\DIRECTORY_SEPARATOR)
  558.                     || $refl->isFinal()
  559.                     || $method->isFinal()
  560.                     || $method->isPrivate()
  561.                     || ('.' === (self::$internal[$class] ?? null) && !$refl->isAbstract())
  562.                     || '.' === (self::$final[$class] ?? null)
  563.                     || '' === ($doc['final'][0] ?? null)
  564.                     || '' === ($doc['internal'][0] ?? null)
  565.                 ;
  566.             }
  568.             if (null !== ($returnType = self::$returnTypes[$class][$method->name] ?? null) && 'docblock' === $this->patchTypes['force'] && !$method->hasReturnType() && isset(TentativeTypes::RETURN_TYPES[$returnType[2]][$method->name])) {
  569.                 $this->patchReturnTypeWillChange($method);
  570.             }
  572.             if (null !== ($returnType ??= self::MAGIC_METHODS[$method->name] ?? null) && !$method->hasReturnType() && !isset($doc['return'])) {
  573.                 [$normalizedType, $returnType, $declaringClass, $declaringFile] = \is_string($returnType) ? [$returnType, $returnType, '', ''] : $returnType;
  575.                 if ($canAddReturnType && 'docblock' !== $this->patchTypes['force']) {
  576.                     $this->patchMethod($method, $returnType, $declaringFile, $normalizedType);
  577.                 }
  578.                 if (!isset($doc['deprecated']) && strncmp($ns, $declaringClass, $len)) {
  579.                     if ('docblock' === $this->patchTypes['force']) {
  580.                         $this->patchMethod($method, $returnType, $declaringFile, $normalizedType);
  581.                     } elseif ('' !== $declaringClass && $this->patchTypes['deprecations']) {
  582.                         $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);
  583.                     }
  584.                 }
  585.             }
  587.             if (!$doc) {
  588.                 $this->patchTypes['force'] = $forcePatchTypes;
  590.                 continue;
  591.             }
  593.             if (isset($doc['return']) || 'void' !== (self::MAGIC_METHODS[$method->name] ?? 'void')) {
  594.                 $this->setReturnType($doc['return'] ?? self::MAGIC_METHODS[$method->name], $method->class, $method->name, $method->getFileName(), $parent, $method->getReturnType());
  596.                 if (isset(self::$returnTypes[$class][$method->name][0]) && $canAddReturnType) {
  597.                     $this->fixReturnStatements($method, self::$returnTypes[$class][$method->name][0]);
  598.                 }
  600.                 if ($method->isPrivate()) {
  601.                     unset(self::$returnTypes[$class][$method->name]);
  602.                 }
  603.             }
  605.             $this->patchTypes['force'] = $forcePatchTypes;
  607.             if ($method->isPrivate()) {
  608.                 continue;
  609.             }
  611.             $finalOrInternal = false;
  613.             foreach (['final', 'internal'] as $annotation) {
  614.                 if (null !== $description = $doc[$annotation][0] ?? null) {
  615.                     self::${$annotation.'Methods'}[$class][$method->name] = [$class, '' !== $description ? ' '.$description.(preg_match('/[[:punct:]]$/', $description) ? '' : '.') : '.'];
  616.                     $finalOrInternal = true;
  617.                 }
  618.             }
  620.             if ($finalOrInternal || $method->isConstructor() || !isset($doc['param']) || StatelessInvocation::class === $class) {
  621.                 continue;
  622.             }
  623.             if (!isset(self::$annotatedParameters[$class][$method->name])) {
  624.                 $definedParameters = [];
  625.                 foreach ($method->getParameters() as $parameter) {
  626.                     $definedParameters[$parameter->name] = true;
  627.                 }
  628.             }
  629.             foreach ($doc['param'] as $parameterName => $parameterType) {
  630.                 if (!isset($definedParameters[$parameterName])) {
  631.                     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);
  632.                 }
  633.             }
  634.         }
  636.         $finals = isset(self::$final[$class]) || $refl->isFinal() ? [] : [
  637.             'finalConstants' => $refl->getReflectionConstants(\ReflectionClassConstant::IS_PUBLIC | \ReflectionClassConstant::IS_PROTECTED),
  638.             'finalProperties' => $refl->getProperties(\ReflectionProperty::IS_PUBLIC | \ReflectionProperty::IS_PROTECTED),
  639.         ];
  640.         foreach ($finals as $type => $reflectors) {
  641.             foreach ($reflectors as $r) {
  642.                 if ($r->class !== $class) {
  643.                     continue;
  644.                 }
  646.                 $doc = $this->parsePhpDoc($r);
  648.                 foreach ($parentAndOwnInterfaces as $use) {
  649.                     if (isset(self::${$type}[$use][$r->name]) && !isset($doc['deprecated']) && ('finalConstants' === $type || substr($use, 0, strrpos($use, '\\')) !== substr($use, 0, strrpos($class, '\\')))) {
  650.                         $msg = 'finalConstants' === $type ? '%s" constant' : '$%s" property';
  651.                         $deprecations[] = sprintf('The "%s::'.$msg.' is considered final. You should not override it in "%s".', self::${$type}[$use][$r->name], $r->name, $class);
  652.                     }
  653.                 }
  655.                 if (isset($doc['final']) || ('finalProperties' === $type && str_starts_with($class, 'Symfony\\') && !$r->hasType())) {
  656.                     self::${$type}[$class][$r->name] = $class;
  657.                 }
  658.             }
  659.         }
  661.         return $deprecations;
  662.     }
  664.     public function checkCase(\ReflectionClass $refl, string $file, string $class): ?array
  665.     {
  666.         $real = explode('\\', $class.strrchr($file, '.'));
  667.         $tail = explode(\DIRECTORY_SEPARATOR, str_replace('/', \DIRECTORY_SEPARATOR, $file));
  669.         $i = \count($tail) - 1;
  670.         $j = \count($real) - 1;
  672.         while (isset($tail[$i], $real[$j]) && $tail[$i] === $real[$j]) {
  673.             --$i;
  674.             --$j;
  675.         }
  677.         array_splice($tail, 0, $i + 1);
  679.         if (!$tail) {
  680.             return null;
  681.         }
  683.         $tail = \DIRECTORY_SEPARATOR.implode(\DIRECTORY_SEPARATOR, $tail);
  684.         $tailLen = \strlen($tail);
  685.         $real = $refl->getFileName();
  687.         if (2 === self::$caseCheck) {
  688.             $real = $this->darwinRealpath($real);
  689.         }
  691.         if (0 === substr_compare($real, $tail, -$tailLen, $tailLen, true)
  692.             && 0 !== substr_compare($real, $tail, -$tailLen, $tailLen, false)
  693.         ) {
  694.             return [substr($tail, -$tailLen + 1), substr($real, -$tailLen + 1), substr($real, 0, -$tailLen + 1)];
  695.         }
  697.         return null;
  698.     }
  700.     /**
  701.      * `realpath` on MacOSX doesn't normalize the case of characters.
  702.      */
  703.     private function darwinRealpath(string $real): string
  704.     {
  705.         $i = 1 + strrpos($real, '/');
  706.         $file = substr($real, $i);
  707.         $real = substr($real, 0, $i);
  709.         if (isset(self::$darwinCache[$real])) {
  710.             $kDir = $real;
  711.         } else {
  712.             $kDir = strtolower($real);
  714.             if (isset(self::$darwinCache[$kDir])) {
  715.                 $real = self::$darwinCache[$kDir][0];
  716.             } else {
  717.                 $dir = getcwd();
  719.                 if (!@chdir($real)) {
  720.                     return $real.$file;
  721.                 }
  723.                 $real = getcwd().'/';
  724.                 chdir($dir);
  726.                 $dir = $real;
  727.                 $k = $kDir;
  728.                 $i = \strlen($dir) - 1;
  729.                 while (!isset(self::$darwinCache[$k])) {
  730.                     self::$darwinCache[$k] = [$dir, []];
  731.                     self::$darwinCache[$dir] = &self::$darwinCache[$k];
  733.                     while ('/' !== $dir[--$i]) {
  734.                     }
  735.                     $k = substr($k, 0, ++$i);
  736.                     $dir = substr($dir, 0, $i--);
  737.                 }
  738.             }
  739.         }
  741.         $dirFiles = self::$darwinCache[$kDir][1];
  743.         if (!isset($dirFiles[$file]) && str_ends_with($file, ') : eval()\'d code')) {
  744.             // Get the file name from "file_name.php(123) : eval()'d code"
  745.             $file = substr($file, 0, strrpos($file, '(', -17));
  746.         }
  748.         if (isset($dirFiles[$file])) {
  749.             return $real.$dirFiles[$file];
  750.         }
  752.         $kFile = strtolower($file);
  754.         if (!isset($dirFiles[$kFile])) {
  755.             foreach (scandir($real, 2) as $f) {
  756.                 if ('.' !== $f[0]) {
  757.                     $dirFiles[$f] = $f;
  758.                     if ($f === $file) {
  759.                         $kFile = $k = $file;
  760.                     } elseif ($f !== $k = strtolower($f)) {
  761.                         $dirFiles[$k] = $f;
  762.                     }
  763.                 }
  764.             }
  765.             self::$darwinCache[$kDir][1] = $dirFiles;
  766.         }
  768.         return $real.$dirFiles[$kFile];
  769.     }
  771.     /**
  772.      * `class_implements` includes interfaces from the parents so we have to manually exclude them.
  773.      *
  774.      * @return string[]
  775.      */
  776.     private function getOwnInterfaces(string $class, ?string $parent): array
  777.     {
  778.         $ownInterfaces = class_implements($class, false);
  780.         if ($parent) {
  781.             foreach (class_implements($parent, false) as $interface) {
  782.                 unset($ownInterfaces[$interface]);
  783.             }
  784.         }
  786.         foreach ($ownInterfaces as $interface) {
  787.             foreach (class_implements($interface) as $interface) {
  788.                 unset($ownInterfaces[$interface]);
  789.             }
  790.         }
  792.         return $ownInterfaces;
  793.     }
  795.     private function setReturnType(string $types, string $class, string $method, string $filename, ?string $parent, \ReflectionType $returnType = null): void
  796.     {
  797.         if ('__construct' === $method) {
  798.             return;
  799.         }
  801.         if ('null' === $types) {
  802.             self::$returnTypes[$class][$method] = ['null', 'null', $class, $filename];
  804.             return;
  805.         }
  807.         if ($nullable = str_starts_with($types, 'null|')) {
  808.             $types = substr($types, 5);
  809.         } elseif ($nullable = str_ends_with($types, '|null')) {
  810.             $types = substr($types, 0, -5);
  811.         }
  812.         $arrayType = ['array' => 'array'];
  813.         $typesMap = [];
  814.         $glue = str_contains($types, '&') ? '&' : '|';
  815.         foreach (explode($glue, $types) as $t) {
  816.             $t = self::SPECIAL_RETURN_TYPES[strtolower($t)] ?? $t;
  817.             $typesMap[$this->normalizeType($t, $class, $parent, $returnType)][$t] = $t;
  818.         }
  820.         if (isset($typesMap['array'])) {
  821.             if (isset($typesMap['Traversable']) || isset($typesMap['\Traversable'])) {
  822.                 $typesMap['iterable'] = $arrayType !== $typesMap['array'] ? $typesMap['array'] : ['iterable'];
  823.                 unset($typesMap['array'], $typesMap['Traversable'], $typesMap['\Traversable']);
  824.             } elseif ($arrayType !== $typesMap['array'] && isset(self::$returnTypes[$class][$method]) && !$returnType) {
  825.                 return;
  826.             }
  827.         }
  829.         if (isset($typesMap['array']) && isset($typesMap['iterable'])) {
  830.             if ($arrayType !== $typesMap['array']) {
  831.                 $typesMap['iterable'] = $typesMap['array'];
  832.             }
  833.             unset($typesMap['array']);
  834.         }
  836.         $iterable = $object = true;
  837.         foreach ($typesMap as $n => $t) {
  838.             if ('null' !== $n) {
  839.                 $iterable = $iterable && (\in_array($n, ['array', 'iterable']) || str_contains($n, 'Iterator'));
  840.                 $object = $object && (\in_array($n, ['callable', 'object', '$this', 'static']) || !isset(self::SPECIAL_RETURN_TYPES[$n]));
  841.             }
  842.         }
  844.         $phpTypes = [];
  845.         $docTypes = [];
  847.         foreach ($typesMap as $n => $t) {
  848.             if ('null' === $n) {
  849.                 $nullable = true;
  850.                 continue;
  851.             }
  853.             $docTypes[] = $t;
  855.             if ('mixed' === $n || 'void' === $n) {
  856.                 $nullable = false;
  857.                 $phpTypes = ['' => $n];
  858.                 continue;
  859.             }
  861.             if ('resource' === $n) {
  862.                 // there is no native type for "resource"
  863.                 return;
  864.             }
  866.             if (!isset($phpTypes[''])) {
  867.                 $phpTypes[] = $n;
  868.             }
  869.         }
  870.         $docTypes = array_merge([], ...$docTypes);
  872.         if (!$phpTypes) {
  873.             return;
  874.         }
  876.         if (1 < \count($phpTypes)) {
  877.             if ($iterable && '8.0' > $this->patchTypes['php']) {
  878.                 $phpTypes = $docTypes = ['iterable'];
  879.             } elseif ($object && 'object' === $this->patchTypes['force']) {
  880.                 $phpTypes = $docTypes = ['object'];
  881.             } elseif ('8.0' > $this->patchTypes['php']) {
  882.                 // ignore multi-types return declarations
  883.                 return;
  884.             }
  885.         }
  887.         $phpType = sprintf($nullable ? (1 < \count($phpTypes) ? '%s|null' : '?%s') : '%s', implode($glue, $phpTypes));
  888.         $docType = sprintf($nullable ? '%s|null' : '%s', implode($glue, $docTypes));
  890.         self::$returnTypes[$class][$method] = [$phpType, $docType, $class, $filename];
  891.     }
  893.     private function normalizeType(string $type, string $class, ?string $parent, ?\ReflectionType $returnType): string
  894.     {
  895.         if (isset(self::SPECIAL_RETURN_TYPES[$lcType = strtolower($type)])) {
  896.             if ('parent' === $lcType = self::SPECIAL_RETURN_TYPES[$lcType]) {
  897.                 $lcType = null !== $parent ? '\\'.$parent : 'parent';
  898.             } elseif ('self' === $lcType) {
  899.                 $lcType = '\\'.$class;
  900.             }
  902.             return $lcType;
  903.         }
  905.         // We could resolve "use" statements to return the FQDN
  906.         // but this would be too expensive for a runtime checker
  908.         if (!str_ends_with($type, '[]')) {
  909.             return $type;
  910.         }
  912.         if ($returnType instanceof \ReflectionNamedType) {
  913.             $type = $returnType->getName();
  915.             if ('mixed' !== $type) {
  916.                 return isset(self::SPECIAL_RETURN_TYPES[$type]) ? $type : '\\'.$type;
  917.             }
  918.         }
  920.         return 'array';
  921.     }
  923.     /**
  924.      * Utility method to add #[ReturnTypeWillChange] where php triggers deprecations.
  925.      */
  926.     private function patchReturnTypeWillChange(\ReflectionMethod $method)
  927.     {
  928.         if (\count($method->getAttributes(\ReturnTypeWillChange::class))) {
  929.             return;
  930.         }
  932.         if (!is_file($file = $method->getFileName())) {
  933.             return;
  934.         }
  936.         $fileOffset = self::$fileOffsets[$file] ?? 0;
  938.         $code = file($file);
  940.         $startLine = $method->getStartLine() + $fileOffset - 2;
  942.         if (false !== stripos($code[$startLine], 'ReturnTypeWillChange')) {
  943.             return;
  944.         }
  946.         $code[$startLine] .= "    #[\\ReturnTypeWillChange]\n";
  947.         self::$fileOffsets[$file] = 1 + $fileOffset;
  948.         file_put_contents($file, $code);
  949.     }
  951.     /**
  952.      * Utility method to add @return annotations to the Symfony code-base where it triggers self-deprecations.
  953.      */
  954.     private function patchMethod(\ReflectionMethod $method, string $returnType, string $declaringFile, string $normalizedType)
  955.     {
  956.         static $patchedMethods = [];
  957.         static $useStatements = [];
  959.         if (!is_file($file = $method->getFileName()) || isset($patchedMethods[$file][$startLine = $method->getStartLine()])) {
  960.             return;
  961.         }
  963.         $patchedMethods[$file][$startLine] = true;
  964.         $fileOffset = self::$fileOffsets[$file] ?? 0;
  965.         $startLine += $fileOffset - 2;
  966.         if ($nullable = str_ends_with($returnType, '|null')) {
  967.             $returnType = substr($returnType, 0, -5);
  968.         }
  969.         $glue = str_contains($returnType, '&') ? '&' : '|';
  970.         $returnType = explode($glue, $returnType);
  971.         $code = file($file);
  973.         foreach ($returnType as $i => $type) {
  974.             if (preg_match('/((?:\[\])+)$/', $type, $m)) {
  975.                 $type = substr($type, 0, -\strlen($m[1]));
  976.                 $format = '%s'.$m[1];
  977.             } else {
  978.                 $format = null;
  979.             }
  981.             if (isset(self::SPECIAL_RETURN_TYPES[$type]) || ('\\' === $type[0] && !$p = strrpos($type, '\\', 1))) {
  982.                 continue;
  983.             }
  985.             [$namespace, $useOffset, $useMap] = $useStatements[$file] ??= self::getUseStatements($file);
  987.             if ('\\' !== $type[0]) {
  988.                 [$declaringNamespace, , $declaringUseMap] = $useStatements[$declaringFile] ??= self::getUseStatements($declaringFile);
  990.                 $p = strpos($type, '\\', 1);
  991.                 $alias = $p ? substr($type, 0, $p) : $type;
  993.                 if (isset($declaringUseMap[$alias])) {
  994.                     $type = '\\'.$declaringUseMap[$alias].($p ? substr($type, $p) : '');
  995.                 } else {
  996.                     $type = '\\'.$declaringNamespace.$type;
  997.                 }
  999.                 $p = strrpos($type, '\\', 1);
  1000.             }
  1002.             $alias = substr($type, 1 + $p);
  1003.             $type = substr($type, 1);
  1005.             if (!isset($useMap[$alias]) && (class_exists($c = $namespace.$alias) || interface_exists($c) || trait_exists($c))) {
  1006.                 $useMap[$alias] = $c;
  1007.             }
  1009.             if (!isset($useMap[$alias])) {
  1010.                 $useStatements[$file][2][$alias] = $type;
  1011.                 $code[$useOffset] = "use $type;\n".$code[$useOffset];
  1012.                 ++$fileOffset;
  1013.             } elseif ($useMap[$alias] !== $type) {
  1014.                 $alias .= 'FIXME';
  1015.                 $useStatements[$file][2][$alias] = $type;
  1016.                 $code[$useOffset] = "use $type as $alias;\n".$code[$useOffset];
  1017.                 ++$fileOffset;
  1018.             }
  1020.             $returnType[$i] = null !== $format ? sprintf($format, $alias) : $alias;
  1021.         }
  1023.         if ('docblock' === $this->patchTypes['force'] || ('object' === $normalizedType && '7.1' === $this->patchTypes['php'])) {
  1024.             $returnType = implode($glue, $returnType).($nullable ? '|null' : '');
  1026.             if (str_contains($code[$startLine], '#[')) {
  1027.                 --$startLine;
  1028.             }
  1030.             if ($method->getDocComment()) {
  1031.                 $code[$startLine] = "     * @return $returnType\n".$code[$startLine];
  1032.             } else {
  1033.                 $code[$startLine] .= <<<EOTXT
  1034.     /**
  1035.      * @return $returnType
  1036.      */
  1038. EOTXT;
  1039.             }
  1041.             $fileOffset += substr_count($code[$startLine], "\n") - 1;
  1042.         }
  1044.         self::$fileOffsets[$file] = $fileOffset;
  1045.         file_put_contents($file, $code);
  1047.         $this->fixReturnStatements($method, $normalizedType);
  1048.     }
  1050.     private static function getUseStatements(string $file): array
  1051.     {
  1052.         $namespace = '';
  1053.         $useMap = [];
  1054.         $useOffset = 0;
  1056.         if (!is_file($file)) {
  1057.             return [$namespace, $useOffset, $useMap];
  1058.         }
  1060.         $file = file($file);
  1062.         for ($i = 0; $i < \count($file); ++$i) {
  1063.             if (preg_match('/^(class|interface|trait|abstract) /', $file[$i])) {
  1064.                 break;
  1065.             }
  1067.             if (str_starts_with($file[$i], 'namespace ')) {
  1068.                 $namespace = substr($file[$i], \strlen('namespace '), -2).'\\';
  1069.                 $useOffset = $i + 2;
  1070.             }
  1072.             if (str_starts_with($file[$i], 'use ')) {
  1073.                 $useOffset = $i;
  1075.                 for (; str_starts_with($file[$i], 'use '); ++$i) {
  1076.                     $u = explode(' as ', substr($file[$i], 4, -2), 2);
  1078.                     if (1 === \count($u)) {
  1079.                         $p = strrpos($u[0], '\\');
  1080.                         $useMap[substr($u[0], false !== $p ? 1 + $p : 0)] = $u[0];
  1081.                     } else {
  1082.                         $useMap[$u[1]] = $u[0];
  1083.                     }
  1084.                 }
  1086.                 break;
  1087.             }
  1088.         }
  1090.         return [$namespace, $useOffset, $useMap];
  1091.     }
  1093.     private function fixReturnStatements(\ReflectionMethod $method, string $returnType)
  1094.     {
  1095.         if ('docblock' !== $this->patchTypes['force']) {
  1096.             if ('7.1' === $this->patchTypes['php'] && 'object' === ltrim($returnType, '?')) {
  1097.                 return;
  1098.             }
  1100.             if ('7.4' > $this->patchTypes['php'] && $method->hasReturnType()) {
  1101.                 return;
  1102.             }
  1104.             if ('8.0' > $this->patchTypes['php'] && (str_contains($returnType, '|') || \in_array($returnType, ['mixed', 'static'], true))) {
  1105.                 return;
  1106.             }
  1108.             if ('8.1' > $this->patchTypes['php'] && str_contains($returnType, '&')) {
  1109.                 return;
  1110.             }
  1111.         }
  1113.         if (!is_file($file = $method->getFileName())) {
  1114.             return;
  1115.         }
  1117.         $fixedCode = $code = file($file);
  1118.         $i = (self::$fileOffsets[$file] ?? 0) + $method->getStartLine();
  1120.         if ('?' !== $returnType && 'docblock' !== $this->patchTypes['force']) {
  1121.             $fixedCode[$i - 1] = preg_replace('/\)(?::[^;\n]++)?(;?\n)/', "): $returnType\\1", $code[$i - 1]);
  1122.         }
  1124.         $end = $method->isGenerator() ? $i : $method->getEndLine();
  1125.         for (; $i < $end; ++$i) {
  1126.             if ('void' === $returnType) {
  1127.                 $fixedCode[$i] = str_replace('    return null;', '    return;', $code[$i]);
  1128.             } elseif ('mixed' === $returnType || '?' === $returnType[0]) {
  1129.                 $fixedCode[$i] = str_replace('    return;', '    return null;', $code[$i]);
  1130.             } else {
  1131.                 $fixedCode[$i] = str_replace('    return;', "    return $returnType!?;", $code[$i]);
  1132.             }
  1133.         }
  1135.         if ($fixedCode !== $code) {
  1136.             file_put_contents($file, $fixedCode);
  1137.         }
  1138.     }
  1140.     /**
  1141.      * @param \ReflectionClass|\ReflectionMethod|\ReflectionProperty $reflector
  1142.      */
  1143.     private function parsePhpDoc(\Reflector $reflector): array
  1144.     {
  1145.         if (!$doc = $reflector->getDocComment()) {
  1146.             return [];
  1147.         }
  1149.         $tagName = '';
  1150.         $tagContent = '';
  1152.         $tags = [];
  1154.         foreach (explode("\n", substr($doc, 3, -2)) as $line) {
  1155.             $line = ltrim($line);
  1156.             $line = ltrim($line, '*');
  1158.             if ('' === $line = trim($line)) {
  1159.                 if ('' !== $tagName) {
  1160.                     $tags[$tagName][] = $tagContent;
  1161.                 }
  1162.                 $tagName = $tagContent = '';
  1163.                 continue;
  1164.             }
  1166.             if ('@' === $line[0]) {
  1167.                 if ('' !== $tagName) {
  1168.                     $tags[$tagName][] = $tagContent;
  1169.                     $tagContent = '';
  1170.                 }
  1172.                 if (preg_match('{^@([-a-zA-Z0-9_:]++)(\s|$)}', $line, $m)) {
  1173.                     $tagName = $m[1];
  1174.                     $tagContent = str_replace("\t", ' ', ltrim(substr($line, 2 + \strlen($tagName))));
  1175.                 } else {
  1176.                     $tagName = '';
  1177.                 }
  1178.             } elseif ('' !== $tagName) {
  1179.                 $tagContent .= ' '.str_replace("\t", ' ', $line);
  1180.             }
  1181.         }
  1183.         if ('' !== $tagName) {
  1184.             $tags[$tagName][] = $tagContent;
  1185.         }
  1187.         foreach ($tags['method'] ?? [] as $i => $method) {
  1188.             unset($tags['method'][$i]);
  1190.             $parts = preg_split('{(\s++|\((?:[^()]*+|(?R))*\)(?: *: *[^ ]++)?|<(?:[^<>]*+|(?R))*>|\{(?:[^{}]*+|(?R))*\})}', $method, -1, \PREG_SPLIT_DELIM_CAPTURE);
  1191.             $returnType = '';
  1192.             $static = 'static' === $parts[0];
  1194.             for ($i = $static ? 2 : 0; null !== $p = $parts[$i] ?? null; $i += 2) {
  1195.                 if (\in_array($p, ['', '|', '&', 'callable'], true) || \in_array(substr($returnType, -1), ['|', '&'], true)) {
  1196.                     $returnType .= trim($parts[$i - 1] ?? '').$p;
  1197.                     continue;
  1198.                 }
  1200.                 $signature = '(' === ($parts[$i + 1][0] ?? '(') ? $parts[$i + 1] ?? '()' : null;
  1202.                 if (null === $signature && '' === $returnType) {
  1203.                     $returnType = $p;
  1204.                     continue;
  1205.                 }
  1207.                 if ($static && 2 === $i) {
  1208.                     $static = false;
  1209.                     $returnType = 'static';
  1210.                 }
  1212.                 if (\in_array($description = trim(implode('', \array_slice($parts, 2 + $i))), ['', '.'], true)) {
  1213.                     $description = null;
  1214.                 } elseif (!preg_match('/[.!]$/', $description)) {
  1215.                     $description .= '.';
  1216.                 }
  1218.                 $tags['method'][$p] = [$static, $returnType, $signature ?? '()', $description];
  1219.                 break;
  1220.             }
  1221.         }
  1223.         foreach ($tags['param'] ?? [] as $i => $param) {
  1224.             unset($tags['param'][$i]);
  1226.             if (\strlen($param) !== strcspn($param, '<{(')) {
  1227.                 $param = preg_replace('{\(([^()]*+|(?R))*\)(?: *: *[^ ]++)?|<([^<>]*+|(?R))*>|\{([^{}]*+|(?R))*\}}', '', $param);
  1228.             }
  1230.             if (false === $i = strpos($param, '$')) {
  1231.                 continue;
  1232.             }
  1234.             $type = 0 === $i ? '' : rtrim(substr($param, 0, $i), ' &');
  1235.             $param = substr($param, 1 + $i, (strpos($param, ' ', $i) ?: (1 + $i + \strlen($param))) - $i - 1);
  1237.             $tags['param'][$param] = $type;
  1238.         }
  1240.         foreach (['var', 'return'] as $k) {
  1241.             if (null === $v = $tags[$k][0] ?? null) {
  1242.                 continue;
  1243.             }
  1244.             if (\strlen($v) !== strcspn($v, '<{(')) {
  1245.                 $v = preg_replace('{\(([^()]*+|(?R))*\)(?: *: *[^ ]++)?|<([^<>]*+|(?R))*>|\{([^{}]*+|(?R))*\}}', '', $v);
  1246.             }
  1248.             $tags[$k] = substr($v, 0, strpos($v, ' ') ?: \strlen($v)) ?: null;
  1249.         }
  1251.         return $tags;
  1252.     }
  1253. }