vendor/symfony/config/Resource/ClassExistenceResource.php line 76

  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\Config\Resource;
  14. /**
  15.  * ClassExistenceResource represents a class existence.
  16.  * Freshness is only evaluated against resource existence.
  17.  *
  18.  * The resource must be a fully-qualified class name.
  19.  *
  20.  * @author Fabien Potencier <fabien@symfony.com>
  21.  *
  22.  * @final
  23.  */
  24. class ClassExistenceResource implements SelfCheckingResourceInterface
  25. {
  26.     private string $resource;
  27.     private ?array $exists = null;
  29.     private static int $autoloadLevel = 0;
  30.     private static ?string $autoloadedClass = null;
  31.     private static array $existsCache = [];
  33.     /**
  34.      * @param string    $resource The fully-qualified class name
  35.      * @param bool|null $exists   Boolean when the existence check has already been done
  36.      */
  37.     public function __construct(string $resource, bool $exists = null)
  38.     {
  39.         $this->resource = $resource;
  40.         if (null !== $exists) {
  41.             $this->exists = [$exists, null];
  42.         }
  43.     }
  45.     public function __toString(): string
  46.     {
  47.         return $this->resource;
  48.     }
  50.     public function getResource(): string
  51.     {
  52.         return $this->resource;
  53.     }
  55.     /**
  56.      * @throws \ReflectionException when a parent class/interface/trait is not found
  57.      */
  58.     public function isFresh(int $timestamp): bool
  59.     {
  60.         $loaded = class_exists($this->resource, false) || interface_exists($this->resource, false) || trait_exists($this->resource, false);
  62.         if (null !== $exists = &self::$existsCache[$this->resource]) {
  63.             if ($loaded) {
  64.                 $exists = [true, null];
  65.             } elseif (0 >= $timestamp && !$exists[0] && null !== $exists[1]) {
  66.                 throw new \ReflectionException($exists[1]);
  67.             }
  68.         } elseif ([false, null] === $exists = [$loaded, null]) {
  69.             if (!self::$autoloadLevel++) {
  70.                 spl_autoload_register(__CLASS__.'::throwOnRequiredClass');
  71.             }
  72.             $autoloadedClass = self::$autoloadedClass;
  73.             self::$autoloadedClass = ltrim($this->resource, '\\');
  75.             try {
  76.                 $exists[0] = class_exists($this->resource) || interface_exists($this->resource, false) || trait_exists($this->resource, false);
  77.             } catch (\Exception $e) {
  78.                 $exists[1] = $e->getMessage();
  80.                 try {
  81.                     self::throwOnRequiredClass($this->resource, $e);
  82.                 } catch (\ReflectionException $e) {
  83.                     if (0 >= $timestamp) {
  84.                         throw $e;
  85.                     }
  86.                 }
  87.             } catch (\Throwable $e) {
  88.                 $exists[1] = $e->getMessage();
  90.                 throw $e;
  91.             } finally {
  92.                 self::$autoloadedClass = $autoloadedClass;
  93.                 if (!--self::$autoloadLevel) {
  94.                     spl_autoload_unregister(__CLASS__.'::throwOnRequiredClass');
  95.                 }
  96.             }
  97.         }
  99.         $this->exists ??= $exists;
  101.         return $this->exists[0] xor !$exists[0];
  102.     }
  104.     /**
  105.      * @internal
  106.      */
  107.     public function __sleep(): array
  108.     {
  109.         if (null === $this->exists) {
  110.             $this->isFresh(0);
  111.         }
  113.         return ['resource', 'exists'];
  114.     }
  116.     /**
  117.      * @internal
  118.      */
  119.     public function __wakeup()
  120.     {
  121.         if (\is_bool($this->exists)) {
  122.             $this->exists = [$this->exists, null];
  123.         }
  124.     }
  126.     /**
  127.      * Throws a reflection exception when the passed class does not exist but is required.
  128.      *
  129.      * A class is considered "not required" when it's loaded as part of a "class_exists" or similar check.
  130.      *
  131.      * This function can be used as an autoload function to throw a reflection
  132.      * exception if the class was not found by previous autoload functions.
  133.      *
  134.      * A previous exception can be passed. In this case, the class is considered as being
  135.      * required totally, so if it doesn't exist, a reflection exception is always thrown.
  136.      * If it exists, the previous exception is rethrown.
  137.      *
  138.      * @throws \ReflectionException
  139.      *
  140.      * @internal
  141.      */
  142.     public static function throwOnRequiredClass(string $class, \Exception $previous = null)
  143.     {
  144.         // If the passed class is the resource being checked, we shouldn't throw.
  145.         if (null === $previous && self::$autoloadedClass === $class) {
  146.             return;
  147.         }
  149.         if (class_exists($class, false) || interface_exists($class, false) || trait_exists($class, false)) {
  150.             if (null !== $previous) {
  151.                 throw $previous;
  152.             }
  154.             return;
  155.         }
  157.         if ($previous instanceof \ReflectionException) {
  158.             throw $previous;
  159.         }
  161.         $message = sprintf('Class "%s" not found.', $class);
  163.         if (self::$autoloadedClass !== $class) {
  164.             $message = substr_replace($message, sprintf(' while loading "%s"', self::$autoloadedClass), -1, 0);
  165.         }
  167.         if (null !== $previous) {
  168.             $message = $previous->getMessage();
  169.         }
  171.         $e = new \ReflectionException($message, 0, $previous);
  173.         if (null !== $previous) {
  174.             throw $e;
  175.         }
  177.         $trace = debug_backtrace();
  178.         $autoloadFrame = [
  179.             'function' => 'spl_autoload_call',
  180.             'args' => [$class],
  181.         ];
  183.         if (isset($trace[1])) {
  184.             $callerFrame = $trace[1];
  185.             $i = 2;
  186.         } elseif (false !== $i = array_search($autoloadFrame, $trace, true)) {
  187.             $callerFrame = $trace[++$i];
  188.         } else {
  189.             throw $e;
  190.         }
  192.         if (isset($callerFrame['function']) && !isset($callerFrame['class'])) {
  193.             switch ($callerFrame['function']) {
  194.                 case 'get_class_methods':
  195.                 case 'get_class_vars':
  196.                 case 'get_parent_class':
  197.                 case 'is_a':
  198.                 case 'is_subclass_of':
  199.                 case 'class_exists':
  200.                 case 'class_implements':
  201.                 case 'class_parents':
  202.                 case 'trait_exists':
  203.                 case 'defined':
  204.                 case 'interface_exists':
  205.                 case 'method_exists':
  206.                 case 'property_exists':
  207.                 case 'is_callable':
  208.                     return;
  209.             }
  211.             $props = [
  212.                 'file' => $callerFrame['file'] ?? null,
  213.                 'line' => $callerFrame['line'] ?? null,
  214.                 'trace' => \array_slice($trace, 1 + $i),
  215.             ];
  217.             foreach ($props as $p => $v) {
  218.                 if (null !== $v) {
  219.                     $r = new \ReflectionProperty(\Exception::class, $p);
  220.                     $r->setValue($e, $v);
  221.                 }
  222.             }
  223.         }
  225.         throw $e;
  226.     }
  227. }