BuildrPHP / Foundation

src/Exception/AggregateException.php

<?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 \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 \Exception|\Throwable $exception
     */
    public function add($exception) {
        if($this->checkException($exception) === FALSE) {
            trigger_error(
                'Only subclasses of \Exception and implementations of \Throwable can be aggregated!',
                E_USER_ERROR
            );
        }

        $this->collection[] = $exception;
    }

    /**
     * Check the exception
     *
     * @param \Throwable|\Exception $exception
     * @return bool
     *
     * @codeCoverageIgnore
     */
    private function checkException($exception) {
        if(version_compare(PHP_VERSION, '7.0.0', '>=')) {
            return in_array("Throwable", class_implements($exception));
        }

        return ($exception instanceof Exception);
    }

    /**
     * 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);
    }

}