Model.php 28.3 KB
Newer Older
w  
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
w  
Qiang Xue committed
5 6 7
 * @license http://www.yiiframework.com/license/
 */

w  
Qiang Xue committed
8
namespace yii\base;
w  
Qiang Xue committed
9

10
use Yii;
11
use ArrayAccess;
12 13
use ArrayObject;
use ArrayIterator;
14 15
use ReflectionClass;
use IteratorAggregate;
16
use yii\helpers\Inflector;
17
use yii\validators\RequiredValidator;
18
use yii\validators\Validator;
Qiang Xue committed
19

w  
Qiang Xue committed
20
/**
w  
Qiang Xue committed
21
 * Model is the base class for data models.
w  
Qiang Xue committed
22
 *
w  
Qiang Xue committed
23 24 25 26 27 28 29 30
 * Model implements the following commonly used features:
 *
 * - attribute declaration: by default, every public class member is considered as
 *   a model attribute
 * - attribute labels: each attribute may be associated with a label for display purpose
 * - massive attribute assignment
 * - scenario-based validation
 *
Qiang Xue committed
31
 * Model also raises the following events when performing data validation:
w  
Qiang Xue committed
32
 *
Qiang Xue committed
33 34
 * - [[EVENT_BEFORE_VALIDATE]]: an event raised at the beginning of [[validate()]]
 * - [[EVENT_AFTER_VALIDATE]]: an event raised at the end of [[validate()]]
w  
Qiang Xue committed
35 36 37
 *
 * You may directly use Model to store model data, or extend it with customization.
 * You may also customize Model by attaching [[ModelBehavior|model behaviors]].
w  
Qiang Xue committed
38
 *
39 40
 * @property \yii\validators\Validator[] $activeValidators The validators applicable to the current
 * [[scenario]]. This property is read-only.
resurtm committed
41
 * @property array $attributes Attribute values (name => value).
42 43 44 45 46 47
 * @property array $errors An array of errors for all attributes. Empty array is returned if no error. The
 * result is a two-dimensional array. See [[getErrors()]] for detailed description. This property is read-only.
 * @property array $firstErrors The first errors. An empty array will be returned if there is no error. This
 * property is read-only.
 * @property ArrayIterator $iterator An iterator for traversing the items in the list. This property is
 * read-only.
48
 * @property string $scenario The scenario that this model is in. Defaults to [[SCENARIO_DEFAULT]].
49 50
 * @property ArrayObject|\yii\validators\Validator[] $validators All the validators declared in the model.
 * This property is read-only.
Qiang Xue committed
51
 *
w  
Qiang Xue committed
52
 * @author Qiang Xue <qiang.xue@gmail.com>
w  
Qiang Xue committed
53
 * @since 2.0
w  
Qiang Xue committed
54
 */
55
class Model extends Component implements IteratorAggregate, ArrayAccess, Arrayable
w  
Qiang Xue committed
56
{
57 58 59
	/**
	 * The name of the default scenario.
	 */
60
	const SCENARIO_DEFAULT = 'default';
61

62 63 64 65 66 67 68 69 70 71
	/**
	 * @event ModelEvent an event raised at the beginning of [[validate()]]. You may set
	 * [[ModelEvent::isValid]] to be false to stop the validation.
	 */
	const EVENT_BEFORE_VALIDATE = 'beforeValidate';
	/**
	 * @event Event an event raised at the end of [[validate()]]
	 */
	const EVENT_AFTER_VALIDATE = 'afterValidate';

Qiang Xue committed
72 73 74 75 76
	/**
	 * @var array validation errors (attribute name => array of errors)
	 */
	private $_errors;
	/**
77
	 * @var ArrayObject list of validators
Qiang Xue committed
78 79 80 81 82
	 */
	private $_validators;
	/**
	 * @var string current scenario
	 */
83
	private $_scenario = self::SCENARIO_DEFAULT;
w  
Qiang Xue committed
84 85 86 87

	/**
	 * Returns the validation rules for attributes.
	 *
Qiang Xue committed
88
	 * Validation rules are used by [[validate()]] to check if attribute values are valid.
w  
Qiang Xue committed
89 90
	 * Child classes may override this method to declare different validation rules.
	 *
w  
Qiang Xue committed
91
	 * Each rule is an array with the following structure:
w  
Qiang Xue committed
92
	 *
w  
Qiang Xue committed
93
	 * ~~~
Alexander Makarov committed
94
	 * [
95
	 *     ['attribute1', 'attribute2'],
Qiang Xue committed
96
	 *     'validator type',
97
	 *     'on' => ['scenario1', 'scenario2'],
Qiang Xue committed
98
	 *     ...other parameters...
Alexander Makarov committed
99
	 * ]
w  
Qiang Xue committed
100 101
	 * ~~~
	 *
w  
Qiang Xue committed
102
	 * where
w  
Qiang Xue committed
103
	 *
slavcodev committed
104
	 *  - attribute list: required, specifies the attributes array to be validated, for single attribute you can pass string;
105 106
	 *  - validator type: required, specifies the validator to be used. It can be a built-in validator name,
	 *    a method name of the model class, an anonymous function, or a validator class name.
107
	 *  - on: optional, specifies the [[scenario|scenarios]] array when the validation
Qiang Xue committed
108
	 *    rule can be applied. If this option is not set, the rule will apply to all scenarios.
w  
Qiang Xue committed
109
	 *  - additional name-value pairs can be specified to initialize the corresponding validator properties.
Qiang Xue committed
110
	 *    Please refer to individual validator class API for possible properties.
w  
Qiang Xue committed
111
	 *
Qiang Xue committed
112 113
	 * A validator can be either an object of a class extending [[Validator]], or a model class method
	 * (called *inline validator*) that has the following signature:
w  
Qiang Xue committed
114
	 *
w  
Qiang Xue committed
115
	 * ~~~
w  
Qiang Xue committed
116
	 * // $params refers to validation parameters given in the rule
w  
Qiang Xue committed
117 118 119
	 * function validatorName($attribute, $params)
	 * ~~~
	 *
120
	 * In the above `$attribute` refers to currently validated attribute name while `$params` contains an array of
Alexander Makarov committed
121
	 * validator configuration options such as `max` in case of `string` validator. Currently validate attribute value
122 123
	 * can be accessed as `$this->[$attribute]`.
	 *
Qiang Xue committed
124
	 * Yii also provides a set of [[Validator::builtInValidators|built-in validators]].
Qiang Xue committed
125
	 * They each has an alias name which can be used when specifying a validation rule.
w  
Qiang Xue committed
126
	 *
Qiang Xue committed
127
	 * Below are some examples:
w  
Qiang Xue committed
128
	 *
w  
Qiang Xue committed
129
	 * ~~~
Alexander Makarov committed
130
	 * [
Qiang Xue committed
131
	 *     // built-in "required" validator
slavcodev committed
132
	 *     [['username', 'password'], 'required'],
Alexander Makarov committed
133
	 *     // built-in "string" validator customized with "min" and "max" properties
Alexander Makarov committed
134
	 *     ['username', 'string', 'min' => 3, 'max' => 12],
Qiang Xue committed
135
	 *     // built-in "compare" validator that is used in "register" scenario only
Alexander Makarov committed
136
	 *     ['password', 'compare', 'compareAttribute' => 'password2', 'on' => 'register'],
Qiang Xue committed
137
	 *     // an inline validator defined via the "authenticate()" method in the model class
Alexander Makarov committed
138
	 *     ['password', 'authenticate', 'on' => 'login'],
Qiang Xue committed
139
	 *     // a validator of class "DateRangeValidator"
Alexander Makarov committed
140 141
	 *     ['dateRange', 'DateRangeValidator'],
	 * ];
w  
Qiang Xue committed
142
	 * ~~~
w  
Qiang Xue committed
143 144
	 *
	 * Note, in order to inherit rules defined in the parent class, a child class needs to
w  
Qiang Xue committed
145
	 * merge the parent rules with child rules using functions such as `array_merge()`.
w  
Qiang Xue committed
146
	 *
w  
Qiang Xue committed
147
	 * @return array validation rules
148
	 * @see scenarios()
w  
Qiang Xue committed
149 150 151
	 */
	public function rules()
	{
Alexander Makarov committed
152
		return [];
w  
Qiang Xue committed
153 154
	}

155
	/**
156
	 * Returns a list of scenarios and the corresponding active attributes.
Qiang Xue committed
157
	 * An active attribute is one that is subject to validation in the current scenario.
158 159 160
	 * The returned array should be in the following format:
	 *
	 * ~~~
Alexander Makarov committed
161 162 163
	 * [
	 *     'scenario1' => ['attribute11', 'attribute12', ...],
	 *     'scenario2' => ['attribute21', 'attribute22', ...],
164
	 *     ...
Alexander Makarov committed
165
	 * ]
166 167
	 * ~~~
	 *
168
	 * By default, an active attribute is considered safe and can be massively assigned.
169
	 * If an attribute should NOT be massively assigned (thus considered unsafe),
Qiang Xue committed
170
	 * please prefix the attribute with an exclamation character (e.g. '!rank').
171
	 *
Qiang Xue committed
172
	 * The default implementation of this method will return all scenarios found in the [[rules()]]
173
	 * declaration. A special scenario named [[SCENARIO_DEFAULT]] will contain all attributes
174 175
	 * found in the [[rules()]]. Each scenario will be associated with the attributes that
	 * are being validated by the validation rules that apply to the scenario.
Qiang Xue committed
176 177
	 *
	 * @return array a list of scenarios and the corresponding active attributes.
178 179 180
	 */
	public function scenarios()
	{
181
		$scenarios = [self::SCENARIO_DEFAULT => []];
182
		foreach ($this->getValidators() as $validator) {
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
			foreach ($validator->on as $scenario) {
				$scenarios[$scenario] = [];
			}
			foreach ($validator->except as $scenario) {
				$scenarios[$scenario] = [];
			}
		}
		$names = array_keys($scenarios);

		foreach ($this->getValidators() as $validator) {
			if (empty($validator->on) && empty($validator->except)) {
				foreach ($names as $name) {
					foreach ($validator->attributes as $attribute) {
						$scenarios[$name][$attribute] = true;
					}
				}
			} elseif (empty($validator->on)) {
				foreach ($names as $name) {
					if (!in_array($name, $validator->except, true)) {
						foreach ($validator->attributes as $attribute) {
							$scenarios[$name][$attribute] = true;
						}
					}
206 207
				}
			} else {
208
				foreach ($validator->on as $name) {
209
					foreach ($validator->attributes as $attribute) {
210
						$scenarios[$name][$attribute] = true;
211 212 213 214
					}
				}
			}
		}
215

216
		foreach ($scenarios as $scenario => $attributes) {
217
			if (empty($attributes) && $scenario !== self::SCENARIO_DEFAULT) {
218 219 220
				unset($scenarios[$scenario]);
			} else {
				$scenarios[$scenario] = array_keys($attributes);
Qiang Xue committed
221 222
			}
		}
Qiang Xue committed
223

224
		return $scenarios;
225 226
	}

227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
	/**
	 * Returns the form name that this model class should use.
	 *
	 * The form name is mainly used by [[\yii\web\ActiveForm]] to determine how to name
	 * the input fields for the attributes in a model. If the form name is "A" and an attribute
	 * name is "b", then the corresponding input name would be "A[b]". If the form name is
	 * an empty string, then the input name would be "b".
	 *
	 * By default, this method returns the model class name (without the namespace part)
	 * as the form name. You may override it when the model is used in different forms.
	 *
	 * @return string the form name of this model class.
	 */
	public function formName()
	{
242
		$reflector = new ReflectionClass($this);
243
		return $reflector->getShortName();
244 245
	}

246 247 248 249 250 251
	/**
	 * Returns the list of attribute names.
	 * By default, this method returns all public non-static properties of the class.
	 * You may override this method to change the default behavior.
	 * @return array list of attribute names.
	 */
252
	public function attributes()
253
	{
254
		$class = new ReflectionClass($this);
Alexander Makarov committed
255
		$names = [];
256 257
		foreach ($class->getProperties(\ReflectionProperty::IS_PUBLIC) as $property) {
			if (!$property->isStatic()) {
258
				$names[] = $property->getName();
259 260
			}
		}
Qiang Xue committed
261
		return $names;
262 263
	}

w  
Qiang Xue committed
264 265
	/**
	 * Returns the attribute labels.
w  
Qiang Xue committed
266 267 268 269 270
	 *
	 * Attribute labels are mainly used for display purpose. For example, given an attribute
	 * `firstName`, we can declare a label `First Name` which is more user-friendly and can
	 * be displayed to end users.
	 *
Qiang Xue committed
271
	 * By default an attribute label is generated using [[generateAttributeLabel()]].
w  
Qiang Xue committed
272 273 274
	 * This method allows you to explicitly specify attribute labels.
	 *
	 * Note, in order to inherit labels defined in the parent class, a child class needs to
w  
Qiang Xue committed
275
	 * merge the parent labels with child labels using functions such as `array_merge()`.
w  
Qiang Xue committed
276
	 *
resurtm committed
277
	 * @return array attribute labels (name => label)
278
	 * @see generateAttributeLabel()
w  
Qiang Xue committed
279 280 281
	 */
	public function attributeLabels()
	{
Alexander Makarov committed
282
		return [];
w  
Qiang Xue committed
283 284 285
	}

	/**
w  
Qiang Xue committed
286
	 * Performs the data validation.
w  
Qiang Xue committed
287
	 *
288 289 290 291 292
	 * This method executes the validation rules applicable to the current [[scenario]].
	 * The following criteria are used to determine whether a rule is currently applicable:
	 *
	 * - the rule must be associated with the attributes relevant to the current scenario;
	 * - the rules must be effective for the current scenario.
w  
Qiang Xue committed
293
	 *
Qiang Xue committed
294
	 * This method will call [[beforeValidate()]] and [[afterValidate()]] before and
295 296
	 * after the actual validation, respectively. If [[beforeValidate()]] returns false,
	 * the validation will be cancelled and [[afterValidate()]] will not be called.
w  
Qiang Xue committed
297
	 *
298 299
	 * Errors found during the validation can be retrieved via [[getErrors()]],
	 * [[getFirstErrors()]] and [[getFirstError()]].
w  
Qiang Xue committed
300
	 *
w  
Qiang Xue committed
301 302 303
	 * @param array $attributes list of attributes that should be validated.
	 * If this parameter is empty, it means any attribute listed in the applicable
	 * validation rules should be validated.
Qiang Xue committed
304
	 * @param boolean $clearErrors whether to call [[clearErrors()]] before performing validation
w  
Qiang Xue committed
305
	 * @return boolean whether the validation is successful without any error.
306
	 * @throws InvalidParamException if the current scenario is unknown.
w  
Qiang Xue committed
307
	 */
w  
Qiang Xue committed
308
	public function validate($attributes = null, $clearErrors = true)
w  
Qiang Xue committed
309
	{
310 311 312 313 314 315
		$scenarios = $this->scenarios();
		$scenario = $this->getScenario();
		if (!isset($scenarios[$scenario])) {
			throw new InvalidParamException("Unknown scenario: $scenario");
		}

w  
Qiang Xue committed
316
		if ($clearErrors) {
w  
Qiang Xue committed
317
			$this->clearErrors();
w  
Qiang Xue committed
318
		}
319 320 321
		if ($attributes === null) {
			$attributes = $this->activeAttributes();
		}
w  
Qiang Xue committed
322
		if ($this->beforeValidate()) {
w  
Qiang Xue committed
323
			foreach ($this->getActiveValidators() as $validator) {
Qiang Xue committed
324
				$validator->validateAttributes($this, $attributes);
w  
Qiang Xue committed
325
			}
w  
Qiang Xue committed
326 327 328
			$this->afterValidate();
			return !$this->hasErrors();
		}
w  
Qiang Xue committed
329
		return false;
w  
Qiang Xue committed
330 331 332 333
	}

	/**
	 * This method is invoked before validation starts.
Qiang Xue committed
334
	 * The default implementation raises a `beforeValidate` event.
w  
Qiang Xue committed
335 336
	 * You may override this method to do preliminary checks before validation.
	 * Make sure the parent implementation is invoked so that the event can be raised.
337
	 * @return boolean whether the validation should be executed. Defaults to true.
w  
Qiang Xue committed
338 339
	 * If false is returned, the validation will stop and the model is considered invalid.
	 */
w  
Qiang Xue committed
340
	public function beforeValidate()
w  
Qiang Xue committed
341
	{
Qiang Xue committed
342
		$event = new ModelEvent;
343
		$this->trigger(self::EVENT_BEFORE_VALIDATE, $event);
Qiang Xue committed
344
		return $event->isValid;
w  
Qiang Xue committed
345 346 347 348
	}

	/**
	 * This method is invoked after validation ends.
Qiang Xue committed
349
	 * The default implementation raises an `afterValidate` event.
w  
Qiang Xue committed
350 351 352
	 * You may override this method to do postprocessing after validation.
	 * Make sure the parent implementation is invoked so that the event can be raised.
	 */
w  
Qiang Xue committed
353
	public function afterValidate()
w  
Qiang Xue committed
354
	{
355
		$this->trigger(self::EVENT_AFTER_VALIDATE);
w  
Qiang Xue committed
356 357 358
	}

	/**
Qiang Xue committed
359
	 * Returns all the validators declared in [[rules()]].
w  
Qiang Xue committed
360
	 *
Qiang Xue committed
361
	 * This method differs from [[getActiveValidators()]] in that the latter
w  
Qiang Xue committed
362 363
	 * only returns the validators applicable to the current [[scenario]].
	 *
364
	 * Because this method returns an ArrayObject object, you may
w  
Qiang Xue committed
365 366 367
	 * manipulate it by inserting or removing validators (useful in model behaviors).
	 * For example,
	 *
w  
Qiang Xue committed
368
	 * ~~~
369
	 * $model->validators[] = $newValidator;
w  
Qiang Xue committed
370 371
	 * ~~~
	 *
slavcodev committed
372
	 * @return ArrayObject|\yii\validators\Validator[] all the validators declared in the model.
w  
Qiang Xue committed
373
	 */
w  
Qiang Xue committed
374
	public function getValidators()
w  
Qiang Xue committed
375
	{
w  
Qiang Xue committed
376
		if ($this->_validators === null) {
w  
Qiang Xue committed
377
			$this->_validators = $this->createValidators();
w  
Qiang Xue committed
378
		}
w  
Qiang Xue committed
379 380 381 382
		return $this->_validators;
	}

	/**
w  
Qiang Xue committed
383 384
	 * Returns the validators applicable to the current [[scenario]].
	 * @param string $attribute the name of the attribute whose applicable validators should be returned.
w  
Qiang Xue committed
385
	 * If this is null, the validators for ALL attributes in the model will be returned.
Qiang Xue committed
386
	 * @return \yii\validators\Validator[] the validators applicable to the current [[scenario]].
w  
Qiang Xue committed
387
	 */
w  
Qiang Xue committed
388
	public function getActiveValidators($attribute = null)
w  
Qiang Xue committed
389
	{
Alexander Makarov committed
390
		$validators = [];
w  
Qiang Xue committed
391
		$scenario = $this->getScenario();
w  
Qiang Xue committed
392
		foreach ($this->getValidators() as $validator) {
Qiang Xue committed
393
			if ($validator->isActive($scenario) && ($attribute === null || in_array($attribute, $validator->attributes, true))) {
Qiang Xue committed
394
				$validators[] = $validator;
w  
Qiang Xue committed
395 396 397 398 399 400
			}
		}
		return $validators;
	}

	/**
Qiang Xue committed
401 402
	 * Creates validator objects based on the validation rules specified in [[rules()]].
	 * Unlike [[getValidators()]], each time this method is called, a new list of validators will be returned.
403
	 * @return ArrayObject validators
Qiang Xue committed
404
	 * @throws InvalidConfigException if any validation rule configuration is invalid
w  
Qiang Xue committed
405 406 407
	 */
	public function createValidators()
	{
408
		$validators = new ArrayObject;
w  
Qiang Xue committed
409
		foreach ($this->rules() as $rule) {
410
			if ($rule instanceof Validator) {
411
				$validators->append($rule);
412
			} elseif (is_array($rule) && isset($rule[0], $rule[1])) { // attributes, validator type
413
				$validator = Validator::createValidator($rule[1], $this, (array) $rule[0], array_slice($rule, 2));
414
				$validators->append($validator);
Qiang Xue committed
415
			} else {
Qiang Xue committed
416
				throw new InvalidConfigException('Invalid validation rule: a rule must specify both attribute names and validator type.');
w  
Qiang Xue committed
417
			}
w  
Qiang Xue committed
418 419 420 421 422 423 424
		}
		return $validators;
	}

	/**
	 * Returns a value indicating whether the attribute is required.
	 * This is determined by checking if the attribute is associated with a
w  
Qiang Xue committed
425
	 * [[\yii\validators\RequiredValidator|required]] validation rule in the
w  
Qiang Xue committed
426
	 * current [[scenario]].
w  
Qiang Xue committed
427 428 429 430 431
	 * @param string $attribute attribute name
	 * @return boolean whether the attribute is required
	 */
	public function isAttributeRequired($attribute)
	{
w  
Qiang Xue committed
432
		foreach ($this->getActiveValidators($attribute) as $validator) {
433
			if ($validator instanceof RequiredValidator) {
w  
Qiang Xue committed
434
				return true;
w  
Qiang Xue committed
435
			}
w  
Qiang Xue committed
436 437 438 439 440 441 442 443
		}
		return false;
	}

	/**
	 * Returns a value indicating whether the attribute is safe for massive assignments.
	 * @param string $attribute attribute name
	 * @return boolean whether the attribute is safe for massive assignments
444
	 * @see safeAttributes()
w  
Qiang Xue committed
445 446 447
	 */
	public function isAttributeSafe($attribute)
	{
448
		return in_array($attribute, $this->safeAttributes(), true);
w  
Qiang Xue committed
449 450
	}

451 452 453 454 455 456 457 458 459 460 461
	/**
	 * Returns a value indicating whether the attribute is active in the current scenario.
	 * @param string $attribute attribute name
	 * @return boolean whether the attribute is active in the current scenario
	 * @see activeAttributes()
	 */
	public function isAttributeActive($attribute)
	{
		return in_array($attribute, $this->activeAttributes(), true);
	}

w  
Qiang Xue committed
462 463 464 465
	/**
	 * Returns the text label for the specified attribute.
	 * @param string $attribute the attribute name
	 * @return string the attribute label
466 467
	 * @see generateAttributeLabel()
	 * @see attributeLabels()
w  
Qiang Xue committed
468 469 470
	 */
	public function getAttributeLabel($attribute)
	{
w  
Qiang Xue committed
471
		$labels = $this->attributeLabels();
Alex committed
472
		return isset($labels[$attribute]) ? $labels[$attribute] : $this->generateAttributeLabel($attribute);
w  
Qiang Xue committed
473 474 475 476
	}

	/**
	 * Returns a value indicating whether there is any validation error.
477
	 * @param string|null $attribute attribute name. Use null to check all attributes.
w  
Qiang Xue committed
478 479
	 * @return boolean whether there is any error.
	 */
w  
Qiang Xue committed
480
	public function hasErrors($attribute = null)
w  
Qiang Xue committed
481
	{
w  
Qiang Xue committed
482
		return $attribute === null ? !empty($this->_errors) : isset($this->_errors[$attribute]);
w  
Qiang Xue committed
483 484 485 486 487
	}

	/**
	 * Returns the errors for all attribute or a single attribute.
	 * @param string $attribute attribute name. Use null to retrieve errors for all attributes.
488 489
	 * @property array An array of errors for all attributes. Empty array is returned if no error.
	 * The result is a two-dimensional array. See [[getErrors()]] for detailed description.
w  
Qiang Xue committed
490
	 * @return array errors for all attributes or the specified attribute. Empty array is returned if no error.
w  
Qiang Xue committed
491 492
	 * Note that when returning errors for all attributes, the result is a two-dimensional array, like the following:
	 *
w  
Qiang Xue committed
493
	 * ~~~
Alexander Makarov committed
494 495
	 * [
	 *     'username' => [
Qiang Xue committed
496 497
	 *         'Username is required.',
	 *         'Username must contain only word characters.',
Alexander Makarov committed
498 499
	 *     ],
	 *     'email' => [
Qiang Xue committed
500
	 *         'Email address is invalid.',
Alexander Makarov committed
501 502
	 *     ]
	 * ]
w  
Qiang Xue committed
503 504
	 * ~~~
	 *
505 506
	 * @see getFirstErrors()
	 * @see getFirstError()
w  
Qiang Xue committed
507
	 */
w  
Qiang Xue committed
508
	public function getErrors($attribute = null)
w  
Qiang Xue committed
509
	{
w  
Qiang Xue committed
510
		if ($attribute === null) {
Alexander Makarov committed
511
			return $this->_errors === null ? [] : $this->_errors;
Qiang Xue committed
512
		} else {
Alexander Makarov committed
513
			return isset($this->_errors[$attribute]) ? $this->_errors[$attribute] : [];
w  
Qiang Xue committed
514
		}
w  
Qiang Xue committed
515 516
	}

Qiang Xue committed
517 518 519
	/**
	 * Returns the first error of every attribute in the model.
	 * @return array the first errors. An empty array will be returned if there is no error.
520 521
	 * @see getErrors()
	 * @see getFirstError()
Qiang Xue committed
522 523 524 525
	 */
	public function getFirstErrors()
	{
		if (empty($this->_errors)) {
Alexander Makarov committed
526
			return [];
Qiang Xue committed
527
		} else {
Alexander Makarov committed
528
			$errors = [];
529 530 531
			foreach ($this->_errors as $attributeErrors) {
				if (isset($attributeErrors[0])) {
					$errors[] = $attributeErrors[0];
Qiang Xue committed
532 533 534 535 536 537
				}
			}
		}
		return $errors;
	}

w  
Qiang Xue committed
538 539 540 541
	/**
	 * Returns the first error of the specified attribute.
	 * @param string $attribute attribute name.
	 * @return string the error message. Null is returned if no error.
542 543
	 * @see getErrors()
	 * @see getFirstErrors()
w  
Qiang Xue committed
544
	 */
Qiang Xue committed
545
	public function getFirstError($attribute)
w  
Qiang Xue committed
546 547 548 549 550 551 552 553 554
	{
		return isset($this->_errors[$attribute]) ? reset($this->_errors[$attribute]) : null;
	}

	/**
	 * Adds a new error to the specified attribute.
	 * @param string $attribute attribute name
	 * @param string $error new error message
	 */
555
	public function addError($attribute, $error = '')
w  
Qiang Xue committed
556
	{
w  
Qiang Xue committed
557
		$this->_errors[$attribute][] = $error;
w  
Qiang Xue committed
558 559 560 561 562 563
	}

	/**
	 * Removes errors for all attributes or a single attribute.
	 * @param string $attribute attribute name. Use null to remove errors for all attribute.
	 */
w  
Qiang Xue committed
564
	public function clearErrors($attribute = null)
w  
Qiang Xue committed
565
	{
w  
Qiang Xue committed
566
		if ($attribute === null) {
Alexander Makarov committed
567
			$this->_errors = [];
Qiang Xue committed
568
		} else {
w  
Qiang Xue committed
569
			unset($this->_errors[$attribute]);
w  
Qiang Xue committed
570
		}
w  
Qiang Xue committed
571 572 573
	}

	/**
w  
Qiang Xue committed
574 575
	 * Generates a user friendly attribute label based on the give attribute name.
	 * This is done by replacing underscores, dashes and dots with blanks and
w  
Qiang Xue committed
576
	 * changing the first letter of each word to upper case.
w  
Qiang Xue committed
577
	 * For example, 'department_name' or 'DepartmentName' will generate 'Department Name'.
w  
Qiang Xue committed
578 579 580 581 582
	 * @param string $name the column name
	 * @return string the attribute label
	 */
	public function generateAttributeLabel($name)
	{
583
		return Inflector::camel2words($name, true);
w  
Qiang Xue committed
584 585 586
	}

	/**
w  
Qiang Xue committed
587
	 * Returns attribute values.
w  
Qiang Xue committed
588
	 * @param array $names list of attributes whose value needs to be returned.
589
	 * Defaults to null, meaning all attributes listed in [[attributes()]] will be returned.
w  
Qiang Xue committed
590
	 * If it is an array, only the attributes in the array will be returned.
591
	 * @param array $except list of attributes whose value should NOT be returned.
resurtm committed
592
	 * @return array attribute values (name => value).
w  
Qiang Xue committed
593
	 */
Alexander Makarov committed
594
	public function getAttributes($names = null, $except = [])
w  
Qiang Xue committed
595
	{
Alexander Makarov committed
596
		$values = [];
597 598 599 600 601 602 603 604
		if ($names === null) {
			$names = $this->attributes();
		}
		foreach ($names as $name) {
			$values[$name] = $this->$name;
		}
		foreach ($except as $name) {
			unset($values[$name]);
w  
Qiang Xue committed
605 606 607
		}

		return $values;
w  
Qiang Xue committed
608 609 610 611
	}

	/**
	 * Sets the attribute values in a massive way.
resurtm committed
612
	 * @param array $values attribute values (name => value) to be assigned to the model.
w  
Qiang Xue committed
613
	 * @param boolean $safeOnly whether the assignments should only be done to the safe attributes.
w  
Qiang Xue committed
614
	 * A safe attribute is one that is associated with a validation rule in the current [[scenario]].
615 616
	 * @see safeAttributes()
	 * @see attributes()
w  
Qiang Xue committed
617
	 */
w  
Qiang Xue committed
618
	public function setAttributes($values, $safeOnly = true)
w  
Qiang Xue committed
619
	{
w  
Qiang Xue committed
620
		if (is_array($values)) {
621
			$attributes = array_flip($safeOnly ? $this->safeAttributes() : $this->attributes());
w  
Qiang Xue committed
622 623 624
			foreach ($values as $name => $value) {
				if (isset($attributes[$name])) {
					$this->$name = $value;
Qiang Xue committed
625
				} elseif ($safeOnly) {
w  
Qiang Xue committed
626 627 628
					$this->onUnsafeAttribute($name, $value);
				}
			}
w  
Qiang Xue committed
629 630 631 632 633 634 635 636 637 638
		}
	}

	/**
	 * This method is invoked when an unsafe attribute is being massively assigned.
	 * The default implementation will log a warning message if YII_DEBUG is on.
	 * It does nothing otherwise.
	 * @param string $name the unsafe attribute name
	 * @param mixed $value the attribute value
	 */
w  
Qiang Xue committed
639
	public function onUnsafeAttribute($name, $value)
w  
Qiang Xue committed
640
	{
w  
Qiang Xue committed
641
		if (YII_DEBUG) {
Qiang Xue committed
642
			Yii::trace("Failed to set unsafe attribute '$name' in '" . get_class($this) . "'.", __METHOD__);
w  
Qiang Xue committed
643
		}
w  
Qiang Xue committed
644 645 646 647 648 649 650 651
	}

	/**
	 * Returns the scenario that this model is used in.
	 *
	 * Scenario affects how validation is performed and which attributes can
	 * be massively assigned.
	 *
652
	 * @return string the scenario that this model is in. Defaults to [[SCENARIO_DEFAULT]].
w  
Qiang Xue committed
653 654 655 656 657 658 659 660
	 */
	public function getScenario()
	{
		return $this->_scenario;
	}

	/**
	 * Sets the scenario for the model.
661 662
	 * Note that this method does not check if the scenario exists or not.
	 * The method [[validate()]] will perform this check.
w  
Qiang Xue committed
663 664 665 666
	 * @param string $value the scenario that this model is in.
	 */
	public function setScenario($value)
	{
w  
Qiang Xue committed
667
		$this->_scenario = $value;
w  
Qiang Xue committed
668 669 670
	}

	/**
671
	 * Returns the attribute names that are safe to be massively assigned in the current scenario.
672
	 * @return string[] safe attribute names
w  
Qiang Xue committed
673
	 */
674
	public function safeAttributes()
w  
Qiang Xue committed
675
	{
676
		$scenario = $this->getScenario();
677
		$scenarios = $this->scenarios();
678
		if (!isset($scenarios[$scenario])) {
Alexander Makarov committed
679
			return [];
680
		}
Alexander Makarov committed
681
		$attributes = [];
682 683 684
		foreach ($scenarios[$scenario] as $attribute) {
			if ($attribute[0] !== '!') {
				$attributes[] = $attribute;
w  
Qiang Xue committed
685 686
			}
		}
Qiang Xue committed
687
		return $attributes;
688
	}
w  
Qiang Xue committed
689

690 691
	/**
	 * Returns the attribute names that are subject to validation in the current scenario.
692
	 * @return string[] safe attribute names
693 694 695
	 */
	public function activeAttributes()
	{
696
		$scenario = $this->getScenario();
697
		$scenarios = $this->scenarios();
698
		if (!isset($scenarios[$scenario])) {
Alexander Makarov committed
699
			return [];
w  
Qiang Xue committed
700
		}
701
		$attributes = $scenarios[$scenario];
702 703 704 705 706 707
		foreach ($attributes as $i => $attribute) {
			if ($attribute[0] === '!') {
				$attributes[$i] = substr($attribute, 1);
			}
		}
		return $attributes;
w  
Qiang Xue committed
708 709
	}

710 711
	/**
	 * Populates the model with the data from end user.
712 713 714
	 * The data to be loaded is `$data[formName]`, where `formName` refers to the value of [[formName()]].
	 * If [[formName()]] is empty, the whole `$data` array will be used to populate the model.
	 * The data being populated is subject to the safety check by [[setAttributes()]].
715 716
	 * @param array $data the data array. This is usually `$_POST` or `$_GET`, but can also be any valid array
	 * supplied by end user.
717 718
	 * @param string $formName the form name to be used for loading the data into the model.
	 * If not set, [[formName()]] will be used.
719 720
	 * @return boolean whether the model is successfully populated with some data.
	 */
721
	public function load($data, $formName = null)
722
	{
723
		$scope = $formName === null ? $this->formName() : $formName;
724
		if ($scope == '' && !empty($data)) {
725 726 727 728 729 730 731 732 733 734
			$this->setAttributes($data);
			return true;
		} elseif (isset($data[$scope])) {
			$this->setAttributes($data[$scope]);
			return true;
		} else {
			return false;
		}
	}

735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
	/**
	 * Populates a set of models with the data from end user.
	 * This method is mainly used to collect tabular data input.
	 * The data to be loaded for each model is `$data[formName][index]`, where `formName`
	 * refers to the value of [[formName()]], and `index` the index of the model in the `$models` array.
	 * If [[formName()]] is empty, `$data[index]` will be used to populate each model.
	 * The data being populated to each model is subject to the safety check by [[setAttributes()]].
	 * @param array $models the models to be populated. Note that all models should have the same class.
	 * @param array $data the data array. This is usually `$_POST` or `$_GET`, but can also be any valid array
	 * supplied by end user.
	 * @return boolean whether the model is successfully populated with some data.
	 */
	public static function loadMultiple($models, $data)
	{
		/** @var Model $model */
		$model = reset($models);
		if ($model === false) {
			return false;
		}
		$success = false;
		$scope = $model->formName();
		foreach ($models as $i => $model) {
			if ($scope == '') {
				if (isset($data[$i])) {
					$model->setAttributes($data[$i]);
					$success = true;
				}
			} elseif (isset($data[$scope][$i])) {
763
				$model->setAttributes($data[$scope][$i]);
764 765 766 767 768 769 770 771
				$success = true;
			}
		}
		return $success;
	}

	/**
	 * Validates multiple models.
772 773
	 * This method will validate every model. The models being validated may
	 * be of the same or different types.
774
	 * @param array $models the models to be validated
775 776 777
	 * @param array $attributes list of attributes that should be validated.
	 * If this parameter is empty, it means any attribute listed in the applicable
	 * validation rules should be validated.
778 779 780
	 * @return boolean whether all models are valid. False will be returned if one
	 * or multiple models have validation error.
	 */
781
	public static function validateMultiple($models, $attributes = null)
782 783 784 785
	{
		$valid = true;
		/** @var Model $model */
		foreach ($models as $model) {
786
			$valid = $model->validate($attributes) && $valid;
787 788 789 790
		}
		return $valid;
	}

Qiang Xue committed
791
	/**
792
	 * Converts the object into an array.
Qiang Xue committed
793
	 * The default implementation will return [[attributes]].
794
	 * @return array the array representation of the object
Qiang Xue committed
795
	 */
796
	public function toArray()
Qiang Xue committed
797
	{
798
		return $this->getAttributes();
Qiang Xue committed
799 800
	}

w  
Qiang Xue committed
801 802 803
	/**
	 * Returns an iterator for traversing the attributes in the model.
	 * This method is required by the interface IteratorAggregate.
804
	 * @return ArrayIterator an iterator for traversing the items in the list.
w  
Qiang Xue committed
805 806 807
	 */
	public function getIterator()
	{
w  
Qiang Xue committed
808
		$attributes = $this->getAttributes();
809
		return new ArrayIterator($attributes);
w  
Qiang Xue committed
810 811 812 813
	}

	/**
	 * Returns whether there is an element at the specified offset.
w  
Qiang Xue committed
814 815
	 * This method is required by the SPL interface `ArrayAccess`.
	 * It is implicitly called when you use something like `isset($model[$offset])`.
w  
Qiang Xue committed
816 817 818 819 820
	 * @param mixed $offset the offset to check on
	 * @return boolean
	 */
	public function offsetExists($offset)
	{
Qiang Xue committed
821
		return $this->$offset !== null;
w  
Qiang Xue committed
822 823 824 825
	}

	/**
	 * Returns the element at the specified offset.
w  
Qiang Xue committed
826 827
	 * This method is required by the SPL interface `ArrayAccess`.
	 * It is implicitly called when you use something like `$value = $model[$offset];`.
w  
Qiang Xue committed
828
	 * @param mixed $offset the offset to retrieve element.
w  
Qiang Xue committed
829 830 831 832 833 834 835 836 837
	 * @return mixed the element at the offset, null if no element is found at the offset
	 */
	public function offsetGet($offset)
	{
		return $this->$offset;
	}

	/**
	 * Sets the element at the specified offset.
w  
Qiang Xue committed
838 839
	 * This method is required by the SPL interface `ArrayAccess`.
	 * It is implicitly called when you use something like `$model[$offset] = $item;`.
w  
Qiang Xue committed
840 841 842
	 * @param integer $offset the offset to set element
	 * @param mixed $item the element value
	 */
w  
Qiang Xue committed
843
	public function offsetSet($offset, $item)
w  
Qiang Xue committed
844
	{
w  
Qiang Xue committed
845
		$this->$offset = $item;
w  
Qiang Xue committed
846 847 848
	}

	/**
849
	 * Sets the element value at the specified offset to null.
w  
Qiang Xue committed
850 851
	 * This method is required by the SPL interface `ArrayAccess`.
	 * It is implicitly called when you use something like `unset($model[$offset])`.
w  
Qiang Xue committed
852 853 854 855
	 * @param mixed $offset the offset to unset element
	 */
	public function offsetUnset($offset)
	{
856
		$this->$offset = null;
w  
Qiang Xue committed
857 858
	}
}