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

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