PEAR2_ExceptionPEAR2_Exception-0.2.0/php/PEAR2/MultiErrors.php

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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
<?php
/**
 * Multi-Error Error aggregator
 *
 * This class is designed to be extended for specific use.  It codifies easy
 * ways of aggregating error conditions that don't necessarily require an exception
 * to be thrown, but do need an easy way to retrieve them.
 *
 * Usage:
 *
 * <code>
 * $multi = new \PEAR2\MultiErrors();
 * $multi->E_WARNING[] = new Exception('test');
 * $multi->E_ERROR[] = new Exception('test 2');
 * foreach ($multi as $error) {
 *     echo $error;
 * }
 * foreach ($multi->E_WARNING as $error) {
 *     echo $error;
 * }
 * foreach ($multi->E_ERROR as $error) {
 *     echo $error;
 * }
 * if (count($multi->E_ERROR)) {
 *     throw new \PEAR2\Exception('Failure to do something', $multi);
 * }
 * </code>
 * @author    Greg Beaver <cellog@php.net>
 * @copyright 2010 The PEAR Group
 * @package \PEAR2\MultiErrors
 * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
 */
namespace PEAR2;
class MultiErrors extends \Exception implements \Iterator, \Countable, \ArrayAccess
{
    private $_allowedLevels = array('E_NOTICE' => 0, 'E_WARNING' => 1, 'E_ERROR' => 2);

    /**
     * Errors are stored in the order that they are declared
     * @var array
     */
    private $_errors = array();

    /**
     * To allow $this->E_WARNING[] = new BlahException;
     *
     * @var int
     */
    private $_requestedLevel = false;

    /**
     * Internal PEAR2_MultiError objects for error levels
     * @var array
     */
    private $_subMulti = array();

    /**
     * Parent \PEAR2\MultiErrors for an error level tracker
     *
     * @var \PEAR2\MultiErrors
     */
    private $_parent;

    public function __construct($mylevel = false,
                                array $allowed = array('E_NOTICE', 'E_WARNING', 'E_ERROR'),
                                MultiErrors $parent = null)
    {
        foreach ($allowed as $level) {
            if (!is_string($level) || strpos($level, 'E_') !== 0) {
                throw new MultiErrors\Exception('Invalid level ' . (string) $level);
            }
        }

        $this->_allowedLevels  = array_flip($allowed);
        $this->_requestedLevel = $mylevel;
        if ($mylevel) {
            $this->_parent = $parent;
        }

        parent::__construct('multiple errors found');
    }

    public function current()
    {
        return current($this->_errors);
    }

    public function key()
    {
        return key($this->_errors);
    }

    public function next()
    {
        return next($this->_errors);
    }

    public function rewind()
    {
        return reset($this->_errors);
    }

    public function valid()
    {
        return false !== current($this->_errors);
    }

    /**
     * Merge in errors from an existing \PEAR2\MultiErrors
     *
     * This also merges in any new error levels not supported in this instance.
     * @param \PEAR2\MultiErrors $error
     */
    public function merge(MultiErrors $error)
    {
        foreach ($error->levels as $level) {
            if (!isset($this->_allowedLevels[$level])) {
                $this->_allowedLevels[$level] = 1;
            }

            foreach ($error->$level as $e) {
                $this->{$level}[] = $e;
            }
        }
    }

    public function count()
    {
        return count($this->_errors);
    }

    public function offsetExists($offset)
    {
        return isset($this->_errors[$offset]);
    }

    public function offsetGet($offset)
    {
        if (isset($this->_errors[$offset])) {
            return $this->_errors[$offset];
        }

        return null;
    }

    public function offsetSet ($offset, $value)
    {
        if ($offset === null && !$this->_requestedLevel && $value instanceof self) {
            $this->merge($value);
            return;
        }

        if (!($value instanceof \Exception)) {
            throw new MultiErrors\Exception('offsetSet: $value is not an Exception object');
        }

        if ($this->_requestedLevel) {
            if ($offset === null) {
                // called with $a->E_BLAH[] = new Exception('hi');
                $offset = count($this->_errors);
            }

            if (!is_int($offset)) {
                throw new MultiErrors\Exception('offsetSet: $offset is not an integer');
            }

            $this->_errors[$offset] = $value;
            $this->_parent[$this->_requestedLevel . '-' . $offset] = $value;
        } else {
            if (!is_string($offset)) {
                throw new MultiErrors\Exception('Cannot add an error directly ' .
                    'to a PEAR2\MultiErrors with $a[] = new Exception, use an ' .
                    ' E_* constant like $a->E_WARNING[] = new Exception');
            }

            $offset = explode('-', $offset);
            $level  = $offset[0];
            $offset = $offset[1];
            // this is called when the "$this->_parent[] = $value" line is executed.
            if (!isset($this->_subMulti[$level]) ||
                $this->_subMulti[$level][$offset] !== $value
            ) {
                // must be in a child or it'll throw off the whole thingy
                throw new MultiErrors\Exception('Cannot add an error directly ' .
                    'to a PEAR2\MultiErrors with $a[] = new Exception, use an ' .
                    ' E_* constant like $a->E_WARNING[] = new Exception');
            }

            $this->_errors[] = $value;
        }
    }

    public function offsetUnset ($offset)
    {
        if (isset($this->_errors[$offset])) {
            unset($this->_errors[$offset]);
        }
    }

    public function __get($level)
    {
        if ($level === 'levels') {
            return array_keys($this->_allowedLevels);
        }

        if (!count($this->_allowedLevels)) {
            throw new MultiErrors\Exception('Cannot nest requests ' .
              '(like $multi->E_WARNING->E_ERROR[] = new Exception(\'\');)');
        }

        if (isset($this->_allowedLevels[$level])) {
            if (!isset($this->_subMulti[$level])) {
                $this->_subMulti[$level] = new self($level, array(), $this);
            }

            return $this->_subMulti[$level];
        }

        throw new MultiErrors\Exception('Requested error level must be one of ' .
          implode(', ', array_keys($this->_allowedLevels)));
    }

    public function toArray()
    {
        return $this->_errors;
    }
}
EOF