class LazyLoadingMetadataFactory
Creates new {@link ClassMetadataInterface} instances.
Whenever {@link getMetadataFor()} is called for the first time with a given class name or object of that class, a new metadata instance is created and returned. On subsequent requests for the same class, the same metadata instance will be returned.
You can optionally pass a {@link LoaderInterface} instance to the constructor. Whenever a new metadata instance is created, it is passed to the loader, which can configure the metadata based on configuration loaded from the filesystem or a database. If you want to use multiple loaders, wrap them in a {@link LoaderChain}.
You can also optionally pass a {@link CacheInterface} instance to the constructor. This cache will be used for persisting the generated metadata between multiple PHP requests.
@author Bernhard Schussek <bschussek@gmail.com>
Hierarchy
- class \Symfony\Component\Validator\Mapping\Factory\LazyLoadingMetadataFactory implements \Symfony\Component\Validator\Mapping\Factory\MetadataFactoryInterface
Expanded class hierarchy of LazyLoadingMetadataFactory
2 files declare their use of LazyLoadingMetadataFactory
- BasicRecursiveValidatorFactory.php in core/
lib/ Drupal/ Core/ Validation/ BasicRecursiveValidatorFactory.php - ValidatorBuilder.php in vendor/
symfony/ validator/ ValidatorBuilder.php
File
-
vendor/
symfony/ validator/ Mapping/ Factory/ LazyLoadingMetadataFactory.php, line 40
Namespace
Symfony\Component\Validator\Mapping\FactoryView source
class LazyLoadingMetadataFactory implements MetadataFactoryInterface {
/**
* The loaded metadata, indexed by class name.
*
* @var ClassMetadata[]
*/
protected array $loadedClasses = [];
public function __construct(?LoaderInterface $loader = null, ?CacheItemPoolInterface $cache = null) {
}
/**
* If the method was called with the same class name (or an object of that
* class) before, the same metadata instance is returned.
*
* If the factory was configured with a cache, this method will first look
* for an existing metadata instance in the cache. If an existing instance
* is found, it will be returned without further ado.
*
* Otherwise, a new metadata instance is created. If the factory was
* configured with a loader, the metadata is passed to the
* {@link LoaderInterface::loadClassMetadata()} method for further
* configuration. At last, the new object is returned.
*/
public function getMetadataFor(mixed $value) : MetadataInterface {
if (!\is_object($value) && !\is_string($value)) {
throw new NoSuchMetadataException(\sprintf('Cannot create metadata for non-objects. Got: "%s".', get_debug_type($value)));
}
$class = ltrim(\is_object($value) ? $value::class : $value, '\\');
if (isset($this->loadedClasses[$class])) {
return $this->loadedClasses[$class];
}
if (!class_exists($class) && !interface_exists($class, false)) {
throw new NoSuchMetadataException(\sprintf('The class or interface "%s" does not exist.', $class));
}
$cacheItem = $this->cache?->getItem($this->escapeClassName($class));
if ($cacheItem?->isHit()) {
$metadata = $cacheItem->get();
// Include constraints from the parent class
$this->mergeConstraints($metadata);
return $this->loadedClasses[$class] = $metadata;
}
$metadata = new ClassMetadata($class);
$this->loader?->loadClassMetadata($metadata);
if (null !== $cacheItem) {
$this->cache
->save($cacheItem->set($metadata));
}
// Include constraints from the parent class
$this->mergeConstraints($metadata);
return $this->loadedClasses[$class] = $metadata;
}
private function mergeConstraints(ClassMetadata $metadata) : void {
if ($metadata->getReflectionClass()
->isInterface()) {
return;
}
// Include constraints from the parent class
if ($parent = $metadata->getReflectionClass()
->getParentClass()) {
$metadata->mergeConstraints($this->getMetadataFor($parent->name));
}
// Include constraints from all directly implemented interfaces
foreach ($metadata->getReflectionClass()
->getInterfaces() as $interface) {
if ('Symfony\\Component\\Validator\\GroupSequenceProviderInterface' === $interface->name) {
continue;
}
if ($parent && \in_array($interface->getName(), $parent->getInterfaceNames(), true)) {
continue;
}
$metadata->mergeConstraints($this->getMetadataFor($interface->name));
}
}
public function hasMetadataFor(mixed $value) : bool {
if (!\is_object($value) && !\is_string($value)) {
return false;
}
$class = ltrim(\is_object($value) ? $value::class : $value, '\\');
return class_exists($class) || interface_exists($class, false);
}
/**
* Replaces backslashes by dots in a class name.
*/
private function escapeClassName(string $class) : string {
if (str_contains($class, '@')) {
// anonymous class: replace all PSR6-reserved characters
return str_replace([
"\x00",
'\\',
'/',
'@',
':',
'{',
'}',
'(',
')',
], '.', $class);
}
return str_replace('\\', '.', $class);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
LazyLoadingMetadataFactory::$loadedClasses | protected | property | The loaded metadata, indexed by class name. | |
LazyLoadingMetadataFactory::escapeClassName | private | function | Replaces backslashes by dots in a class name. | |
LazyLoadingMetadataFactory::getMetadataFor | public | function | If the method was called with the same class name (or an object of that class) before, the same metadata instance is returned. |
Overrides MetadataFactoryInterface::getMetadataFor |
LazyLoadingMetadataFactory::hasMetadataFor | public | function | Returns whether the class is able to return metadata for the given value. | Overrides MetadataFactoryInterface::hasMetadataFor |
LazyLoadingMetadataFactory::mergeConstraints | private | function | ||
LazyLoadingMetadataFactory::__construct | public | function |