Error202
/
yii2-swiftmailer
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

w

tags/2.0.0-beta
Qiang Xue 14 years ago
parent
3762569fce
commit
e18dc2a1a7
6 changed files with 246 additions and 201 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 4
      framework/YiiBase.php
  2. 8
      framework/base/Dictionary.php
  3. 419
      framework/base/Model.php
  4. 6
      framework/base/ModelBehavior.php
  5. 2
      framework/base/ModelEvent.php
  6. 8
      framework/base/Vector.php

4
framework/YiiBase.php
Unescape View File

@ -141,7 +141,7 @@ class YiiBase
* will be included only when the class is being used. This parameter is used only when * will be included only when the class is being used. This parameter is used only when
* the path alias refers to a class. * the path alias refers to a class.
* @return string the class name or the directory that this alias refers to * @return string the class name or the directory that this alias refers to
* @throws Exception if the path alias is invalid * @throws \yii\base\Exception if the path alias is invalid
*/ */
public static function import($alias, $forceInclude = false) public static function import($alias, $forceInclude = false)
{ {
@ -315,7 +315,7 @@ class YiiBase
* *
* @param mixed $config the configuration. It can be either a string or an array. * @param mixed $config the configuration. It can be either a string or an array.
* @return mixed the created object * @return mixed the created object
* @throws Exception if the configuration does not have a 'class' element. * @throws \yii\base\Exception if the configuration does not have a 'class' element.
*/ */
public static function createComponent($config) public static function createComponent($config)
{ {

8
framework/base/Dictionary.php
Unescape View File

@ -259,7 +259,7 @@ class Dictionary extends Component implements \IteratorAggregate, \ArrayAccess,
/** /**
* Returns whether there is an element at the specified offset. * Returns whether there is an element at the specified offset.
* This method is required by the SPL interface `ArrayAccess`. * This method is required by the SPL interface `ArrayAccess`.
* It is implicitly called when you use something like `isset($vector[$index])`. * It is implicitly called when you use something like `isset($dictionary[$offset])`.
* This is equivalent to [[contains]]. * This is equivalent to [[contains]].
* @param mixed $offset the offset to check on * @param mixed $offset the offset to check on
* @return boolean * @return boolean
@ -272,7 +272,7 @@ class Dictionary extends Component implements \IteratorAggregate, \ArrayAccess,
/** /**
* Returns the element at the specified offset. * Returns the element at the specified offset.
* This method is required by the SPL interface `ArrayAccess`. * This method is required by the SPL interface `ArrayAccess`.
* It is implicitly called when you use something like `$value = $dictionary[$index];`. * It is implicitly called when you use something like `$value = $dictionary[$offset];`.
* This is equivalent to [[itemAt]]. * This is equivalent to [[itemAt]].
* @param integer $offset the offset to retrieve element. * @param integer $offset the offset to retrieve element.
* @return mixed the element at the offset, null if no element is found at the offset * @return mixed the element at the offset, null if no element is found at the offset
@ -285,7 +285,7 @@ class Dictionary extends Component implements \IteratorAggregate, \ArrayAccess,
/** /**
* Sets the element at the specified offset. * Sets the element at the specified offset.
* This method is required by the SPL interface `ArrayAccess`. * This method is required by the SPL interface `ArrayAccess`.
* It is implicitly called when you use something like `$dictionary[$key] = $value;`. * It is implicitly called when you use something like `$dictionary[$offset] = $item;`.
* If the offset is null, the new item will be appended to the dictionary. * If the offset is null, the new item will be appended to the dictionary.
* Otherwise, the existing item at the offset will be replaced with the new item. * Otherwise, the existing item at the offset will be replaced with the new item.
* This is equivalent to [[add]]. * This is equivalent to [[add]].
@ -300,7 +300,7 @@ class Dictionary extends Component implements \IteratorAggregate, \ArrayAccess,
/** /**
* Unsets the element at the specified offset. * Unsets the element at the specified offset.
* This method is required by the SPL interface `ArrayAccess`. * This method is required by the SPL interface `ArrayAccess`.
* It is implicitly called when you use something like `unset($dictionary[$index])`. * It is implicitly called when you use something like `unset($dictionary[$offset])`.
* This is equivalent to [[remove]]. * This is equivalent to [[remove]].
* @param mixed $offset the offset to unset element * @param mixed $offset the offset to unset element
*/ */

419
framework/base/Model.php
Unescape View File

@ -1,79 +1,129 @@
<?php <?php
/** /**
* CModel class file. * Model class file.
* *
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.yiiframework.com/ * @link http://www.yiiframework.com/
* @copyright Copyright &copy; 2008-2011 Yii Software LLC * @copyright Copyright &copy; 2008-2012 Yii Software LLC
* @license http://www.yiiframework.com/license/ * @license http://www.yiiframework.com/license/
*/ */
namespace yii\base;
/** /**
* CModel is the base class providing the common features needed by data model objects. * Model is the base class providing the common features needed by data model objects.
* *
* CModel defines the basic framework for data models that need to be validated. * Model defines the basic framework for data models that need to be validated.
* *
* @author Qiang Xue <qiang.xue@gmail.com> * @author Qiang Xue <qiang.xue@gmail.com>
* @version $Id: CModel.php 3349 2011-07-08 11:27:53Z mdomba $ * @since 2.0
* @package system.base
* @since 1.0
*/ */
abstract class CModel extends CComponent implements IteratorAggregate, ArrayAccess class Model extends Component implements \IteratorAggregate, \ArrayAccess
{ {
private $_errors=array(); // attribute name => array of errors private static $_attributes = array(); // class name => array of attribute names
private $_validators; // validators private $_errors = array(); // attribute name => array of errors
private $_scenario=''; // scenario private $_validators; // validators
private $_scenario; // scenario
/**
* Constructor.
* @param string $scenario name of the [[scenario]] that this model is used in.
*/
public function __construct($scenario='')
{
$this->_scenario = $scenario;
$this->init();
$this->attachBehaviors($this->behaviors());
$this->afterConstruct();
}
/**
* Initializes this model.
* This method is invoked in the constructor right after [[scenario]] is set.
* You may override this method to provide code that is needed to initialize the model (e.g. setting
* initial property values.)
*/
public function init()
{
}
/** /**
* Returns the list of attribute names of the model. * 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.
* @return array list of attribute names. * @return array list of attribute names.
* @since 1.0.1
*/ */
abstract public function attributeNames(); public function attributeNames()
{
$className = get_class($this);
if (isset(self::$_attributes[$className])) {
return self::$_attributes[$className];
}
$class = new ReflectionClass($this);
$names = array();
foreach ($class->getProperties() as $property) {
$name = $property->getName();
if ($property->isPublic() && !$property->isStatic()) {
$names[] = $name;
}
}
return self::$_attributes[$className] = $names;
}
/** /**
* Returns the validation rules for attributes. * Returns the validation rules for attributes.
* *
* This method should be overridden to declare validation rules. * Validation rules are used by [[validate()]] to check if attribute values are valid.
* Child classes may override this method to declare different validation rules.
*
* Each rule is an array with the following structure: * Each rule is an array with the following structure:
* <pre> *
* array('attribute list', 'validator name', 'on'=>'scenario name', ...validation parameters...) * ~~~php
* </pre> * array(
* 'attribute list',
* 'validator type',
* 'on'=>'scenario name',
* ...other parameters...
* )
* ~~~
*
* where * where
* <ul> *
* <li>attribute list: specifies the attributes (separated by commas) to be validated;</li> * - attribute list: required, specifies the attributes (separated by commas) to be validated;
* <li>validator name: specifies the validator to be used. It can be the name of a model class * - validator type: required, specifies the validator to be used. It can be the name of a model
* method, the name of a built-in validator, or a validator class (or its path alias). * class method, the name of a built-in validator, or a validator class (or its path alias).
* A validation method must have the following signature: * - on: optional, specifies the [[scenario|scenarios]] (separated by commas) when the validation
* <pre> * rule can be applied. If this option is not set, the rule will apply to any scenario.
* - additional name-value pairs can be specified to initialize the corresponding validator properties.
* Please refer to individual validator class API for possible properties.
*
* A validator can be either a model class method or an object.
* If the former, the method must have the following signature:
*
* ~~~php
* // $params refers to validation parameters given in the rule * // $params refers to validation parameters given in the rule
* function validatorName($attribute,$params) * function validatorName($attribute, $params)
* </pre> * ~~~
* A built-in validator refers to one of the validators declared in {@link CValidator::builtInValidators}. *
* And a validator class is a class extending {@link CValidator}.</li> * If the latter, the object must be extending from [[\yii\validators\Validator]].
* <li>on: this specifies the scenarios when the validation rule should be performed. * Yii provides a set of [[\yii\validators\Validator::builtInValidators|built-in validators]].
* Separate different scenarios with commas. If this option is not set, the rule * They each have an alias name which can be used when specifying a validation rule.
* will be applied in any scenario. Please see {@link scenario} for more details about this option.</li>
* <li>additional parameters are used to initialize the corresponding validator properties.
* Please refer to individal validator class API for possible properties.</li>
* </ul>
* *
* The following are some examples: * The following are some examples:
* <pre> *
* ~~~php
* array( * array(
* array('username', 'required'), * array('username', 'required'),
* array('username', 'length', 'min'=>3, 'max'=>12), * array('username', 'length', 'min'=>3, 'max'=>12),
* array('password', 'compare', 'compareAttribute'=>'password2', 'on'=>'register'), * array('password', 'compare', 'compareAttribute'=>'password2', 'on'=>'register'),
* array('password', 'authenticate', 'on'=>'login'), * array('password', 'authenticate', 'on'=>'login'),
* ); * );
* </pre> * ~~~
* *
* Note, in order to inherit rules defined in the parent class, a child class needs to * Note, in order to inherit rules defined in the parent class, a child class needs to
* merge the parent rules with child rules using functions like array_merge(). * merge the parent rules with child rules using functions such as `array_merge()`.
* *
* @return array validation rules to be applied when {@link validate()} is called. * @return array validation rules
* @see scenario
*/ */
public function rules() public function rules()
{ {
@ -85,21 +135,21 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
* The return value should be an array of behavior configurations indexed by * The return value should be an array of behavior configurations indexed by
* behavior names. Each behavior configuration can be either a string specifying * behavior names. Each behavior configuration can be either a string specifying
* the behavior class or an array of the following structure: * the behavior class or an array of the following structure:
* <pre> *
* 'behaviorName'=>array( * ~~~php
* 'class'=>'path.to.BehaviorClass', * 'behaviorName' => array(
* 'property1'=>'value1', * 'class' => 'BehaviorClass',
* 'property2'=>'value2', * 'property1' => 'value1',
* 'property2' => 'value2',
* ) * )
* </pre> * ~~~
* *
* Note, the behavior classes must implement {@link IBehavior} or extend from * Note, the behavior classes must extend from [[Behavior]]. Behaviors declared
* {@link CBehavior}. Behaviors declared in this method will be attached * in this method will be attached to the model when it is instantiated.
* to the model when it is instantiated.
* *
* For more details about behaviors, see {@link CComponent}. * For more details about behaviors, see [[Component]].
* @return array the behavior configurations (behavior name=>behavior configuration) *
* @since 1.0.2 * @return array the behavior configurations.
*/ */
public function behaviors() public function behaviors()
{ {
@ -108,12 +158,16 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
/** /**
* Returns the attribute labels. * Returns the attribute labels.
* Attribute labels are mainly used in error messages of validation. *
* By default an attribute label is generated using {@link generateAttributeLabel}. * 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.
*
* By default an attribute label is generated using [[generateAttributeLabel]].
* This method allows you to explicitly specify attribute labels. * 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 * Note, in order to inherit labels defined in the parent class, a child class needs to
* merge the parent labels with child labels using functions like array_merge(). * merge the parent labels with child labels using functions such as `array_merge()`.
* *
* @return array attribute labels (name=>label) * @return array attribute labels (name=>label)
* @see generateAttributeLabel * @see generateAttributeLabel
@ -124,37 +178,40 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
} }
/** /**
* Performs the validation. * Performs the data validation.
* *
* This method executes the validation rules as declared in {@link rules}. * This method executes the validation rules as declared in [[rules]].
* Only the rules applicable to the current {@link scenario} will be executed. * Only the rules applicable to the current [[scenario]] will be executed.
* A rule is considered applicable to a scenario if its 'on' option is not set * A rule is considered applicable to a scenario if its `on` option is not set
* or contains the scenario. * or contains the scenario.
* *
* Errors found during the validation can be retrieved via {@link getErrors}. * This method will call [[beforeValidate]] and [[afterValidate]] before and
* after actual validation, respectively. If [[beforeValidate]] returns false,
* the validation and [[afterValidate]] will be cancelled.
*
* Errors found during the validation can be retrieved via [[getErrors]].
* *
* @param array $attributes list of attributes that should be validated. Defaults to null, * @param array $attributes list of attributes that should be validated.
* meaning any attribute listed in the applicable validation rules should be * If this parameter is empty, it means any attribute listed in the applicable
* validated. If this parameter is given as a list of attributes, only * validation rules should be validated.
* the listed attributes will be validated. * @param boolean $clearErrors whether to call [[clearErrors]] before performing validation
* @param boolean $clearErrors whether to call {@link clearErrors} before performing validation
* @return boolean whether the validation is successful without any error. * @return boolean whether the validation is successful without any error.
* @see beforeValidate * @see beforeValidate
* @see afterValidate * @see afterValidate
*/ */
public function validate($attributes=null, $clearErrors=true) public function validate($attributes = null, $clearErrors = true)
{ {
if($clearErrors) if ($clearErrors) {
$this->clearErrors(); $this->clearErrors();
if($this->beforeValidate()) }
{ if ($this->beforeValidate()) {
foreach($this->getValidators() as $validator) foreach ($this->getValidators() as $validator) {
$validator->validate($this,$attributes); $validator->validate($this, $attributes);
}
$this->afterValidate(); $this->afterValidate();
return !$this->hasErrors(); return !$this->hasErrors();
} }
else return false;
return false;
} }
/** /**
@ -163,9 +220,9 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
* You may override this method to do postprocessing after model creation. * You may override this method to do postprocessing after model creation.
* Make sure you call the parent implementation so that the event is raised properly. * Make sure you call the parent implementation so that the event is raised properly.
*/ */
protected function afterConstruct() public function afterConstruct()
{ {
if($this->hasEventHandler('onAfterConstruct')) if ($this->hasEventHandler('onAfterConstruct'))
$this->onAfterConstruct(new CEvent($this)); $this->onAfterConstruct(new CEvent($this));
} }
@ -177,9 +234,9 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
* @return boolean whether validation should be executed. Defaults to true. * @return boolean whether validation should be executed. Defaults to true.
* If false is returned, the validation will stop and the model is considered invalid. * If false is returned, the validation will stop and the model is considered invalid.
*/ */
protected function beforeValidate() public function beforeValidate()
{ {
$event=new CModelEvent($this); $event = new ModelEvent($this);
$this->onBeforeValidate($event); $this->onBeforeValidate($event);
return $event->isValid; return $event->isValid;
} }
@ -190,7 +247,7 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
* You may override this method to do postprocessing after validation. * You may override this method to do postprocessing after validation.
* Make sure the parent implementation is invoked so that the event can be raised. * Make sure the parent implementation is invoked so that the event can be raised.
*/ */
protected function afterValidate() public function afterValidate()
{ {
$this->onAfterValidate(new CEvent($this)); $this->onAfterValidate(new CEvent($this));
} }
@ -198,31 +255,28 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
/** /**
* This event is raised after the model instance is created by new operator. * This event is raised after the model instance is created by new operator.
* @param CEvent $event the event parameter * @param CEvent $event the event parameter
* @since 1.0.2
*/ */
public function onAfterConstruct($event) public function onAfterConstruct($event)
{ {
$this->raiseEvent('onAfterConstruct',$event); $this->raiseEvent('onAfterConstruct', $event);
} }
/** /**
* This event is raised before the validation is performed. * This event is raised before the validation is performed.
* @param CModelEvent $event the event parameter * @param ModelEvent $event the event parameter
* @since 1.0.2
*/ */
public function onBeforeValidate($event) public function onBeforeValidate($event)
{ {
$this->raiseEvent('onBeforeValidate',$event); $this->raiseEvent('onBeforeValidate', $event);
} }
/** /**
* This event is raised after the validation is performed. * This event is raised after the validation is performed.
* @param CEvent $event the event parameter * @param CEvent $event the event parameter
* @since 1.0.2
*/ */
public function onAfterValidate($event) public function onAfterValidate($event)
{ {
$this->raiseEvent('onAfterValidate',$event); $this->raiseEvent('onAfterValidate', $event);
} }
/** /**
@ -235,12 +289,11 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
* The change made to the {@link CList} object will persist and reflect * The change made to the {@link CList} object will persist and reflect
* in the result of the next call of {@link getValidators}. * in the result of the next call of {@link getValidators}.
* @return CList all the validators declared in the model. * @return CList all the validators declared in the model.
* @since 1.1.2
*/ */
public function getValidatorList() public function getValidatorList()
{ {
if($this->_validators===null) if ($this->_validators === null)
$this->_validators=$this->createValidators(); $this->_validators = $this->createValidators();
return $this->_validators; return $this->_validators;
} }
@ -249,21 +302,20 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
* @param string $attribute the name of the attribute whose validators should be returned. * @param string $attribute the name of the attribute whose validators should be returned.
* If this is null, the validators for ALL attributes in the model will be returned. * If this is null, the validators for ALL attributes in the model will be returned.
* @return array the validators applicable to the current {@link scenario}. * @return array the validators applicable to the current {@link scenario}.
* @since 1.0.1
*/ */
public function getValidators($attribute=null) public function getValidators($attribute = null)
{ {
if($this->_validators===null) if ($this->_validators === null)
$this->_validators=$this->createValidators(); $this->_validators = $this->createValidators();
$validators=array(); $validators = array();
$scenario=$this->getScenario(); $scenario = $this->getScenario();
foreach($this->_validators as $validator) foreach ($this->_validators as $validator)
{ {
if($validator->applyTo($scenario)) if ($validator->applyTo($scenario))
{ {
if($attribute===null || in_array($attribute,$validator->attributes,true)) if ($attribute === null || in_array($attribute, $validator->attributes, true))
$validators[]=$validator; $validators[] = $validator;
} }
} }
return $validators; return $validators;
@ -276,14 +328,14 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
*/ */
public function createValidators() public function createValidators()
{ {
$validators=new CList; $validators = new CList;
foreach($this->rules() as $rule) foreach ($this->rules() as $rule)
{ {
if(isset($rule[0],$rule[1])) // attributes, validator name if (isset($rule[0], $rule[1])) // attributes, validator name
$validators->add(CValidator::createValidator($rule[1],$this,$rule[0],array_slice($rule,2))); $validators->add(CValidator::createValidator($rule[1], $this, $rule[0], array_slice($rule, 2)));
else else
throw new CException(Yii::t('yii','{class} has an invalid validation rule. The rule must specify attributes to be validated and the validator name.', throw new CException(Yii::t('yii', '{class} has an invalid validation rule. The rule must specify attributes to be validated and the validator name.',
array('{class}'=>get_class($this)))); array('{class}' => get_class($this))));
} }
return $validators; return $validators;
} }
@ -294,13 +346,12 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
* {@link CRequiredValidator} validation rule in the current {@link scenario}. * {@link CRequiredValidator} validation rule in the current {@link scenario}.
* @param string $attribute attribute name * @param string $attribute attribute name
* @return boolean whether the attribute is required * @return boolean whether the attribute is required
* @since 1.0.2
*/ */
public function isAttributeRequired($attribute) public function isAttributeRequired($attribute)
{ {
foreach($this->getValidators($attribute) as $validator) foreach ($this->getValidators($attribute) as $validator)
{ {
if($validator instanceof CRequiredValidator) if ($validator instanceof CRequiredValidator)
return true; return true;
} }
return false; return false;
@ -310,12 +361,11 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
* Returns a value indicating whether the attribute is safe for massive assignments. * Returns a value indicating whether the attribute is safe for massive assignments.
* @param string $attribute attribute name * @param string $attribute attribute name
* @return boolean whether the attribute is safe for massive assignments * @return boolean whether the attribute is safe for massive assignments
* @since 1.1
*/ */
public function isAttributeSafe($attribute) public function isAttributeSafe($attribute)
{ {
$attributes=$this->getSafeAttributeNames(); $attributes = $this->getSafeAttributeNames();
return in_array($attribute,$attributes); return in_array($attribute, $attributes);
} }
/** /**
@ -327,8 +377,8 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
*/ */
public function getAttributeLabel($attribute) public function getAttributeLabel($attribute)
{ {
$labels=$this->attributeLabels(); $labels = $this->attributeLabels();
if(isset($labels[$attribute])) if (isset($labels[$attribute]))
return $labels[$attribute]; return $labels[$attribute];
else else
return $this->generateAttributeLabel($attribute); return $this->generateAttributeLabel($attribute);
@ -339,10 +389,10 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
* @param string $attribute attribute name. Use null to check all attributes. * @param string $attribute attribute name. Use null to check all attributes.
* @return boolean whether there is any error. * @return boolean whether there is any error.
*/ */
public function hasErrors($attribute=null) public function hasErrors($attribute = null)
{ {
if($attribute===null) if ($attribute === null)
return $this->_errors!==array(); return $this->_errors !== array();
else else
return isset($this->_errors[$attribute]); return isset($this->_errors[$attribute]);
} }
@ -352,9 +402,9 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
* @param string $attribute attribute name. Use null to retrieve errors for all attributes. * @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. * @return array errors for all attributes or the specified attribute. Empty array is returned if no error.
*/ */
public function getErrors($attribute=null) public function getErrors($attribute = null)
{ {
if($attribute===null) if ($attribute === null)
return $this->_errors; return $this->_errors;
else else
return isset($this->_errors[$attribute]) ? $this->_errors[$attribute] : array(); return isset($this->_errors[$attribute]) ? $this->_errors[$attribute] : array();
@ -364,7 +414,6 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
* Returns the first error of the specified attribute. * Returns the first error of the specified attribute.
* @param string $attribute attribute name. * @param string $attribute attribute name.
* @return string the error message. Null is returned if no error. * @return string the error message. Null is returned if no error.
* @since 1.0.2
*/ */
public function getError($attribute) public function getError($attribute)
{ {
@ -376,9 +425,9 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
* @param string $attribute attribute name * @param string $attribute attribute name
* @param string $error new error message * @param string $error new error message
*/ */
public function addError($attribute,$error) public function addError($attribute, $error)
{ {
$this->_errors[$attribute][]=$error; $this->_errors[$attribute][] = $error;
} }
/** /**
@ -387,19 +436,18 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
* The array values should be error messages. If an attribute has multiple errors, * The array values should be error messages. If an attribute has multiple errors,
* these errors must be given in terms of an array. * these errors must be given in terms of an array.
* You may use the result of {@link getErrors} as the value for this parameter. * You may use the result of {@link getErrors} as the value for this parameter.
* @since 1.0.5
*/ */
public function addErrors($errors) public function addErrors($errors)
{ {
foreach($errors as $attribute=>$error) foreach ($errors as $attribute => $error)
{ {
if(is_array($error)) if (is_array($error))
{ {
foreach($error as $e) foreach ($error as $e)
$this->_errors[$attribute][]=$e; $this->_errors[$attribute][] = $e;
} }
else else
$this->_errors[$attribute][]=$error; $this->_errors[$attribute][] = $error;
} }
} }
@ -407,10 +455,10 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
* Removes errors for all attributes or a single attribute. * Removes errors for all attributes or a single attribute.
* @param string $attribute attribute name. Use null to remove errors for all attribute. * @param string $attribute attribute name. Use null to remove errors for all attribute.
*/ */
public function clearErrors($attribute=null) public function clearErrors($attribute = null)
{ {
if($attribute===null) if ($attribute === null)
$this->_errors=array(); $this->_errors = array();
else else
unset($this->_errors[$attribute]); unset($this->_errors[$attribute]);
} }
@ -425,7 +473,7 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
*/ */
public function generateAttributeLabel($name) public function generateAttributeLabel($name)
{ {
return ucwords(trim(strtolower(str_replace(array('-','_','.'),' ',preg_replace('/(?<![A-Z])[A-Z]/', ' \0', $name))))); return ucwords(trim(strtolower(str_replace(array('-', '_', '.'), ' ', preg_replace('/(?<![A-Z])[A-Z]/', ' \0', $name)))));
} }
/** /**
@ -435,17 +483,17 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
* If it is an array, only the attributes in the array will be returned. * If it is an array, only the attributes in the array will be returned.
* @return array attribute values (name=>value). * @return array attribute values (name=>value).
*/ */
public function getAttributes($names=null) public function getAttributes($names = null)
{ {
$values=array(); $values = array();
foreach($this->attributeNames() as $name) foreach ($this->attributeNames() as $name)
$values[$name]=$this->$name; $values[$name] = $this->$name;
if(is_array($names)) if (is_array($names))
{ {
$values2=array(); $values2 = array();
foreach($names as $name) foreach ($names as $name)
$values2[$name]=isset($values[$name]) ? $values[$name] : null; $values2[$name] = isset($values[$name]) ? $values[$name] : null;
return $values2; return $values2;
} }
else else
@ -460,32 +508,33 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
* @see getSafeAttributeNames * @see getSafeAttributeNames
* @see attributeNames * @see attributeNames
*/ */
public function setAttributes($values,$safeOnly=true) public function setAttributes($values, $safeOnly = true)
{ {
if(!is_array($values)) if (!is_array($values))
return; return;
$attributes=array_flip($safeOnly ? $this->getSafeAttributeNames() : $this->attributeNames()); $attributes = array_flip($safeOnly ? $this->getSafeAttributeNames() : $this->attributeNames());
foreach($values as $name=>$value) foreach ($values as $name => $value)
{ {
if(isset($attributes[$name])) if (isset($attributes[$name]))
$this->$name=$value; $this->$name = $value;
else if($safeOnly) elseif ($safeOnly)
$this->onUnsafeAttribute($name,$value); $this->onUnsafeAttribute($name, $value);
} }
} }
/** /**
* Sets the attributes to be null. * Sets the attributes to be null.
* @param array $names list of attributes to be set null. If this parameter is not given, * @param array $names list of attributes to be set null. If this parameter is not given,
* all attributes as specified by {@link attributeNames} will have their values unset. * all attributes as specified by [[attributeNames]] will have their values unset.
* @since 1.1.3
*/ */
public function unsetAttributes($names=null) public function unsetAttributes($names = null)
{ {
if($names===null) if ($names === null) {
$names=$this->attributeNames(); $names = $this->attributeNames();
foreach($names as $name) }
$this->$name=null; foreach ($names as $name) {
$this->$name = null;
}
} }
/** /**
@ -494,12 +543,11 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
* It does nothing otherwise. * It does nothing otherwise.
* @param string $name the unsafe attribute name * @param string $name the unsafe attribute name
* @param mixed $value the attribute value * @param mixed $value the attribute value
* @since 1.1.1
*/ */
public function onUnsafeAttribute($name,$value) public function onUnsafeAttribute($name, $value)
{ {
if(YII_DEBUG) if (YII_DEBUG)
Yii::log(Yii::t('yii','Failed to set unsafe attribute "{attribute}" of "{class}".',array('{attribute}'=>$name, '{class}'=>get_class($this))),CLogger::LEVEL_WARNING); \Yii::warning(sprintf('Failed to set unsafe attribute "%s" of "%s".', $name, get_class($this));
} }
/** /**
@ -508,16 +556,15 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
* Scenario affects how validation is performed and which attributes can * Scenario affects how validation is performed and which attributes can
* be massively assigned. * be massively assigned.
* *
* A validation rule will be performed when calling {@link validate()} * A validation rule will be performed when calling [[validate]]
* if its 'on' option is not set or contains the current scenario value. * if its 'on' option is not set or contains the current scenario value.
* *
* And an attribute can be massively assigned if it is associated with * And an attribute can be massively assigned if it is associated with
* a validation rule for the current scenario. Note that an exception is * a validation rule for the current scenario. An exception is
* the {@link CUnsafeValidator unsafe} validator which marks the associated * the [[\yii\validators\UnsafeValidator|unsafe]] validator which marks
* attributes as unsafe and not allowed to be massively assigned. * the associated attributes as unsafe and not allowed to be massively assigned.
* *
* @return string the scenario that this model is in. * @return string the scenario that this model is in.
* @since 1.0.4
*/ */
public function getScenario() public function getScenario()
{ {
@ -528,38 +575,36 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
* Sets the scenario for the model. * Sets the scenario for the model.
* @param string $value the scenario that this model is in. * @param string $value the scenario that this model is in.
* @see getScenario * @see getScenario
* @since 1.0.4
*/ */
public function setScenario($value) public function setScenario($value)
{ {
$this->_scenario=$value; $this->_scenario = $value;
} }
/** /**
* Returns the attribute names that are safe to be massively assigned. * Returns the attribute names that are safe to be massively assigned.
* A safe attribute is one that is associated with a validation rule in the current {@link scenario}. * A safe attribute is one that is associated with a validation rule in the current {@link scenario}.
* @return array safe attribute names * @return array safe attribute names
* @since 1.0.2
*/ */
public function getSafeAttributeNames() public function getSafeAttributeNames()
{ {
$attributes=array(); $attributes = array();
$unsafe=array(); $unsafe = array();
foreach($this->getValidators() as $validator) foreach ($this->getValidators() as $validator)
{ {
if(!$validator->safe) if (!$validator->safe)
{ {
foreach($validator->attributes as $name) foreach ($validator->attributes as $name)
$unsafe[]=$name; $unsafe[] = $name;
} }
else else
{ {
foreach($validator->attributes as $name) foreach ($validator->attributes as $name)
$attributes[$name]=true; $attributes[$name] = true;
} }
} }
foreach($unsafe as $name) foreach ($unsafe as $name)
unset($attributes[$name]); unset($attributes[$name]);
return array_keys($attributes); return array_keys($attributes);
} }
@ -571,28 +616,28 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
*/ */
public function getIterator() public function getIterator()
{ {
$attributes=$this->getAttributes(); $attributes = $this->getAttributes();
return new CMapIterator($attributes); return new DictionaryIterator($attributes);
} }
/** /**
* Returns whether there is an element at the specified offset. * Returns whether there is an element at the specified offset.
* This method is required by the interface ArrayAccess. * This method is required by the SPL interface `ArrayAccess`.
* It is implicitly called when you use something like `isset($model[$offset])`.
* @param mixed $offset the offset to check on * @param mixed $offset the offset to check on
* @return boolean * @return boolean
* @since 1.0.2
*/ */
public function offsetExists($offset) public function offsetExists($offset)
{ {
return property_exists($this,$offset); return property_exists($this, $offset) && $this->$offset !== null;
} }
/** /**
* Returns the element at the specified offset. * Returns the element at the specified offset.
* This method is required by the interface ArrayAccess. * This method is required by the SPL interface `ArrayAccess`.
* It is implicitly called when you use something like `$value = $model[$offset];`.
* @param integer $offset the offset to retrieve element. * @param integer $offset the offset to retrieve element.
* @return mixed the element at the offset, null if no element is found at the offset * @return mixed the element at the offset, null if no element is found at the offset
* @since 1.0.2
*/ */
public function offsetGet($offset) public function offsetGet($offset)
{ {
@ -601,21 +646,21 @@ abstract class CModel extends CComponent implements IteratorAggregate, ArrayAcce
/** /**
* Sets the element at the specified offset. * Sets the element at the specified offset.
* This method is required by the interface ArrayAccess. * This method is required by the SPL interface `ArrayAccess`.
* It is implicitly called when you use something like `$model[$offset] = $item;`.
* @param integer $offset the offset to set element * @param integer $offset the offset to set element
* @param mixed $item the element value * @param mixed $item the element value
* @since 1.0.2
*/ */
public function offsetSet($offset,$item) public function offsetSet($offset, $item)
{ {
$this->$offset=$item; $this->$offset = $item;
} }
/** /**
* Unsets the element at the specified offset. * Unsets the element at the specified offset.
* This method is required by the interface ArrayAccess. * This method is required by the SPL interface `ArrayAccess`.
* It is implicitly called when you use something like `unset($model[$offset])`.
* @param mixed $offset the offset to unset element * @param mixed $offset the offset to unset element
* @since 1.0.2
*/ */
public function offsetUnset($offset) public function offsetUnset($offset)
{ {

6
framework/base/ModelBehavior.php
Unescape View File

@ -28,9 +28,9 @@ class CModelBehavior extends CBehavior
public function events() public function events()
{ {
return array( return array(
'onAfterConstruct'=>'afterConstruct', 'onAfterConstruct' => 'afterConstruct',
'onBeforeValidate'=>'beforeValidate', 'onBeforeValidate' => 'beforeValidate',
'onAfterValidate'=>'afterValidate', 'onAfterValidate' => 'afterValidate',
); );
} }

2
framework/base/ModelEvent.php
Unescape View File

@ -28,7 +28,7 @@ class CModelEvent extends CEvent
* If true, the normal execution cycles will continue, including performing the real validations and calling * If true, the normal execution cycles will continue, including performing the real validations and calling
* {@link CModel::afterValidate}. * {@link CModel::afterValidate}.
*/ */
public $isValid=true; public $isValid = true;
/** /**
* @var CDbCrireria the query criteria that is passed as a parameter to a find method of {@link CActiveRecord}. * @var CDbCrireria the query criteria that is passed as a parameter to a find method of {@link CActiveRecord}.
* Note that this property is only used by {@link CActiveRecord::onBeforeFind} event. * Note that this property is only used by {@link CActiveRecord::onBeforeFind} event.

8
framework/base/Vector.php
Unescape View File

@ -299,7 +299,7 @@ class Vector extends Component implements \IteratorAggregate, \ArrayAccess, \Cou
/** /**
* Returns a value indicating whether there is an item at the specified offset. * Returns a value indicating whether there is an item at the specified offset.
* This method is required by the SPL interface `ArrayAccess`. * This method is required by the SPL interface `ArrayAccess`.
* It is implicitly called when you use something like `isset($vector[$index])`. * It is implicitly called when you use something like `isset($vector[$offset])`.
* @param integer $offset the offset to be checked * @param integer $offset the offset to be checked
* @return boolean whether there is an item at the specified offset. * @return boolean whether there is an item at the specified offset.
*/ */
@ -311,7 +311,7 @@ class Vector extends Component implements \IteratorAggregate, \ArrayAccess, \Cou
/** /**
* Returns the item at the specified offset. * Returns the item at the specified offset.
* This method is required by the SPL interface `ArrayAccess`. * This method is required by the SPL interface `ArrayAccess`.
* It is implicitly called when you use something like `$value = $vector[$index];`. * It is implicitly called when you use something like `$value = $vector[$offset];`.
* This is equivalent to [[itemAt]]. * This is equivalent to [[itemAt]].
* @param integer $offset the offset to retrieve item. * @param integer $offset the offset to retrieve item.
* @return mixed the item at the offset * @return mixed the item at the offset
@ -325,7 +325,7 @@ class Vector extends Component implements \IteratorAggregate, \ArrayAccess, \Cou
/** /**
* Sets the item at the specified offset. * Sets the item at the specified offset.
* This method is required by the SPL interface `ArrayAccess`. * This method is required by the SPL interface `ArrayAccess`.
* It is implicitly called when you use something like `$vector[$index] = $value;`. * It is implicitly called when you use something like `$vector[$offset] = $item;`.
* If the offset is null or equal to the number of the existing items, * If the offset is null or equal to the number of the existing items,
* the new item will be appended to the vector. * the new item will be appended to the vector.
* Otherwise, the existing item at the offset will be replaced with the new item. * Otherwise, the existing item at the offset will be replaced with the new item.
@ -347,7 +347,7 @@ class Vector extends Component implements \IteratorAggregate, \ArrayAccess, \Cou
/** /**
* Unsets the item at the specified offset. * Unsets the item at the specified offset.
* This method is required by the SPL interface `ArrayAccess`. * This method is required by the SPL interface `ArrayAccess`.
* It is implicitly called when you use something like `unset($vector[$index])`. * It is implicitly called when you use something like `unset($vector[$offset])`.
* This is equivalent to [[removeAt]]. * This is equivalent to [[removeAt]].
* @param integer $offset the offset to unset item * @param integer $offset the offset to unset item
* @throws Exception if the offset is out of range, or the vector is read only. * @throws Exception if the offset is out of range, or the vector is read only.

Write Preview
Loading…
Cancel
Save