Classes List

Symfony\Component\Validator\Context\ExecutionContextInterface

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
 163 
 164 
 165 
 166 
 167 
 168 
 169 
 170 
 171 
 172 
 173 
 174 
 175 
 176 
 177 
 178 
 179 
 180 
 181 
 182 
 183 
 184 
 185 
 186 
 187 
 188 
 189 
 190 
 191 
 192 
 193 
 194 
 195 
 196 
 197 
 198 
 199 
 200 
 201 
 202 
 203 
 204 
 205 
 206 
 207 
 208 
 209 
 210 
 211 
 212 
 213 
 214 
 215 
 216 
 217 
 218 
 219 
 220 
 221 
 222 
 223 
 224 
 225 
 226 
 227 
 228 
 229 
 230 
 231 
 232 
 233 
 234 
 235 
 236 
 237 
 238 
 239 
 240 
 241 
 242 
 243 
 244 
 245 
 246 
 247 
 248 
 249 
 250 
 251 
 252 
 253 
 254 
 255 
 256 
 257 
 258 
 259 
 260 
 261 
 262 
 263 
 264 
 265 
 266 
 267 
 268 
 269 
 270 
 271 
 272 
 273 
 274 
 275 
 276 
 277 
 278 
 279 
 280 
 281 
 282 
 283 
 284 
 285 
 286 
 287 
 288 
 289 
 290 
 291 
 292 
 293 
 294 
 295 
 296 
 297 
 298 
 299 
 300 
 301 
 302 
 303 
 304 
 305 
 306 
 307 
 308 
 309 
 310 
 311 
 312 
 313 
 314 
 315 
 316 
 317 
 318 
 319 
 320 
 321 
 322 
 323 
 324 
 325 
 326 
 327 
 328 
 329 
 330 
 331 
 332 
 333 
 334 
 335 
 336 
 337 
 338 
 339 
 340 
 341 
 342 
 343 
 344 
 345 
<?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\Mapping;
use Symfony\Component\Validator\Mapping\MetadataInterface;
use Symfony\Component\Validator\Validator\ValidatorInterface;
use Symfony\Component\Validator\Violation\ConstraintViolationBuilderInterface;
use Symfony\Component\Validator\ConstraintViolationListInterface;

/** * 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 $message The error message * @param array $params The parameters substituted in the error message */
    public function addViolation($messagearray $params = array());

    /** * 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 $message The error message * @param array $parameters The parameters substituted in the error message * * @return ConstraintViolationBuilderInterface The violation builder */
    public function buildViolation($messagearray $parameters = array());

    /** * Returns the validator. * * Useful if you want to validate additional constraints: * * public function validate($value, Constraint $constraint) * { * $validator = $this->context->getValidator(); * * $violations = $validator->validateValue($value, new Length(array('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 a 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 MetadataInterface|null $metadata The validation metadata * @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$objectMetadataInterface $metadata = null$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($group);

    /** * Sets the currently validated constraint. * * @param Constraint $constraint The 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($cacheKey$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($cacheKey$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($cacheKey$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($cacheKey$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($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($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 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($subPath = '');
}