vendor/symfony/validator/Mapping/Loader/AbstractLoader.php line 73

  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\Loader;
  14. use Symfony\Component\Validator\Attribute\HasNamedArguments;
  15. use Symfony\Component\Validator\Constraint;
  16. use Symfony\Component\Validator\Exception\MappingException;
  18. /**
  19.  * Base loader for validation metadata.
  20.  *
  21.  * This loader supports the loading of constraints from Symfony's default
  22.  * namespace (see {@link DEFAULT_NAMESPACE}) using the short class names of
  23.  * those constraints. Constraints can also be loaded using their fully
  24.  * qualified class names. At last, namespace aliases can be defined to load
  25.  * constraints with the syntax "alias:ShortName".
  26.  *
  27.  * @author Bernhard Schussek <bschussek@gmail.com>
  28.  */
  29. abstract class AbstractLoader implements LoaderInterface
  30. {
  31.     /**
  32.      * The namespace to load constraints from by default.
  33.      */
  34.     public const DEFAULT_NAMESPACE = '\\Symfony\\Component\\Validator\\Constraints\\';
  36.     protected $namespaces = [];
  38.     /**
  39.      * @var array<class-string, bool>
  40.      */
  41.     private array $namedArgumentsCache = [];
  43.     /**
  44.      * Adds a namespace alias.
  45.      *
  46.      * The namespace alias can be used to reference constraints from specific
  47.      * namespaces in {@link newConstraint()}:
  48.      *
  49.      *     $this->addNamespaceAlias('mynamespace', '\\Acme\\Package\\Constraints\\');
  50.      *
  51.      *     $constraint = $this->newConstraint('mynamespace:NotNull');
  52.      */
  53.     protected function addNamespaceAlias(string $alias, string $namespace)
  54.     {
  55.         $this->namespaces[$alias] = $namespace;
  56.     }
  58.     /**
  59.      * Creates a new constraint instance for the given constraint name.
  60.      *
  61.      * @param string $name    The constraint name. Either a constraint relative
  62.      *                        to the default constraint namespace, or a fully
  63.      *                        qualified class name. Alternatively, the constraint
  64.      *                        may be preceded by a namespace alias and a colon.
  65.      *                        The namespace alias must have been defined using
  66.      *                        {@link addNamespaceAlias()}.
  67.      * @param mixed  $options The constraint options
  68.      *
  69.      * @throws MappingException If the namespace prefix is undefined
  70.      */
  71.     protected function newConstraint(string $name, mixed $options = null): Constraint
  72.     {
  73.         if (str_contains($name, '\\') && class_exists($name)) {
  74.             $className = $name;
  75.         } elseif (str_contains($name, ':')) {
  76.             [$prefix, $className] = explode(':', $name, 2);
  78.             if (!isset($this->namespaces[$prefix])) {
  79.                 throw new MappingException(sprintf('Undefined namespace prefix "%s".', $prefix));
  80.             }
  82.             $className = $this->namespaces[$prefix].$className;
  83.         } else {
  84.             $className = self::DEFAULT_NAMESPACE.$name;
  85.         }
  87.         if ($this->namedArgumentsCache[$className] ??= (bool) (new \ReflectionMethod($className, '__construct'))->getAttributes(HasNamedArguments::class)) {
  88.             return new $className(...$options);
  89.         }
  91.         return new $className($options);
  92.     }
  93. }