You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
90 lines
2.7 KiB
90 lines
2.7 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\validators; |
|
|
|
/** |
|
* InlineValidator represents a validator which is defined as a method in the object being validated. |
|
* |
|
* The validation method must have the following signature: |
|
* |
|
* ~~~ |
|
* function foo($attribute, $params) |
|
* ~~~ |
|
* |
|
* where `$attribute` refers to the name of the attribute being validated, while `$params` |
|
* is an array representing the additional parameters supplied in the validation rule. |
|
* |
|
* @author Qiang Xue <qiang.xue@gmail.com> |
|
* @since 2.0 |
|
*/ |
|
class InlineValidator extends Validator |
|
{ |
|
/** |
|
* @var string the name of the validation method defined in the |
|
* \yii\base\Model class |
|
*/ |
|
public $method; |
|
/** |
|
* @var array additional parameters that are passed to the validation method |
|
*/ |
|
public $params; |
|
/** |
|
* @var string the name of the method that returns the client validation code (see [[clientValidateAttribute()]] |
|
* for details on how to return client validation code). The signature of the method should be like the following: |
|
* |
|
* ~~~ |
|
* function foo($attribute) |
|
* { |
|
* return "javascript"; |
|
* } |
|
* ~~~ |
|
* |
|
* where `$attribute` refers to the attribute name to be validated. |
|
*/ |
|
public $clientValidate; |
|
|
|
/** |
|
* Validates the attribute of the object. |
|
* @param \yii\base\Model $object the object being validated |
|
* @param string $attribute the attribute being validated |
|
*/ |
|
public function validateAttribute($object, $attribute) |
|
{ |
|
$method = $this->method; |
|
$object->$method($attribute, $this->params); |
|
} |
|
|
|
/** |
|
* Returns the JavaScript needed for performing client-side validation. |
|
* |
|
* You may override this method to return the JavaScript validation code if |
|
* the validator can support client-side validation. |
|
* |
|
* The following JavaScript variables are predefined and can be used in the validation code: |
|
* |
|
* - `attribute`: the name of the attribute being validated. |
|
* - `value`: the value being validated. |
|
* - `messages`: an array used to hold the validation error messages for the attribute. |
|
* |
|
* @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. Null if the validator does not support |
|
* client-side validation. |
|
* @see enableClientValidation |
|
* @see \yii\web\ActiveForm::enableClientValidation |
|
*/ |
|
public function clientValidateAttribute($object, $attribute) |
|
{ |
|
if ($this->clientValidate !== null) { |
|
$method = $this->clientValidate; |
|
return $object->$method($attribute); |
|
} else { |
|
return null; |
|
} |
|
} |
|
} |