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

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