InlineValidator.php 2.33 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 9
namespace yii\validators;

w  
Qiang Xue committed
10
/**
w  
Qiang Xue committed
11 12 13 14 15 16 17 18 19 20
 * 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.
w  
Qiang Xue committed
21 22
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
w  
Qiang Xue committed
23
 * @since 2.0
w  
Qiang Xue committed
24
 */
w  
Qiang Xue committed
25
class InlineValidator extends Validator
w  
Qiang Xue committed
26
{
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
    /**
     * @var string|\Closure an anonymous function or the name of a model class method that will be
     * called to perform the actual validation. The signature of the method should be like the following:
     *
     * ~~~
     * function foo($attribute, $params)
     * ~~~
     */
    public $method;
    /**
     * @var array additional parameters that are passed to the validation method
     */
    public $params;
    /**
     * @var string|\Closure an anonymous function or the name of a model class method that returns the client validation code.
     * The signature of the method should be like the following:
     *
     * ~~~
     * function foo($attribute, $params)
     * {
     *     return "javascript";
     * }
     * ~~~
     *
     * where `$attribute` refers to the attribute name to be validated.
     *
     * Please refer to [[clientValidateAttribute()]] for details on how to return client validation code.
     */
    public $clientValidate;
w  
Qiang Xue committed
56

57

58 59 60
    /**
     * @inheritdoc
     */
Qiang Xue committed
61
    public function validateAttribute($model, $attribute)
62 63 64
    {
        $method = $this->method;
        if (is_string($method)) {
Qiang Xue committed
65
            $method = [$model, $method];
66 67 68
        }
        call_user_func($method, $attribute, $this->params);
    }
Qiang Xue committed
69

70 71 72
    /**
     * @inheritdoc
     */
Qiang Xue committed
73
    public function clientValidateAttribute($model, $attribute, $view)
74 75 76 77
    {
        if ($this->clientValidate !== null) {
            $method = $this->clientValidate;
            if (is_string($method)) {
Qiang Xue committed
78
                $method = [$model, $method];
79 80 81 82 83 84 85
            }

            return call_user_func($method, $attribute, $this->params);
        } else {
            return null;
        }
    }
Zander Baldwin committed
86
}