class RecursiveValidator in Zircon Profile 8

Defines a recursive validator for Typed Data.

The difference to \Symfony\Component\Validator\Validator\RecursiveValidator is that we just allow to validate typed data objects.

Hierarchy

• class \Drupal\Core\TypedData\Validation\RecursiveValidator implements ValidatorInterface

2 files declare their use of RecursiveValidator

RecursiveContextualValidatorTest.php in core/tests/Drupal/Tests/Core/TypedData/RecursiveContextualValidatorTest.php

Contains \Drupal\Tests\Core\TypedData\RecursiveContextualValidatorTest.

TypedDataManager.php in core/lib/Drupal/Core/TypedData/TypedDataManager.php

Contains \Drupal\Core\TypedData\TypedDataManager.

File

core/lib/Drupal/Core/TypedData/Validation/RecursiveValidator.php, line 23

Contains \Drupal\Core\TypedData\Validation\RecursiveValidator.

Namespace

Drupal\Core\TypedData\Validation

class RecursiveValidator implements ValidatorInterface {

  /**
   * @var \Symfony\Component\Validator\Context\ExecutionContextFactoryInterface
   */
  protected $contextFactory;

  /**
   * @var \Symfony\Component\Validator\ConstraintValidatorFactoryInterface
   */
  protected $constraintValidatorFactory;

  /**
   * @var \Drupal\Core\TypedData\TypedDataManager
   */
  protected $typedDataManager;

  /**
   * Creates a new validator.
   *
   * @param \Symfony\Component\Validator\Context\ExecutionContextFactoryInterface $context_factory
   *   The factory for creating new contexts.
   * @param \Symfony\Component\Validator\ConstraintValidatorFactoryInterface $validator_factory
   *   The constraint validator factory.
   * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
   *   The typed data manager.
   */
  public function __construct(ExecutionContextFactoryInterface $context_factory, ConstraintValidatorFactoryInterface $validator_factory, TypedDataManagerInterface $typed_data_manager) {
    $this->contextFactory = $context_factory;
    $this->constraintValidatorFactory = $validator_factory;
    $this->typedDataManager = $typed_data_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function startContext($root = NULL) {
    return new RecursiveContextualValidator($this->contextFactory
      ->createContext($this, $root), $this, $this->constraintValidatorFactory, $this->typedDataManager);
  }

  /**
   * {@inheritdoc}
   */
  public function inContext(ExecutionContextInterface $context) {
    return new RecursiveContextualValidator($context, $this, $this->constraintValidatorFactory, $this->typedDataManager);
  }

  /**
   * {@inheritdoc}
   *
   * @param \Drupal\Core\TypedData\TypedDataInterface $typed_data
   *   A typed data object containing the value to validate.
   */
  public function getMetadataFor($typed_data) {
    if (!$typed_data instanceof TypedDataInterface) {
      throw new \InvalidArgumentException('The passed value must be a typed data object.');
    }
    return new TypedDataMetadata($typed_data);
  }

  /**
   * {@inheritdoc}
   */
  public function hasMetadataFor($value) {
    return $value instanceof TypedDataInterface;
  }

  /**
   * {@inheritdoc}
   */
  public function validate($value, $constraints = null, $groups = null) {
    return $this
      ->startContext($value)
      ->validate($value, $constraints, $groups)
      ->getViolations();
  }

  /**
   * {@inheritdoc}
   */
  public function validateProperty($object, $propertyName, $groups = NULL) {
    return $this
      ->startContext($object)
      ->validateProperty($object, $propertyName, $groups)
      ->getViolations();
  }

  /**
   * {@inheritdoc}
   */
  public function validatePropertyValue($objectOrClass, $propertyName, $value, $groups = NULL) {

    // Just passing a class name is not supported.
    if (!is_object($objectOrClass)) {
      throw new \LogicException('Typed data validation does not support passing the class name only.');
    }
    return $this
      ->startContext($objectOrClass)
      ->validatePropertyValue($objectOrClass, $propertyName, $value, $groups)
      ->getViolations();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RecursiveValidator::$constraintValidatorFactory	protected	property
RecursiveValidator::$contextFactory	protected	property
RecursiveValidator::$typedDataManager	protected	property
RecursiveValidator::getMetadataFor	public	function	Overrides MetadataFactoryInterface::getMetadataFor
RecursiveValidator::hasMetadataFor	public	function	Returns whether the class is able to return metadata for the given value. Overrides MetadataFactoryInterface::hasMetadataFor
RecursiveValidator::inContext	public	function	Returns a validator in the given execution context. Overrides ValidatorInterface::inContext
RecursiveValidator::startContext	public	function	Starts a new validation context and returns a validator for that context. Overrides ValidatorInterface::startContext
RecursiveValidator::validate	public	function	Validates a value against a constraint or a list of constraints. Overrides ValidatorInterface::validate
RecursiveValidator::validateProperty	public	function	Validates a property of an object against the constraints specified for this property. Overrides ValidatorInterface::validateProperty
RecursiveValidator::validatePropertyValue	public	function	Validates a value against the constraints specified for an object's property. Overrides ValidatorInterface::validatePropertyValue
RecursiveValidator::__construct	public	function	Creates a new validator.