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

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