2012-07-30 09:57:16 +01:00
< ? 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 ;
2014-03-17 15:44:19 +00:00
use Doctrine\Common\Annotations\AnnotationReader ;
use Doctrine\Common\Annotations\CachedReader ;
use Doctrine\Common\Annotations\Reader ;
use Doctrine\Common\Cache\ArrayCache ;
2013-09-10 16:14:04 +01:00
use Symfony\Component\PropertyAccess\PropertyAccessorInterface ;
2015-01-04 17:59:57 +00:00
use Symfony\Component\Translation\IdentityTranslator ;
2014-03-17 15:44:19 +00:00
use Symfony\Component\Translation\TranslatorInterface ;
2014-07-26 12:48:25 +01:00
use Symfony\Component\Validator\Context\ExecutionContextFactory ;
2014-02-21 17:48:33 +00:00
use Symfony\Component\Validator\Exception\InvalidArgumentException ;
2012-07-30 09:57:16 +01:00
use Symfony\Component\Validator\Exception\ValidatorException ;
use Symfony\Component\Validator\Mapping\Cache\CacheInterface ;
2015-01-04 14:37:21 +00:00
use Symfony\Component\Validator\Mapping\Factory\LazyLoadingMetadataFactory ;
2012-07-30 09:57:16 +01:00
use Symfony\Component\Validator\Mapping\Loader\AnnotationLoader ;
2014-03-17 15:44:19 +00:00
use Symfony\Component\Validator\Mapping\Loader\LoaderChain ;
use Symfony\Component\Validator\Mapping\Loader\StaticMethodLoader ;
2012-07-30 09:57:16 +01:00
use Symfony\Component\Validator\Mapping\Loader\XmlFileLoader ;
use Symfony\Component\Validator\Mapping\Loader\XmlFilesLoader ;
2014-03-17 15:44:19 +00:00
use Symfony\Component\Validator\Mapping\Loader\YamlFileLoader ;
use Symfony\Component\Validator\Mapping\Loader\YamlFilesLoader ;
2014-03-18 09:02:15 +00:00
use Symfony\Component\Validator\Validator\RecursiveValidator ;
2012-07-30 09:57:16 +01:00
/**
* The default implementation of { @ link ValidatorBuilderInterface } .
*
* @ author Bernhard Schussek < bschussek @ gmail . com >
*/
class ValidatorBuilder implements ValidatorBuilderInterface
{
/**
* @ var array
*/
private $initializers = array ();
/**
* @ var array
*/
private $xmlMappings = array ();
/**
* @ var array
*/
private $yamlMappings = array ();
/**
* @ var array
*/
private $methodMappings = array ();
/**
2014-06-17 11:31:26 +01:00
* @ var Reader | null
2012-07-30 09:57:16 +01:00
*/
2014-06-17 11:31:26 +01:00
private $annotationReader ;
2012-07-30 09:57:16 +01:00
/**
2014-06-17 11:31:26 +01:00
* @ var MetadataFactoryInterface | null
2012-07-30 09:57:16 +01:00
*/
private $metadataFactory ;
/**
2014-06-17 11:31:26 +01:00
* @ var ConstraintValidatorFactoryInterface | null
2012-07-30 09:57:16 +01:00
*/
private $validatorFactory ;
/**
2014-06-17 11:31:26 +01:00
* @ var CacheInterface | null
2012-07-30 09:57:16 +01:00
*/
private $metadataCache ;
2012-11-27 21:42:05 +00:00
/**
2014-06-17 11:31:26 +01:00
* @ var TranslatorInterface | null
2012-11-27 21:42:05 +00:00
*/
private $translator ;
/**
* @ var null | string
*/
private $translationDomain ;
2013-09-10 16:14:04 +01:00
/**
2014-06-17 11:31:26 +01:00
* @ var PropertyAccessorInterface | null
2013-09-10 16:14:04 +01:00
*/
private $propertyAccessor ;
2012-07-30 09:57:16 +01:00
/**
* { @ inheritdoc }
*/
public function addObjectInitializer ( ObjectInitializerInterface $initializer )
{
$this -> initializers [] = $initializer ;
2012-08-23 10:11:16 +01:00
return $this ;
2012-07-30 09:57:16 +01:00
}
/**
* { @ inheritdoc }
*/
public function addObjectInitializers ( array $initializers )
{
$this -> initializers = array_merge ( $this -> initializers , $initializers );
2012-08-23 10:11:16 +01:00
return $this ;
2012-07-30 09:57:16 +01:00
}
/**
* { @ inheritdoc }
*/
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 ;
2012-08-23 10:11:16 +01:00
return $this ;
2012-07-30 09:57:16 +01:00
}
/**
* { @ inheritdoc }
*/
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 );
2012-08-23 10:11:16 +01:00
return $this ;
2012-07-30 09:57:16 +01:00
}
/**
* { @ inheritdoc }
*/
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 ;
2012-08-23 10:11:16 +01:00
return $this ;
2012-07-30 09:57:16 +01:00
}
/**
* { @ inheritdoc }
*/
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 );
2012-08-23 10:11:16 +01:00
return $this ;
2012-07-30 09:57:16 +01:00
}
/**
* { @ inheritdoc }
*/
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 ;
2012-08-23 10:11:16 +01:00
return $this ;
2012-07-30 09:57:16 +01:00
}
/**
* { @ inheritdoc }
*/
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 );
2012-08-23 10:11:16 +01:00
return $this ;
2012-07-30 09:57:16 +01:00
}
/**
* { @ inheritdoc }
*/
2012-07-30 11:49:07 +01:00
public function enableAnnotationMapping ( Reader $annotationReader = null )
2012-07-30 09:57:16 +01:00
{
2012-07-30 11:49:07 +01:00
if ( null !== $this -> metadataFactory ) {
2012-07-30 09:57:16 +01:00
throw new ValidatorException ( 'You cannot enable annotation mapping after setting a custom metadata factory. Configure your metadata factory instead.' );
}
2012-07-30 11:49:07 +01:00
if ( null === $annotationReader ) {
2013-10-31 18:07:47 +00:00
if ( ! class_exists ( 'Doctrine\Common\Annotations\AnnotationReader' ) || ! class_exists ( 'Doctrine\Common\Cache\ArrayCache' )) {
throw new \RuntimeException ( 'Enabling annotation based constraint mapping requires the packages doctrine/annotations and doctrine/cache to be installed.' );
2012-07-30 11:49:07 +01:00
}
$annotationReader = new CachedReader ( new AnnotationReader (), new ArrayCache ());
}
$this -> annotationReader = $annotationReader ;
2012-08-23 10:11:16 +01:00
return $this ;
2012-07-30 11:49:07 +01:00
}
/**
* { @ inheritdoc }
*/
public function disableAnnotationMapping ()
{
$this -> annotationReader = null ;
2012-08-23 10:11:16 +01:00
return $this ;
2012-07-30 09:57:16 +01:00
}
/**
* { @ inheritdoc }
*/
2013-03-01 08:39:10 +00:00
public function setMetadataFactory ( MetadataFactoryInterface $metadataFactory )
2012-07-30 09:57:16 +01:00
{
2012-07-30 11:49:07 +01:00
if ( count ( $this -> xmlMappings ) > 0 || count ( $this -> yamlMappings ) > 0 || count ( $this -> methodMappings ) > 0 || null !== $this -> annotationReader ) {
2012-07-30 09:57:16 +01:00
throw new ValidatorException ( 'You cannot set a custom metadata factory after adding custom mappings. You should do either of both.' );
}
$this -> metadataFactory = $metadataFactory ;
2012-08-23 10:11:16 +01:00
return $this ;
2012-07-30 09:57:16 +01:00
}
/**
* { @ inheritdoc }
*/
public function setMetadataCache ( CacheInterface $cache )
{
if ( null !== $this -> metadataFactory ) {
throw new ValidatorException ( 'You cannot set a custom metadata cache after setting a custom metadata factory. Configure your metadata factory instead.' );
}
2012-10-22 15:37:12 +01:00
2012-07-30 09:57:16 +01:00
$this -> metadataCache = $cache ;
2012-08-23 10:11:16 +01:00
return $this ;
2012-07-30 09:57:16 +01:00
}
/**
* { @ inheritdoc }
*/
public function setConstraintValidatorFactory ( ConstraintValidatorFactoryInterface $validatorFactory )
{
2013-09-10 16:14:04 +01:00
if ( null !== $this -> propertyAccessor ) {
throw new ValidatorException ( 'You cannot set a validator factory after setting a custom property accessor. Remove the call to setPropertyAccessor() if you want to call setConstraintValidatorFactory().' );
}
2012-07-30 09:57:16 +01:00
$this -> validatorFactory = $validatorFactory ;
2012-08-23 10:11:16 +01:00
return $this ;
2012-07-30 09:57:16 +01:00
}
2012-11-27 21:42:05 +00:00
/**
* { @ inheritdoc }
*/
public function setTranslator ( TranslatorInterface $translator )
{
$this -> translator = $translator ;
return $this ;
}
/**
* { @ inheritdoc }
*/
public function setTranslationDomain ( $translationDomain )
{
$this -> translationDomain = $translationDomain ;
return $this ;
}
2013-09-10 16:14:04 +01:00
/**
* { @ inheritdoc }
2014-11-29 13:44:34 +00:00
*
2014-12-29 23:26:56 +00:00
* @ deprecated since version 2.5 , to be removed in 3.0 .
* The validator will function without a property accessor .
2013-09-10 16:14:04 +01:00
*/
public function setPropertyAccessor ( PropertyAccessorInterface $propertyAccessor )
{
2015-06-07 07:33:05 +01:00
@ trigger_error ( 'The ' . __METHOD__ . ' method is deprecated since version 2.5 and will be removed in 3.0. The validator will function without a property accessor.' , E_USER_DEPRECATED );
2014-11-29 13:44:34 +00:00
2013-09-10 16:14:04 +01:00
if ( null !== $this -> validatorFactory ) {
throw new ValidatorException ( 'You cannot set a property accessor after setting a custom validator factory. Configure your validator factory instead.' );
}
$this -> propertyAccessor = $propertyAccessor ;
return $this ;
}
2014-02-21 17:48:33 +00:00
/**
* { @ inheritdoc }
2015-01-25 05:54:05 +00:00
*
* @ deprecated since version 2.7 , to be removed in 3.0 .
2014-02-21 17:48:33 +00:00
*/
public function setApiVersion ( $apiVersion )
{
2015-06-07 07:33:05 +01:00
@ trigger_error ( 'The ' . __METHOD__ . ' method is deprecated in version 2.7 and will be removed in version 3.0.' , E_USER_DEPRECATED );
2015-01-25 05:54:05 +00:00
2014-03-18 16:36:12 +00:00
if ( ! in_array ( $apiVersion , array ( Validation :: API_VERSION_2_4 , Validation :: API_VERSION_2_5 , Validation :: API_VERSION_2_5_BC ))) {
2015-01-25 05:54:05 +00:00
throw new InvalidArgumentException ( sprintf ( 'The requested API version is invalid: "%s"' , $apiVersion ));
2014-02-21 17:48:33 +00:00
}
return $this ;
}
2012-07-30 09:57:16 +01:00
/**
* { @ inheritdoc }
*/
public function getValidator ()
{
$metadataFactory = $this -> metadataFactory ;
if ( ! $metadataFactory ) {
$loaders = array ();
if ( count ( $this -> xmlMappings ) > 1 ) {
$loaders [] = new XmlFilesLoader ( $this -> xmlMappings );
} elseif ( 1 === count ( $this -> xmlMappings )) {
$loaders [] = new XmlFileLoader ( $this -> xmlMappings [ 0 ]);
}
if ( count ( $this -> yamlMappings ) > 1 ) {
$loaders [] = new YamlFilesLoader ( $this -> yamlMappings );
} elseif ( 1 === count ( $this -> yamlMappings )) {
$loaders [] = new YamlFileLoader ( $this -> yamlMappings [ 0 ]);
}
2012-07-30 11:49:07 +01:00
foreach ( $this -> methodMappings as $methodName ) {
$loaders [] = new StaticMethodLoader ( $methodName );
2012-07-30 09:57:16 +01:00
}
2012-07-30 11:49:07 +01:00
if ( $this -> annotationReader ) {
$loaders [] = new AnnotationLoader ( $this -> annotationReader );
2012-07-30 09:57:16 +01:00
}
$loader = null ;
if ( count ( $loaders ) > 1 ) {
$loader = new LoaderChain ( $loaders );
} elseif ( 1 === count ( $loaders )) {
$loader = $loaders [ 0 ];
}
2015-01-09 14:07:29 +00:00
$metadataFactory = new LazyLoadingMetadataFactory ( $loader , $this -> metadataCache );
2012-07-30 09:57:16 +01:00
}
2014-08-06 14:23:29 +01:00
$validatorFactory = $this -> validatorFactory ? : new ConstraintValidatorFactory ( $this -> propertyAccessor );
2015-01-04 17:59:57 +00:00
$translator = $this -> translator ;
if ( null === $translator ) {
$translator = new IdentityTranslator ();
// 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' );
}
2014-02-21 17:48:33 +00:00
2015-01-19 17:16:09 +00:00
$contextFactory = new ExecutionContextFactory ( $translator , $this -> translationDomain );
2014-07-26 12:48:25 +01:00
2015-01-19 17:16:09 +00:00
return new RecursiveValidator ( $contextFactory , $metadataFactory , $validatorFactory , $this -> initializers );
2012-07-30 09:57:16 +01:00
}
}