Model.php 27.7 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 [[DEFAULT_SCENARIO]].
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
w  
Qiang Xue committed
56
{
57 58 59 60 61
	/**
	 * The name of the default scenario.
	 */
	const DEFAULT_SCENARIO = 'default';

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::DEFAULT_SCENARIO;
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;
w  
Qiang Xue committed
105
	 *  - validator type: required, specifies the validator to be used. It can be the name of a model
Qiang Xue committed
106
	 *    class method, the name of a built-in validator, or a validator class name (or its path alias).
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
	 * ~~~
	 *
Qiang Xue committed
168
	 * By default, an active attribute that 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 174 175
	 * declaration. A special scenario named [[DEFAULT_SCENARIO]] will contain all attributes
	 * 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()
	{
Alexander Makarov committed
181 182
		$scenarios = [];
		$defaults = [];
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
		/** @var $validator Validator */
		foreach ($this->getValidators() as $validator) {
			if (empty($validator->on)) {
				foreach ($validator->attributes as $attribute) {
					$defaults[$attribute] = true;
				}
			} else {
				foreach ($validator->on as $scenario) {
					foreach ($validator->attributes as $attribute) {
						$scenarios[$scenario][$attribute] = true;
					}
				}
			}
		}
		foreach ($scenarios as $scenario => $attributes) {
			foreach (array_keys($defaults) as $attribute) {
				$attributes[$attribute] = true;
Qiang Xue committed
200
			}
201
			$scenarios[$scenario] = array_keys($attributes);
Qiang Xue committed
202
		}
203 204
		$scenarios[self::DEFAULT_SCENARIO] = array_keys($defaults);
		return $scenarios;
205 206
	}

207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
	/**
	 * 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()
	{
222
		$reflector = new ReflectionClass($this);
223
		return $reflector->getShortName();
224 225
	}

226 227 228 229 230 231
	/**
	 * 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.
	 */
232
	public static function attributes()
233
	{
234
		$class = new ReflectionClass(get_called_class());
Alexander Makarov committed
235
		$names = [];
236 237
		foreach ($class->getProperties(\ReflectionProperty::IS_PUBLIC) as $property) {
			if (!$property->isStatic()) {
238
				$names[] = $property->getName();
239 240
			}
		}
Qiang Xue committed
241
		return $names;
242 243
	}

w  
Qiang Xue committed
244 245
	/**
	 * Returns the attribute labels.
w  
Qiang Xue committed
246 247 248 249 250
	 *
	 * 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
251
	 * By default an attribute label is generated using [[generateAttributeLabel()]].
w  
Qiang Xue committed
252 253 254
	 * 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
255
	 * merge the parent labels with child labels using functions such as `array_merge()`.
w  
Qiang Xue committed
256
	 *
resurtm committed
257
	 * @return array attribute labels (name => label)
258
	 * @see generateAttributeLabel()
w  
Qiang Xue committed
259 260 261
	 */
	public function attributeLabels()
	{
Alexander Makarov committed
262
		return [];
w  
Qiang Xue committed
263 264 265
	}

	/**
w  
Qiang Xue committed
266
	 * Performs the data validation.
w  
Qiang Xue committed
267
	 *
268 269 270 271 272
	 * 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
273
	 *
Qiang Xue committed
274
	 * This method will call [[beforeValidate()]] and [[afterValidate()]] before and
275 276
	 * after the actual validation, respectively. If [[beforeValidate()]] returns false,
	 * the validation will be cancelled and [[afterValidate()]] will not be called.
w  
Qiang Xue committed
277
	 *
278 279
	 * Errors found during the validation can be retrieved via [[getErrors()]],
	 * [[getFirstErrors()]] and [[getFirstError()]].
w  
Qiang Xue committed
280
	 *
w  
Qiang Xue committed
281 282 283
	 * @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
284
	 * @param boolean $clearErrors whether to call [[clearErrors()]] before performing validation
w  
Qiang Xue committed
285
	 * @return boolean whether the validation is successful without any error.
286
	 * @throws InvalidParamException if the current scenario is unknown.
w  
Qiang Xue committed
287
	 */
w  
Qiang Xue committed
288
	public function validate($attributes = null, $clearErrors = true)
w  
Qiang Xue committed
289
	{
290 291 292 293 294 295
		$scenarios = $this->scenarios();
		$scenario = $this->getScenario();
		if (!isset($scenarios[$scenario])) {
			throw new InvalidParamException("Unknown scenario: $scenario");
		}

w  
Qiang Xue committed
296
		if ($clearErrors) {
w  
Qiang Xue committed
297
			$this->clearErrors();
w  
Qiang Xue committed
298
		}
299 300 301
		if ($attributes === null) {
			$attributes = $this->activeAttributes();
		}
w  
Qiang Xue committed
302
		if ($this->beforeValidate()) {
w  
Qiang Xue committed
303
			foreach ($this->getActiveValidators() as $validator) {
w  
Qiang Xue committed
304 305
				$validator->validate($this, $attributes);
			}
w  
Qiang Xue committed
306 307 308
			$this->afterValidate();
			return !$this->hasErrors();
		}
w  
Qiang Xue committed
309
		return false;
w  
Qiang Xue committed
310 311 312 313
	}

	/**
	 * This method is invoked before validation starts.
Qiang Xue committed
314
	 * The default implementation raises a `beforeValidate` event.
w  
Qiang Xue committed
315 316
	 * 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.
317
	 * @return boolean whether the validation should be executed. Defaults to true.
w  
Qiang Xue committed
318 319
	 * If false is returned, the validation will stop and the model is considered invalid.
	 */
w  
Qiang Xue committed
320
	public function beforeValidate()
w  
Qiang Xue committed
321
	{
Qiang Xue committed
322
		$event = new ModelEvent;
323
		$this->trigger(self::EVENT_BEFORE_VALIDATE, $event);
Qiang Xue committed
324
		return $event->isValid;
w  
Qiang Xue committed
325 326 327 328
	}

	/**
	 * This method is invoked after validation ends.
Qiang Xue committed
329
	 * The default implementation raises an `afterValidate` event.
w  
Qiang Xue committed
330 331 332
	 * 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
333
	public function afterValidate()
w  
Qiang Xue committed
334
	{
335
		$this->trigger(self::EVENT_AFTER_VALIDATE);
w  
Qiang Xue committed
336 337 338
	}

	/**
Qiang Xue committed
339
	 * Returns all the validators declared in [[rules()]].
w  
Qiang Xue committed
340
	 *
Qiang Xue committed
341
	 * This method differs from [[getActiveValidators()]] in that the latter
w  
Qiang Xue committed
342 343
	 * only returns the validators applicable to the current [[scenario]].
	 *
344
	 * Because this method returns an ArrayObject object, you may
w  
Qiang Xue committed
345 346 347
	 * manipulate it by inserting or removing validators (useful in model behaviors).
	 * For example,
	 *
w  
Qiang Xue committed
348
	 * ~~~
349
	 * $model->validators[] = $newValidator;
w  
Qiang Xue committed
350 351
	 * ~~~
	 *
slavcodev committed
352
	 * @return ArrayObject|\yii\validators\Validator[] all the validators declared in the model.
w  
Qiang Xue committed
353
	 */
w  
Qiang Xue committed
354
	public function getValidators()
w  
Qiang Xue committed
355
	{
w  
Qiang Xue committed
356
		if ($this->_validators === null) {
w  
Qiang Xue committed
357
			$this->_validators = $this->createValidators();
w  
Qiang Xue committed
358
		}
w  
Qiang Xue committed
359 360 361 362
		return $this->_validators;
	}

	/**
w  
Qiang Xue committed
363 364
	 * 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
365
	 * If this is null, the validators for ALL attributes in the model will be returned.
Qiang Xue committed
366
	 * @return \yii\validators\Validator[] the validators applicable to the current [[scenario]].
w  
Qiang Xue committed
367
	 */
w  
Qiang Xue committed
368
	public function getActiveValidators($attribute = null)
w  
Qiang Xue committed
369
	{
Alexander Makarov committed
370
		$validators = [];
w  
Qiang Xue committed
371
		$scenario = $this->getScenario();
w  
Qiang Xue committed
372
		foreach ($this->getValidators() as $validator) {
Qiang Xue committed
373
			if ($validator->isActive($scenario) && ($attribute === null || in_array($attribute, $validator->attributes, true))) {
Qiang Xue committed
374
				$validators[] = $validator;
w  
Qiang Xue committed
375 376 377 378 379 380
			}
		}
		return $validators;
	}

	/**
Qiang Xue committed
381 382
	 * 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.
383
	 * @return ArrayObject validators
Qiang Xue committed
384
	 * @throws InvalidConfigException if any validation rule configuration is invalid
w  
Qiang Xue committed
385 386 387
	 */
	public function createValidators()
	{
388
		$validators = new ArrayObject;
w  
Qiang Xue committed
389
		foreach ($this->rules() as $rule) {
390
			if ($rule instanceof Validator) {
391
				$validators->append($rule);
392
			} elseif (is_array($rule) && isset($rule[0], $rule[1])) { // attributes, validator type
393
				$validator = Validator::createValidator($rule[1], $this, (array) $rule[0], array_slice($rule, 2));
394
				$validators->append($validator);
Qiang Xue committed
395
			} else {
Qiang Xue committed
396
				throw new InvalidConfigException('Invalid validation rule: a rule must specify both attribute names and validator type.');
w  
Qiang Xue committed
397
			}
w  
Qiang Xue committed
398 399 400 401 402 403 404
		}
		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
405
	 * [[\yii\validators\RequiredValidator|required]] validation rule in the
w  
Qiang Xue committed
406
	 * current [[scenario]].
w  
Qiang Xue committed
407 408 409 410 411
	 * @param string $attribute attribute name
	 * @return boolean whether the attribute is required
	 */
	public function isAttributeRequired($attribute)
	{
w  
Qiang Xue committed
412
		foreach ($this->getActiveValidators($attribute) as $validator) {
413
			if ($validator instanceof RequiredValidator) {
w  
Qiang Xue committed
414
				return true;
w  
Qiang Xue committed
415
			}
w  
Qiang Xue committed
416 417 418 419 420 421 422 423
		}
		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
424
	 * @see safeAttributes()
w  
Qiang Xue committed
425 426 427
	 */
	public function isAttributeSafe($attribute)
	{
428
		return in_array($attribute, $this->safeAttributes(), true);
w  
Qiang Xue committed
429 430
	}

431 432 433 434 435 436 437 438 439 440 441
	/**
	 * 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
442 443 444 445
	/**
	 * Returns the text label for the specified attribute.
	 * @param string $attribute the attribute name
	 * @return string the attribute label
446 447
	 * @see generateAttributeLabel()
	 * @see attributeLabels()
w  
Qiang Xue committed
448 449 450
	 */
	public function getAttributeLabel($attribute)
	{
w  
Qiang Xue committed
451
		$labels = $this->attributeLabels();
Alex committed
452
		return isset($labels[$attribute]) ? $labels[$attribute] : $this->generateAttributeLabel($attribute);
w  
Qiang Xue committed
453 454 455 456
	}

	/**
	 * Returns a value indicating whether there is any validation error.
457
	 * @param string|null $attribute attribute name. Use null to check all attributes.
w  
Qiang Xue committed
458 459
	 * @return boolean whether there is any error.
	 */
w  
Qiang Xue committed
460
	public function hasErrors($attribute = null)
w  
Qiang Xue committed
461
	{
w  
Qiang Xue committed
462
		return $attribute === null ? !empty($this->_errors) : isset($this->_errors[$attribute]);
w  
Qiang Xue committed
463 464 465 466 467
	}

	/**
	 * Returns the errors for all attribute or a single attribute.
	 * @param string $attribute attribute name. Use null to retrieve errors for all attributes.
468 469
	 * @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
470
	 * @return array errors for all attributes or the specified attribute. Empty array is returned if no error.
w  
Qiang Xue committed
471 472
	 * Note that when returning errors for all attributes, the result is a two-dimensional array, like the following:
	 *
w  
Qiang Xue committed
473
	 * ~~~
Alexander Makarov committed
474 475
	 * [
	 *     'username' => [
Qiang Xue committed
476 477
	 *         'Username is required.',
	 *         'Username must contain only word characters.',
Alexander Makarov committed
478 479
	 *     ],
	 *     'email' => [
Qiang Xue committed
480
	 *         'Email address is invalid.',
Alexander Makarov committed
481 482
	 *     ]
	 * ]
w  
Qiang Xue committed
483 484
	 * ~~~
	 *
485 486
	 * @see getFirstErrors()
	 * @see getFirstError()
w  
Qiang Xue committed
487
	 */
w  
Qiang Xue committed
488
	public function getErrors($attribute = null)
w  
Qiang Xue committed
489
	{
w  
Qiang Xue committed
490
		if ($attribute === null) {
Alexander Makarov committed
491
			return $this->_errors === null ? [] : $this->_errors;
Qiang Xue committed
492
		} else {
Alexander Makarov committed
493
			return isset($this->_errors[$attribute]) ? $this->_errors[$attribute] : [];
w  
Qiang Xue committed
494
		}
w  
Qiang Xue committed
495 496
	}

Qiang Xue committed
497 498 499
	/**
	 * 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.
500 501
	 * @see getErrors()
	 * @see getFirstError()
Qiang Xue committed
502 503 504 505
	 */
	public function getFirstErrors()
	{
		if (empty($this->_errors)) {
Alexander Makarov committed
506
			return [];
Qiang Xue committed
507
		} else {
Alexander Makarov committed
508
			$errors = [];
509 510 511
			foreach ($this->_errors as $attributeErrors) {
				if (isset($attributeErrors[0])) {
					$errors[] = $attributeErrors[0];
Qiang Xue committed
512 513 514 515 516 517
				}
			}
		}
		return $errors;
	}

w  
Qiang Xue committed
518 519 520 521
	/**
	 * Returns the first error of the specified attribute.
	 * @param string $attribute attribute name.
	 * @return string the error message. Null is returned if no error.
522 523
	 * @see getErrors()
	 * @see getFirstErrors()
w  
Qiang Xue committed
524
	 */
Qiang Xue committed
525
	public function getFirstError($attribute)
w  
Qiang Xue committed
526 527 528 529 530 531 532 533 534
	{
		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
	 */
535
	public function addError($attribute, $error = '')
w  
Qiang Xue committed
536
	{
w  
Qiang Xue committed
537
		$this->_errors[$attribute][] = $error;
w  
Qiang Xue committed
538 539 540 541 542 543
	}

	/**
	 * 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
544
	public function clearErrors($attribute = null)
w  
Qiang Xue committed
545
	{
w  
Qiang Xue committed
546
		if ($attribute === null) {
Alexander Makarov committed
547
			$this->_errors = [];
Qiang Xue committed
548
		} else {
w  
Qiang Xue committed
549
			unset($this->_errors[$attribute]);
w  
Qiang Xue committed
550
		}
w  
Qiang Xue committed
551 552 553
	}

	/**
w  
Qiang Xue committed
554 555
	 * 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
556
	 * changing the first letter of each word to upper case.
w  
Qiang Xue committed
557
	 * For example, 'department_name' or 'DepartmentName' will generate 'Department Name'.
w  
Qiang Xue committed
558 559 560 561 562
	 * @param string $name the column name
	 * @return string the attribute label
	 */
	public function generateAttributeLabel($name)
	{
563
		return Inflector::camel2words($name, true);
w  
Qiang Xue committed
564 565 566
	}

	/**
w  
Qiang Xue committed
567
	 * Returns attribute values.
w  
Qiang Xue committed
568
	 * @param array $names list of attributes whose value needs to be returned.
569
	 * Defaults to null, meaning all attributes listed in [[attributes()]] will be returned.
w  
Qiang Xue committed
570
	 * If it is an array, only the attributes in the array will be returned.
571
	 * @param array $except list of attributes whose value should NOT be returned.
resurtm committed
572
	 * @return array attribute values (name => value).
w  
Qiang Xue committed
573
	 */
Alexander Makarov committed
574
	public function getAttributes($names = null, $except = [])
w  
Qiang Xue committed
575
	{
Alexander Makarov committed
576
		$values = [];
577 578 579 580 581 582 583 584
		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
585 586 587
		}

		return $values;
w  
Qiang Xue committed
588 589 590 591
	}

	/**
	 * Sets the attribute values in a massive way.
resurtm committed
592
	 * @param array $values attribute values (name => value) to be assigned to the model.
w  
Qiang Xue committed
593
	 * @param boolean $safeOnly whether the assignments should only be done to the safe attributes.
w  
Qiang Xue committed
594
	 * A safe attribute is one that is associated with a validation rule in the current [[scenario]].
595 596
	 * @see safeAttributes()
	 * @see attributes()
w  
Qiang Xue committed
597
	 */
w  
Qiang Xue committed
598
	public function setAttributes($values, $safeOnly = true)
w  
Qiang Xue committed
599
	{
w  
Qiang Xue committed
600
		if (is_array($values)) {
601
			$attributes = array_flip($safeOnly ? $this->safeAttributes() : $this->attributes());
w  
Qiang Xue committed
602 603 604
			foreach ($values as $name => $value) {
				if (isset($attributes[$name])) {
					$this->$name = $value;
Qiang Xue committed
605
				} elseif ($safeOnly) {
w  
Qiang Xue committed
606 607 608
					$this->onUnsafeAttribute($name, $value);
				}
			}
w  
Qiang Xue committed
609 610 611 612 613 614 615 616 617 618
		}
	}

	/**
	 * 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
619
	public function onUnsafeAttribute($name, $value)
w  
Qiang Xue committed
620
	{
w  
Qiang Xue committed
621
		if (YII_DEBUG) {
Qiang Xue committed
622
			Yii::trace("Failed to set unsafe attribute '$name' in '" . get_class($this) . "'.", __METHOD__);
w  
Qiang Xue committed
623
		}
w  
Qiang Xue committed
624 625 626 627 628 629 630 631
	}

	/**
	 * Returns the scenario that this model is used in.
	 *
	 * Scenario affects how validation is performed and which attributes can
	 * be massively assigned.
	 *
632
	 * @return string the scenario that this model is in. Defaults to [[DEFAULT_SCENARIO]].
w  
Qiang Xue committed
633 634 635 636 637 638 639 640
	 */
	public function getScenario()
	{
		return $this->_scenario;
	}

	/**
	 * Sets the scenario for the model.
641 642
	 * Note that this method does not check if the scenario exists or not.
	 * The method [[validate()]] will perform this check.
w  
Qiang Xue committed
643 644 645 646
	 * @param string $value the scenario that this model is in.
	 */
	public function setScenario($value)
	{
w  
Qiang Xue committed
647
		$this->_scenario = $value;
w  
Qiang Xue committed
648 649 650
	}

	/**
651
	 * Returns the attribute names that are safe to be massively assigned in the current scenario.
652
	 * @return string[] safe attribute names
w  
Qiang Xue committed
653
	 */
654
	public function safeAttributes()
w  
Qiang Xue committed
655
	{
656
		$scenario = $this->getScenario();
657
		$scenarios = $this->scenarios();
658
		if (!isset($scenarios[$scenario])) {
Alexander Makarov committed
659
			return [];
660
		}
Alexander Makarov committed
661
		$attributes = [];
662 663 664
		foreach ($scenarios[$scenario] as $attribute) {
			if ($attribute[0] !== '!') {
				$attributes[] = $attribute;
w  
Qiang Xue committed
665 666
			}
		}
Qiang Xue committed
667
		return $attributes;
668
	}
w  
Qiang Xue committed
669

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

690 691
	/**
	 * Populates the model with the data from end user.
692 693 694
	 * 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()]].
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
	 * @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 function load($data)
	{
		$scope = $this->formName();
		if ($scope == '') {
			$this->setAttributes($data);
			return true;
		} elseif (isset($data[$scope])) {
			$this->setAttributes($data[$scope]);
			return true;
		} else {
			return false;
		}
	}

713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
	/**
	 * 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])) {
741
				$model->setAttributes($data[$scope][$i]);
742 743 744 745 746 747 748 749
				$success = true;
			}
		}
		return $success;
	}

	/**
	 * Validates multiple models.
750 751
	 * This method will validate every model. The models being validated may
	 * be of the same or different types.
752
	 * @param array $models the models to be validated
753 754 755
	 * @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.
756 757 758
	 * @return boolean whether all models are valid. False will be returned if one
	 * or multiple models have validation error.
	 */
759
	public static function validateMultiple($models, $attributes = null)
760 761 762 763
	{
		$valid = true;
		/** @var Model $model */
		foreach ($models as $model) {
764
			$valid = $model->validate($attributes) && $valid;
765 766 767 768
		}
		return $valid;
	}

Qiang Xue committed
769
	/**
770
	 * Converts the object into an array.
Qiang Xue committed
771
	 * The default implementation will return [[attributes]].
772
	 * @return array the array representation of the object
Qiang Xue committed
773
	 */
774
	public function toArray()
Qiang Xue committed
775
	{
776
		return $this->getAttributes();
Qiang Xue committed
777 778
	}

w  
Qiang Xue committed
779 780 781
	/**
	 * Returns an iterator for traversing the attributes in the model.
	 * This method is required by the interface IteratorAggregate.
782
	 * @return ArrayIterator an iterator for traversing the items in the list.
w  
Qiang Xue committed
783 784 785
	 */
	public function getIterator()
	{
w  
Qiang Xue committed
786
		$attributes = $this->getAttributes();
787
		return new ArrayIterator($attributes);
w  
Qiang Xue committed
788 789 790 791
	}

	/**
	 * Returns whether there is an element at the specified offset.
w  
Qiang Xue committed
792 793
	 * 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
794 795 796 797 798
	 * @param mixed $offset the offset to check on
	 * @return boolean
	 */
	public function offsetExists($offset)
	{
Qiang Xue committed
799
		return $this->$offset !== null;
w  
Qiang Xue committed
800 801 802 803
	}

	/**
	 * Returns the element at the specified offset.
w  
Qiang Xue committed
804 805
	 * 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
806
	 * @param mixed $offset the offset to retrieve element.
w  
Qiang Xue committed
807 808 809 810 811 812 813 814 815
	 * @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
816 817
	 * 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
818 819 820
	 * @param integer $offset the offset to set element
	 * @param mixed $item the element value
	 */
w  
Qiang Xue committed
821
	public function offsetSet($offset, $item)
w  
Qiang Xue committed
822
	{
w  
Qiang Xue committed
823
		$this->$offset = $item;
w  
Qiang Xue committed
824 825 826
	}

	/**
827
	 * Sets the element value at the specified offset to null.
w  
Qiang Xue committed
828 829
	 * 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
830 831 832 833
	 * @param mixed $offset the offset to unset element
	 */
	public function offsetUnset($offset)
	{
834
		$this->$offset = null;
w  
Qiang Xue committed
835 836
	}
}