vendor/symfony/validator/Mapping/Factory/LazyLoadingMetadataFactory.php line 71

  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\Validator\Mapping\Factory;
  14. use Psr\Cache\CacheItemPoolInterface;
  15. use Symfony\Component\Validator\Exception\NoSuchMetadataException;
  16. use Symfony\Component\Validator\Mapping\ClassMetadata;
  17. use Symfony\Component\Validator\Mapping\Loader\LoaderInterface;
  18. use Symfony\Component\Validator\Mapping\MetadataInterface;
  20. /**
  21.  * Creates new {@link ClassMetadataInterface} instances.
  22.  *
  23.  * Whenever {@link getMetadataFor()} is called for the first time with a given
  24.  * class name or object of that class, a new metadata instance is created and
  25.  * returned. On subsequent requests for the same class, the same metadata
  26.  * instance will be returned.
  27.  *
  28.  * You can optionally pass a {@link LoaderInterface} instance to the constructor.
  29.  * Whenever a new metadata instance is created, it is passed to the loader,
  30.  * which can configure the metadata based on configuration loaded from the
  31.  * filesystem or a database. If you want to use multiple loaders, wrap them in a
  32.  * {@link LoaderChain}.
  33.  *
  34.  * You can also optionally pass a {@link CacheInterface} instance to the
  35.  * constructor. This cache will be used for persisting the generated metadata
  36.  * between multiple PHP requests.
  37.  *
  38.  * @author Bernhard Schussek <bschussek@gmail.com>
  39.  */
  40. class LazyLoadingMetadataFactory implements MetadataFactoryInterface
  41. {
  42.     protected $loader;
  43.     protected $cache;
  45.     /**
  46.      * The loaded metadata, indexed by class name.
  47.      *
  48.      * @var ClassMetadata[]
  49.      */
  50.     protected $loadedClasses = [];
  52.     public function __construct(LoaderInterface $loader = null, CacheItemPoolInterface $cache = null)
  53.     {
  54.         $this->loader = $loader;
  55.         $this->cache = $cache;
  56.     }
  58.     /**
  59.      * If the method was called with the same class name (or an object of that
  60.      * class) before, the same metadata instance is returned.
  61.      *
  62.      * If the factory was configured with a cache, this method will first look
  63.      * for an existing metadata instance in the cache. If an existing instance
  64.      * is found, it will be returned without further ado.
  65.      *
  66.      * Otherwise, a new metadata instance is created. If the factory was
  67.      * configured with a loader, the metadata is passed to the
  68.      * {@link LoaderInterface::loadClassMetadata()} method for further
  69.      * configuration. At last, the new object is returned.
  70.      */
  71.     public function getMetadataFor(mixed $value): MetadataInterface
  72.     {
  73.         if (!\is_object($value) && !\is_string($value)) {
  74.             throw new NoSuchMetadataException(sprintf('Cannot create metadata for non-objects. Got: "%s".', get_debug_type($value)));
  75.         }
  77.         $class = ltrim(\is_object($value) ? $value::class : $value, '\\');
  79.         if (isset($this->loadedClasses[$class])) {
  80.             return $this->loadedClasses[$class];
  81.         }
  83.         if (!class_exists($class) && !interface_exists($class, false)) {
  84.             throw new NoSuchMetadataException(sprintf('The class or interface "%s" does not exist.', $class));
  85.         }
  87.         $cacheItem = $this->cache?->getItem($this->escapeClassName($class));
  88.         if ($cacheItem?->isHit()) {
  89.             $metadata = $cacheItem->get();
  91.             // Include constraints from the parent class
  92.             $this->mergeConstraints($metadata);
  94.             return $this->loadedClasses[$class] = $metadata;
  95.         }
  97.         $metadata = new ClassMetadata($class);
  99.         $this->loader?->loadClassMetadata($metadata);
  101.         if (null !== $cacheItem) {
  102.             $this->cache->save($cacheItem->set($metadata));
  103.         }
  105.         // Include constraints from the parent class
  106.         $this->mergeConstraints($metadata);
  108.         return $this->loadedClasses[$class] = $metadata;
  109.     }
  111.     private function mergeConstraints(ClassMetadata $metadata)
  112.     {
  113.         if ($metadata->getReflectionClass()->isInterface()) {
  114.             return;
  115.         }
  117.         // Include constraints from the parent class
  118.         if ($parent = $metadata->getReflectionClass()->getParentClass()) {
  119.             $metadata->mergeConstraints($this->getMetadataFor($parent->name));
  120.         }
  122.         // Include constraints from all directly implemented interfaces
  123.         foreach ($metadata->getReflectionClass()->getInterfaces() as $interface) {
  124.             if ('Symfony\Component\Validator\GroupSequenceProviderInterface' === $interface->name) {
  125.                 continue;
  126.             }
  128.             if ($parent && \in_array($interface->getName(), $parent->getInterfaceNames(), true)) {
  129.                 continue;
  130.             }
  132.             $metadata->mergeConstraints($this->getMetadataFor($interface->name));
  133.         }
  134.     }
  136.     public function hasMetadataFor(mixed $value): bool
  137.     {
  138.         if (!\is_object($value) && !\is_string($value)) {
  139.             return false;
  140.         }
  142.         $class = ltrim(\is_object($value) ? $value::class : $value, '\\');
  144.         return class_exists($class) || interface_exists($class, false);
  145.     }
  147.     /**
  148.      * Replaces backslashes by dots in a class name.
  149.      */
  150.     private function escapeClassName(string $class): string
  151.     {
  152.         if (str_contains($class, '@')) {
  153.             // anonymous class: replace all PSR6-reserved characters
  154.             return str_replace(["\0", '\\', '/', '@', ':', '{', '}', '(', ')'], '.', $class);
  155.         }
  157.         return str_replace('\\', '.', $class);
  158.     }
  159. }