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 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 <?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;
/**
* An error collection.
*/
class ErrorCollection implements \ArrayAccess, \IteratorAggregate, \Countable, \JsonSerializable, ToArray
{
/**
* Special identifier used when an error is not associated with a specific attribute.
*/
const GENERIC = '__generic__';
/**
* @var Error[][]
*/
private $collection = [];
/**
* Add an error associated with an attribute.
*
* @param string $attribute Attribute name.
* @param Error|string|bool $error_or_format_or_true A {@link Error} instance or
* a format to create that instance, or `true`.
* @param array $args Only used if `$error_or_format_or_true` is not a {@link Error}
* instance or `true`.
*
* @return $this
*/
public function add($attribute, $error_or_format_or_true = true, array $args = [])
{
$this->assert_valid_attribute($attribute);
$this->assert_valid_error($error_or_format_or_true);
$this->collection[$attribute][] = $this
->ensure_error_instance($error_or_format_or_true, $args);
return $this;
}
/**
* Add an error not associated with any attribute.
*
* @param Error|string|bool $error_or_format_or_true A {@link Error} instance or
* a format to create that instance, or `true`.
* @param array $args Only used if `$error_or_format_or_true` is not a {@link Error}
* instance or `true`.
*
* @return $this
*/
public function add_generic($error_or_format_or_true = true, array $args = [])
{
return $this->add(self::GENERIC, $error_or_format_or_true, $args);
}
/**
* Asserts that an attribute is valid.
*
* @param string $attribute
*/
protected function assert_valid_attribute($attribute)
{
if (is_string($attribute)) {
return;
}
throw new \InvalidArgumentException(sprintf(
"\$attribute must a string. Given: `%s`",
Error::class,
is_object($attribute)
? get_class($attribute)
: gettype($attribute)
));
}
/**
* Asserts that the error type is valid.
*
* @param mixed $error_or_format_or_true
*/
protected function assert_valid_error($error_or_format_or_true)
{
if ($error_or_format_or_true === true
|| is_string($error_or_format_or_true)
|| $error_or_format_or_true instanceof Error) {
return;
}
throw new \InvalidArgumentException(sprintf(
"\$error_or_format_or_true must be a an instance of `%s`, a string, or true. Given: `%s`",
Error::class,
is_object($error_or_format_or_true)
? get_class($error_or_format_or_true)
: gettype($error_or_format_or_true)
));
}
/**
* Ensures a {@link Error} instance.
*
* @param Error|string|bool $error_or_format_or_true
* @param array $args
*
* @return Error
*/
protected function ensure_error_instance($error_or_format_or_true, array $args = [])
{
$error = $error_or_format_or_true;
if (!$error instanceof Error)
{
$error = new Error($error === true ? "" : $error, $args);
}
return $error;
}
/**
* Adds an error.
*
* @param string $attribute
* @param Error|string|true $error
*
* @see add()
*/
public function offsetSet($attribute, $error)
{
$this->add($attribute === null ? self::GENERIC : $attribute, $error);
}
/**
* Clears the errors of an attribute.
*
* @param string|null $attribute Attribute name or `null` for _generic_.
*/
public function offsetUnset($attribute)
{
unset($this->collection[$attribute === null ? self::GENERIC : $attribute]);
}
/**
* Checks if an error is defined for an attribute.
*
* ```php
* <?php
*
* use ICanBoogie\ErrorCollection
*
* $errors = new ErrorCollection;
* isset($errors['username']);
* // false
* $errors->add('username');
* isset($errors['username']);
* // true
* ```
*
* @param string|null $attribute Attribute name or `null` for _generic_.
*
* @return boolean true if an error is defined for the specified attribute, false otherwise.
*/
public function offsetExists($attribute)
{
return isset($this->collection[$attribute === null ? self::GENERIC : $attribute]);
}
/**
* Returns errors associated with an attribute.
*
* ```php
* <?php
*
* use ICanBoogie\ErrorCollection;
*
* $errors = new ErrorCollection;
* $errors['password']
* // []
* $errors->add('password')
* // [ Message ]
* ```
*
* @param string|null $attribute Attribute name or `null` for _generic_.
*
* @return Error[]
*/
public function offsetGet($attribute)
{
if (!$this->offsetExists($attribute))
{
return [];
}
return $this->collection[$attribute === null ? self::GENERIC : $attribute];
}
/**
* Clears errors.
*
* @return $this
*/
public function clear()
{
$this->collection = [];
return $this;
}
/**
* Merges with another error collection.
*
* @param ErrorCollection $collection
*/
public function merge(ErrorCollection $collection)
{
foreach ($collection as $attribute => $error)
{
$this->add($attribute, $error);
}
}
/**
* @inheritdoc
*/
public function getIterator()
{
foreach ($this->to_array() as $attribute => $errors)
{
foreach ($errors as $error)
{
yield $attribute => $error;
}
}
}
/**
* Iterates through errors using a callback.
*
* ```php
* <?php
*
* use ICanBoogie\ErrorCollection;
*
* $errors = new ErrorCollection;
* $errors->add('username', "Funny user name");
* $errors->add('password', "Weak password");
*
* $errors->each(function ($error, $attribute, $errors) {
*
* echo "$attribute => $error<br />";
*
* });
* </pre>
*
* @param callable $callback Function to execute for each element, taking three arguments:
*
* - `Error $error`: The current error.
* - `string $attribute`: The attribute or {@link self::GENERIC}.
* - `ErrorCollection $collection`: This instance.
*/
public function each(callable $callback)
{
foreach ($this as $attribute => $error)
{
$callback($error, $attribute, $this);
}
}
/**
* Returns the total number of errors.
*
* @inheritdoc
*/
public function count()
{
return count($this->collection, COUNT_RECURSIVE) - count($this->collection);
}
/**
* @inheritdoc
*/
public function jsonSerialize()
{
return $this->to_array();
}
/**
* Converts the object into an array.
*
* @return Error[][]
*/
public function to_array()
{
return array_filter(array_merge([ self::GENERIC => [] ], $this->collection));
}
}