ICanBoogie/Errors 2.0.x
  • Namespace
  • Class

Namespaces

  • ICanBoogie

Classes

  • Error
  • ErrorCollection
  • ErrorCollectionIterator
  • Errors

Interfaces

  • RenderError
 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 
<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie;

/**
 * Iterates over an error collection and return rendered errors.
 */
class ErrorCollectionIterator implements \IteratorAggregate
{
    /**
     * @var ErrorCollection
     */
    private $collection;

    /**
     * @var callable|RenderError
     */
    private $render_error;

    /**
     * @param ErrorCollection $collection
     * @param RenderError|callable $render_error
     */
    public function __construct(ErrorCollection $collection, callable $render_error = null)
    {
        $this->collection = $collection;
        $this->render_error = $render_error ?: function (Error $error) { return (string) $error; };
    }

    /**
     * @inheritdoc
     */
    public function getIterator()
    {
        /* @var $error Error */

        foreach ($this->collection as $attribute => $error)
        {
            yield $attribute => $this->render_error($error, $attribute);
        }
    }

    /**
     * Renders an error into a string.
     *
     * @param Error $error
     * @param string $attribute
     *
     * @return string
     */
    protected function render_error(Error $error, $attribute)
    {
        $render_error = $this->render_error;

        return $render_error($error, $attribute, $this->collection);
    }
}
ICanBoogie/Errors 2.0.x API documentation generated by ApiGen