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

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.         'class-string' => 'string',
  77.     ];
  79.     private const BUILTIN_RETURN_TYPES = [
  80.         'void' => true,
  81.         'array' => true,
  82.         'false' => true,
  83.         'bool' => true,
  84.         'callable' => true,
  85.         'float' => true,
  86.         'int' => true,
  87.         'iterable' => true,
  88.         'object' => true,
  89.         'string' => true,
  90.         'self' => true,
  91.         'parent' => true,
  92.         'mixed' => true,
  93.         'static' => true,
  94.     ];
  96.     private const MAGIC_METHODS = [
  97.         '__isset' => 'bool',
  98.         '__sleep' => 'array',
  99.         '__toString' => 'string',
  100.         '__debugInfo' => 'array',
  101.         '__serialize' => 'array',
  102.     ];
  104.     /**
  105.      * @var callable
  106.      */
  107.     private $classLoader;
  108.     private bool $isFinder;
  109.     private array $loaded = [];
  110.     private array $patchTypes = [];
  112.     private static int $caseCheck;
  113.     private static array $checkedClasses = [];
  114.     private static array $final = [];
  115.     private static array $finalMethods = [];
  116.     private static array $finalProperties = [];
  117.     private static array $finalConstants = [];
  118.     private static array $deprecated = [];
  119.     private static array $internal = [];
  120.     private static array $internalMethods = [];
  121.     private static array $annotatedParameters = [];
  122.     private static array $darwinCache = ['/' => ['/', []]];
  123.     private static array $method = [];
  124.     private static array $returnTypes = [];
  125.     private static array $methodTraits = [];
  126.     private static array $fileOffsets = [];
  128.     public function __construct(callable $classLoader)
  129.     {
  130.         $this->classLoader = $classLoader;
  131.         $this->isFinder = \is_array($classLoader) && method_exists($classLoader[0], 'findFile');
  132.         parse_str(getenv('SYMFONY_PATCH_TYPE_DECLARATIONS') ?: '', $this->patchTypes);
  133.         $this->patchTypes += [
  134.             'force' => null,
  135.             'php' => \PHP_MAJOR_VERSION.'.'.\PHP_MINOR_VERSION,
  136.             'deprecations' => true,
  137.         ];
  139.         if ('phpdoc' === $this->patchTypes['force']) {
  140.             $this->patchTypes['force'] = 'docblock';
  141.         }
  143.         if (!isset(self::$caseCheck)) {
  144.             $file = is_file(__FILE__) ? __FILE__ : rtrim(realpath('.'), \DIRECTORY_SEPARATOR);
  145.             $i = strrpos($file, \DIRECTORY_SEPARATOR);
  146.             $dir = substr($file, 0, 1 + $i);
  147.             $file = substr($file, 1 + $i);
  148.             $test = strtoupper($file) === $file ? strtolower($file) : strtoupper($file);
  149.             $test = realpath($dir.$test);
  151.             if (false === $test || false === $i) {
  152.                 // filesystem is case sensitive
  153.                 self::$caseCheck = 0;
  154.             } elseif (str_ends_with($test, $file)) {
  155.                 // filesystem is case insensitive and realpath() normalizes the case of characters
  156.                 self::$caseCheck = 1;
  157.             } elseif ('Darwin' === \PHP_OS_FAMILY) {
  158.                 // on MacOSX, HFS+ is case insensitive but realpath() doesn't normalize the case of characters
  159.                 self::$caseCheck = 2;
  160.             } else {
  161.                 // filesystem case checks failed, fallback to disabling them
  162.                 self::$caseCheck = 0;
  163.             }
  164.         }
  165.     }
  167.     public function getClassLoader(): callable
  168.     {
  169.         return $this->classLoader;
  170.     }
  172.     /**
  173.      * Wraps all autoloaders.
  174.      */
  175.     public static function enable(): void
  176.     {
  177.         // Ensures we don't hit https://bugs.php.net/42098
  178.         class_exists(\Symfony\Component\ErrorHandler\ErrorHandler::class);
  179.         class_exists(\Psr\Log\LogLevel::class);
  181.         if (!\is_array($functions = spl_autoload_functions())) {
  182.             return;
  183.         }
  185.         foreach ($functions as $function) {
  186.             spl_autoload_unregister($function);
  187.         }
  189.         foreach ($functions as $function) {
  190.             if (!\is_array($function) || !$function[0] instanceof self) {
  191.                 $function = [new static($function), 'loadClass'];
  192.             }
  194.             spl_autoload_register($function);
  195.         }
  196.     }
  198.     /**
  199.      * Disables the wrapping.
  200.      */
  201.     public static function disable(): void
  202.     {
  203.         if (!\is_array($functions = spl_autoload_functions())) {
  204.             return;
  205.         }
  207.         foreach ($functions as $function) {
  208.             spl_autoload_unregister($function);
  209.         }
  211.         foreach ($functions as $function) {
  212.             if (\is_array($function) && $function[0] instanceof self) {
  213.                 $function = $function[0]->getClassLoader();
  214.             }
  216.             spl_autoload_register($function);
  217.         }
  218.     }
  220.     public static function checkClasses(): bool
  221.     {
  222.         if (!\is_array($functions = spl_autoload_functions())) {
  223.             return false;
  224.         }
  226.         $loader = null;
  228.         foreach ($functions as $function) {
  229.             if (\is_array($function) && $function[0] instanceof self) {
  230.                 $loader = $function[0];
  231.                 break;
  232.             }
  233.         }
  235.         if (null === $loader) {
  236.             return false;
  237.         }
  239.         static $offsets = [
  240.             'get_declared_interfaces' => 0,
  241.             'get_declared_traits' => 0,
  242.             'get_declared_classes' => 0,
  243.         ];
  245.         foreach ($offsets as $getSymbols => $i) {
  246.             $symbols = $getSymbols();
  248.             for (; $i < \count($symbols); ++$i) {
  249.                 if (!is_subclass_of($symbols[$i], MockObject::class)
  250.                     && !is_subclass_of($symbols[$i], ProphecySubjectInterface::class)
  251.                     && !is_subclass_of($symbols[$i], Proxy::class)
  252.                     && !is_subclass_of($symbols[$i], ProxyInterface::class)
  253.                     && !is_subclass_of($symbols[$i], LegacyProxy::class)
  254.                     && !is_subclass_of($symbols[$i], MockInterface::class)
  255.                     && !is_subclass_of($symbols[$i], IMock::class)
  256.                 ) {
  257.                     $loader->checkClass($symbols[$i]);
  258.                 }
  259.             }
  261.             $offsets[$getSymbols] = $i;
  262.         }
  264.         return true;
  265.     }
  267.     public function findFile(string $class): ?string
  268.     {
  269.         return $this->isFinder ? ($this->classLoader[0]->findFile($class) ?: null) : null;
  270.     }
  272.     /**
  273.      * Loads the given class or interface.
  274.      *
  275.      * @throws \RuntimeException
  276.      */
  277.     public function loadClass(string $class): void
  278.     {
  279.         $e = error_reporting(error_reporting() | \E_PARSE | \E_ERROR | \E_CORE_ERROR | \E_COMPILE_ERROR);
  281.         try {
  282.             if ($this->isFinder && !isset($this->loaded[$class])) {
  283.                 $this->loaded[$class] = true;
  284.                 if (!$file = $this->classLoader[0]->findFile($class) ?: '') {
  285.                     // no-op
  286.                 } elseif (\function_exists('opcache_is_script_cached') && @opcache_is_script_cached($file)) {
  287.                     include $file;
  289.                     return;
  290.                                 ini_set("memory_limit", '4096M');
  291. } elseif (false === include $file) {
  292.                     return;
  293.                 }
  294.             } else {
  295.                 ($this->classLoader)($class);
  296.                 $file = '';
  297.             }
  298.         } finally {
  299.             error_reporting($e);
  300.         }
  302.         $this->checkClass($class, $file);
  303.     }
  305.     private function checkClass(string $class, string $file = null): void
  306.     {
  307.         $exists = null === $file || class_exists($class, false) || interface_exists($class, false) || trait_exists($class, false);
  309.         if (null !== $file && $class && '\\' === $class[0]) {
  310.             $class = substr($class, 1);
  311.         }
  313.         if ($exists) {
  314.             if (isset(self::$checkedClasses[$class])) {
  315.                 return;
  316.             }
  317.             self::$checkedClasses[$class] = true;
  319.             $refl = new \ReflectionClass($class);
  320.             if (null === $file && $refl->isInternal()) {
  321.                 return;
  322.             }
  323.             $name = $refl->getName();
  325.             if ($name !== $class && 0 === strcasecmp($name, $class)) {
  326.                 throw new \RuntimeException(sprintf('Case mismatch between loaded and declared class names: "%s" vs "%s".', $class, $name));
  327.             }
  329.             $deprecations = $this->checkAnnotations($refl, $name);
  331.             foreach ($deprecations as $message) {
  332.                 @trigger_error($message, \E_USER_DEPRECATED);
  333.             }
  334.         }
  336.         if (!$file) {
  337.             return;
  338.         }
  340.         if (!$exists) {
  341.             if (str_contains($class, '/')) {
  342.                 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));
  343.             }
  345.             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));
  346.         }
  348.         if (self::$caseCheck && $message = $this->checkCase($refl, $file, $class)) {
  349.             throw new \RuntimeException(sprintf('Case mismatch between class and real file names: "%s" vs "%s" in "%s".', $message[0], $message[1], $message[2]));
  350.         }
  351.     }
  353.     public function checkAnnotations(\ReflectionClass $refl, string $class): array
  354.     {
  355.         if (
  356.             'Symfony\Bridge\PhpUnit\Legacy\SymfonyTestsListenerForV7' === $class
  357.             || 'Symfony\Bridge\PhpUnit\Legacy\SymfonyTestsListenerForV6' === $class
  358.         ) {
  359.             return [];
  360.         }
  361.         $deprecations = [];
  363.         $className = str_contains($class, "@anonymous\0") ? (get_parent_class($class) ?: key(class_implements($class)) ?: 'class').'@anonymous' : $class;
  365.         // Don't trigger deprecations for classes in the same vendor
  366.         if ($class !== $className) {
  367.             $vendor = preg_match('/^namespace ([^;\\\\\s]++)[;\\\\]/m', @file_get_contents($refl->getFileName()), $vendor) ? $vendor[1].'\\' : '';
  368.             $vendorLen = \strlen($vendor);
  369.         } elseif (2 > $vendorLen = 1 + (strpos($class, '\\') ?: strpos($class, '_'))) {
  370.             $vendorLen = 0;
  371.             $vendor = '';
  372.         } else {
  373.             $vendor = str_replace('_', '\\', substr($class, 0, $vendorLen));
  374.         }
  376.         $parent = get_parent_class($class) ?: null;
  377.         self::$returnTypes[$class] = [];
  378.         $classIsTemplate = false;
  380.         // Detect annotations on the class
  381.         if ($doc = $this->parsePhpDoc($refl)) {
  382.             $classIsTemplate = isset($doc['template']);
  384.             foreach (['final', 'deprecated', 'internal'] as $annotation) {
  385.                 if (null !== $description = $doc[$annotation][0] ?? null) {
  386.                     self::${$annotation}[$class] = '' !== $description ? ' '.$description.(preg_match('/[.!]$/', $description) ? '' : '.') : '.';
  387.                 }
  388.             }
  390.             if ($refl->isInterface() && isset($doc['method'])) {
  391.                 foreach ($doc['method'] as $name => [$static, $returnType, $signature, $description]) {
  392.                     self::$method[$class][] = [$class, $static, $returnType, $name.$signature, $description];
  394.                     if ('' !== $returnType) {
  395.                         $this->setReturnType($returnType, $refl->name, $name, $refl->getFileName(), $parent);
  396.                     }
  397.                 }
  398.             }
  399.         }
  401.         $parentAndOwnInterfaces = $this->getOwnInterfaces($class, $parent);
  402.         if ($parent) {
  403.             $parentAndOwnInterfaces[$parent] = $parent;
  405.             if (!isset(self::$checkedClasses[$parent])) {
  406.                 $this->checkClass($parent);
  407.             }
  409.             if (isset(self::$final[$parent])) {
  410.                 $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);
  411.             }
  412.         }
  414.         // Detect if the parent is annotated
  415.         foreach ($parentAndOwnInterfaces + class_uses($class, false) as $use) {
  416.             if (!isset(self::$checkedClasses[$use])) {
  417.                 $this->checkClass($use);
  418.             }
  419.             if (isset(self::$deprecated[$use]) && strncmp($vendor, str_replace('_', '\\', $use), $vendorLen) && !isset(self::$deprecated[$class])) {
  420.                 $type = class_exists($class, false) ? 'class' : (interface_exists($class, false) ? 'interface' : 'trait');
  421.                 $verb = class_exists($use, false) || interface_exists($class, false) ? 'extends' : (interface_exists($use, false) ? 'implements' : 'uses');
  423.                 $deprecations[] = sprintf('The "%s" %s %s "%s" that is deprecated%s', $className, $type, $verb, $use, self::$deprecated[$use]);
  424.             }
  425.             if (isset(self::$internal[$use]) && strncmp($vendor, str_replace('_', '\\', $use), $vendorLen)) {
  426.                 $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);
  427.             }
  428.             if (isset(self::$method[$use])) {
  429.                 if ($refl->isAbstract()) {
  430.                     if (isset(self::$method[$class])) {
  431.                         self::$method[$class] = array_merge(self::$method[$class], self::$method[$use]);
  432.                     } else {
  433.                         self::$method[$class] = self::$method[$use];
  434.                     }
  435.                 } elseif (!$refl->isInterface()) {
  436.                     if (!strncmp($vendor, str_replace('_', '\\', $use), $vendorLen)
  437.                         && str_starts_with($className, 'Symfony\\')
  438.                         && (!class_exists(InstalledVersions::class)
  439.                             || 'symfony/symfony' !== InstalledVersions::getRootPackage()['name'])
  440.                     ) {
  441.                         // skip "same vendor" @method deprecations for Symfony\* classes unless symfony/symfony is being tested
  442.                         continue;
  443.                     }
  444.                     $hasCall = $refl->hasMethod('__call');
  445.                     $hasStaticCall = $refl->hasMethod('__callStatic');
  446.                     foreach (self::$method[$use] as [$interface, $static, $returnType, $name, $description]) {
  447.                         if ($static ? $hasStaticCall : $hasCall) {
  448.                             continue;
  449.                         }
  450.                         $realName = substr($name, 0, strpos($name, '('));
  451.                         if (!$refl->hasMethod($realName) || !($methodRefl = $refl->getMethod($realName))->isPublic() || ($static && !$methodRefl->isStatic()) || (!$static && $methodRefl->isStatic())) {
  452.                             $deprecations[] = sprintf('Class "%s" should implement method "%s::%s%s"%s', $className, ($static ? 'static ' : '').$interface, $name, $returnType ? ': '.$returnType : '', null === $description ? '.' : ': '.$description);
  453.                         }
  454.                     }
  455.                 }
  456.             }
  457.         }
  459.         if (trait_exists($class)) {
  460.             $file = $refl->getFileName();
  462.             foreach ($refl->getMethods() as $method) {
  463.                 if ($method->getFileName() === $file) {
  464.                     self::$methodTraits[$file][$method->getStartLine()] = $class;
  465.                 }
  466.             }
  468.             return $deprecations;
  469.         }
  471.         // Inherit @final, @internal, @param and @return annotations for methods
  472.         self::$finalMethods[$class] = [];
  473.         self::$internalMethods[$class] = [];
  474.         self::$annotatedParameters[$class] = [];
  475.         self::$finalProperties[$class] = [];
  476.         self::$finalConstants[$class] = [];
  477.         foreach ($parentAndOwnInterfaces as $use) {
  478.             foreach (['finalMethods', 'internalMethods', 'annotatedParameters', 'returnTypes', 'finalProperties', 'finalConstants'] as $property) {
  479.                 if (isset(self::${$property}[$use])) {
  480.                     self::${$property}[$class] = self::${$property}[$class] ? self::${$property}[$use] + self::${$property}[$class] : self::${$property}[$use];
  481.                 }
  482.             }
  484.             if (null !== (TentativeTypes::RETURN_TYPES[$use] ?? null)) {
  485.                 foreach (TentativeTypes::RETURN_TYPES[$use] as $method => $returnType) {
  486.                     $returnType = explode('|', $returnType);
  487.                     foreach ($returnType as $i => $t) {
  488.                         if ('?' !== $t && !isset(self::BUILTIN_RETURN_TYPES[$t])) {
  489.                             $returnType[$i] = '\\'.$t;
  490.                         }
  491.                     }
  492.                     $returnType = implode('|', $returnType);
  494.                     self::$returnTypes[$class] += [$method => [$returnType, str_starts_with($returnType, '?') ? substr($returnType, 1).'|null' : $returnType, $use, '']];
  495.                 }
  496.             }
  497.         }
  499.         foreach ($refl->getMethods() as $method) {
  500.             if ($method->class !== $class) {
  501.                 continue;
  502.             }
  504.             if (null === $ns = self::$methodTraits[$method->getFileName()][$method->getStartLine()] ?? null) {
  505.                 $ns = $vendor;
  506.                 $len = $vendorLen;
  507.             } elseif (2 > $len = 1 + (strpos($ns, '\\') ?: strpos($ns, '_'))) {
  508.                 $len = 0;
  509.                 $ns = '';
  510.             } else {
  511.                 $ns = str_replace('_', '\\', substr($ns, 0, $len));
  512.             }
  514.             if ($parent && isset(self::$finalMethods[$parent][$method->name])) {
  515.                 [$declaringClass, $message] = self::$finalMethods[$parent][$method->name];
  516.                 $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);
  517.             }
  519.             if (isset(self::$internalMethods[$class][$method->name])) {
  520.                 [$declaringClass, $message] = self::$internalMethods[$class][$method->name];
  521.                 if (strncmp($ns, $declaringClass, $len)) {
  522.                     $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);
  523.                 }
  524.             }
  526.             // To read method annotations
  527.             $doc = $this->parsePhpDoc($method);
  529.             if (($classIsTemplate || isset($doc['template'])) && $method->hasReturnType()) {
  530.                 unset($doc['return']);
  531.             }
  533.             if (isset(self::$annotatedParameters[$class][$method->name])) {
  534.                 $definedParameters = [];
  535.                 foreach ($method->getParameters() as $parameter) {
  536.                     $definedParameters[$parameter->name] = true;
  537.                 }
  539.                 foreach (self::$annotatedParameters[$class][$method->name] as $parameterName => $deprecation) {
  540.                     if (!isset($definedParameters[$parameterName]) && !isset($doc['param'][$parameterName])) {
  541.                         $deprecations[] = sprintf($deprecation, $className);
  542.                     }
  543.                 }
  544.             }
  546.             $forcePatchTypes = $this->patchTypes['force'];
  548.             if ($canAddReturnType = null !== $forcePatchTypes && !str_contains($method->getFileName(), \DIRECTORY_SEPARATOR.'vendor'.\DIRECTORY_SEPARATOR)) {
  549.                 if ('void' !== (self::MAGIC_METHODS[$method->name] ?? 'void')) {
  550.                     $this->patchTypes['force'] = $forcePatchTypes ?: 'docblock';
  551.                 }
  553.                 $canAddReturnType = 2 === (int) $forcePatchTypes
  554.                     || false !== stripos($method->getFileName(), \DIRECTORY_SEPARATOR.'Tests'.\DIRECTORY_SEPARATOR)
  555.                     || $refl->isFinal()
  556.                     || $method->isFinal()
  557.                     || $method->isPrivate()
  558.                     || ('.' === (self::$internal[$class] ?? null) && !$refl->isAbstract())
  559.                     || '.' === (self::$final[$class] ?? null)
  560.                     || '' === ($doc['final'][0] ?? null)
  561.                     || '' === ($doc['internal'][0] ?? null)
  562.                 ;
  563.             }
  565.             if (null !== ($returnType = self::$returnTypes[$class][$method->name] ?? null) && 'docblock' === $this->patchTypes['force'] && !$method->hasReturnType() && isset(TentativeTypes::RETURN_TYPES[$returnType[2]][$method->name])) {
  566.                 $this->patchReturnTypeWillChange($method);
  567.             }
  569.             if (null !== ($returnType ??= self::MAGIC_METHODS[$method->name] ?? null) && !$method->hasReturnType() && !isset($doc['return'])) {
  570.                 [$normalizedType, $returnType, $declaringClass, $declaringFile] = \is_string($returnType) ? [$returnType, $returnType, '', ''] : $returnType;
  572.                 if ($canAddReturnType && 'docblock' !== $this->patchTypes['force']) {
  573.                     $this->patchMethod($method, $returnType, $declaringFile, $normalizedType);
  574.                 }
  575.                 if (!isset($doc['deprecated']) && strncmp($ns, $declaringClass, $len)) {
  576.                     if ('docblock' === $this->patchTypes['force']) {
  577.                         $this->patchMethod($method, $returnType, $declaringFile, $normalizedType);
  578.                     } elseif ('' !== $declaringClass && $this->patchTypes['deprecations']) {
  579.                         $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);
  580.                     }
  581.                 }
  582.             }
  584.             if (!$doc) {
  585.                 $this->patchTypes['force'] = $forcePatchTypes;
  587.                 continue;
  588.             }
  590.             if (isset($doc['return']) || 'void' !== (self::MAGIC_METHODS[$method->name] ?? 'void')) {
  591.                 $this->setReturnType($doc['return'] ?? self::MAGIC_METHODS[$method->name], $method->class, $method->name, $method->getFileName(), $parent, $method->getReturnType());
  593.                 if (isset(self::$returnTypes[$class][$method->name][0]) && $canAddReturnType) {
  594.                     $this->fixReturnStatements($method, self::$returnTypes[$class][$method->name][0]);
  595.                 }
  597.                 if ($method->isPrivate()) {
  598.                     unset(self::$returnTypes[$class][$method->name]);
  599.                 }
  600.             }
  602.             $this->patchTypes['force'] = $forcePatchTypes;
  604.             if ($method->isPrivate()) {
  605.                 continue;
  606.             }
  608.             $finalOrInternal = false;
  610.             foreach (['final', 'internal'] as $annotation) {
  611.                 if (null !== $description = $doc[$annotation][0] ?? null) {
  612.                     self::${$annotation.'Methods'}[$class][$method->name] = [$class, '' !== $description ? ' '.$description.(preg_match('/[[:punct:]]$/', $description) ? '' : '.') : '.'];
  613.                     $finalOrInternal = true;
  614.                 }
  615.             }
  617.             if ($finalOrInternal || $method->isConstructor() || !isset($doc['param']) || StatelessInvocation::class === $class) {
  618.                 continue;
  619.             }
  620.             if (!isset(self::$annotatedParameters[$class][$method->name])) {
  621.                 $definedParameters = [];
  622.                 foreach ($method->getParameters() as $parameter) {
  623.                     $definedParameters[$parameter->name] = true;
  624.                 }
  625.             }
  626.             foreach ($doc['param'] as $parameterName => $parameterType) {
  627.                 if (!isset($definedParameters[$parameterName])) {
  628.                     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);
  629.                 }
  630.             }
  631.         }
  633.         $finals = isset(self::$final[$class]) || $refl->isFinal() ? [] : [
  634.             'finalConstants' => $refl->getReflectionConstants(\ReflectionClassConstant::IS_PUBLIC | \ReflectionClassConstant::IS_PROTECTED),
  635.             'finalProperties' => $refl->getProperties(\ReflectionProperty::IS_PUBLIC | \ReflectionProperty::IS_PROTECTED),
  636.         ];
  637.         foreach ($finals as $type => $reflectors) {
  638.             foreach ($reflectors as $r) {
  639.                 if ($r->class !== $class) {
  640.                     continue;
  641.                 }
  643.                 $doc = $this->parsePhpDoc($r);
  645.                 foreach ($parentAndOwnInterfaces as $use) {
  646.                     if (isset(self::${$type}[$use][$r->name]) && !isset($doc['deprecated']) && ('finalConstants' === $type || substr($use, 0, strrpos($use, '\\')) !== substr($use, 0, strrpos($class, '\\')))) {
  647.                         $msg = 'finalConstants' === $type ? '%s" constant' : '$%s" property';
  648.                         $deprecations[] = sprintf('The "%s::'.$msg.' is considered final. You should not override it in "%s".', self::${$type}[$use][$r->name], $r->name, $class);
  649.                     }
  650.                 }
  652.                 if (isset($doc['final']) || ('finalProperties' === $type && str_starts_with($class, 'Symfony\\') && !$r->hasType())) {
  653.                     self::${$type}[$class][$r->name] = $class;
  654.                 }
  655.             }
  656.         }
  658.         return $deprecations;
  659.     }
  661.     public function checkCase(\ReflectionClass $refl, string $file, string $class): ?array
  662.     {
  663.         $real = explode('\\', $class.strrchr($file, '.'));
  664.         $tail = explode(\DIRECTORY_SEPARATOR, str_replace('/', \DIRECTORY_SEPARATOR, $file));
  666.         $i = \count($tail) - 1;
  667.         $j = \count($real) - 1;
  669.         while (isset($tail[$i], $real[$j]) && $tail[$i] === $real[$j]) {
  670.             --$i;
  671.             --$j;
  672.         }
  674.         array_splice($tail, 0, $i + 1);
  676.         if (!$tail) {
  677.             return null;
  678.         }
  680.         $tail = \DIRECTORY_SEPARATOR.implode(\DIRECTORY_SEPARATOR, $tail);
  681.         $tailLen = \strlen($tail);
  682.         $real = $refl->getFileName();
  684.         if (2 === self::$caseCheck) {
  685.             $real = $this->darwinRealpath($real);
  686.         }
  688.         if (0 === substr_compare($real, $tail, -$tailLen, $tailLen, true)
  689.             && 0 !== substr_compare($real, $tail, -$tailLen, $tailLen, false)
  690.         ) {
  691.             return [substr($tail, -$tailLen + 1), substr($real, -$tailLen + 1), substr($real, 0, -$tailLen + 1)];
  692.         }
  694.         return null;
  695.     }
  697.     /**
  698.      * `realpath` on MacOSX doesn't normalize the case of characters.
  699.      */
  700.     private function darwinRealpath(string $real): string
  701.     {
  702.         $i = 1 + strrpos($real, '/');
  703.         $file = substr($real, $i);
  704.         $real = substr($real, 0, $i);
  706.         if (isset(self::$darwinCache[$real])) {
  707.             $kDir = $real;
  708.         } else {
  709.             $kDir = strtolower($real);
  711.             if (isset(self::$darwinCache[$kDir])) {
  712.                 $real = self::$darwinCache[$kDir][0];
  713.             } else {
  714.                 $dir = getcwd();
  716.                 if (!@chdir($real)) {
  717.                     return $real.$file;
  718.                 }
  720.                 $real = getcwd().'/';
  721.                 chdir($dir);
  723.                 $dir = $real;
  724.                 $k = $kDir;
  725.                 $i = \strlen($dir) - 1;
  726.                 while (!isset(self::$darwinCache[$k])) {
  727.                     self::$darwinCache[$k] = [$dir, []];
  728.                     self::$darwinCache[$dir] = &self::$darwinCache[$k];
  730.                     while ('/' !== $dir[--$i]) {
  731.                     }
  732.                     $k = substr($k, 0, ++$i);
  733.                     $dir = substr($dir, 0, $i--);
  734.                 }
  735.             }
  736.         }
  738.         $dirFiles = self::$darwinCache[$kDir][1];
  740.         if (!isset($dirFiles[$file]) && str_ends_with($file, ') : eval()\'d code')) {
  741.             // Get the file name from "file_name.php(123) : eval()'d code"
  742.             $file = substr($file, 0, strrpos($file, '(', -17));
  743.         }
  745.         if (isset($dirFiles[$file])) {
  746.             return $real.$dirFiles[$file];
  747.         }
  749.         $kFile = strtolower($file);
  751.         if (!isset($dirFiles[$kFile])) {
  752.             foreach (scandir($real, 2) as $f) {
  753.                 if ('.' !== $f[0]) {
  754.                     $dirFiles[$f] = $f;
  755.                     if ($f === $file) {
  756.                         $kFile = $k = $file;
  757.                     } elseif ($f !== $k = strtolower($f)) {
  758.                         $dirFiles[$k] = $f;
  759.                     }
  760.                 }
  761.             }
  762.             self::$darwinCache[$kDir][1] = $dirFiles;
  763.         }
  765.         return $real.$dirFiles[$kFile];
  766.     }
  768.     /**
  769.      * `class_implements` includes interfaces from the parents so we have to manually exclude them.
  770.      *
  771.      * @return string[]
  772.      */
  773.     private function getOwnInterfaces(string $class, ?string $parent): array
  774.     {
  775.         $ownInterfaces = class_implements($class, false);
  777.         if ($parent) {
  778.             foreach (class_implements($parent, false) as $interface) {
  779.                 unset($ownInterfaces[$interface]);
  780.             }
  781.         }
  783.         foreach ($ownInterfaces as $interface) {
  784.             foreach (class_implements($interface) as $interface) {
  785.                 unset($ownInterfaces[$interface]);
  786.             }
  787.         }
  789.         return $ownInterfaces;
  790.     }
  792.     private function setReturnType(string $types, string $class, string $method, string $filename, ?string $parent, \ReflectionType $returnType = null): void
  793.     {
  794.         if ('__construct' === $method) {
  795.             return;
  796.         }
  798.         if ($nullable = str_starts_with($types, 'null|')) {
  799.             $types = substr($types, 5);
  800.         } elseif ($nullable = str_ends_with($types, '|null')) {
  801.             $types = substr($types, 0, -5);
  802.         }
  803.         $arrayType = ['array' => 'array'];
  804.         $typesMap = [];
  805.         $glue = str_contains($types, '&') ? '&' : '|';
  806.         foreach (explode($glue, $types) as $t) {
  807.             $t = self::SPECIAL_RETURN_TYPES[strtolower($t)] ?? $t;
  808.             $typesMap[$this->normalizeType($t, $class, $parent, $returnType)][$t] = $t;
  809.         }
  811.         if (isset($typesMap['array'])) {
  812.             if (isset($typesMap['Traversable']) || isset($typesMap['\Traversable'])) {
  813.                 $typesMap['iterable'] = $arrayType !== $typesMap['array'] ? $typesMap['array'] : ['iterable'];
  814.                 unset($typesMap['array'], $typesMap['Traversable'], $typesMap['\Traversable']);
  815.             } elseif ($arrayType !== $typesMap['array'] && isset(self::$returnTypes[$class][$method]) && !$returnType) {
  816.                 return;
  817.             }
  818.         }
  820.         if (isset($typesMap['array']) && isset($typesMap['iterable'])) {
  821.             if ($arrayType !== $typesMap['array']) {
  822.                 $typesMap['iterable'] = $typesMap['array'];
  823.             }
  824.             unset($typesMap['array']);
  825.         }
  827.         $iterable = $object = true;
  828.         foreach ($typesMap as $n => $t) {
  829.             if ('null' !== $n) {
  830.                 $iterable = $iterable && (\in_array($n, ['array', 'iterable']) || str_contains($n, 'Iterator'));
  831.                 $object = $object && (\in_array($n, ['callable', 'object', '$this', 'static']) || !isset(self::SPECIAL_RETURN_TYPES[$n]));
  832.             }
  833.         }
  835.         $phpTypes = [];
  836.         $docTypes = [];
  838.         foreach ($typesMap as $n => $t) {
  839.             if ('null' === $n) {
  840.                 $nullable = true;
  841.                 continue;
  842.             }
  844.             $docTypes[] = $t;
  846.             if ('mixed' === $n || 'void' === $n) {
  847.                 $nullable = false;
  848.                 $phpTypes = ['' => $n];
  849.                 continue;
  850.             }
  852.             if ('resource' === $n) {
  853.                 // there is no native type for "resource"
  854.                 return;
  855.             }
  857.             if (!isset($phpTypes[''])) {
  858.                 $phpTypes[] = $n;
  859.             }
  860.         }
  861.         $docTypes = array_merge([], ...$docTypes);
  863.         if (!$phpTypes) {
  864.             return;
  865.         }
  867.         if (1 < \count($phpTypes)) {
  868.             if ($iterable && '8.0' > $this->patchTypes['php']) {
  869.                 $phpTypes = $docTypes = ['iterable'];
  870.             } elseif ($object && 'object' === $this->patchTypes['force']) {
  871.                 $phpTypes = $docTypes = ['object'];
  872.             } elseif ('8.0' > $this->patchTypes['php']) {
  873.                 // ignore multi-types return declarations
  874.                 return;
  875.             }
  876.         }
  878.         $phpType = sprintf($nullable ? (1 < \count($phpTypes) ? '%s|null' : '?%s') : '%s', implode($glue, $phpTypes));
  879.         $docType = sprintf($nullable ? '%s|null' : '%s', implode($glue, $docTypes));
  881.         self::$returnTypes[$class][$method] = [$phpType, $docType, $class, $filename];
  882.     }
  884.     private function normalizeType(string $type, string $class, ?string $parent, ?\ReflectionType $returnType): string
  885.     {
  886.         if (isset(self::SPECIAL_RETURN_TYPES[$lcType = strtolower($type)])) {
  887.             if ('parent' === $lcType = self::SPECIAL_RETURN_TYPES[$lcType]) {
  888.                 $lcType = null !== $parent ? '\\'.$parent : 'parent';
  889.             } elseif ('self' === $lcType) {
  890.                 $lcType = '\\'.$class;
  891.             }
  893.             return $lcType;
  894.         }
  896.         // We could resolve "use" statements to return the FQDN
  897.         // but this would be too expensive for a runtime checker
  899.         if (!str_ends_with($type, '[]')) {
  900.             return $type;
  901.         }
  903.         if ($returnType instanceof \ReflectionNamedType) {
  904.             $type = $returnType->getName();
  906.             if ('mixed' !== $type) {
  907.                 return isset(self::SPECIAL_RETURN_TYPES[$type]) ? $type : '\\'.$type;
  908.             }
  909.         }
  911.         return 'array';
  912.     }
  914.     /**
  915.      * Utility method to add #[ReturnTypeWillChange] where php triggers deprecations.
  916.      */
  917.     private function patchReturnTypeWillChange(\ReflectionMethod $method)
  918.     {
  919.         if (\count($method->getAttributes(\ReturnTypeWillChange::class))) {
  920.             return;
  921.         }
  923.         if (!is_file($file = $method->getFileName())) {
  924.             return;
  925.         }
  927.         $fileOffset = self::$fileOffsets[$file] ?? 0;
  929.         $code = file($file);
  931.         $startLine = $method->getStartLine() + $fileOffset - 2;
  933.         if (false !== stripos($code[$startLine], 'ReturnTypeWillChange')) {
  934.             return;
  935.         }
  937.         $code[$startLine] .= "    #[\\ReturnTypeWillChange]\n";
  938.         self::$fileOffsets[$file] = 1 + $fileOffset;
  939.         file_put_contents($file, $code);
  940.     }
  942.     /**
  943.      * Utility method to add @return annotations to the Symfony code-base where it triggers self-deprecations.
  944.      */
  945.     private function patchMethod(\ReflectionMethod $method, string $returnType, string $declaringFile, string $normalizedType)
  946.     {
  947.         static $patchedMethods = [];
  948.         static $useStatements = [];
  950.         if (!is_file($file = $method->getFileName()) || isset($patchedMethods[$file][$startLine = $method->getStartLine()])) {
  951.             return;
  952.         }
  954.         $patchedMethods[$file][$startLine] = true;
  955.         $fileOffset = self::$fileOffsets[$file] ?? 0;
  956.         $startLine += $fileOffset - 2;
  957.         if ($nullable = str_ends_with($returnType, '|null')) {
  958.             $returnType = substr($returnType, 0, -5);
  959.         }
  960.         $glue = str_contains($returnType, '&') ? '&' : '|';
  961.         $returnType = explode($glue, $returnType);
  962.         $code = file($file);
  964.         foreach ($returnType as $i => $type) {
  965.             if (preg_match('/((?:\[\])+)$/', $type, $m)) {
  966.                 $type = substr($type, 0, -\strlen($m[1]));
  967.                 $format = '%s'.$m[1];
  968.             } else {
  969.                 $format = null;
  970.             }
  972.             if (isset(self::SPECIAL_RETURN_TYPES[$type]) || ('\\' === $type[0] && !$p = strrpos($type, '\\', 1))) {
  973.                 continue;
  974.             }
  976.             [$namespace, $useOffset, $useMap] = $useStatements[$file] ??= self::getUseStatements($file);
  978.             if ('\\' !== $type[0]) {
  979.                 [$declaringNamespace, , $declaringUseMap] = $useStatements[$declaringFile] ??= self::getUseStatements($declaringFile);
  981.                 $p = strpos($type, '\\', 1);
  982.                 $alias = $p ? substr($type, 0, $p) : $type;
  984.                 if (isset($declaringUseMap[$alias])) {
  985.                     $type = '\\'.$declaringUseMap[$alias].($p ? substr($type, $p) : '');
  986.                 } else {
  987.                     $type = '\\'.$declaringNamespace.$type;
  988.                 }
  990.                 $p = strrpos($type, '\\', 1);
  991.             }
  993.             $alias = substr($type, 1 + $p);
  994.             $type = substr($type, 1);
  996.             if (!isset($useMap[$alias]) && (class_exists($c = $namespace.$alias) || interface_exists($c) || trait_exists($c))) {
  997.                 $useMap[$alias] = $c;
  998.             }
  1000.             if (!isset($useMap[$alias])) {
  1001.                 $useStatements[$file][2][$alias] = $type;
  1002.                 $code[$useOffset] = "use $type;\n".$code[$useOffset];
  1003.                 ++$fileOffset;
  1004.             } elseif ($useMap[$alias] !== $type) {
  1005.                 $alias .= 'FIXME';
  1006.                 $useStatements[$file][2][$alias] = $type;
  1007.                 $code[$useOffset] = "use $type as $alias;\n".$code[$useOffset];
  1008.                 ++$fileOffset;
  1009.             }
  1011.             $returnType[$i] = null !== $format ? sprintf($format, $alias) : $alias;
  1012.         }
  1014.         if ('docblock' === $this->patchTypes['force'] || ('object' === $normalizedType && '7.1' === $this->patchTypes['php'])) {
  1015.             $returnType = implode($glue, $returnType).($nullable ? '|null' : '');
  1017.             if (str_contains($code[$startLine], '#[')) {
  1018.                 --$startLine;
  1019.             }
  1021.             if ($method->getDocComment()) {
  1022.                 $code[$startLine] = "     * @return $returnType\n".$code[$startLine];
  1023.             } else {
  1024.                 $code[$startLine] .= <<<EOTXT
  1025.     /**
  1026.      * @return $returnType
  1027.      */
  1029. EOTXT;
  1030.             }
  1032.             $fileOffset += substr_count($code[$startLine], "\n") - 1;
  1033.         }
  1035.         self::$fileOffsets[$file] = $fileOffset;
  1036.         file_put_contents($file, $code);
  1038.         $this->fixReturnStatements($method, $normalizedType);
  1039.     }
  1041.     private static function getUseStatements(string $file): array
  1042.     {
  1043.         $namespace = '';
  1044.         $useMap = [];
  1045.         $useOffset = 0;
  1047.         if (!is_file($file)) {
  1048.             return [$namespace, $useOffset, $useMap];
  1049.         }
  1051.         $file = file($file);
  1053.         for ($i = 0; $i < \count($file); ++$i) {
  1054.             if (preg_match('/^(class|interface|trait|abstract) /', $file[$i])) {
  1055.                 break;
  1056.             }
  1058.             if (str_starts_with($file[$i], 'namespace ')) {
  1059.                 $namespace = substr($file[$i], \strlen('namespace '), -2).'\\';
  1060.                 $useOffset = $i + 2;
  1061.             }
  1063.             if (str_starts_with($file[$i], 'use ')) {
  1064.                 $useOffset = $i;
  1066.                 for (; str_starts_with($file[$i], 'use '); ++$i) {
  1067.                     $u = explode(' as ', substr($file[$i], 4, -2), 2);
  1069.                     if (1 === \count($u)) {
  1070.                         $p = strrpos($u[0], '\\');
  1071.                         $useMap[substr($u[0], false !== $p ? 1 + $p : 0)] = $u[0];
  1072.                     } else {
  1073.                         $useMap[$u[1]] = $u[0];
  1074.                     }
  1075.                 }
  1077.                 break;
  1078.             }
  1079.         }
  1081.         return [$namespace, $useOffset, $useMap];
  1082.     }
  1084.     private function fixReturnStatements(\ReflectionMethod $method, string $returnType)
  1085.     {
  1086.         if ('docblock' !== $this->patchTypes['force']) {
  1087.             if ('7.1' === $this->patchTypes['php'] && 'object' === ltrim($returnType, '?')) {
  1088.                 return;
  1089.             }
  1091.             if ('7.4' > $this->patchTypes['php'] && $method->hasReturnType()) {
  1092.                 return;
  1093.             }
  1095.             if ('8.0' > $this->patchTypes['php'] && (str_contains($returnType, '|') || \in_array($returnType, ['mixed', 'static'], true))) {
  1096.                 return;
  1097.             }
  1099.             if ('8.1' > $this->patchTypes['php'] && str_contains($returnType, '&')) {
  1100.                 return;
  1101.             }
  1102.         }
  1104.         if (!is_file($file = $method->getFileName())) {
  1105.             return;
  1106.         }
  1108.         $fixedCode = $code = file($file);
  1109.         $i = (self::$fileOffsets[$file] ?? 0) + $method->getStartLine();
  1111.         if ('?' !== $returnType && 'docblock' !== $this->patchTypes['force']) {
  1112.             $fixedCode[$i - 1] = preg_replace('/\)(?::[^;\n]++)?(;?\n)/', "): $returnType\\1", $code[$i - 1]);
  1113.         }
  1115.         $end = $method->isGenerator() ? $i : $method->getEndLine();
  1116.         for (; $i < $end; ++$i) {
  1117.             if ('void' === $returnType) {
  1118.                 $fixedCode[$i] = str_replace('    return null;', '    return;', $code[$i]);
  1119.             } elseif ('mixed' === $returnType || '?' === $returnType[0]) {
  1120.                 $fixedCode[$i] = str_replace('    return;', '    return null;', $code[$i]);
  1121.             } else {
  1122.                 $fixedCode[$i] = str_replace('    return;', "    return $returnType!?;", $code[$i]);
  1123.             }
  1124.         }
  1126.         if ($fixedCode !== $code) {
  1127.             file_put_contents($file, $fixedCode);
  1128.         }
  1129.     }
  1131.     /**
  1132.      * @param \ReflectionClass|\ReflectionMethod|\ReflectionProperty $reflector
  1133.      */
  1134.     private function parsePhpDoc(\Reflector $reflector): array
  1135.     {
  1136.         if (!$doc = $reflector->getDocComment()) {
  1137.             return [];
  1138.         }
  1140.         $tagName = '';
  1141.         $tagContent = '';
  1143.         $tags = [];
  1145.         foreach (explode("\n", substr($doc, 3, -2)) as $line) {
  1146.             $line = ltrim($line);
  1147.             $line = ltrim($line, '*');
  1149.             if ('' === $line = trim($line)) {
  1150.                 if ('' !== $tagName) {
  1151.                     $tags[$tagName][] = $tagContent;
  1152.                 }
  1153.                 $tagName = $tagContent = '';
  1154.                 continue;
  1155.             }
  1157.             if ('@' === $line[0]) {
  1158.                 if ('' !== $tagName) {
  1159.                     $tags[$tagName][] = $tagContent;
  1160.                     $tagContent = '';
  1161.                 }
  1163.                 if (preg_match('{^@([-a-zA-Z0-9_:]++)(\s|$)}', $line, $m)) {
  1164.                     $tagName = $m[1];
  1165.                     $tagContent = str_replace("\t", ' ', ltrim(substr($line, 2 + \strlen($tagName))));
  1166.                 } else {
  1167.                     $tagName = '';
  1168.                 }
  1169.             } elseif ('' !== $tagName) {
  1170.                 $tagContent .= ' '.str_replace("\t", ' ', $line);
  1171.             }
  1172.         }
  1174.         if ('' !== $tagName) {
  1175.             $tags[$tagName][] = $tagContent;
  1176.         }
  1178.         foreach ($tags['method'] ?? [] as $i => $method) {
  1179.             unset($tags['method'][$i]);
  1181.             $parts = preg_split('{(\s++|\((?:[^()]*+|(?R))*\)(?: *: *[^ ]++)?|<(?:[^<>]*+|(?R))*>|\{(?:[^{}]*+|(?R))*\})}', $method, -1, \PREG_SPLIT_DELIM_CAPTURE);
  1182.             $returnType = '';
  1183.             $static = 'static' === $parts[0];
  1185.             for ($i = $static ? 2 : 0; null !== $p = $parts[$i] ?? null; $i += 2) {
  1186.                 if (\in_array($p, ['', '|', '&', 'callable'], true) || \in_array(substr($returnType, -1), ['|', '&'], true)) {
  1187.                     $returnType .= trim($parts[$i - 1] ?? '').$p;
  1188.                     continue;
  1189.                 }
  1191.                 $signature = '(' === ($parts[$i + 1][0] ?? '(') ? $parts[$i + 1] ?? '()' : null;
  1193.                 if (null === $signature && '' === $returnType) {
  1194.                     $returnType = $p;
  1195.                     continue;
  1196.                 }
  1198.                 if ($static && 2 === $i) {
  1199.                     $static = false;
  1200.                     $returnType = 'static';
  1201.                 }
  1203.                 if (\in_array($description = trim(implode('', \array_slice($parts, 2 + $i))), ['', '.'], true)) {
  1204.                     $description = null;
  1205.                 } elseif (!preg_match('/[.!]$/', $description)) {
  1206.                     $description .= '.';
  1207.                 }
  1209.                 $tags['method'][$p] = [$static, $returnType, $signature ?? '()', $description];
  1210.                 break;
  1211.             }
  1212.         }
  1214.         foreach ($tags['param'] ?? [] as $i => $param) {
  1215.             unset($tags['param'][$i]);
  1217.             if (\strlen($param) !== strcspn($param, '<{(')) {
  1218.                 $param = preg_replace('{\(([^()]*+|(?R))*\)(?: *: *[^ ]++)?|<([^<>]*+|(?R))*>|\{([^{}]*+|(?R))*\}}', '', $param);
  1219.             }
  1221.             if (false === $i = strpos($param, '$')) {
  1222.                 continue;
  1223.             }
  1225.             $type = 0 === $i ? '' : rtrim(substr($param, 0, $i), ' &');
  1226.             $param = substr($param, 1 + $i, (strpos($param, ' ', $i) ?: (1 + $i + \strlen($param))) - $i - 1);
  1228.             $tags['param'][$param] = $type;
  1229.         }
  1231.         foreach (['var', 'return'] as $k) {
  1232.             if (null === $v = $tags[$k][0] ?? null) {
  1233.                 continue;
  1234.             }
  1235.             if (\strlen($v) !== strcspn($v, '<{(')) {
  1236.                 $v = preg_replace('{\(([^()]*+|(?R))*\)(?: *: *[^ ]++)?|<([^<>]*+|(?R))*>|\{([^{}]*+|(?R))*\}}', '', $v);
  1237.             }
  1239.             $tags[$k] = substr($v, 0, strpos($v, ' ') ?: \strlen($v)) ?: null;
  1240.         }
  1242.         return $tags;
  1243.     }
  1244. }