From 78396afb02b1db331f2fc4dba2bc17fb96ca858d Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Sun, 20 Jan 2013 19:39:56 -0500 Subject: [PATCH] validator cleanup. --- framework/base/Controller.php | 9 --- framework/logging/Logger.php | 2 +- framework/validators/UniqueValidator.php | 28 +++---- framework/validators/UnsafeValidator.php | 36 --------- framework/validators/UrlValidator.php | 2 +- framework/validators/Validator.php | 131 +++++++++++++------------------ 6 files changed, 65 insertions(+), 143 deletions(-) delete mode 100644 framework/validators/UnsafeValidator.php diff --git a/framework/base/Controller.php b/framework/base/Controller.php index 666b9b0..61dec24 100644 --- a/framework/base/Controller.php +++ b/framework/base/Controller.php @@ -88,15 +88,6 @@ class Controller extends Component } /** - * Initializes the controller. - * This method is called by the application before the controller starts to execute an action. - * You may override this method to perform the needed initialization for the controller. - */ - public function init() - { - } - - /** * Runs the controller with the specified action and parameters. * @param Action|string $action the action to be executed. This can be either an action object * or the ID of the action. diff --git a/framework/logging/Logger.php b/framework/logging/Logger.php index b963ea9..c139193 100644 --- a/framework/logging/Logger.php +++ b/framework/logging/Logger.php @@ -138,7 +138,7 @@ class Logger extends \yii\base\Component */ public function flush($final = false) { - $this->trigger($final ? 'finalFlush' : 'flush'); + $this->trigger($final ? self::EVENT_FINAL_FLUSH : self::EVENT_FLUSH); $this->messages = array(); } diff --git a/framework/validators/UniqueValidator.php b/framework/validators/UniqueValidator.php index f8c49b2..e97fb09 100644 --- a/framework/validators/UniqueValidator.php +++ b/framework/validators/UniqueValidator.php @@ -8,6 +8,7 @@ */ namespace yii\validators; +use yii\base\InvalidConfigException; /** * CUniqueValidator validates that the attribute value is unique in the corresponding database table. @@ -23,10 +24,9 @@ class UniqueValidator extends Validator */ public $allowEmpty = true; /** - * @var string the yii\db\ActiveRecord class name or alias of the class + * @var string the ActiveRecord class name or alias of the class * that should be used to look for the attribute value being validated. - * Defaults to null, meaning using the yii\db\ActiveRecord class of - * the attribute being validated. + * Defaults to null, meaning using the ActiveRecord class of the attribute being validated. * @see attributeName */ public $className; @@ -36,23 +36,13 @@ class UniqueValidator extends Validator * meaning using the name of the attribute being validated. */ public $attributeName; - /** - * @var string the user-defined error message. The placeholders "{attribute}" and "{value}" - * are recognized, which will be replaced with the actual attribute name and value, respectively. - */ - public $message; - /** - * @var boolean whether this validation rule should be skipped if when there is already a validation - * error for the current attribute. Defaults to true. - */ - public $skipOnError = true; /** * Validates the attribute of the object. * If there is any error, the error message is added to the object. * @param \yii\db\ActiveRecord $object the object being validated * @param string $attribute the attribute being validated - * @throws \yii\base\Exception if table doesn't have column specified + * @throws InvalidConfigException if table doesn't have column specified */ public function validateAttribute($object, $attribute) { @@ -62,12 +52,12 @@ class UniqueValidator extends Validator } /** @var $className \yii\db\ActiveRecord */ - $className = ($this->className === null) ? get_class($object) : \Yii::import($this->className); - $attributeName = ($this->attributeName === null) ? $attribute : $this->attributeName; + $className = $this->className === null ? get_class($object) : \Yii::import($this->className); + $attributeName = $this->attributeName === null ? $attribute : $this->attributeName; $table = $className::getTableSchema(); if (($column = $table->getColumn($attributeName)) === null) { - throw new \yii\base\Exception('Table "' . $table->name . '" does not have a column named "' . $attributeName . '"'); + throw new InvalidConfigException('Table "' . $table->name . '" does not have a column named "' . $attributeName . '"'); } $query = $className::find(); @@ -97,8 +87,8 @@ class UniqueValidator extends Validator } if ($exists) { - $message = ($this->message !== null) ? $this->message : \Yii::t('yii', '{attribute} "{value}" has already been taken.'); - $this->addError($object, $attribute, $message, array('{value}' => $value)); + $message = $this->message !== null ? $this->message : \Yii::t('yii', '{attribute} "{value}" has already been taken.'); + $this->addError($object, $attribute, $message); } } } \ No newline at end of file diff --git a/framework/validators/UnsafeValidator.php b/framework/validators/UnsafeValidator.php deleted file mode 100644 index a85c213..0000000 --- a/framework/validators/UnsafeValidator.php +++ /dev/null @@ -1,36 +0,0 @@ - - * @since 2.0 - */ -class UnsafeValidator extends Validator -{ - /** - * @var boolean whether attributes listed with this validator should be considered safe for massive assignment. - * Defaults to false. - */ - public $safe = false; - - /** - * Validates the attribute of the object. - * If there is any error, the error message is added to the object. - * @param \yii\base\Model $object the object being validated - * @param string $attribute the attribute being validated - */ - public function validateAttribute($object, $attribute) - { - } -} - diff --git a/framework/validators/UrlValidator.php b/framework/validators/UrlValidator.php index f7235d4..c6242a2 100644 --- a/framework/validators/UrlValidator.php +++ b/framework/validators/UrlValidator.php @@ -93,7 +93,7 @@ class UrlValidator extends Validator * @param \yii\base\Model $object the data object being validated * @param string $attribute the name of the attribute to be validated. * @return string the client-side validation script. - * @see CActiveForm::enableClientValidation + * @see \yii\Web\ActiveForm::enableClientValidation */ public function clientValidateAttribute($object, $attribute) { diff --git a/framework/validators/Validator.php b/framework/validators/Validator.php index f706642..ad6fbee 100644 --- a/framework/validators/Validator.php +++ b/framework/validators/Validator.php @@ -9,67 +9,62 @@ namespace yii\validators; +use yii\base\Component; + /** * Validator is the base class for all validators. * - * Child classes must override the [[validateAttribute]] method to provide the actual - * logic of performing data validation. Child classes may also override [[clientValidateAttribute]] + * Child classes should override the [[validateAttribute()]] method to provide the actual + * logic of performing data validation. Child classes may also override [[clientValidateAttribute()]] * to provide client-side validation support. * - * Validator defines the following properties that are common among concrete validators: - * - * - [[attributes]]: array, list of attributes to be validated; - * - [[message]]: string, the error message used when validation fails; - * - [[on]]: string, scenarios on which the validator applies. - * - * Validator also declares a set of [[builtInValidators|built-in validators] which can + * Validator declares a set of [[builtInValidators|built-in validators] which can * be referenced using short names. They are listed as follows: * - * - `required`: [[RequiredValidator]] - * - `filter`: [[FilterValidator]] - * - `match`: [[RegularExpressionValidator]] - * - `email`: [[EmailValidator]] - * - `url`: [[UrlValidator]] - * - `unique`: [[UniqueValidator]] - * - `compare`: [[CompareValidator]] - * - `in`: [[RangeValidator]] * - `boolean`: [[BooleanValidator]] - * - `string`: [[StringValidator]] - * - `integer`: [[NumberValidator]] - * - `double`: [[NumberValidator]] - * - `date`: [[DateValidator]] - * - `file`: [[FileValidator]] * - `captcha`: [[CaptchaValidator]] + * - `compare`: [[CompareValidator]] + * - `date`: [[DateValidator]] * - `default`: [[DefaultValueValidator]] + * - `double`: [[NumberValidator]] + * - `email`: [[EmailValidator]] * - `exist`: [[ExistValidator]] + * - `file`: [[FileValidator]] + * - `filter`: [[FilterValidator]] + * - `in`: [[RangeValidator]] + * - `integer`: [[NumberValidator]] + * - `match`: [[RegularExpressionValidator]] + * - `required`: [[RequiredValidator]] + * - `string`: [[StringValidator]] + * - `unique`: [[UniqueValidator]] + * - `url`: [[UrlValidator]] * * @author Qiang Xue * @since 2.0 */ -abstract class Validator extends \yii\base\Component +abstract class Validator extends Component { /** * @var array list of built-in validators (name => class or configuration) */ public static $builtInValidators = array( - 'required' => '\yii\validators\RequiredValidator', - 'match' => '\yii\validators\RegularExpressionValidator', - 'email' => '\yii\validators\EmailValidator', - 'url' => '\yii\validators\UrlValidator', - 'filter' => '\yii\validators\FilterValidator', - 'captcha' => '\yii\validators\CaptchaValidator', - 'default' => '\yii\validators\DefaultValueValidator', - 'in' => '\yii\validators\RangeValidator', - 'boolean' => '\yii\validators\BooleanValidator', - 'string' => '\yii\validators\StringValidator', - 'integer' => '\yii\validators\IntegerValidator', - 'double' => '\yii\validators\NumberValidator', - 'compare' => '\yii\validators\CompareValidator', - 'file' => '\yii\validators\FileValidator', - 'date' => '\yii\validators\DateValidator', - 'unique' => '\yii\validators\UniqueValidator', - 'exist' => '\yii\validators\ExistValidator', - + 'boolean' => 'yii\validators\BooleanValidator', + 'captcha' => 'yii\validators\CaptchaValidator', + 'compare' => 'yii\validators\CompareValidator', + 'date' => 'yii\validators\DateValidator', + 'default' => 'yii\validators\DefaultValueValidator', + 'double' => 'yii\validators\NumberValidator', + 'email' => 'yii\validators\EmailValidator', + 'exist' => 'yii\validators\ExistValidator', + 'file' => 'yii\validators\FileValidator', + 'filter' => 'yii\validators\FilterValidator', + 'in' => 'yii\validators\RangeValidator', + 'integer' => 'yii\validators\IntegerValidator', + 'match' => 'yii\validators\RegularExpressionValidator', + 'required' => 'yii\validators\RequiredValidator', + 'string' => 'yii\validators\StringValidator', + 'unique' => 'yii\validators\UniqueValidator', + 'url' => 'yii\validators\UrlValidator', ); /** @@ -85,30 +80,27 @@ abstract class Validator extends \yii\base\Component public $message; /** * @var array list of scenarios that the validator should be applied. - * Each array value refers to a scenario name with the same name as its array key. */ - public $on; + public $on = array(); /** * @var array list of scenarios that the validator should not be applied to. - * Each array value refers to a scenario name with the same name as its array key. */ - public $except; + public $except = array(); /** * @var boolean whether this validation rule should be skipped if the attribute being validated - * already has some validation error according to the previous rules. Defaults to true. + * already has some validation error according to some previous rules. Defaults to true. */ public $skipOnError = true; /** - * @var boolean whether to enable client-side validation. Defaults to true. - * Please refer to [[\yii\web\ActiveForm::enableClientValidation]] for more details about - * client-side validation. + * @var boolean whether to enable client-side validation. Defaults to null, meaning + * its actual value inherits from that of [[\yii\web\ActiveForm::enableClientValidation]]. */ - public $enableClientValidation = true; + public $enableClientValidation; /** * Validates a single attribute. * Child classes must implement this method to provide the actual validation logic. - * @param \yii\base\Model $object the data object being validated + * @param \yii\base\Model $object the data object to be validated * @param string $attribute the name of the attribute to be validated. */ abstract public function validateAttribute($object, $attribute); @@ -116,9 +108,9 @@ abstract class Validator extends \yii\base\Component /** * Creates a validator object. * @param string $type the validator type. This can be a method name, - * a built-in validator name, a class name, or a path alias of validator class. - * @param \yii\base\Model $object the data object being validated. - * @param mixed $attributes list of attributes to be validated. This can be either an array of + * a built-in validator name, a class name, or a path alias of the validator class. + * @param \yii\base\Model $object the data object to be validated. + * @param array|string $attributes list of attributes to be validated. This can be either an array of * the attribute names or a string of comma-separated attribute names. * @param array $params initial values to be applied to the validator properties * @return Validator the validator @@ -129,32 +121,18 @@ abstract class Validator extends \yii\base\Component $attributes = preg_split('/[\s,]+/', $attributes, -1, PREG_SPLIT_NO_EMPTY); } - if (isset($params['on'])) { - if (is_array($params['on'])) { - $on = $params['on']; - } else { - $on = preg_split('/[\s,]+/', $params['on'], -1, PREG_SPLIT_NO_EMPTY); - } - $params['on'] = empty($on) ? array() : array_combine($on, $on); - } else { - $params['on'] = array(); + if (isset($params['on']) && !is_array($params['on'])) { + $params['on'] = preg_split('/[\s,]+/', $params['on'], -1, PREG_SPLIT_NO_EMPTY); } - if (isset($params['except'])) { - if (is_array($params['except'])) { - $except = $params['except']; - } else { - $except = preg_split('/[\s,]+/', $params['except'], -1, PREG_SPLIT_NO_EMPTY); - } - $params['except'] = empty($on) ? array() : array_combine($except, $except); - } else { - $params['except'] = array(); + if (isset($params['except']) && !is_array($params['except'])) { + $params['except'] = preg_split('/[\s,]+/', $params['except'], -1, PREG_SPLIT_NO_EMPTY); } if (method_exists($object, $type)) { // method-based validator $config = array( - 'class' => '\yii\validators\InlineValidator', + 'class' => __NAMESPACE__ . '\InlineValidator', 'method' => $type, 'attributes' => $attributes, ); @@ -170,9 +148,8 @@ abstract class Validator extends \yii\base\Component foreach ($params as $name => $value) { $config[$name] = $value; } - $validator = \Yii::createObject($config); - return $validator; + return \Yii::createObject($config); } /** @@ -191,7 +168,7 @@ abstract class Validator extends \yii\base\Component $attributes = $this->attributes; } foreach ($attributes as $attribute) { - if (!$this->skipOnError || !$object->hasErrors($attribute)) { + if (!($this->skipOnError && $object->hasErrors($attribute))) { $this->validateAttribute($object, $attribute); } } @@ -233,7 +210,7 @@ abstract class Validator extends \yii\base\Component */ public function isActive($scenario) { - return !isset($this->except[$scenario]) && (empty($this->on) || isset($this->on[$scenario])); + return !in_array($scenario, $this->except, true) && (empty($this->on) || in_array($scenario, $this->on, true)); } /**