123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341 |
- <?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\Context;
- use Symfony\Component\Validator\Constraint;
- use Symfony\Component\Validator\ConstraintViolationListInterface;
- use Symfony\Component\Validator\Mapping;
- use Symfony\Component\Validator\Mapping\MetadataInterface;
- use Symfony\Component\Validator\Validator\ValidatorInterface;
- use Symfony\Component\Validator\Violation\ConstraintViolationBuilderInterface;
- /**
- * The context of a validation run.
- *
- * The context collects all violations generated during the validation. By
- * default, validators execute all validations in a new context:
- *
- * $violations = $validator->validate($object);
- *
- * When you make another call to the validator, while the validation is in
- * progress, the violations will be isolated from each other:
- *
- * public function validate($value, Constraint $constraint)
- * {
- * $validator = $this->context->getValidator();
- *
- * // The violations are not added to $this->context
- * $violations = $validator->validate($value);
- * }
- *
- * However, if you want to add the violations to the current context, use the
- * {@link ValidatorInterface::inContext()} method:
- *
- * public function validate($value, Constraint $constraint)
- * {
- * $validator = $this->context->getValidator();
- *
- * // The violations are added to $this->context
- * $validator
- * ->inContext($this->context)
- * ->validate($value)
- * ;
- * }
- *
- * Additionally, the context provides information about the current state of
- * the validator, such as the currently validated class, the name of the
- * currently validated property and more. These values change over time, so you
- * cannot store a context and expect that the methods still return the same
- * results later on.
- *
- * @author Bernhard Schussek <bschussek@gmail.com>
- */
- interface ExecutionContextInterface
- {
- /**
- * Adds a violation at the current node of the validation graph.
- *
- * @param string|\Stringable $message The error message as a string or a stringable object
- * @param array $params The parameters substituted in the error message
- */
- public function addViolation(string $message, array $params = []);
- /**
- * Returns a builder for adding a violation with extended information.
- *
- * Call {@link ConstraintViolationBuilderInterface::addViolation()} to
- * add the violation when you're done with the configuration:
- *
- * $context->buildViolation('Please enter a number between %min% and %max%.')
- * ->setParameter('%min%', 3)
- * ->setParameter('%max%', 10)
- * ->setTranslationDomain('number_validation')
- * ->addViolation();
- *
- * @param string|\Stringable $message The error message as a string or a stringable object
- * @param array $parameters The parameters substituted in the error message
- *
- * @return ConstraintViolationBuilderInterface The violation builder
- */
- public function buildViolation(string $message, array $parameters = []);
- /**
- * Returns the validator.
- *
- * Useful if you want to validate additional constraints:
- *
- * public function validate($value, Constraint $constraint)
- * {
- * $validator = $this->context->getValidator();
- *
- * $violations = $validator->validate($value, new Length(['min' => 3]));
- *
- * if (count($violations) > 0) {
- * // ...
- * }
- * }
- *
- * @return ValidatorInterface
- */
- public function getValidator();
- /**
- * Returns the currently validated object.
- *
- * If the validator is currently validating a class constraint, the
- * object of that class is returned. If it is validating a property or
- * getter constraint, the object that the property/getter belongs to is
- * returned.
- *
- * In other cases, null is returned.
- *
- * @return object|null The currently validated object or null
- */
- public function getObject();
- /**
- * Sets the currently validated value.
- *
- * @param mixed $value The validated value
- * @param object|null $object The currently validated object
- * @param string $propertyPath The property path to the current value
- *
- * @internal Used by the validator engine. Should not be called by user
- * code.
- */
- public function setNode($value, ?object $object, MetadataInterface $metadata = null, string $propertyPath);
- /**
- * Sets the currently validated group.
- *
- * @param string|null $group The validated group
- *
- * @internal Used by the validator engine. Should not be called by user
- * code.
- */
- public function setGroup(?string $group);
- /**
- * Sets the currently validated constraint.
- *
- * @internal Used by the validator engine. Should not be called by user
- * code.
- */
- public function setConstraint(Constraint $constraint);
- /**
- * Marks an object as validated in a specific validation group.
- *
- * @param string $cacheKey The hash of the object
- * @param string $groupHash The group's name or hash, if it is group
- * sequence
- *
- * @internal Used by the validator engine. Should not be called by user
- * code.
- */
- public function markGroupAsValidated(string $cacheKey, string $groupHash);
- /**
- * Returns whether an object was validated in a specific validation group.
- *
- * @param string $cacheKey The hash of the object
- * @param string $groupHash The group's name or hash, if it is group
- * sequence
- *
- * @return bool Whether the object was already validated for that
- * group
- *
- * @internal Used by the validator engine. Should not be called by user
- * code.
- */
- public function isGroupValidated(string $cacheKey, string $groupHash);
- /**
- * Marks a constraint as validated for an object.
- *
- * @param string $cacheKey The hash of the object
- * @param string $constraintHash The hash of the constraint
- *
- * @internal Used by the validator engine. Should not be called by user
- * code.
- */
- public function markConstraintAsValidated(string $cacheKey, string $constraintHash);
- /**
- * Returns whether a constraint was validated for an object.
- *
- * @param string $cacheKey The hash of the object
- * @param string $constraintHash The hash of the constraint
- *
- * @return bool Whether the constraint was already validated
- *
- * @internal Used by the validator engine. Should not be called by user
- * code.
- */
- public function isConstraintValidated(string $cacheKey, string $constraintHash);
- /**
- * Marks that an object was initialized.
- *
- * @param string $cacheKey The hash of the object
- *
- * @internal Used by the validator engine. Should not be called by user
- * code.
- *
- * @see ObjectInitializerInterface
- */
- public function markObjectAsInitialized(string $cacheKey);
- /**
- * Returns whether an object was initialized.
- *
- * @param string $cacheKey The hash of the object
- *
- * @return bool Whether the object was already initialized
- *
- * @internal Used by the validator engine. Should not be called by user
- * code.
- *
- * @see ObjectInitializerInterface
- */
- public function isObjectInitialized(string $cacheKey);
- /**
- * Returns the violations generated by the validator so far.
- *
- * @return ConstraintViolationListInterface The constraint violation list
- */
- public function getViolations();
- /**
- * Returns the value at which validation was started in the object graph.
- *
- * The validator, when given an object, traverses the properties and
- * related objects and their properties. The root of the validation is the
- * object from which the traversal started.
- *
- * The current value is returned by {@link getValue}.
- *
- * @return mixed The root value of the validation
- */
- public function getRoot();
- /**
- * Returns the value that the validator is currently validating.
- *
- * If you want to retrieve the object that was originally passed to the
- * validator, use {@link getRoot}.
- *
- * @return mixed The currently validated value
- */
- public function getValue();
- /**
- * Returns the metadata for the currently validated value.
- *
- * With the core implementation, this method returns a
- * {@link Mapping\ClassMetadataInterface} instance if the current value is an object,
- * a {@link Mapping\PropertyMetadata} instance if the current value is
- * the value of a property and a {@link Mapping\GetterMetadata} instance if
- * the validated value is the result of a getter method.
- *
- * If the validated value is neither of these, for example if the validator
- * has been called with a plain value and constraint, this method returns
- * null.
- *
- * @return MetadataInterface|null the metadata of the currently validated
- * value
- */
- public function getMetadata();
- /**
- * Returns the validation group that is currently being validated.
- *
- * @return string|null The current validation group
- */
- public function getGroup();
- /**
- * Returns the class name of the current node.
- *
- * If the metadata of the current node does not implement
- * {@link Mapping\ClassMetadataInterface} or if no metadata is available for the
- * current node, this method returns null.
- *
- * @return string|null The class name or null, if no class name could be found
- */
- public function getClassName();
- /**
- * Returns the property name of the current node.
- *
- * If the metadata of the current node does not implement
- * {@link PropertyMetadataInterface} or if no metadata is available for the
- * current node, this method returns null.
- *
- * @return string|null The property name or null, if no property name could be found
- */
- public function getPropertyName();
- /**
- * Returns the property path to the value that the validator is currently
- * validating.
- *
- * For example, take the following object graph:
- *
- * <pre>
- * (Person)---($address: Address)---($street: string)
- * </pre>
- *
- * When the <tt>Person</tt> instance is passed to the validator, the
- * property path is initially empty. When the <tt>$address</tt> property
- * of that person is validated, the property path is "address". When
- * the <tt>$street</tt> property of the related <tt>Address</tt> instance
- * is validated, the property path is "address.street".
- *
- * Properties of objects are prefixed with a dot in the property path.
- * Indices of arrays or objects implementing the {@link \ArrayAccess}
- * interface are enclosed in brackets. For example, if the property in
- * the previous example is <tt>$addresses</tt> and contains an array
- * of <tt>Address</tt> instance, the property path generated for the
- * <tt>$street</tt> property of one of these addresses is for example
- * "addresses[0].street".
- *
- * @param string $subPath Optional. The suffix appended to the current
- * property path.
- *
- * @return string The current property path. The result may be an empty
- * string if the validator is currently validating the
- * root value of the validation graph.
- */
- public function getPropertyPath(string $subPath = '');
- }
|