ginkgo\Validate

验证

类摘要

namespace ginkgo;

class Validate {
    // 属性
    public $config    = array();
    public $delimiter = ' - ';

    protected static $instance;
    protected $obj_lang;
    protected $obj_rule;
    protected $rule         = array();
    protected $data         = array();
    protected $attrName     = array();
    protected $scene        = array();
    protected $only         = array();
    protected $remove       = array();
    protected $append       = array();
    protected $currentScene = null;

    protected $typeMsg = array(
        'require'           => '{:attr} require',
        'confirm'           => '{:attr} out of accord with {:confirm}',
        'different'         => '{:attr} cannot be same with {:different}',
        'accepted'          => '{:attr} must be yes, on or 1',
        'in'                => '{:attr} must be in {:rule}',
        'not_in'            => '{:attr} be notin {:rule}',
        'between'           => '{:attr} must between {:rule}',
        'not_between'       => '{:attr} cannot between {:rule}',
        'length'            => 'Size of {:attr} must be {:rule}',
        'min'               => 'Min size of {:attr} must be {:rule}',
        'max'               => 'Max size of {:attr} must be {:rule}',
        'after'             => '{:attr} cannot be less than {:rule}',
        'before'            => '{:attr} cannot exceed {:rule}',
        'expire'            => '{:attr} not within {:rule}',
        'egt'               => '{:attr} must greater than or equal {:rule}',
        'gt'                => '{:attr} must greater than {:rule}',
        'elt'               => '{:attr} must less than or equal {:rule}',
        'lt'                => '{:attr} must less than {:rule}',
        'eq'                => '{:attr} must equal {:rule}',
        'neq'               => '{:attr} cannot be same with {:rule}',
        'filter'            => '{:attr} not conform to the rules',
        'regex'             => '{:attr} not conform to the rules',
        'format'            => '{:attr} not conform format of {:rule}',
        'date_format'       => '{:attr} must be date format of {:rule}',
        'time_format'       => '{:attr} must be time format of {:rule}',
        'date_time_format'  => '{:attr} must be datetime format of {:rule}',
        'token'             => 'Form token is incorrect',
        'captcha'           => 'Captcha is incorrect',
    );

    protected $formatMsg = array(
        'number'            => '{:attr} must be numeric',
        'int'               => '{:attr} must be integer',
        'float'             => '{:attr} must be float',
        'bool'              => '{:attr} must be bool',
        'email'             => '{:attr} not a valid email address',
        'array'             => '{:attr} must be a array',
        'date'              => '{:attr} not a valid date',
        'time'              => '{:attr} not a valid time',
        'date_time'         => '{:attr} not a valid datetime',
        'alpha'             => '{:attr} must be alpha',
        'alpha_number'      => '{:attr} must be alpha-numeric',
        'alpha_dash'        => '{:attr} must be alpha-numeric, dash, underscore',
        'chs'               => '{:attr} must be chinese',
        'chs_alpha'         => '{:attr} must be chinese or alpha',
        'chs_alpha_number'  => '{:attr} must be chinese, alpha-numeric',
        'chs_dash'          => '{:attr} must be chinese, alpha-numeric, underscore, dash',
        'url'               => '{:attr} not a valid url',
        'ip'                => '{:attr} not a valid ip',
    );

    private $configThis     = array(
        'rule_class' => 'ginkgo',
    );

    private $message        = array();

    private $alias = array(
        '>'         => 'gt',
        '>='        => 'egt',
        '<'         => 'lt',
        '<='        => 'elt',
        '='         => 'eq',
        'same'      => 'eq',
        '!='        => 'neq',
        '<>'        => 'neq',
    );

    // 方法
    public static instance( [ array $config ] ) : object
    public v_init( [ array $param ] )
    public config( array $config )
    public rule( mixed $rule [, string $value ] )
    public setScene( mixed $scene [, array $value ] )
    public setTypeMsg( mixed $msg [, string $value ] )
    public setFormatMsg( mixed $msg [, string $value ] )
    public setAttrName( mixed $attr [, string $value ] )
    public verify( array $data ) : bool
    public scene( string $scene )
    public only( mixed $field )
    public remove( mixed $field )
    public append( mixed $field [, string $rule ] )
    public is( mixed $value, string $rule ) : bool
    public getMessage() : array
    public __callStatic( string $method, string $params ) : mixed

    protected __construct( [ array $config ] ) : object
    protected __clone()

    private token( string $value [, string $rule = '__token__'] ) : bool
    private captcha( string $value [, string $id ] ) : bool
    private check( mixed $value, string $rule [, mixed $key ] ) : int
    private checkItem( mixed $value, string $rule [, mixed $key ] ) : bool
    private parseRule( mixed $value, string $rule [, mixed $key ] ) : array
    private getRule() : array
    private getRuleDate( string $rule ) : string
}

成员目录

$config 配置，$configThis 默认配置

public $config;
private $configThis;

结构

instance() 实例化方法

public static function instance( [ array $config ] ) : object

参数

• config 配置参数

返回

• 本类的实例

v_init() 验证器初始化

public function v_init( [ array $param ] )

参数

• param 参数

返回

• 无

config() 配置

public function config( array $config )

参数

• config 配置参数

返回

• 无

rule() 设置规则

public function rule( mixed $rule [, string $value ] )

参数

• rule 规则

  为字符串时表示属性，为数组时表示批量设置

• value 规则值

  当 rule 为字符串时为必须，当 rule 为数组时自动忽略

返回

• 无

setScene() 设置场景

public function setScene( mixed $scene [, array $value ] )

参数

• scene 规则

  为字符串时表示场景名，为数组时表示批量设置

• value 该场景要验证的属性

  当 scene 为字符串时为必须，当 scene 为数组时自动忽略

返回

• 无

setTypeMsg() 设置验证类型消息

public function setTypeMsg( mixed $msg [, string $value ] )

参数

• msg 消息

  为字符串时表示验证类型名，为数组时表示批量设置

• value 消息内容

  当 msg 为字符串时为必须，当 msg 为数组时自动忽略

返回

• 无

setFormatMsg() 设置验证格式消息

public function setFormatMsg( mixed $msg [, string $value ] )

参数

• msg 消息

  为字符串时表示验证格式名，为数组时表示批量设置

• value 消息内容

  当 msg 为字符串时为必须，当 msg 为数组时自动忽略

返回

• 无

setAttrName() 设置验证属性名称

public function setAttrName( mixed $attr [, string $value ] )

参数

• attr 属性

  为字符串时表示验证属性名，为数组时表示批量设置

• value 消息内容

  当 attr 为字符串时为必须，当 attr 为数组时自动忽略

返回

• 无

verify() 验证

public function verify( array $data ) : bool

参数

• data 待验证数据

返回

• 布尔值

scene() 设置当前场景

public function scene( string $scene )

参数

• scene 当前场景

返回

• 无

only() 设置仅验证字段

public function only( mixed $field )

参数

• field 字段，为数组时表示批量设置

返回

• 无

remove() 设置移除规则

public function remove( mixed $field )

参数

• field 字段，为数组时表示批量设置

返回

• 无

append() 设置追加规则

public function append( mixed $field )

参数

• field 字段，为数组时表示批量设置

返回

• 无

is() 直接验证格式

public function is( mixed $value, string $rule ) : bool

参数

• value 值
• rule 规则

返回

• 验证结果

getMessage() 获取验证消息

public function getMessage() : array

参数

• 无

返回

• 验证结果消息

__callStatic() 魔术静态调用，用于直接验证

public function __callStatic( string $method, string $params ) : mixed

参数

• method 方法
• params 参数

返回

• 验证结果

token() 验证表单令牌

private function token( string $value [, string $rule = '__token__'] ) : bool

参数

• value 值
• rule 规则

返回

• 验证结果

captcha() 验证码

private function captcha( string $value [, string $id ] ) : bool

参数

• value 值
• id 验证码 ID

返回

• 验证结果

check() 验证

private function check( mixed $value, string $rule [, mixed $key ] ) : int

参数

• value 值
• rule 规则
• key 键名

返回

• 错误数

checkItem() 逐个验证

private function checkItem( mixed $value, string $rule [, mixed $key ] ) : bool

参数

• value 值
• rule 规则
• key 键名

返回

• 验证结果

parseRule() 解析规则

private function parseRule( mixed $value, string $rule [, mixed $key ] ) : array

参数

• value 值
• rule 规则
• key 键名

返回

• 规则

getRule() 获取规则

private function getRule() : array

参数

• 无

返回

• 规则

getRuleDate() 获取日期规则

private function getRuleDate( string $rule ) : string

参数

• rule 规则类型

返回

• 日期规则