annotate vendor/symfony/validator/ConstraintViolationListInterface.php @ 2:92f882872392

Trusted hosts, + remove migration modules
author Chris Cannam
date Tue, 05 Dec 2017 09:26:43 +0000
parents 4c8ae668cc8c
children 1fec387a4317
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\Validator;
Chris@0 13
Chris@0 14 /**
Chris@0 15 * A list of constraint violations.
Chris@0 16 *
Chris@0 17 * @author Bernhard Schussek <bschussek@gmail.com>
Chris@0 18 */
Chris@0 19 interface ConstraintViolationListInterface extends \Traversable, \Countable, \ArrayAccess
Chris@0 20 {
Chris@0 21 /**
Chris@0 22 * Adds a constraint violation to this list.
Chris@0 23 *
Chris@0 24 * @param ConstraintViolationInterface $violation The violation to add
Chris@0 25 */
Chris@0 26 public function add(ConstraintViolationInterface $violation);
Chris@0 27
Chris@0 28 /**
Chris@0 29 * Merges an existing violation list into this list.
Chris@0 30 *
Chris@0 31 * @param ConstraintViolationListInterface $otherList The list to merge
Chris@0 32 */
Chris@0 33 public function addAll(ConstraintViolationListInterface $otherList);
Chris@0 34
Chris@0 35 /**
Chris@0 36 * Returns the violation at a given offset.
Chris@0 37 *
Chris@0 38 * @param int $offset The offset of the violation
Chris@0 39 *
Chris@0 40 * @return ConstraintViolationInterface The violation
Chris@0 41 *
Chris@0 42 * @throws \OutOfBoundsException If the offset does not exist.
Chris@0 43 */
Chris@0 44 public function get($offset);
Chris@0 45
Chris@0 46 /**
Chris@0 47 * Returns whether the given offset exists.
Chris@0 48 *
Chris@0 49 * @param int $offset The violation offset
Chris@0 50 *
Chris@0 51 * @return bool Whether the offset exists
Chris@0 52 */
Chris@0 53 public function has($offset);
Chris@0 54
Chris@0 55 /**
Chris@0 56 * Sets a violation at a given offset.
Chris@0 57 *
Chris@0 58 * @param int $offset The violation offset
Chris@0 59 * @param ConstraintViolationInterface $violation The violation
Chris@0 60 */
Chris@0 61 public function set($offset, ConstraintViolationInterface $violation);
Chris@0 62
Chris@0 63 /**
Chris@0 64 * Removes a violation at a given offset.
Chris@0 65 *
Chris@0 66 * @param int $offset The offset to remove
Chris@0 67 */
Chris@0 68 public function remove($offset);
Chris@0 69 }