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 <?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 collector.
*/
class Errors implements \ArrayAccess, \Countable, \Iterator
{
static public $message_constructor;
protected $errors = array(null => array());
/**
* Checks if an error is defined for an attribute.
*
* Example:
*
* <pre>
* $e = new Errors();
* $e['username'] = 'Funny username';
* var_dump(isset($e['username']);
* #=> true
* var_dump(isset($e['password']);
* #=> false
* </pre>
*
* @return boolean true if an error is defined for the specified attribute, false otherwise.
*/
public function offsetExists($attribute)
{
return isset($this->errors[$attribute]);
}
/**
* Returns error messages.
*
* Example:
*
* <pre>
* $e = new Errors();
* var_dump($e['password']);
* #=> null
* $e['password'] = 'Invalid password';
* var_dump($e['password']);
* #=> 'Invalid password'
* $e['password'] = 'Ugly password';
* var_dump($e['password']);
* #=> array('Invalid password', 'Ugly password')
* </pre>
*
* @param string|null $attribute The attribute that caused the error, or null if the error is global.
*
* @return string|array|null Return the global error messages or the error messages attached
* to an attribute. If there is only one message a string is returned, otherwise an array
* with all the messages is returned. null is returned if there is no message defined.
*/
public function offsetGet($attribute)
{
if (empty($this->errors[$attribute]))
{
return null;
}
$messages = $this->errors[$attribute];
return count($messages) > 1 ? $messages : current($messages);
}
/**
* Adds an error message.
*
* Example:
*
* <pre>
* $e = new Errors();
* $e['password'] = 'Invalid password';
* $e[] = 'Requires authentication';
* </pre>
*
* @param string|null $attribute If null, the message is considered as a general error message
* instead of an attribute message.
* @param string $message The error message.
*/
public function offsetSet($attribute, $message)
{
$this->errors[$attribute][] = $message;
}
/**
* Removes error messages.
*
* @param string|null attribute If null, general message are removed, otherwise the message
* attached to the attribute are removed.
*/
public function offsetUnset($attribute)
{
unset($this->errors[$attribute]);
}
/**
* Returns the number of errors defined.
*
* Example:
*
* <pre>
* $e = new Errors();
* $e['username'] = 'Funny user name';
* $e['password'] = 'Weak password';
* $e['password'] = 'should have at least one digit';
* count($e);
* #=> 3
* </pre>
*/
public function count()
{
$n = 0;
foreach ($this->errors as $errors)
{
$n += count($errors);
}
return $n;
}
private $i;
private $ia;
public function current()
{
return $this->ia[$this->i][1];
}
public function next()
{
++$this->i;
}
public function key()
{
return $this->ia[$this->i][0];
}
public function valid()
{
return isset($this->ia[$this->i]);
}
public function rewind()
{
$this->i = 0;
$ia = array();
foreach ($this->errors as $attribute => $errors)
{
foreach ($errors as $error)
{
$ia[] = array($attribute, $error);
}
}
$this->ia = $ia;
}
/**
* Iterates through errors using the specified callback.
*
* Example:
*
* <pre>
* $e = new Errors();
* $e['username'] = 'Funny user name';
* $e['password'] = 'Weak password';
*
* $e->each(function($attribute, $message) {
*
* echo "$attribute => $message<br />";
*
* });
* </pre>
*
* @param mixed $callback
*/
public function each($callback)
{
foreach ($this->errors as $attribute => $errors)
{
foreach ($errors as $error)
{
call_user_func($callback, $attribute, $error);
}
}
}
/**
* Clears the errors.
*/
public function clear()
{
$this->errors = array(null => array());
}
/**
* Formats the given string by replacing placeholders with the values provided.
*
* @param string $pattern The format pattern.
* @param array $args An array of replacements for the placeholders.
* @param array $options Options for the formatter.
*
* @return mixed A string or a stringyfiable object.
*
* @see \ICanBoogie\I18n\FormattedString
* @see \ICanBoogie\FormattedString
* @see \ICanBoogie\format
*/
public function format($pattern, array $args=array(), array $options=array())
{
if (!self::$message_constructor)
{
$constructors = array('ICanBoogie\I18n\FormattedString', 'ICanBoogie\FormattedString');
foreach ($constructors as $constructor)
{
if (class_exists($constructor, true))
{
self::$message_constructor = $constructor;
break;
}
}
}
$constructor = self::$message_constructor;
if (!$constructor)
{
return \ICanBoogie\format($pattern, $args);
}
return new $constructor($pattern, $args, $options);
}
/**
* Formats and add an error message.
*
* @param string $id
* @param string $pattern The format pattern.
* @param array $args An array of replacements for the placeholders.
* @param array $options Options for the formatter.
*
* @return string The formatted message.
*/
public function add($id, $pattern, array $args = array(), array $options = array())
{
$this[$id] = $message = $this->format($pattern, $args, $options);
return $message;
}
}