Файл: symfony-2.7/src/Symfony/Component/Form/FormErrorIterator.php
Строк: 325
<?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 SymfonyComponentForm;
use SymfonyComponentFormExceptionInvalidArgumentException;
use SymfonyComponentFormExceptionOutOfBoundsException;
use SymfonyComponentFormExceptionBadMethodCallException;
/**
* Iterates over the errors of a form.
*
* Optionally, this class supports recursive iteration. In order to iterate
* recursively, set the constructor argument $deep to true. Now each element
* returned by the iterator is either an instance of {@link FormError} or of
* {@link FormErrorIterator}, in case the errors belong to a sub-form.
*
* You can also wrap the iterator into a {@link RecursiveIteratorIterator} to
* flatten the recursive structure into a flat list of errors.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*
* @since 2.5
*/
class FormErrorIterator implements RecursiveIterator, SeekableIterator, ArrayAccess, Countable
{
/**
* The prefix used for indenting nested error messages.
*
* @var string
*/
const INDENTATION = ' ';
/**
* @var FormInterface
*/
private $form;
/**
* @var FormError[]|FormErrorIterator[]
*/
private $errors;
/**
* Creates a new iterator.
*
* @param FormInterface $form The erroneous form
* @param array $errors The form errors
*
* @throws InvalidArgumentException If the errors are invalid
*/
public function __construct(FormInterface $form, array $errors)
{
foreach ($errors as $error) {
if (!($error instanceof FormError || $error instanceof self)) {
throw new InvalidArgumentException(sprintf(
'The errors must be instances of '.
'"SymfonyComponentFormFormError" or "%s". Got: "%s".',
__CLASS__,
is_object($error) ? get_class($error) : gettype($error)
));
}
}
$this->form = $form;
$this->errors = $errors;
}
/**
* Returns all iterated error messages as string.
*
* @return string The iterated error messages
*/
public function __toString()
{
$string = '';
foreach ($this->errors as $error) {
if ($error instanceof FormError) {
$string .= 'ERROR: '.$error->getMessage()."n";
} else {
/** @var $error FormErrorIterator */
$string .= $error->form->getName().":n";
$string .= self::indent((string) $error);
}
}
return $string;
}
/**
* Returns the iterated form.
*
* @return FormInterface The form whose errors are iterated by this object.
*/
public function getForm()
{
return $this->form;
}
/**
* Returns the current element of the iterator.
*
* @return FormError|FormErrorIterator An error or an iterator containing
* nested errors.
*/
public function current()
{
return current($this->errors);
}
/**
* Advances the iterator to the next position.
*/
public function next()
{
next($this->errors);
}
/**
* Returns the current position of the iterator.
*
* @return int The 0-indexed position.
*/
public function key()
{
return key($this->errors);
}
/**
* Returns whether the iterator's position is valid.
*
* @return bool Whether the iterator is valid.
*/
public function valid()
{
return null !== key($this->errors);
}
/**
* Sets the iterator's position to the beginning.
*
* This method detects if errors have been added to the form since the
* construction of the iterator.
*/
public function rewind()
{
reset($this->errors);
}
/**
* Returns whether a position exists in the iterator.
*
* @param int $position The position
*
* @return bool Whether that position exists
*/
public function offsetExists($position)
{
return isset($this->errors[$position]);
}
/**
* Returns the element at a position in the iterator.
*
* @param int $position The position
*
* @return FormError|FormErrorIterator The element at the given position
*
* @throws OutOfBoundsException If the given position does not exist
*/
public function offsetGet($position)
{
if (!isset($this->errors[$position])) {
throw new OutOfBoundsException('The offset '.$position.' does not exist.');
}
return $this->errors[$position];
}
/**
* Unsupported method.
*
* @throws BadMethodCallException
*/
public function offsetSet($position, $value)
{
throw new BadMethodCallException('The iterator doesn't support modification of elements.');
}
/**
* Unsupported method.
*
* @throws BadMethodCallException
*/
public function offsetUnset($position)
{
throw new BadMethodCallException('The iterator doesn't support modification of elements.');
}
/**
* Returns whether the current element of the iterator can be recursed
* into.
*
* @return bool Whether the current element is an instance of this class
*/
public function hasChildren()
{
return current($this->errors) instanceof self;
}
/**
* Alias of {@link current()}.
*/
public function getChildren()
{
return current($this->errors);
}
/**
* Returns the number of elements in the iterator.
*
* Note that this is not the total number of errors, if the constructor
* parameter $deep was set to true! In that case, you should wrap the
* iterator into a {@link RecursiveIteratorIterator} with the standard mode
* {@link RecursiveIteratorIterator::LEAVES_ONLY} and count the result.
*
* $iterator = new RecursiveIteratorIterator($form->getErrors(true));
* $count = count(iterator_to_array($iterator));
*
* Alternatively, set the constructor argument $flatten to true as well.
*
* $count = count($form->getErrors(true, true));
*
* @return int The number of iterated elements
*/
public function count()
{
return count($this->errors);
}
/**
* Sets the position of the iterator.
*
* @param int $position The new position
*
* @throws OutOfBoundsException If the position is invalid
*/
public function seek($position)
{
if (!isset($this->errors[$position])) {
throw new OutOfBoundsException('The offset '.$position.' does not exist.');
}
reset($this->errors);
while ($position !== key($this->errors)) {
next($this->errors);
}
}
/**
* Utility function for indenting multi-line strings.
*
* @param string $string The string
*
* @return string The indented string
*/
private static function indent($string)
{
return rtrim(self::INDENTATION.str_replace("n", "n".self::INDENTATION, $string), ' ');
}
}