PHP Class think\Validate

Show file Open project: top-think/framework Class Usage Examples

Protected Properties

Property Type Description
$alias 验证类型别名
$batch 批量验证
$currentScene 当前验证场景
$error 验证失败错误信息
$instance 实例
$message 验证提示信息
$regex ..]
$rule 当前验证的规则
$scene ..']
$type 自定义的验证类型
$typeMsg 验证规则默认提示信息

Public Methods

Method Description
__callStatic ( $method, $params )
__construct ( array $rules = [], array $message = [] ) 架构函数
batch ( boolean $batch = true ) : Validate 设置批量验证
check ( array $data, mixed $rules = [], string $scene = '' ) : boolean 数据自动验证
extend ( string $type, mixed $callback = null ) : void 注册验证(类型)规则
getError ( ) 获取错误信息
make ( array $rules = [], array $message = [] ) : Validate 实例化验证
message ( string | array $name, string $message = '' ) : Validate 设置提示信息
rule ( string | array $name, mixed $rule = '' ) : Validate 添加字段验证规则
scene ( string | array $name, mixed $fields = null ) : Validate 设置验证场景
setTypeMsg ( string | array $type, string $msg = null ) : void 获取验证规则的默认提示信息

Protected Methods

Method Description
activeUrl ( mixed $value, mixed $rule ) : boolean 验证是否为合格的域名或者IP 支持A,MX,NS,SOA,PTR,CNAME,AAAA,A6, SRV,NAPTR,TXT 或者 ANY类型
after ( mixed $value, mixed $rule ) : boolean 验证日期
allowIp ( string $value, mixed $rule ) : mixed 验证IP许可
before ( mixed $value, mixed $rule ) : boolean 验证日期
behavior ( mixed $value, mixed $rule, array $data ) : mixed 使用行为类验证
between ( mixed $value, mixed $rule ) : boolean between验证数据
checkItem ( string $field, mixed $value, mixed $rules, array $data, string $title = '', array $msg = [] ) : mixed 验证单个字段规则
confirm ( mixed $value, mixed $rule, array $data ) : boolean 验证是否和某个字段的值一致
dateFormat ( mixed $value, mixed $rule ) : boolean 验证时间和日期是否符合指定格式
denyIp ( string $value, mixed $rule ) : mixed 验证IP禁用
different ( mixed $value, mixed $rule, array $data ) : boolean 验证是否和某个字段的值是否不同
egt ( mixed $value, mixed $rule ) : boolean 验证是否大于等于某个值
elt ( mixed $value, mixed $rule ) : boolean 验证是否小于等于某个值
eq ( mixed $value, mixed $rule ) : boolean 验证是否等于某个值
expire ( mixed $value, mixed $rule ) : boolean 验证有效期
fileExt ( mixed $file, mixed $rule ) : boolean 验证上传文件后缀
fileMime ( mixed $file, mixed $rule ) : boolean 验证上传文件类型
fileSize ( mixed $file, mixed $rule ) : boolean 验证上传文件大小
filter ( mixed $value, mixed $rule ) : boolean 使用filter_var方式验证
getDataValue ( array $data, string $key ) : mixed 获取数据值
getImageType ( $image ) 判断图像类型
getRuleMsg ( string $attribute, string $title, string $type, mixed $rule ) : string 获取验证规则的错误提示信息
getScene ( string $scene = '' ) : array 获取数据验证的场景
gt ( mixed $value, mixed $rule ) : boolean 验证是否大于某个值
image ( mixed $file, mixed $rule ) : boolean 验证图片的宽高及类型
in ( mixed $value, mixed $rule ) : boolean 验证是否在范围内
ip ( mixed $value, mixed $rule ) : boolean 验证是否有效IP
is ( mixed $value, string $rule, array $data = [] ) : boolean 验证字段值是否为有效格式
length ( mixed $value, mixed $rule ) : boolean 验证数据长度
lt ( mixed $value, mixed $rule ) : boolean 验证是否小于某个值
max ( mixed $value, mixed $rule ) : boolean 验证数据最大长度
method ( mixed $value, mixed $rule ) : boolean 验证请求类型
min ( mixed $value, mixed $rule ) : boolean 验证数据最小长度
notBetween ( mixed $value, mixed $rule ) : boolean 使用notbetween验证数据
notIn ( mixed $value, mixed $rule ) : boolean 验证是否不在某个范围
regex ( mixed $value, mixed $rule ) : mixed 使用正则验证数据
requireCallback ( mixed $value, mixed $rule, array $data ) : boolean 通过回调方法验证某个字段是否必须
requireIf ( mixed $value, mixed $rule, array $data ) : boolean 验证某个字段等于某个值的时候必须
requireWith ( mixed $value, mixed $rule, array $data ) : boolean 验证某个字段有值的情况下必须
token ( mixed $value, mixed $rule, array $data ) : boolean 验证表单令牌
unique ( mixed $value, mixed $rule, array $data, string $field ) : boolean 验证是否唯一

Method Details

__callStatic() public static method

public static __callStatic ( $method, $params )

__construct() public method

架构函数
public __construct ( array $rules = [], array $message = [] )
$rules array 验证规则
$message array 验证提示信息

activeUrl() protected method

验证是否为合格的域名或者IP 支持A,MX,NS,SOA,PTR,CNAME,AAAA,A6, SRV,NAPTR,TXT 或者 ANY类型
protected activeUrl ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则
return boolean

after() protected method

验证日期
protected after ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则
return boolean

allowIp() protected method

验证IP许可
protected allowIp ( string $value, mixed $rule ) : mixed
$value string 字段值
$rule mixed 验证规则
return mixed

batch() public method

设置批量验证
public batch ( boolean $batch = true ) : Validate
$batch boolean 是否批量验证
return Validate

before() protected method

验证日期
protected before ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则
return boolean

behavior() protected method

使用行为类验证
protected behavior ( mixed $value, mixed $rule, array $data ) : mixed
$value mixed 字段值
$rule mixed 验证规则
$data array 数据
return mixed

between() protected method

between验证数据
protected between ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则
return boolean

check() public method

数据自动验证
public check ( array $data, mixed $rules = [], string $scene = '' ) : boolean
$data array 数据
$rules mixed 验证规则
$scene string 验证场景
return boolean

checkItem() protected method

验证单个字段规则
protected checkItem ( string $field, mixed $value, mixed $rules, array $data, string $title = '', array $msg = [] ) : mixed
$field string 字段名
$value mixed 字段值
$rules mixed 验证规则
$data array 数据
$title string 字段描述
$msg array 提示信息
return mixed

confirm() protected method

验证是否和某个字段的值一致
protected confirm ( mixed $value, mixed $rule, array $data ) : boolean
$value mixed 字段值
$rule mixed 验证规则
$data array 数据
return boolean

dateFormat() protected method

验证时间和日期是否符合指定格式
protected dateFormat ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则
return boolean

denyIp() protected method

验证IP禁用
protected denyIp ( string $value, mixed $rule ) : mixed
$value string 字段值
$rule mixed 验证规则
return mixed

different() protected method

验证是否和某个字段的值是否不同
protected different ( mixed $value, mixed $rule, array $data ) : boolean
$value mixed 字段值
$rule mixed 验证规则
$data array 数据
return boolean

egt() protected method

验证是否大于等于某个值
protected egt ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则
return boolean

elt() protected method

验证是否小于等于某个值
protected elt ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则
return boolean

eq() protected method

验证是否等于某个值
protected eq ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则
return boolean

expire() protected method

验证有效期
protected expire ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则
return boolean

extend() public static method

注册验证(类型)规则
public static extend ( string $type, mixed $callback = null ) : void
$type string 验证规则类型
$callback mixed callback方法(或闭包)
return void

fileExt() protected method

验证上传文件后缀
protected fileExt ( mixed $file, mixed $rule ) : boolean
$file mixed 上传文件
$rule mixed 验证规则
return boolean

fileMime() protected method

验证上传文件类型
protected fileMime ( mixed $file, mixed $rule ) : boolean
$file mixed 上传文件
$rule mixed 验证规则
return boolean

fileSize() protected method

验证上传文件大小
protected fileSize ( mixed $file, mixed $rule ) : boolean
$file mixed 上传文件
$rule mixed 验证规则
return boolean

filter() protected method

使用filter_var方式验证
protected filter ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则
return boolean

getDataValue() protected method

获取数据值
protected getDataValue ( array $data, string $key ) : mixed
$data array 数据
$key string 数据标识 支持二维
return mixed

getError() public method

获取错误信息
public getError ( )

getImageType() protected method

判断图像类型
protected getImageType ( $image )

getRuleMsg() protected method

获取验证规则的错误提示信息
protected getRuleMsg ( string $attribute, string $title, string $type, mixed $rule ) : string
$attribute string 字段英文名
$title string 字段描述名
$type string 验证规则名称
$rule mixed 验证规则数据
return string

getScene() protected method

获取数据验证的场景
protected getScene ( string $scene = '' ) : array
$scene string 验证场景
return array

gt() protected method

验证是否大于某个值
protected gt ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则
return boolean

image() protected method

验证图片的宽高及类型
protected image ( mixed $file, mixed $rule ) : boolean
$file mixed 上传文件
$rule mixed 验证规则
return boolean

in() protected method

验证是否在范围内
protected in ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则
return boolean

ip() protected method

验证是否有效IP
protected ip ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则 ipv4 ipv6
return boolean

is() protected method

验证字段值是否为有效格式
protected is ( mixed $value, string $rule, array $data = [] ) : boolean
$value mixed 字段值
$rule string 验证规则
$data array 验证数据
return boolean

length() protected method

验证数据长度
protected length ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则
return boolean

lt() protected method

验证是否小于某个值
protected lt ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则
return boolean

make() public static method

实例化验证
public static make ( array $rules = [], array $message = [] ) : Validate
$rules array 验证规则
$message array 验证提示信息
return Validate

max() protected method

验证数据最大长度
protected max ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则
return boolean

message() public method

设置提示信息
public message ( string | array $name, string $message = '' ) : Validate
$name string | array 字段名称
$message string 提示信息
return Validate

method() protected method

验证请求类型
protected method ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则
return boolean

min() protected method

验证数据最小长度
protected min ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则
return boolean

notBetween() protected method

使用notbetween验证数据
protected notBetween ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则
return boolean

notIn() protected method

验证是否不在某个范围
protected notIn ( mixed $value, mixed $rule ) : boolean
$value mixed 字段值
$rule mixed 验证规则
return boolean

regex() protected method

使用正则验证数据
protected regex ( mixed $value, mixed $rule ) : mixed
$value mixed 字段值
$rule mixed 验证规则 正则规则或者预定义正则名
return mixed

requireCallback() protected method

通过回调方法验证某个字段是否必须
protected requireCallback ( mixed $value, mixed $rule, array $data ) : boolean
$value mixed 字段值
$rule mixed 验证规则
$data array 数据
return boolean

requireIf() protected method

验证某个字段等于某个值的时候必须
protected requireIf ( mixed $value, mixed $rule, array $data ) : boolean
$value mixed 字段值
$rule mixed 验证规则
$data array 数据
return boolean

requireWith() protected method

验证某个字段有值的情况下必须
protected requireWith ( mixed $value, mixed $rule, array $data ) : boolean
$value mixed 字段值
$rule mixed 验证规则
$data array 数据
return boolean

rule() public method

添加字段验证规则
public rule ( string | array $name, mixed $rule = '' ) : Validate
$name string | array 字段名称或者规则数组
$rule mixed 验证规则
return Validate

scene() public method

设置验证场景
public scene ( string | array $name, mixed $fields = null ) : Validate
$name string | array 场景名或者场景设置数组
$fields mixed 要验证的字段
return Validate

setTypeMsg() public static method

获取验证规则的默认提示信息
public static setTypeMsg ( string | array $type, string $msg = null ) : void
$type string | array 验证规则类型名称或者数组
$msg string 验证提示信息
return void

token() protected method

验证表单令牌
protected token ( mixed $value, mixed $rule, array $data ) : boolean
$value mixed 字段值
$rule mixed 验证规则
$data array 数据
return boolean

unique() protected method

验证是否唯一
protected unique ( mixed $value, mixed $rule, array $data, string $field ) : boolean
$value mixed 字段值
$rule mixed 验证规则 格式:数据表,字段名,排除ID,主键名
$data array 数据
$field string 验证字段名
return boolean

Property Details

$alias protected property

验证类型别名
protected $alias

$batch protected property

批量验证
protected $batch

$currentScene protected property

当前验证场景
protected $currentScene

$error protected property

验证失败错误信息
protected $error

$instance protected static property

实例
protected static $instance

$message protected property

验证提示信息
protected $message

$regex protected property

..]
protected $regex

$rule protected property

当前验证的规则
protected $rule

$scene protected property

..']
protected $scene

$type protected static property

自定义的验证类型
protected static $type

$typeMsg protected static property

验证规则默认提示信息
protected static $typeMsg