Completed
Push — master ( 30d48c...00d18e )
by Zoltán
03:12
created

AggregateException::checkException()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 7
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 1 Features 0
Metric Value
c 1
b 1
f 0
dl 0
loc 7
rs 9.4285
cc 2
eloc 4
nc 2
nop 1
1
<?php namespace BuildR\Foundation\Exception;
2
3
use BuildR\Foundation\Object\ArrayConvertibleInterface;
4
use \Exception;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, BuildR\Foundation\Exception\Exception.

Let’s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let’s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
5
use \IteratorAggregate;
6
use \ArrayIterator;
7
use \Countable;
8
9
/**
10
 * Aggregates multiple PHP exception into one exception. Useful when iterating over
11
 * large set of objects and call a method on each that might be raise an exception.
12
 *
13
 * Simply aggregate all thrown exception to this class and throw it when the
14
 * iteration is end.
15
 *
16
 * BuildR PHP Framework
17
 *
18
 * @author Zoltán Borsos <[email protected]>
19
 * @package Foundation
20
 * @subpackage Exception
21
 *
22
 * @copyright    Copyright 2015, Zoltán Borsos.
23
 * @license      https://github.com/Zolli/BuildR/blob/master/LICENSE.md
24
 * @link         https://github.com/Zolli/BuildR
25
 *
26
 * @codeCoverageIgnore
27
 */
28
class AggregateException extends Exception implements \IteratorAggregate, Countable, ArrayConvertibleInterface {
29
30
    /**
31
     * @var array
32
     */
33
    private $collection = [];
34
35
    /**
36
     * Add a new exception to the stack
37
     *
38
     * @param \Exception|\Throwable $exception
39
     */
40
    public function add($exception) {
41
        if($this->checkException($exception) === FALSE) {
42
            trigger_error(
43
                'Only subclasses of \Exception and implementations of \Throwable can be aggregated!',
44
                E_USER_ERROR
45
            );
46
        }
47
48
        $this->collection[] = $exception;
49
    }
50
51
    /**
52
     * Check the exception
53
     *
54
     * @param \Throwable|\Exception $exception
55
     * @return bool
56
     *
57
     * @codeCoverageIgnore
58
     */
59
    private function checkException($exception) {
60
        if(version_compare(PHP_VERSION, '7.0.0', '>=')) {
61
            return in_array("Throwable", class_implements($exception));
62
        }
63
64
        return ($exception instanceof Exception);
65
    }
66
67
    /**
68
     * Determines, the current exception stack contains any exception
69
     *
70
     * @return bool
71
     */
72
    public function hasAny() {
73
        return ($this->count() > 0);
74
    }
75
76
    /**
77
     * {@inheritDoc}
78
     */
79
    public function getIterator() {
80
        return new ArrayIterator($this->collection);
81
    }
82
83
    /**
84
     * {@inheritDoc}
85
     */
86
    public function toArray() {
87
        return $this->collection;
88
    }
89
90
    /**
91
     * {@inheritDoc}
92
     */
93
    public function count() {
94
        return count($this->collection);
95
    }
96
97
}
98