\thinkValidate

数据验证类

Summary

Methods

Properties

Constants

__construct()
maker()
setLang()
setDb()
setRequest()
rule()
extend()
setTypeMsg()
message()
scene()
hasScene()
batch()
failException()
only()
remove()
append()
check()
checkRule()
confirm()
different()
egt()
gt()
elt()
lt()
eq()
must()
is()
token()
activeUrl()
ip()
fileExt()
fileMime()
fileSize()
image()
dateFormat()
unique()
filter()
requireIf()
requireCallback()
requireWith()
requireWithout()
in()
notIn()
between()
notBetween()
length()
max()
min()
after()
before()
afterWith()
beforeWith()
expire()
allowIp()
denyIp()
regex()
getError()
__call()

No public properties found

No constants found

checkItem()
getValidateType()
getImageType()
checkExt()
checkSize()
checkMime()
getDataValue()
getRuleMsg()
parseErrorMsg()
errorMsgIsArray()
getScene()

$type
$alias
$rule
$message
$field
$typeMsg
$currentScene
$defaultRegex
$filter
$scene
$error
$batch
$failException
$only
$remove
$append
$regex
$db
$lang
$request
$maker

N/A

No private methods found

No private properties found

N/A

File: vendor/topthink/framework/src/think/Validate.php
Package: think
Class hierarchy: \think\Validate
Uses

Properties

$type

$type : array

自定义验证类型

Type

array —

$alias

$alias : array

验证类型别名

Type

array —

$rule

$rule : array

当前验证规则

Type

array —

$message

$message : array

验证提示信息

Type

array —

$field

$field : array

验证字段描述

Type

array —

$typeMsg

$typeMsg : array

默认规则提示

Type

array —

$currentScene

$currentScene : string

当前验证场景

Type

string —

$defaultRegex

$defaultRegex : array

内置正则验证规则

Type

array —

$filter

$filter : array

Filter_var 规则

Type

array —

$scene

$scene : array

验证场景定义

Type

array —

$error

$error : string|array

验证失败错误信息

Type

string|array —

$batch

$batch : bool

是否批量验证

Type

bool —

$failException

$failException : bool

验证失败是否抛出异常

Type

bool —

$only

$only : array

场景需要验证的规则

Type

array —

$remove

$remove : array

场景需要移除的验证规则

Type

array —

$append

$append : array

场景需要追加的验证规则

Type

array —

$regex

$regex : array

验证正则定义

Type

array —

$db

$db : \think\Db

Db对象

Type

Db —

$lang

$lang : \think\Lang

语言对象

Type

Lang —

$request

$request : \think\Request

请求对象

Type

Request —

$maker

$maker : \Closure[]

Type

Closure[] —

Methods

__construct()

__construct() : mixed

构造方法

Returns

mixed —

maker()

maker(\Closure  $maker) : void

设置服务注入

Parameters

\Closure

$maker

setLang()

setLang(\think\Lang  $lang) : void

设置Lang对象

Parameters

\think\Lang

$lang

Lang对象

setDb()

setDb(\think\Db  $db) : void

设置Db对象

Parameters

\think\Db

$db

Db对象

setRequest()

setRequest(\think\Request  $request) : void

设置Request对象

Parameters

\think\Request

$request

Request对象

rule()

rule(string|array  $name, mixed  $rule = '') : $this

添加字段验证规则

Parameters

string\|array	$name	字段名称或者规则数组
mixed	$rule	验证规则或者字段描述信息

Returns

$this —

extend()

extend(string  $type, callable  $callback = null, string  $message = null) : $this

注册验证（类型）规则

Parameters

string	$type	验证规则类型
callable	$callback	callback方法(或闭包)
string	$message	验证失败提示信息

Returns

$this —

setTypeMsg()

setTypeMsg(string|array  $type, string  $msg = null) : void

设置验证规则的默认提示信息

Parameters

string\|array	$type	验证规则类型名称或者数组
string	$msg	验证提示信息

message()

message(array  $message) : \think\Validate

设置提示信息

Parameters

array

$message

错误信息

Returns

\think\Validate —

scene()

scene(string  $name) : $this

设置验证场景

Parameters

string

$name

场景名

Returns

$this —

hasScene()

hasScene(string  $name) : bool

判断是否存在某个验证场景

Parameters

string

$name

场景名

Returns

bool —

batch()

batch(bool  $batch = true) : $this

设置批量验证

Parameters

bool

$batch

是否批量验证

Returns

$this —

failException()

failException(bool  $fail = true) : $this

设置验证失败后是否抛出异常

Parameters

bool

$fail

是否抛出异常

Returns

$this —

only()

only(array  $fields) : $this

指定需要验证的字段列表

Parameters

array

$fields

字段名

Returns

$this —

remove()

remove(string|array  $field, mixed  $rule = null) : $this

移除某个字段的验证规则

Parameters

string\|array	$field	字段名
mixed	$rule	验证规则 true 移除所有规则

Returns

$this —

append()

append(string|array  $field, mixed  $rule = null) : $this

追加某个字段的验证规则

Parameters

string\|array	$field	字段名
mixed	$rule	验证规则

Returns

$this —

check()

check(array  $data, array  $rules = []) : bool

数据自动验证

Parameters

array	$data	数据
array	$rules	验证规则

Returns

bool —

checkRule()

checkRule(mixed  $value, mixed  $rules) : bool

根据验证规则验证数据

Parameters

mixed	$value	字段值
mixed	$rules	验证规则

Returns

bool —

confirm()

confirm(mixed  $value, mixed  $rule, array  $data = [], string  $field = '') : bool

验证是否和某个字段的值一致

Parameters

mixed	$value	字段值
mixed	$rule	验证规则
array	$data	数据
string	$field	字段名

Returns

bool —

different()

different(mixed  $value, mixed  $rule, array  $data = []) : bool

验证是否和某个字段的值是否不同

Parameters

mixed	$value	字段值
mixed	$rule	验证规则
array	$data	数据

Returns

bool —

egt()

egt(mixed  $value, mixed  $rule, array  $data = []) : bool

验证是否大于等于某个值

Parameters

mixed	$value	字段值
mixed	$rule	验证规则
array	$data	数据

Returns

bool —

gt()

gt(mixed  $value, mixed  $rule, array  $data = []) : bool

验证是否大于某个值

Parameters

mixed	$value	字段值
mixed	$rule	验证规则
array	$data	数据

Returns

bool —

elt()

elt(mixed  $value, mixed  $rule, array  $data = []) : bool

验证是否小于等于某个值

Parameters

mixed	$value	字段值
mixed	$rule	验证规则
array	$data	数据

Returns

bool —

lt()

lt(mixed  $value, mixed  $rule, array  $data = []) : bool

验证是否小于某个值

Parameters

mixed	$value	字段值
mixed	$rule	验证规则
array	$data	数据

Returns

bool —

eq()

eq(mixed  $value, mixed  $rule) : bool

验证是否等于某个值

Parameters

mixed	$value	字段值
mixed	$rule	验证规则

Returns

bool —

must()

must(mixed  $value, mixed  $rule = null) : bool

必须验证

Parameters

mixed	$value	字段值
mixed	$rule	验证规则

Returns

bool —

is()

is(mixed  $value, string  $rule, array  $data = []) : bool

验证字段值是否为有效格式

Parameters

mixed	$value	字段值
string	$rule	验证规则
array	$data	数据

Returns

bool —

token()

token(mixed  $value, mixed  $rule, array  $data) : bool

验证表单令牌

Parameters

mixed	$value	字段值
mixed	$rule	验证规则
array	$data	数据

Returns

bool —

activeUrl()

activeUrl(mixed  $value, mixed  $rule = 'MX') : bool

验证是否为合格的域名或者IP 支持A，MX，NS，SOA，PTR，CNAME，AAAA，A6， SRV，NAPTR，TXT 或者 ANY类型

Parameters

mixed	$value	字段值
mixed	$rule	验证规则

Returns

bool —

ip()

ip(mixed  $value, mixed  $rule = 'ipv4') : bool

验证是否有效IP

Parameters

mixed	$value	字段值
mixed	$rule	验证规则 ipv4 ipv6

Returns

bool —

fileExt()

fileExt(mixed  $file, mixed  $rule) : bool

验证上传文件后缀

Parameters

mixed	$file	上传文件
mixed	$rule	验证规则

Returns

bool —

fileMime()

fileMime(mixed  $file, mixed  $rule) : bool

验证上传文件类型

Parameters

mixed	$file	上传文件
mixed	$rule	验证规则

Returns

bool —

fileSize()

fileSize(mixed  $file, mixed  $rule) : bool

验证上传文件大小

Parameters

mixed	$file	上传文件
mixed	$rule	验证规则

Returns

bool —

image()

image(mixed  $file, mixed  $rule) : bool

验证图片的宽高及类型

Parameters

mixed	$file	上传文件
mixed	$rule	验证规则

Returns

bool —

dateFormat()

dateFormat(mixed  $value, mixed  $rule) : bool

验证时间和日期是否符合指定格式

Parameters

mixed	$value	字段值
mixed	$rule	验证规则

Returns

bool —

unique()

unique(mixed  $value, mixed  $rule, array  $data = [], string  $field = '') : bool

验证是否唯一

Parameters

mixed	$value	字段值
mixed	$rule	验证规则格式：数据表,字段名,排除ID,主键名
array	$data	数据
string	$field	验证字段名

Returns

bool —

filter()

filter(mixed  $value, mixed  $rule) : bool

使用filter_var方式验证

Parameters

mixed	$value	字段值
mixed	$rule	验证规则

Returns

bool —

requireIf()

requireIf(mixed  $value, mixed  $rule, array  $data = []) : bool

验证某个字段等于某个值的时候必须

Parameters

mixed	$value	字段值
mixed	$rule	验证规则
array	$data	数据

Returns

bool —

requireCallback()

requireCallback(mixed  $value, mixed  $rule, array  $data = []) : bool

通过回调方法验证某个字段是否必须

Parameters

mixed	$value	字段值
mixed	$rule	验证规则
array	$data	数据

Returns

bool —

requireWith()

requireWith(mixed  $value, mixed  $rule, array  $data = []) : bool

验证某个字段有值的情况下必须

Parameters

mixed	$value	字段值
mixed	$rule	验证规则
array	$data	数据

Returns

bool —

requireWithout()

requireWithout(mixed  $value, mixed  $rule, array  $data = []) : bool

验证某个字段没有值的情况下必须

Parameters

mixed	$value	字段值
mixed	$rule	验证规则
array	$data	数据

Returns

bool —

in()

in(mixed  $value, mixed  $rule) : bool

验证是否在范围内

Parameters

mixed	$value	字段值
mixed	$rule	验证规则

Returns

bool —

notIn()

notIn(mixed  $value, mixed  $rule) : bool

验证是否不在某个范围

Parameters

mixed	$value	字段值
mixed	$rule	验证规则

Returns

bool —

between()

between(mixed  $value, mixed  $rule) : bool

between验证数据

Parameters

mixed	$value	字段值
mixed	$rule	验证规则

Returns

bool —

notBetween()

notBetween(mixed  $value, mixed  $rule) : bool

使用notbetween验证数据

Parameters

mixed	$value	字段值
mixed	$rule	验证规则

Returns

bool —

length()

length(mixed  $value, mixed  $rule) : bool

验证数据长度

Parameters

mixed	$value	字段值
mixed	$rule	验证规则

Returns

bool —

max()

max(mixed  $value, mixed  $rule) : bool

验证数据最大长度

Parameters

mixed	$value	字段值
mixed	$rule	验证规则

Returns

bool —

min()

min(mixed  $value, mixed  $rule) : bool

验证数据最小长度

Parameters

mixed	$value	字段值
mixed	$rule	验证规则

Returns

bool —

after()

after(mixed  $value, mixed  $rule, array  $data = []) : bool

验证日期

Parameters

mixed	$value	字段值
mixed	$rule	验证规则
array	$data	数据

Returns

bool —

before()

before(mixed  $value, mixed  $rule, array  $data = []) : bool

验证日期

Parameters

mixed	$value	字段值
mixed	$rule	验证规则
array	$data	数据

Returns

bool —

afterWith()

afterWith(mixed  $value, mixed  $rule, array  $data = []) : bool

验证日期

Parameters

mixed	$value	字段值
mixed	$rule	验证规则
array	$data	数据

Returns

bool —

beforeWith()

beforeWith(mixed  $value, mixed  $rule, array  $data = []) : bool

验证日期

Parameters

mixed	$value	字段值
mixed	$rule	验证规则
array	$data	数据

Returns

bool —

expire()

expire(mixed  $value, mixed  $rule) : bool

验证有效期

Parameters

mixed	$value	字段值
mixed	$rule	验证规则

Returns

bool —

allowIp()

allowIp(mixed  $value, mixed  $rule) : bool

验证IP许可

Parameters

mixed	$value	字段值
mixed	$rule	验证规则

Returns

bool —

denyIp()

denyIp(mixed  $value, mixed  $rule) : bool

验证IP禁用

Parameters

mixed	$value	字段值
mixed	$rule	验证规则

Returns

bool —

regex()

regex(mixed  $value, mixed  $rule) : bool

使用正则验证数据

Parameters

mixed	$value	字段值
mixed	$rule	验证规则正则规则或者预定义正则名

Returns

bool —

getError()

getError() : array|string

获取错误信息

Returns

array|string —

__call()

__call(string  $method, array  $args) : bool

动态方法直接调用is方法进行验证

Parameters

string	$method	方法名
array	$args	调用参数

Returns

bool —

checkItem()

checkItem(string  $field, mixed  $value, mixed  $rules, array  $data, string  $title = '', array  $msg = []) : mixed

验证单个字段规则

Parameters

string	$field	字段名
mixed	$value	字段值
mixed	$rules	验证规则
array	$data	数据
string	$title	字段描述
array	$msg	提示信息

Returns

mixed —

getValidateType()

getValidateType(mixed  $key, mixed  $rule) : array

获取当前验证类型及规则

Parameters

mixed	$key
mixed	$rule

Returns

array —

getImageType()

getImageType(mixed  $image) : mixed

Parameters

mixed

$image

Returns

mixed —

checkExt()

checkExt(\think\File  $file, array|string  $ext) : bool

检测上传文件后缀

Parameters

\think\File	$file
array\|string	$ext	允许后缀

Returns

bool —

checkSize()

checkSize(\think\File  $file, int  $size) : bool

检测上传文件大小

Parameters

\think\File	$file
int	$size	最大大小

Returns

bool —

checkMime()

checkMime(\think\File  $file, array|string  $mime) : bool

检测上传文件类型

Parameters

\think\File	$file
array\|string	$mime	允许类型

Returns

bool —

getDataValue()

getDataValue(array  $data, string  $key) : mixed

获取数据值

Parameters

array	$data	数据
string	$key	数据标识支持二维

Returns

mixed —

getRuleMsg()

getRuleMsg(string  $attribute, string  $title, string  $type, mixed  $rule) : string|array

获取验证规则的错误提示信息

Parameters

string	$attribute	字段英文名
string	$title	字段描述名
string	$type	验证规则名称
mixed	$rule	验证规则数据

Returns

string|array —

parseErrorMsg()

parseErrorMsg(string  $msg, mixed  $rule, string  $title) : string

获取验证规则的错误提示信息

Parameters

string	$msg	错误信息
mixed	$rule	验证规则数据
string	$title	字段描述名

Returns

string —

errorMsgIsArray()

errorMsgIsArray(array  $msg, mixed  $rule, string  $title) : array

错误信息数组处理

Parameters

array	$msg	错误信息
mixed	$rule	验证规则数据
string	$title	字段描述名

Returns

array —

getScene()

getScene(string  $scene) : void

获取数据验证的场景

Parameters

string

$scene

验证场景