123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\Validator;
- use Doctrine\Common\Annotations\AnnotationReader;
- use Doctrine\Common\Annotations\CachedReader;
- use Doctrine\Common\Annotations\Reader;
- use Doctrine\Common\Cache\ArrayCache;
- use Psr\Cache\CacheItemPoolInterface;
- use Symfony\Component\Cache\Adapter\ArrayAdapter;
- use Symfony\Component\Cache\DoctrineProvider;
- use Symfony\Component\Validator\Context\ExecutionContextFactory;
- use Symfony\Component\Validator\Exception\ValidatorException;
- use Symfony\Component\Validator\Mapping\Factory\LazyLoadingMetadataFactory;
- use Symfony\Component\Validator\Mapping\Factory\MetadataFactoryInterface;
- use Symfony\Component\Validator\Mapping\Loader\AnnotationLoader;
- use Symfony\Component\Validator\Mapping\Loader\LoaderChain;
- use Symfony\Component\Validator\Mapping\Loader\LoaderInterface;
- use Symfony\Component\Validator\Mapping\Loader\StaticMethodLoader;
- use Symfony\Component\Validator\Mapping\Loader\XmlFileLoader;
- use Symfony\Component\Validator\Mapping\Loader\YamlFileLoader;
- use Symfony\Component\Validator\Validator\RecursiveValidator;
- use Symfony\Component\Validator\Validator\ValidatorInterface;
- use Symfony\Contracts\Translation\LocaleAwareInterface;
- use Symfony\Contracts\Translation\TranslatorInterface;
- use Symfony\Contracts\Translation\TranslatorTrait;
- // Help opcache.preload discover always-needed symbols
- class_exists(TranslatorInterface::class);
- class_exists(LocaleAwareInterface::class);
- class_exists(TranslatorTrait::class);
- /**
- * @author Bernhard Schussek <bschussek@gmail.com>
- */
- class ValidatorBuilder
- {
- private $initializers = [];
- private $loaders = [];
- private $xmlMappings = [];
- private $yamlMappings = [];
- private $methodMappings = [];
- /**
- * @var Reader|null
- */
- private $annotationReader;
- private $enableAnnotationMapping = false;
- /**
- * @var MetadataFactoryInterface|null
- */
- private $metadataFactory;
- /**
- * @var ConstraintValidatorFactoryInterface|null
- */
- private $validatorFactory;
- /**
- * @var CacheItemPoolInterface|null
- */
- private $mappingCache;
- /**
- * @var TranslatorInterface|null
- */
- private $translator;
- /**
- * @var string|null
- */
- private $translationDomain;
- /**
- * Adds an object initializer to the validator.
- *
- * @return $this
- */
- public function addObjectInitializer(ObjectInitializerInterface $initializer)
- {
- $this->initializers[] = $initializer;
- return $this;
- }
- /**
- * Adds a list of object initializers to the validator.
- *
- * @param ObjectInitializerInterface[] $initializers
- *
- * @return $this
- */
- public function addObjectInitializers(array $initializers)
- {
- $this->initializers = array_merge($this->initializers, $initializers);
- return $this;
- }
- /**
- * Adds an XML constraint mapping file to the validator.
- *
- * @return $this
- */
- public function addXmlMapping($path)
- {
- if (null !== $this->metadataFactory) {
- throw new ValidatorException('You cannot add custom mappings after setting a custom metadata factory. Configure your metadata factory instead.');
- }
- $this->xmlMappings[] = $path;
- return $this;
- }
- /**
- * Adds a list of XML constraint mapping files to the validator.
- *
- * @param string[] $paths The paths to the mapping files
- *
- * @return $this
- */
- public function addXmlMappings(array $paths)
- {
- if (null !== $this->metadataFactory) {
- throw new ValidatorException('You cannot add custom mappings after setting a custom metadata factory. Configure your metadata factory instead.');
- }
- $this->xmlMappings = array_merge($this->xmlMappings, $paths);
- return $this;
- }
- /**
- * Adds a YAML constraint mapping file to the validator.
- *
- * @param string $path The path to the mapping file
- *
- * @return $this
- */
- public function addYamlMapping($path)
- {
- if (null !== $this->metadataFactory) {
- throw new ValidatorException('You cannot add custom mappings after setting a custom metadata factory. Configure your metadata factory instead.');
- }
- $this->yamlMappings[] = $path;
- return $this;
- }
- /**
- * Adds a list of YAML constraint mappings file to the validator.
- *
- * @param string[] $paths The paths to the mapping files
- *
- * @return $this
- */
- public function addYamlMappings(array $paths)
- {
- if (null !== $this->metadataFactory) {
- throw new ValidatorException('You cannot add custom mappings after setting a custom metadata factory. Configure your metadata factory instead.');
- }
- $this->yamlMappings = array_merge($this->yamlMappings, $paths);
- return $this;
- }
- /**
- * Enables constraint mapping using the given static method.
- *
- * @return $this
- */
- public function addMethodMapping($methodName)
- {
- if (null !== $this->metadataFactory) {
- throw new ValidatorException('You cannot add custom mappings after setting a custom metadata factory. Configure your metadata factory instead.');
- }
- $this->methodMappings[] = $methodName;
- return $this;
- }
- /**
- * Enables constraint mapping using the given static methods.
- *
- * @param string[] $methodNames The names of the methods
- *
- * @return $this
- */
- public function addMethodMappings(array $methodNames)
- {
- if (null !== $this->metadataFactory) {
- throw new ValidatorException('You cannot add custom mappings after setting a custom metadata factory. Configure your metadata factory instead.');
- }
- $this->methodMappings = array_merge($this->methodMappings, $methodNames);
- return $this;
- }
- /**
- * Enables annotation based constraint mapping.
- *
- * @param bool $skipDoctrineAnnotations
- *
- * @return $this
- */
- public function enableAnnotationMapping(/* bool $skipDoctrineAnnotations = true */)
- {
- if (null !== $this->metadataFactory) {
- throw new ValidatorException('You cannot enable annotation mapping after setting a custom metadata factory. Configure your metadata factory instead.');
- }
- $skipDoctrineAnnotations = 1 > \func_num_args() ? false : func_get_arg(0);
- if (false === $skipDoctrineAnnotations || null === $skipDoctrineAnnotations) {
- trigger_deprecation('symfony/validator', '5.2', 'Not passing true as first argument to "%s" is deprecated. Pass true and call "addDefaultDoctrineAnnotationReader()" if you want to enable annotation mapping with Doctrine Annotations.', __METHOD__);
- $this->addDefaultDoctrineAnnotationReader();
- } elseif ($skipDoctrineAnnotations instanceof Reader) {
- trigger_deprecation('symfony/validator', '5.2', 'Passing an instance of "%s" as first argument to "%s" is deprecated. Pass true instead and call setDoctrineAnnotationReader() if you want to enable annotation mapping with Doctrine Annotations.', get_debug_type($skipDoctrineAnnotations), __METHOD__);
- $this->setDoctrineAnnotationReader($skipDoctrineAnnotations);
- } elseif (true !== $skipDoctrineAnnotations) {
- throw new \TypeError(sprintf('"%s": Argument 1 is expected to be a boolean, "%s" given.', __METHOD__, get_debug_type($skipDoctrineAnnotations)));
- }
- $this->enableAnnotationMapping = true;
- return $this;
- }
- /**
- * Disables annotation based constraint mapping.
- *
- * @return $this
- */
- public function disableAnnotationMapping()
- {
- $this->enableAnnotationMapping = false;
- $this->annotationReader = null;
- return $this;
- }
- /**
- * @return $this
- */
- public function setDoctrineAnnotationReader(?Reader $reader): self
- {
- $this->annotationReader = $reader;
- return $this;
- }
- /**
- * @return $this
- */
- public function addDefaultDoctrineAnnotationReader(): self
- {
- if (class_exists(ArrayAdapter::class)) {
- $this->annotationReader = new CachedReader(new AnnotationReader(), new DoctrineProvider(new ArrayAdapter()));
- } else {
- $this->annotationReader = new CachedReader(new AnnotationReader(), new ArrayCache());
- }
- return $this;
- }
- /**
- * Sets the class metadata factory used by the validator.
- *
- * @return $this
- */
- public function setMetadataFactory(MetadataFactoryInterface $metadataFactory)
- {
- if (\count($this->xmlMappings) > 0 || \count($this->yamlMappings) > 0 || \count($this->methodMappings) > 0 || $this->enableAnnotationMapping) {
- throw new ValidatorException('You cannot set a custom metadata factory after adding custom mappings. You should do either of both.');
- }
- $this->metadataFactory = $metadataFactory;
- return $this;
- }
- /**
- * Sets the cache for caching class metadata.
- *
- * @return $this
- */
- public function setMappingCache(CacheItemPoolInterface $cache)
- {
- if (null !== $this->metadataFactory) {
- throw new ValidatorException('You cannot set a custom mapping cache after setting a custom metadata factory. Configure your metadata factory instead.');
- }
- $this->mappingCache = $cache;
- return $this;
- }
- /**
- * Sets the constraint validator factory used by the validator.
- *
- * @return $this
- */
- public function setConstraintValidatorFactory(ConstraintValidatorFactoryInterface $validatorFactory)
- {
- $this->validatorFactory = $validatorFactory;
- return $this;
- }
- /**
- * Sets the translator used for translating violation messages.
- *
- * @return $this
- */
- public function setTranslator(TranslatorInterface $translator)
- {
- $this->translator = $translator;
- return $this;
- }
- /**
- * Sets the default translation domain of violation messages.
- *
- * The same message can have different translations in different domains.
- * Pass the domain that is used for violation messages by default to this
- * method.
- *
- * @return $this
- */
- public function setTranslationDomain($translationDomain)
- {
- $this->translationDomain = $translationDomain;
- return $this;
- }
- /**
- * @return $this
- */
- public function addLoader(LoaderInterface $loader)
- {
- $this->loaders[] = $loader;
- return $this;
- }
- /**
- * @return LoaderInterface[]
- */
- public function getLoaders()
- {
- $loaders = [];
- foreach ($this->xmlMappings as $xmlMapping) {
- $loaders[] = new XmlFileLoader($xmlMapping);
- }
- foreach ($this->yamlMappings as $yamlMappings) {
- $loaders[] = new YamlFileLoader($yamlMappings);
- }
- foreach ($this->methodMappings as $methodName) {
- $loaders[] = new StaticMethodLoader($methodName);
- }
- if ($this->enableAnnotationMapping) {
- $loaders[] = new AnnotationLoader($this->annotationReader);
- }
- return array_merge($loaders, $this->loaders);
- }
- /**
- * Builds and returns a new validator object.
- *
- * @return ValidatorInterface
- */
- public function getValidator()
- {
- $metadataFactory = $this->metadataFactory;
- if (!$metadataFactory) {
- $loaders = $this->getLoaders();
- $loader = null;
- if (\count($loaders) > 1) {
- $loader = new LoaderChain($loaders);
- } elseif (1 === \count($loaders)) {
- $loader = $loaders[0];
- }
- $metadataFactory = new LazyLoadingMetadataFactory($loader, $this->mappingCache);
- }
- $validatorFactory = $this->validatorFactory ?: new ConstraintValidatorFactory();
- $translator = $this->translator;
- if (null === $translator) {
- $translator = new class() implements TranslatorInterface, LocaleAwareInterface {
- use TranslatorTrait;
- };
- // Force the locale to be 'en' when no translator is provided rather than relying on the Intl default locale
- // This avoids depending on Intl or the stub implementation being available. It also ensures that Symfony
- // validation messages are pluralized properly even when the default locale gets changed because they are in
- // English.
- $translator->setLocale('en');
- }
- $contextFactory = new ExecutionContextFactory($translator, $this->translationDomain);
- return new RecursiveValidator($contextFactory, $metadataFactory, $validatorFactory, $this->initializers);
- }
- }
|