Model.php 25.5 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 12
use ArrayObject;
use ArrayIterator;
13
use yii\helpers\Inflector;
14
use yii\validators\RequiredValidator;
15
use yii\validators\Validator;
Qiang Xue committed
16

w  
Qiang Xue committed
17
/**
w  
Qiang Xue committed
18
 * Model is the base class for data models.
w  
Qiang Xue committed
19
 *
w  
Qiang Xue committed
20 21 22 23 24 25 26 27
 * 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
28
 * Model also raises the following events when performing data validation:
w  
Qiang Xue committed
29
 *
Qiang Xue committed
30 31
 * - [[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
32 33 34
 *
 * 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
35
 *
36
 * @property ArrayObject $validators All the validators declared in the model.
Qiang Xue committed
37 38
 * @property array $activeValidators The validators applicable to the current [[scenario]].
 * @property array $errors Errors for all attributes or the specified attribute. Empty array is returned if no error.
resurtm committed
39
 * @property array $attributes Attribute values (name => value).
Qiang Xue committed
40 41
 * @property string $scenario The scenario that this model is in.
 *
w  
Qiang Xue committed
42
 * @author Qiang Xue <qiang.xue@gmail.com>
w  
Qiang Xue committed
43
 * @since 2.0
w  
Qiang Xue committed
44
 */
45
class Model extends Component implements \IteratorAggregate, \ArrayAccess
w  
Qiang Xue committed
46
{
47 48 49 50 51 52 53 54 55 56
	/**
	 * @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
57 58 59 60 61
	/**
	 * @var array validation errors (attribute name => array of errors)
	 */
	private $_errors;
	/**
62
	 * @var ArrayObject list of validators
Qiang Xue committed
63 64 65 66 67
	 */
	private $_validators;
	/**
	 * @var string current scenario
	 */
68
	private $_scenario = 'default';
w  
Qiang Xue committed
69 70 71 72

	/**
	 * Returns the validation rules for attributes.
	 *
Qiang Xue committed
73
	 * Validation rules are used by [[validate()]] to check if attribute values are valid.
w  
Qiang Xue committed
74 75
	 * Child classes may override this method to declare different validation rules.
	 *
w  
Qiang Xue committed
76
	 * Each rule is an array with the following structure:
w  
Qiang Xue committed
77
	 *
w  
Qiang Xue committed
78
	 * ~~~
w  
Qiang Xue committed
79
	 * array(
Qiang Xue committed
80 81
	 *     'attribute list',
	 *     'validator type',
resurtm committed
82
	 *     'on' => 'scenario name',
Qiang Xue committed
83
	 *     ...other parameters...
w  
Qiang Xue committed
84 85 86
	 * )
	 * ~~~
	 *
w  
Qiang Xue committed
87
	 * where
w  
Qiang Xue committed
88 89 90
	 *
	 *  - attribute list: required, specifies the attributes (separated by commas) to be validated;
	 *  - validator type: required, specifies the validator to be used. It can be the name of a model
Qiang Xue committed
91
	 *    class method, the name of a built-in validator, or a validator class name (or its path alias).
w  
Qiang Xue committed
92
	 *  - on: optional, specifies the [[scenario|scenarios]] (separated by commas) when the validation
Qiang Xue committed
93
	 *    rule can be applied. If this option is not set, the rule will apply to all scenarios.
w  
Qiang Xue committed
94
	 *  - additional name-value pairs can be specified to initialize the corresponding validator properties.
Qiang Xue committed
95
	 *    Please refer to individual validator class API for possible properties.
w  
Qiang Xue committed
96
	 *
Qiang Xue committed
97 98
	 * 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
99
	 *
w  
Qiang Xue committed
100
	 * ~~~
w  
Qiang Xue committed
101
	 * // $params refers to validation parameters given in the rule
w  
Qiang Xue committed
102 103 104
	 * function validatorName($attribute, $params)
	 * ~~~
	 *
Qiang Xue committed
105
	 * Yii also provides a set of [[Validator::builtInValidators|built-in validators]].
Qiang Xue committed
106
	 * They each has an alias name which can be used when specifying a validation rule.
w  
Qiang Xue committed
107
	 *
Qiang Xue committed
108
	 * Below are some examples:
w  
Qiang Xue committed
109
	 *
w  
Qiang Xue committed
110
	 * ~~~
w  
Qiang Xue committed
111
	 * array(
Qiang Xue committed
112 113 114
	 *     // built-in "required" validator
	 *     array('username', 'required'),
	 *     // built-in "length" validator customized with "min" and "max" properties
resurtm committed
115
	 *     array('username', 'length', 'min' => 3, 'max' => 12),
Qiang Xue committed
116
	 *     // built-in "compare" validator that is used in "register" scenario only
resurtm committed
117
	 *     array('password', 'compare', 'compareAttribute' => 'password2', 'on' => 'register'),
Qiang Xue committed
118
	 *     // an inline validator defined via the "authenticate()" method in the model class
resurtm committed
119
	 *     array('password', 'authenticate', 'on' => 'login'),
Qiang Xue committed
120 121
	 *     // a validator of class "DateRangeValidator"
	 *     array('dateRange', 'DateRangeValidator'),
w  
Qiang Xue committed
122
	 * );
w  
Qiang Xue committed
123
	 * ~~~
w  
Qiang Xue committed
124 125
	 *
	 * Note, in order to inherit rules defined in the parent class, a child class needs to
w  
Qiang Xue committed
126
	 * merge the parent rules with child rules using functions such as `array_merge()`.
w  
Qiang Xue committed
127
	 *
w  
Qiang Xue committed
128
	 * @return array validation rules
129
	 * @see scenarios
w  
Qiang Xue committed
130 131 132 133 134 135
	 */
	public function rules()
	{
		return array();
	}

136
	/**
137
	 * Returns a list of scenarios and the corresponding active attributes.
Qiang Xue committed
138
	 * An active attribute is one that is subject to validation in the current scenario.
139 140 141 142 143 144 145 146 147 148
	 * The returned array should be in the following format:
	 *
	 * ~~~
	 * array(
	 *     'scenario1' => array('attribute11', 'attribute12', ...),
	 *     'scenario2' => array('attribute21', 'attribute22', ...),
	 *     ...
	 * )
	 * ~~~
	 *
Qiang Xue committed
149
	 * By default, an active attribute that is considered safe and can be massively assigned.
150
	 * If an attribute should NOT be massively assigned (thus considered unsafe),
Qiang Xue committed
151
	 * please prefix the attribute with an exclamation character (e.g. '!rank').
152
	 *
Qiang Xue committed
153 154 155 156 157
	 * The default implementation of this method will return a 'default' scenario
	 * which corresponds to all attributes listed in the validation rules applicable
	 * to the 'default' scenario.
	 *
	 * @return array a list of scenarios and the corresponding active attributes.
158 159 160
	 */
	public function scenarios()
	{
Qiang Xue committed
161 162
		$attributes = array();
		foreach ($this->getActiveValidators() as $validator) {
Qiang Xue committed
163 164
			foreach ($validator->attributes as $name) {
				$attributes[$name] = true;
Qiang Xue committed
165 166 167 168 169
			}
		}
		return array(
			'default' => array_keys($attributes),
		);
170 171
	}

172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
	/**
	 * 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()
	{
187 188
		$reflector = new \ReflectionClass($this);
		return $reflector->getShortName();
189 190
	}

191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
	/**
	 * 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.
	 */
	public function attributes()
	{
		$class = new \ReflectionClass($this);
		$names = array();
		foreach ($class->getProperties(\ReflectionProperty::IS_PUBLIC) as $property) {
			$name = $property->getName();
			if (!$property->isStatic()) {
				$names[] = $name;
			}
		}
Qiang Xue committed
207
		return $names;
208 209
	}

w  
Qiang Xue committed
210 211
	/**
	 * Returns the attribute labels.
w  
Qiang Xue committed
212 213 214 215 216
	 *
	 * 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
217
	 * By default an attribute label is generated using [[generateAttributeLabel()]].
w  
Qiang Xue committed
218 219 220
	 * 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
221
	 * merge the parent labels with child labels using functions such as `array_merge()`.
w  
Qiang Xue committed
222
	 *
resurtm committed
223
	 * @return array attribute labels (name => label)
w  
Qiang Xue committed
224 225 226 227 228 229 230 231
	 * @see generateAttributeLabel
	 */
	public function attributeLabels()
	{
		return array();
	}

	/**
w  
Qiang Xue committed
232
	 * Performs the data validation.
w  
Qiang Xue committed
233
	 *
234 235 236 237 238
	 * 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
239
	 *
Qiang Xue committed
240
	 * This method will call [[beforeValidate()]] and [[afterValidate()]] before and
241 242
	 * after the actual validation, respectively. If [[beforeValidate()]] returns false,
	 * the validation will be cancelled and [[afterValidate()]] will not be called.
w  
Qiang Xue committed
243
	 *
244 245
	 * Errors found during the validation can be retrieved via [[getErrors()]]
	 * and [[getError()]].
w  
Qiang Xue committed
246
	 *
w  
Qiang Xue committed
247 248 249
	 * @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
250
	 * @param boolean $clearErrors whether to call [[clearErrors()]] before performing validation
w  
Qiang Xue committed
251
	 * @return boolean whether the validation is successful without any error.
252
	 * @throws InvalidParamException if the current scenario is unknown.
w  
Qiang Xue committed
253
	 */
w  
Qiang Xue committed
254
	public function validate($attributes = null, $clearErrors = true)
w  
Qiang Xue committed
255
	{
256 257 258 259 260 261
		$scenarios = $this->scenarios();
		$scenario = $this->getScenario();
		if (!isset($scenarios[$scenario])) {
			throw new InvalidParamException("Unknown scenario: $scenario");
		}

w  
Qiang Xue committed
262
		if ($clearErrors) {
w  
Qiang Xue committed
263
			$this->clearErrors();
w  
Qiang Xue committed
264
		}
265 266 267
		if ($attributes === null) {
			$attributes = $this->activeAttributes();
		}
w  
Qiang Xue committed
268
		if ($this->beforeValidate()) {
w  
Qiang Xue committed
269
			foreach ($this->getActiveValidators() as $validator) {
w  
Qiang Xue committed
270 271
				$validator->validate($this, $attributes);
			}
w  
Qiang Xue committed
272 273 274
			$this->afterValidate();
			return !$this->hasErrors();
		}
w  
Qiang Xue committed
275
		return false;
w  
Qiang Xue committed
276 277 278 279
	}

	/**
	 * This method is invoked before validation starts.
Qiang Xue committed
280
	 * The default implementation raises a `beforeValidate` event.
w  
Qiang Xue committed
281 282
	 * 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.
283
	 * @return boolean whether the validation should be executed. Defaults to true.
w  
Qiang Xue committed
284 285
	 * If false is returned, the validation will stop and the model is considered invalid.
	 */
w  
Qiang Xue committed
286
	public function beforeValidate()
w  
Qiang Xue committed
287
	{
Qiang Xue committed
288
		$event = new ModelEvent;
289
		$this->trigger(self::EVENT_BEFORE_VALIDATE, $event);
Qiang Xue committed
290
		return $event->isValid;
w  
Qiang Xue committed
291 292 293 294
	}

	/**
	 * This method is invoked after validation ends.
Qiang Xue committed
295
	 * The default implementation raises an `afterValidate` event.
w  
Qiang Xue committed
296 297 298
	 * 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
299
	public function afterValidate()
w  
Qiang Xue committed
300
	{
301
		$this->trigger(self::EVENT_AFTER_VALIDATE);
w  
Qiang Xue committed
302 303 304
	}

	/**
Qiang Xue committed
305
	 * Returns all the validators declared in [[rules()]].
w  
Qiang Xue committed
306
	 *
Qiang Xue committed
307
	 * This method differs from [[getActiveValidators()]] in that the latter
w  
Qiang Xue committed
308 309
	 * only returns the validators applicable to the current [[scenario]].
	 *
310
	 * Because this method returns an ArrayObject object, you may
w  
Qiang Xue committed
311 312 313
	 * manipulate it by inserting or removing validators (useful in model behaviors).
	 * For example,
	 *
w  
Qiang Xue committed
314
	 * ~~~
315
	 * $model->validators[] = $newValidator;
w  
Qiang Xue committed
316 317
	 * ~~~
	 *
318
	 * @return ArrayObject all the validators declared in the model.
w  
Qiang Xue committed
319
	 */
w  
Qiang Xue committed
320
	public function getValidators()
w  
Qiang Xue committed
321
	{
w  
Qiang Xue committed
322
		if ($this->_validators === null) {
w  
Qiang Xue committed
323
			$this->_validators = $this->createValidators();
w  
Qiang Xue committed
324
		}
w  
Qiang Xue committed
325 326 327 328
		return $this->_validators;
	}

	/**
w  
Qiang Xue committed
329 330
	 * 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
331
	 * If this is null, the validators for ALL attributes in the model will be returned.
Qiang Xue committed
332
	 * @return \yii\validators\Validator[] the validators applicable to the current [[scenario]].
w  
Qiang Xue committed
333
	 */
w  
Qiang Xue committed
334
	public function getActiveValidators($attribute = null)
w  
Qiang Xue committed
335
	{
w  
Qiang Xue committed
336 337
		$validators = array();
		$scenario = $this->getScenario();
338
		/** @var $validator Validator */
w  
Qiang Xue committed
339
		foreach ($this->getValidators() as $validator) {
Qiang Xue committed
340
			if ($validator->isActive($scenario) && ($attribute === null || in_array($attribute, $validator->attributes, true))) {
Qiang Xue committed
341
				$validators[] = $validator;
w  
Qiang Xue committed
342 343 344 345 346 347
			}
		}
		return $validators;
	}

	/**
Qiang Xue committed
348 349
	 * 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.
350
	 * @return ArrayObject validators
Qiang Xue committed
351
	 * @throws InvalidConfigException if any validation rule configuration is invalid
w  
Qiang Xue committed
352 353 354
	 */
	public function createValidators()
	{
355
		$validators = new ArrayObject;
w  
Qiang Xue committed
356
		foreach ($this->rules() as $rule) {
357
			if ($rule instanceof Validator) {
358
				$validators->append($rule);
359
			} elseif (is_array($rule) && isset($rule[0], $rule[1])) { // attributes, validator type
360
				$validator = Validator::createValidator($rule[1], $this, $rule[0], array_slice($rule, 2));
361
				$validators->append($validator);
Qiang Xue committed
362
			} else {
Qiang Xue committed
363
				throw new InvalidConfigException('Invalid validation rule: a rule must specify both attribute names and validator type.');
w  
Qiang Xue committed
364
			}
w  
Qiang Xue committed
365 366 367 368 369 370 371
		}
		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
372
	 * [[\yii\validators\RequiredValidator|required]] validation rule in the
w  
Qiang Xue committed
373
	 * current [[scenario]].
w  
Qiang Xue committed
374 375 376 377 378
	 * @param string $attribute attribute name
	 * @return boolean whether the attribute is required
	 */
	public function isAttributeRequired($attribute)
	{
w  
Qiang Xue committed
379
		foreach ($this->getActiveValidators($attribute) as $validator) {
380
			if ($validator instanceof RequiredValidator) {
w  
Qiang Xue committed
381
				return true;
w  
Qiang Xue committed
382
			}
w  
Qiang Xue committed
383 384 385 386 387 388 389 390 391 392 393
		}
		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
	 */
	public function isAttributeSafe($attribute)
	{
394
		return in_array($attribute, $this->safeAttributes(), true);
w  
Qiang Xue committed
395 396 397 398 399 400 401 402 403 404 405
	}

	/**
	 * Returns the text label for the specified attribute.
	 * @param string $attribute the attribute name
	 * @return string the attribute label
	 * @see generateAttributeLabel
	 * @see attributeLabels
	 */
	public function getAttributeLabel($attribute)
	{
w  
Qiang Xue committed
406
		$labels = $this->attributeLabels();
Alex committed
407
		return isset($labels[$attribute]) ? $labels[$attribute] : $this->generateAttributeLabel($attribute);
w  
Qiang Xue committed
408 409 410 411
	}

	/**
	 * Returns a value indicating whether there is any validation error.
412
	 * @param string|null $attribute attribute name. Use null to check all attributes.
w  
Qiang Xue committed
413 414
	 * @return boolean whether there is any error.
	 */
w  
Qiang Xue committed
415
	public function hasErrors($attribute = null)
w  
Qiang Xue committed
416
	{
w  
Qiang Xue committed
417
		return $attribute === null ? !empty($this->_errors) : isset($this->_errors[$attribute]);
w  
Qiang Xue committed
418 419 420 421 422 423
	}

	/**
	 * Returns the errors for all attribute or a single attribute.
	 * @param string $attribute attribute name. Use null to retrieve errors for all attributes.
	 * @return array errors for all attributes or the specified attribute. Empty array is returned if no error.
w  
Qiang Xue committed
424 425
	 * Note that when returning errors for all attributes, the result is a two-dimensional array, like the following:
	 *
w  
Qiang Xue committed
426
	 * ~~~
w  
Qiang Xue committed
427
	 * array(
Qiang Xue committed
428 429 430 431 432 433 434
	 *     'username' => array(
	 *         'Username is required.',
	 *         'Username must contain only word characters.',
	 *     ),
	 *     'email' => array(
	 *         'Email address is invalid.',
	 *     )
w  
Qiang Xue committed
435 436 437 438
	 * )
	 * ~~~
	 *
	 * @see getError
w  
Qiang Xue committed
439
	 */
w  
Qiang Xue committed
440
	public function getErrors($attribute = null)
w  
Qiang Xue committed
441
	{
w  
Qiang Xue committed
442
		if ($attribute === null) {
w  
Qiang Xue committed
443
			return $this->_errors === null ? array() : $this->_errors;
Qiang Xue committed
444
		} else {
w  
Qiang Xue committed
445
			return isset($this->_errors[$attribute]) ? $this->_errors[$attribute] : array();
w  
Qiang Xue committed
446
		}
w  
Qiang Xue committed
447 448
	}

Qiang Xue committed
449 450 451 452 453 454 455 456 457 458
	/**
	 * 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.
	 */
	public function getFirstErrors()
	{
		if (empty($this->_errors)) {
			return array();
		} else {
			$errors = array();
459 460 461
			foreach ($this->_errors as $attributeErrors) {
				if (isset($attributeErrors[0])) {
					$errors[] = $attributeErrors[0];
Qiang Xue committed
462 463 464 465 466 467
				}
			}
		}
		return $errors;
	}

w  
Qiang Xue committed
468 469 470 471
	/**
	 * Returns the first error of the specified attribute.
	 * @param string $attribute attribute name.
	 * @return string the error message. Null is returned if no error.
w  
Qiang Xue committed
472
	 * @see getErrors
w  
Qiang Xue committed
473
	 */
Qiang Xue committed
474
	public function getFirstError($attribute)
w  
Qiang Xue committed
475 476 477 478 479 480 481 482 483
	{
		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
	 */
484
	public function addError($attribute, $error = '')
w  
Qiang Xue committed
485
	{
w  
Qiang Xue committed
486
		$this->_errors[$attribute][] = $error;
w  
Qiang Xue committed
487 488 489 490 491 492
	}

	/**
	 * 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
493
	public function clearErrors($attribute = null)
w  
Qiang Xue committed
494
	{
w  
Qiang Xue committed
495
		if ($attribute === null) {
w  
Qiang Xue committed
496
			$this->_errors = array();
Qiang Xue committed
497
		} else {
w  
Qiang Xue committed
498
			unset($this->_errors[$attribute]);
w  
Qiang Xue committed
499
		}
w  
Qiang Xue committed
500 501 502
	}

	/**
w  
Qiang Xue committed
503 504
	 * 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
505
	 * changing the first letter of each word to upper case.
w  
Qiang Xue committed
506
	 * For example, 'department_name' or 'DepartmentName' will generate 'Department Name'.
w  
Qiang Xue committed
507 508 509 510 511
	 * @param string $name the column name
	 * @return string the attribute label
	 */
	public function generateAttributeLabel($name)
	{
512
		return Inflector::camel2words($name, true);
w  
Qiang Xue committed
513 514 515
	}

	/**
w  
Qiang Xue committed
516
	 * Returns attribute values.
w  
Qiang Xue committed
517
	 * @param array $names list of attributes whose value needs to be returned.
518
	 * Defaults to null, meaning all attributes listed in [[attributes()]] will be returned.
w  
Qiang Xue committed
519
	 * If it is an array, only the attributes in the array will be returned.
520
	 * @param array $except list of attributes whose value should NOT be returned.
resurtm committed
521
	 * @return array attribute values (name => value).
w  
Qiang Xue committed
522
	 */
523
	public function getAttributes($names = null, $except = array())
w  
Qiang Xue committed
524
	{
w  
Qiang Xue committed
525
		$values = array();
526 527 528 529 530 531 532 533
		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
534 535 536
		}

		return $values;
w  
Qiang Xue committed
537 538 539 540
	}

	/**
	 * Sets the attribute values in a massive way.
resurtm committed
541
	 * @param array $values attribute values (name => value) to be assigned to the model.
w  
Qiang Xue committed
542
	 * @param boolean $safeOnly whether the assignments should only be done to the safe attributes.
w  
Qiang Xue committed
543
	 * A safe attribute is one that is associated with a validation rule in the current [[scenario]].
544 545
	 * @see safeAttributes()
	 * @see attributes()
w  
Qiang Xue committed
546
	 */
w  
Qiang Xue committed
547
	public function setAttributes($values, $safeOnly = true)
w  
Qiang Xue committed
548
	{
w  
Qiang Xue committed
549
		if (is_array($values)) {
550
			$attributes = array_flip($safeOnly ? $this->safeAttributes() : $this->attributes());
w  
Qiang Xue committed
551 552 553
			foreach ($values as $name => $value) {
				if (isset($attributes[$name])) {
					$this->$name = $value;
Qiang Xue committed
554
				} elseif ($safeOnly) {
w  
Qiang Xue committed
555 556 557
					$this->onUnsafeAttribute($name, $value);
				}
			}
w  
Qiang Xue committed
558 559 560 561 562 563 564 565 566 567
		}
	}

	/**
	 * 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
568
	public function onUnsafeAttribute($name, $value)
w  
Qiang Xue committed
569
	{
w  
Qiang Xue committed
570
		if (YII_DEBUG) {
571
			\Yii::info("Failed to set unsafe attribute '$name' in '" . get_class($this) . "'.", __METHOD__);
w  
Qiang Xue committed
572
		}
w  
Qiang Xue committed
573 574 575 576 577 578 579 580
	}

	/**
	 * Returns the scenario that this model is used in.
	 *
	 * Scenario affects how validation is performed and which attributes can
	 * be massively assigned.
	 *
581
	 * @return string the scenario that this model is in. Defaults to 'default'.
w  
Qiang Xue committed
582 583 584 585 586 587 588 589
	 */
	public function getScenario()
	{
		return $this->_scenario;
	}

	/**
	 * Sets the scenario for the model.
590 591
	 * Note that this method does not check if the scenario exists or not.
	 * The method [[validate()]] will perform this check.
w  
Qiang Xue committed
592 593 594 595
	 * @param string $value the scenario that this model is in.
	 */
	public function setScenario($value)
	{
w  
Qiang Xue committed
596
		$this->_scenario = $value;
w  
Qiang Xue committed
597 598 599
	}

	/**
600
	 * Returns the attribute names that are safe to be massively assigned in the current scenario.
601
	 * @return string[] safe attribute names
w  
Qiang Xue committed
602
	 */
603
	public function safeAttributes()
w  
Qiang Xue committed
604
	{
605
		$scenario = $this->getScenario();
606
		$scenarios = $this->scenarios();
607 608 609
		if (!isset($scenarios[$scenario])) {
			return array();
		}
Qiang Xue committed
610
		$attributes = array();
611 612 613 614 615 616
		if (isset($scenarios[$scenario]['attributes']) && is_array($scenarios[$scenario]['attributes'])) {
			$scenarios[$scenario] = $scenarios[$scenario]['attributes'];
		}
		foreach ($scenarios[$scenario] as $attribute) {
			if ($attribute[0] !== '!') {
				$attributes[] = $attribute;
w  
Qiang Xue committed
617 618
			}
		}
Qiang Xue committed
619
		return $attributes;
620
	}
w  
Qiang Xue committed
621

622 623
	/**
	 * Returns the attribute names that are subject to validation in the current scenario.
624
	 * @return string[] safe attribute names
625 626 627
	 */
	public function activeAttributes()
	{
628
		$scenario = $this->getScenario();
629
		$scenarios = $this->scenarios();
630
		if (!isset($scenarios[$scenario])) {
Qiang Xue committed
631
			return array();
w  
Qiang Xue committed
632
		}
633 634 635 636 637 638 639 640 641 642 643
		if (isset($scenarios[$scenario]['attributes']) && is_array($scenarios[$scenario]['attributes'])) {
			$attributes = $scenarios[$scenario]['attributes'];
		} else {
			$attributes = $scenarios[$scenario];
		}
		foreach ($attributes as $i => $attribute) {
			if ($attribute[0] === '!') {
				$attributes[$i] = substr($attribute, 1);
			}
		}
		return $attributes;
w  
Qiang Xue committed
644 645
	}

646 647
	/**
	 * Populates the model with the data from end user.
648 649 650
	 * 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()]].
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
	 * @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;
		}
	}

669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
	/**
	 * 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])) {
697
				$model->setAttributes($data[$scope][$i]);
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
				$success = true;
			}
		}
		return $success;
	}

	/**
	 * Validates multiple models.
	 * @param array $models the models to be validated
	 * @return boolean whether all models are valid. False will be returned if one
	 * or multiple models have validation error.
	 */
	public static function validateMultiple($models)
	{
		$valid = true;
		/** @var Model $model */
		foreach ($models as $model) {
			$valid = $model->validate() && $valid;
		}
		return $valid;
	}

Qiang Xue committed
720
	/**
721
	 * Converts the object into an array.
Qiang Xue committed
722
	 * The default implementation will return [[attributes]].
723
	 * @return array the array representation of the object
Qiang Xue committed
724
	 */
725
	public function toArray()
Qiang Xue committed
726
	{
727
		return $this->getAttributes();
Qiang Xue committed
728 729
	}

w  
Qiang Xue committed
730 731 732
	/**
	 * Returns an iterator for traversing the attributes in the model.
	 * This method is required by the interface IteratorAggregate.
733
	 * @return ArrayIterator an iterator for traversing the items in the list.
w  
Qiang Xue committed
734 735 736
	 */
	public function getIterator()
	{
w  
Qiang Xue committed
737
		$attributes = $this->getAttributes();
738
		return new ArrayIterator($attributes);
w  
Qiang Xue committed
739 740 741 742
	}

	/**
	 * Returns whether there is an element at the specified offset.
w  
Qiang Xue committed
743 744
	 * 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
745 746 747 748 749
	 * @param mixed $offset the offset to check on
	 * @return boolean
	 */
	public function offsetExists($offset)
	{
Qiang Xue committed
750
		return $this->$offset !== null;
w  
Qiang Xue committed
751 752 753 754
	}

	/**
	 * Returns the element at the specified offset.
w  
Qiang Xue committed
755 756
	 * 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
757
	 * @param mixed $offset the offset to retrieve element.
w  
Qiang Xue committed
758 759 760 761 762 763 764 765 766
	 * @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
767 768
	 * 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
769 770 771
	 * @param integer $offset the offset to set element
	 * @param mixed $item the element value
	 */
w  
Qiang Xue committed
772
	public function offsetSet($offset, $item)
w  
Qiang Xue committed
773
	{
w  
Qiang Xue committed
774
		$this->$offset = $item;
w  
Qiang Xue committed
775 776 777
	}

	/**
778
	 * Sets the element value at the specified offset to null.
w  
Qiang Xue committed
779 780
	 * 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
781 782 783 784
	 * @param mixed $offset the offset to unset element
	 */
	public function offsetUnset($offset)
	{
785
		$this->$offset = null;
w  
Qiang Xue committed
786 787
	}
}