vendor/symfony/validator/Validator/ValidatorInterface.php line 40

  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\Validator;
  14. use Symfony\Component\Validator\Constraint;
  15. use Symfony\Component\Validator\Constraints\GroupSequence;
  16. use Symfony\Component\Validator\ConstraintViolationListInterface;
  17. use Symfony\Component\Validator\Context\ExecutionContextInterface;
  18. use Symfony\Component\Validator\Mapping\Factory\MetadataFactoryInterface;
  20. /**
  21.  * Validates PHP values against constraints.
  22.  *
  23.  * @author Bernhard Schussek <bschussek@gmail.com>
  24.  */
  25. interface ValidatorInterface extends MetadataFactoryInterface
  26. {
  27.     /**
  28.      * Validates a value against a constraint or a list of constraints.
  29.      *
  30.      * If no constraint is passed, the constraint
  31.      * {@link \Symfony\Component\Validator\Constraints\Valid} is assumed.
  32.      *
  33.      * @param Constraint|Constraint[]                               $constraints The constraint(s) to validate against
  34.      * @param string|GroupSequence|array<string|GroupSequence>|null $groups      The validation groups to validate. If none is given, "Default" is assumed
  35.      *
  36.      * @return ConstraintViolationListInterface A list of constraint violations
  37.      *                                          If the list is empty, validation
  38.      *                                          succeeded
  39.      */
  40.     public function validate(mixed $value, Constraint|array $constraints = null, string|GroupSequence|array $groups = null): ConstraintViolationListInterface;
  42.     /**
  43.      * Validates a property of an object against the constraints specified
  44.      * for this property.
  45.      *
  46.      * @param string                                                $propertyName The name of the validated property
  47.      * @param string|GroupSequence|array<string|GroupSequence>|null $groups       The validation groups to validate. If none is given, "Default" is assumed
  48.      *
  49.      * @return ConstraintViolationListInterface A list of constraint violations
  50.      *                                          If the list is empty, validation
  51.      *                                          succeeded
  52.      */
  53.     public function validateProperty(object $object, string $propertyName, string|GroupSequence|array $groups = null): ConstraintViolationListInterface;
  55.     /**
  56.      * Validates a value against the constraints specified for an object's
  57.      * property.
  58.      *
  59.      * @param object|string                                         $objectOrClass The object or its class name
  60.      * @param string                                                $propertyName  The name of the property
  61.      * @param mixed                                                 $value         The value to validate against the property's constraints
  62.      * @param string|GroupSequence|array<string|GroupSequence>|null $groups        The validation groups to validate. If none is given, "Default" is assumed
  63.      *
  64.      * @return ConstraintViolationListInterface A list of constraint violations
  65.      *                                          If the list is empty, validation
  66.      *                                          succeeded
  67.      */
  68.     public function validatePropertyValue(object|string $objectOrClass, string $propertyName, mixed $value, string|GroupSequence|array $groups = null): ConstraintViolationListInterface;
  70.     /**
  71.      * Starts a new validation context and returns a validator for that context.
  72.      *
  73.      * The returned validator collects all violations generated within its
  74.      * context. You can access these violations with the
  75.      * {@link ContextualValidatorInterface::getViolations()} method.
  76.      */
  77.     public function startContext(): ContextualValidatorInterface;
  79.     /**
  80.      * Returns a validator in the given execution context.
  81.      *
  82.      * The returned validator adds all generated violations to the given
  83.      * context.
  84.      */
  85.     public function inContext(ExecutionContextInterface $context): ContextualValidatorInterface;
  86. }