BuildR\Foundation\Exception\AggregateException

Complexity

Total Complexity

5

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	add()	0	3	1
A	hasAny()	0	3	1
A	getIterator()	0	3	1
A	toArray()	0	3	1
A	count()	0	3	1

<?php namespace BuildR\Foundation\Exception;

use BuildR\Foundation\Object\ArrayConvertibleInterface;
use \Exception;

This use statement conflicts with another class in this namespace, BuildR\Foundation\Exception\Exception.

use \Throwable;
use \IteratorAggregate;
use \ArrayIterator;
use \Countable;

/**
 * Aggregates multiple PHP exception into one exception. Useful when iterating over
 * large set of objects and call a method on each that might be raise an exception.
 *
 * Simply aggregate all thrown exception to this class and throw it when the
 * iteration is end.
 *
 * BuildR PHP Framework
 *
 * @author Zoltán Borsos <zolli07@gmail.com>
 * @package Foundation
 * @subpackage Exception
 *
 * @copyright    Copyright 2015, Zoltán Borsos.
 * @license      https://github.com/Zolli/BuildR/blob/master/LICENSE.md
 * @link         https://github.com/Zolli/BuildR
 *
 * @codeCoverageIgnore
 */
class AggregateException extends Exception implements \IteratorAggregate, Countable, ArrayConvertibleInterface {

    /**
     * @var array
     */
    private $collection = [];

    /**
     * Add a new exception to the stack
     *
     * @param Throwable $throwable
     */
    public function add(Throwable $throwable) {
        $this->collection[] = $throwable;
    }

    /**
     * Determines, the current exception stack contains any exception
     *
     * @return bool
     */
    public function hasAny() {
        return ($this->count() > 0);
    }

    /**
     * {@inheritDoc}
     */
    public function getIterator() {
        return new ArrayIterator($this->collection);
    }

    /**
     * {@inheritDoc}
     */
    public function toArray() {
        return $this->collection;
    }

    /**
     * {@inheritDoc}
     */
    public function count() {
        return count($this->collection);
    }

}