ContextualValidatorInterface.php in Zircon Profile 8

Namespace

Symfony\Component\Validator\Validator

File

vendor/symfony/validator/Validator/ContextualValidatorInterface.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <[e-mail]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\Validator\Validator;

use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintViolationListInterface;

/**
 * A validator in a specific execution context.
 *
 * @since  2.5
 *
 * @author Bernhard Schussek <[e-mail]>
 */
interface ContextualValidatorInterface {

  /**
   * Appends the given path to the property path of the context.
   *
   * If called multiple times, the path will always be reset to the context's
   * original path with the given path appended to it.
   *
   * @param string $path The path to append
   *
   * @return ContextualValidatorInterface This validator
   */
  public function atPath($path);

  /**
   * Validates a value against a constraint or a list of constraints.
   *
   * If no constraint is passed, the constraint
   * {@link \Symfony\Component\Validator\Constraints\Valid} is assumed.
   *
   * @param mixed                   $value       The value to validate
   * @param Constraint|Constraint[] $constraints The constraint(s) to validate
   *                                             against
   * @param array|null              $groups      The validation groups to
   *                                             validate. If none is given,
   *                                             "Default" is assumed
   *
   * @return ContextualValidatorInterface This validator
   */
  public function validate($value, $constraints = null, $groups = null);

  /**
   * Validates a property of an object against the constraints specified
   * for this property.
   *
   * @param object     $object       The object
   * @param string     $propertyName The name of the validated property
   * @param array|null $groups       The validation groups to validate. If
   *                                 none is given, "Default" is assumed
   *
   * @return ContextualValidatorInterface This validator
   */
  public function validateProperty($object, $propertyName, $groups = null);

  /**
   * Validates a value against the constraints specified for an object's
   * property.
   *
   * @param object|string $objectOrClass The object or its class name
   * @param string        $propertyName  The name of the property
   * @param mixed         $value         The value to validate against the
   *                                     property's constraints
   * @param array|null    $groups        The validation groups to validate. If
   *                                     none is given, "Default" is assumed
   *
   * @return ContextualValidatorInterface This validator
   */
  public function validatePropertyValue($objectOrClass, $propertyName, $value, $groups = null);

  /**
   * Returns the violations that have been generated so far in the context
   * of the validator.
   *
   * @return ConstraintViolationListInterface The constraint violations
   */
  public function getViolations();

}

Interfaces

Name	Description
ContextualValidatorInterface	A validator in a specific execution context.