Model.php 22.1 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

Qiang Xue committed
10
use yii\helpers\StringHelper;
11
use yii\validators\RequiredValidator;
12
use yii\validators\Validator;
Qiang Xue committed
13

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

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

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

171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
	/**
	 * 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()
	{
		$class = get_class($this);
		$pos = strrpos($class, '\\');
		return $pos === false ? $class : substr($class, $pos + 1);
	}

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 223 224 225 226 227 228 229 230 231
	 *
	 * @return array attribute labels (name=>label)
	 * @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 252
	 * @return boolean whether the validation is successful without any error.
	 */
w  
Qiang Xue committed
253
	public function validate($attributes = null, $clearErrors = true)
w  
Qiang Xue committed
254
	{
w  
Qiang Xue committed
255
		if ($clearErrors) {
w  
Qiang Xue committed
256
			$this->clearErrors();
w  
Qiang Xue committed
257
		}
258 259 260
		if ($attributes === null) {
			$attributes = $this->activeAttributes();
		}
w  
Qiang Xue committed
261
		if ($this->beforeValidate()) {
w  
Qiang Xue committed
262
			foreach ($this->getActiveValidators() as $validator) {
w  
Qiang Xue committed
263 264
				$validator->validate($this, $attributes);
			}
w  
Qiang Xue committed
265 266 267
			$this->afterValidate();
			return !$this->hasErrors();
		}
w  
Qiang Xue committed
268
		return false;
w  
Qiang Xue committed
269 270 271 272
	}

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

	/**
	 * This method is invoked after validation ends.
Qiang Xue committed
288
	 * The default implementation raises an `afterValidate` event.
w  
Qiang Xue committed
289 290 291
	 * 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
292
	public function afterValidate()
w  
Qiang Xue committed
293
	{
294
		$this->trigger(self::EVENT_AFTER_VALIDATE);
w  
Qiang Xue committed
295 296 297
	}

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

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

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

	/**
	 * 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
399
		$labels = $this->attributeLabels();
Alex committed
400
		return isset($labels[$attribute]) ? $labels[$attribute] : $this->generateAttributeLabel($attribute);
w  
Qiang Xue committed
401 402 403 404
	}

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

	/**
	 * 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
417 418
	 * Note that when returning errors for all attributes, the result is a two-dimensional array, like the following:
	 *
w  
Qiang Xue committed
419
	 * ~~~
w  
Qiang Xue committed
420
	 * array(
Qiang Xue committed
421 422 423 424 425 426 427
	 *     'username' => array(
	 *         'Username is required.',
	 *         'Username must contain only word characters.',
	 *     ),
	 *     'email' => array(
	 *         'Email address is invalid.',
	 *     )
w  
Qiang Xue committed
428 429 430 431
	 * )
	 * ~~~
	 *
	 * @see getError
w  
Qiang Xue committed
432
	 */
w  
Qiang Xue committed
433
	public function getErrors($attribute = null)
w  
Qiang Xue committed
434
	{
w  
Qiang Xue committed
435
		if ($attribute === null) {
w  
Qiang Xue committed
436
			return $this->_errors === null ? array() : $this->_errors;
Qiang Xue committed
437
		} else {
w  
Qiang Xue committed
438
			return isset($this->_errors[$attribute]) ? $this->_errors[$attribute] : array();
w  
Qiang Xue committed
439
		}
w  
Qiang Xue committed
440 441
	}

Qiang Xue committed
442 443 444 445 446 447 448 449 450 451
	/**
	 * 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();
452 453 454
			foreach ($this->_errors as $attributeErrors) {
				if (isset($attributeErrors[0])) {
					$errors[] = $attributeErrors[0];
Qiang Xue committed
455 456 457 458 459 460
				}
			}
		}
		return $errors;
	}

w  
Qiang Xue committed
461 462 463 464
	/**
	 * 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
465
	 * @see getErrors
w  
Qiang Xue committed
466
	 */
Qiang Xue committed
467
	public function getFirstError($attribute)
w  
Qiang Xue committed
468 469 470 471 472 473 474 475 476
	{
		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
	 */
w  
Qiang Xue committed
477
	public function addError($attribute, $error)
w  
Qiang Xue committed
478
	{
w  
Qiang Xue committed
479
		$this->_errors[$attribute][] = $error;
w  
Qiang Xue committed
480 481 482 483 484 485
	}

	/**
	 * 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
486
	public function clearErrors($attribute = null)
w  
Qiang Xue committed
487
	{
w  
Qiang Xue committed
488
		if ($attribute === null) {
w  
Qiang Xue committed
489
			$this->_errors = array();
Qiang Xue committed
490
		} else {
w  
Qiang Xue committed
491
			unset($this->_errors[$attribute]);
w  
Qiang Xue committed
492
		}
w  
Qiang Xue committed
493 494 495
	}

	/**
w  
Qiang Xue committed
496 497
	 * 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
498
	 * changing the first letter of each word to upper case.
w  
Qiang Xue committed
499
	 * For example, 'department_name' or 'DepartmentName' will generate 'Department Name'.
w  
Qiang Xue committed
500 501 502 503 504
	 * @param string $name the column name
	 * @return string the attribute label
	 */
	public function generateAttributeLabel($name)
	{
Qiang Xue committed
505
		return StringHelper::camel2words($name, true);
w  
Qiang Xue committed
506 507 508
	}

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

		return $values;
w  
Qiang Xue committed
530 531 532 533
	}

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

	/**
	 * 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
561
	public function onUnsafeAttribute($name, $value)
w  
Qiang Xue committed
562
	{
w  
Qiang Xue committed
563
		if (YII_DEBUG) {
564
			\Yii::info("Failed to set unsafe attribute '$name' in '" . get_class($this) . "'.", __METHOD__);
w  
Qiang Xue committed
565
		}
w  
Qiang Xue committed
566 567 568 569 570 571 572 573
	}

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

	/**
	 * Sets the scenario for the model.
	 * @param string $value the scenario that this model is in.
	 * @see getScenario
	 */
	public function setScenario($value)
	{
w  
Qiang Xue committed
588
		$this->_scenario = $value;
w  
Qiang Xue committed
589 590 591
	}

	/**
592
	 * Returns the attribute names that are safe to be massively assigned in the current scenario.
w  
Qiang Xue committed
593 594
	 * @return array safe attribute names
	 */
595
	public function safeAttributes()
w  
Qiang Xue committed
596
	{
597
		$scenario = $this->getScenario();
598
		$scenarios = $this->scenarios();
Qiang Xue committed
599
		$attributes = array();
600 601 602 603 604
		if (isset($scenarios[$scenario])) {
			foreach ($scenarios[$scenario] as $attribute) {
				if ($attribute[0] !== '!') {
					$attributes[] = $attribute;
				}
w  
Qiang Xue committed
605 606
			}
		}
Qiang Xue committed
607
		return $attributes;
608
	}
w  
Qiang Xue committed
609

610 611 612 613 614 615
	/**
	 * Returns the attribute names that are subject to validation in the current scenario.
	 * @return array safe attribute names
	 */
	public function activeAttributes()
	{
616
		$scenario = $this->getScenario();
617
		$scenarios = $this->scenarios();
618 619 620 621 622 623 624
		if (isset($scenarios[$scenario])) {
			$attributes = $scenarios[$this->getScenario()];
			foreach ($attributes as $i => $attribute) {
				if ($attribute[0] === '!') {
					$attributes[$i] = substr($attribute, 1);
				}
			}
Qiang Xue committed
625
			return $attributes;
626
		} else {
Qiang Xue committed
627
			return array();
w  
Qiang Xue committed
628
		}
w  
Qiang Xue committed
629 630 631 632 633
	}

	/**
	 * Returns an iterator for traversing the attributes in the model.
	 * This method is required by the interface IteratorAggregate.
Qiang Xue committed
634
	 * @return DictionaryIterator an iterator for traversing the items in the list.
w  
Qiang Xue committed
635 636 637
	 */
	public function getIterator()
	{
w  
Qiang Xue committed
638 639
		$attributes = $this->getAttributes();
		return new DictionaryIterator($attributes);
w  
Qiang Xue committed
640 641 642 643
	}

	/**
	 * Returns whether there is an element at the specified offset.
w  
Qiang Xue committed
644 645
	 * 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
646 647 648 649 650
	 * @param mixed $offset the offset to check on
	 * @return boolean
	 */
	public function offsetExists($offset)
	{
Qiang Xue committed
651
		return $this->$offset !== null;
w  
Qiang Xue committed
652 653 654 655
	}

	/**
	 * Returns the element at the specified offset.
w  
Qiang Xue committed
656 657
	 * 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
658
	 * @param mixed $offset the offset to retrieve element.
w  
Qiang Xue committed
659 660 661 662 663 664 665 666 667
	 * @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
668 669
	 * 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
670 671 672
	 * @param integer $offset the offset to set element
	 * @param mixed $item the element value
	 */
w  
Qiang Xue committed
673
	public function offsetSet($offset, $item)
w  
Qiang Xue committed
674
	{
w  
Qiang Xue committed
675
		$this->$offset = $item;
w  
Qiang Xue committed
676 677 678
	}

	/**
679
	 * Sets the element value at the specified offset to null.
w  
Qiang Xue committed
680 681
	 * 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
682 683 684 685
	 * @param mixed $offset the offset to unset element
	 */
	public function offsetUnset($offset)
	{
686
		$this->$offset = null;
w  
Qiang Xue committed
687 688
	}
}