ConstraintViolationListInterface.php in Plug 7

Namespace

Symfony\Component\Validator

File

lib/Symfony/validator/Symfony/Component/Validator/ConstraintViolationListInterface.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;


/**
 * A list of constraint violations.
 *
 * @author Bernhard Schussek <[e-mail]>
 *
 * @api
 */
interface ConstraintViolationListInterface extends \Traversable, \Countable, \ArrayAccess {

  /**
   * Adds a constraint violation to this list.
   *
   * @param ConstraintViolationInterface $violation The violation to add.
   *
   * @api
   */
  public function add(ConstraintViolationInterface $violation);

  /**
   * Merges an existing violation list into this list.
   *
   * @param ConstraintViolationListInterface $otherList The list to merge.
   *
   * @api
   */
  public function addAll(ConstraintViolationListInterface $otherList);

  /**
   * Returns the violation at a given offset.
   *
   * @param int $offset The offset of the violation.
   *
   * @return ConstraintViolationInterface The violation.
   *
   * @throws \OutOfBoundsException If the offset does not exist.
   *
   * @api
   */
  public function get($offset);

  /**
   * Returns whether the given offset exists.
   *
   * @param int $offset The violation offset.
   *
   * @return bool Whether the offset exists.
   *
   * @api
   */
  public function has($offset);

  /**
   * Sets a violation at a given offset.
   *
   * @param int                          $offset    The violation offset.
   * @param ConstraintViolationInterface $violation The violation.
   *
   * @api
   */
  public function set($offset, ConstraintViolationInterface $violation);

  /**
   * Removes a violation at a given offset.
   *
   * @param int $offset The offset to remove.
   *
   * @api
   */
  public function remove($offset);

}

Interfaces

Name	Description
ConstraintViolationListInterface	A list of constraint violations.