mirror-fastadminnet/framework
1
0
Fork 0
mirror of https://gitee.com/fastadminnet/framework.git synced 2026-07-05 22:52:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

注释规范

Browse Source
This commit is contained in:
thinkphp
2016-06-20 17:34:54 +08:00
parent 940ed22965
commit a032828d5c
48 changed files with 724 additions and 760 deletions
Download Patch File Download Diff File Expand all files Collapse all files

206
library/think/Validate.php
View File

@@ -108,8 +108,8 @@ class Validate
/**
* 实例化验证
* @access public
* @param array $rules 验证规则
* @param array $message 验证提示信息
* @param array $rules 验证规则
* @param array $message 验证提示信息
* @return Validate
*/
public static function make($rules = [], $message = [])
@@ -123,8 +123,8 @@ class Validate
/**
* 添加字段验证规则
* @access protected
* @param string|array $name 字段名称或者规则数组
* @param mixed $rule 验证规则
* @param string|array $name 字段名称或者规则数组
* @param mixed $rule 验证规则
* @return Validate
*/
public function rule($name, $rule = '')
@@ -140,8 +140,8 @@ class Validate
/**
* 注册验证（类型）规则
* @access public
* @param string $type 验证规则类型
* @param mixed $callback callback方法(或闭包)
* @param string $type 验证规则类型
* @param mixed $callback callback方法(或闭包)
* @return void
*/
public static function extend($type, $callback = null)
@@ -156,8 +156,8 @@ class Validate
/**
* 获取验证规则的默认提示信息
* @access protected
* @param string|array $type 验证规则类型名称或者数组
* @param string $msg 验证提示信息
* @param string|array $type 验证规则类型名称或者数组
* @param string $msg 验证提示信息
* @return void
*/
public static function setTypeMsg($type, $msg = null)
@@ -172,8 +172,8 @@ class Validate
/**
* 设置提示信息
* @access public
* @param string|array $name 字段名称
* @param string $message 提示信息
* @param string|array $name 字段名称
* @param string $message 提示信息
* @return Validate
*/
public function message($name, $message = '')
@@ -189,8 +189,8 @@ class Validate
/**
* 设置验证场景
* @access public
* @param string|array $name 场景名或者场景设置数组
* @param mixed $fields 要验证的字段
* @param string|array $name 场景名或者场景设置数组
* @param mixed $fields 要验证的字段
* @return Validate
*/
public function scene($name, $fields = null)
@@ -222,9 +222,9 @@ class Validate
/**
* 数据自动验证
* @access public
* @param array $data 数据
* @param mixed $rules 验证规则
* @param string $scene 验证场景
* @param array $data 数据
* @param mixed $rules 验证规则
* @param string $scene 验证场景
* @return bool
*/
public function check($data, $rules = [], $scene = '')
@@ -315,12 +315,12 @@ class Validate
/**
* 验证单个字段规则
* @access protected
* @param string $field 字段名
* @param mixed $value 字段值
* @param mixed $rules 验证规则
* @param array $data 数据
* @param string $title 字段描述
* @param array $msg 提示信息
* @param string $field 字段名
* @param mixed $value 字段值
* @param mixed $rules 验证规则
* @param array $data 数据
* @param string $title 字段描述
* @param array $msg 提示信息
* @return mixed
*/
protected function checkItem($field, $value, $rules, $data, $title = '', $msg = [])
@@ -385,9 +385,9 @@ class Validate
/**
* 验证表单令牌（需要配置令牌生成行为）
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param array $data 数据
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param array $data 数据
* @return bool
*/
protected function token($value, $rule, $data)
@@ -412,9 +412,9 @@ class Validate
/**
* 验证是否和某个字段的值一致
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param array $data 数据
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param array $data 数据
* @return bool
*/
protected function confirm($value, $rule, $data)
@@ -425,8 +425,8 @@ class Validate
/**
* 验证是否大于等于某个值
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function egt($value, $rule)
@@ -437,8 +437,8 @@ class Validate
/**
* 验证是否大于某个值
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function gt($value, $rule)
@@ -449,8 +449,8 @@ class Validate
/**
* 验证是否小于等于某个值
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function elt($value, $rule)
@@ -461,8 +461,8 @@ class Validate
/**
* 验证是否小于某个值
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function lt($value, $rule)
@@ -473,8 +473,8 @@ class Validate
/**
* 验证是否等于某个值
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function eq($value, $rule)
@@ -485,8 +485,8 @@ class Validate
/**
* 验证字段值是否为有效格式
* @access protected
* @param mixed $value 字段值
* @param string $rule 验证规则
* @param mixed $value 字段值
* @param string $rule 验证规则
* @return bool
*/
protected function is($value, $rule)
@@ -568,8 +568,8 @@ class Validate
/**
* 验证是否为合格的域名或者IP 支持A，MX，NS，SOA，PTR，CNAME，AAAA，A6， SRV，NAPTR，TXT 或者 ANY类型
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function activeUrl($value, $rule)
@@ -580,8 +580,8 @@ class Validate
/**
* 验证是否有效IP
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则 ipv4 ipv6
* @param mixed $value 字段值
* @param mixed $rule 验证规则 ipv4 ipv6
* @return bool
*/
protected function ip($value, $rule)
@@ -595,8 +595,8 @@ class Validate
/**
* 验证上传文件后缀
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function fileExt($value, $rule)
@@ -623,8 +623,8 @@ class Validate
/**
* 验证上传文件类型
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function fileMime($value, $rule)
@@ -651,8 +651,8 @@ class Validate
/**
* 验证上传文件大小
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function fileSize($value, $rule)
@@ -679,8 +679,8 @@ class Validate
/**
* 验证请求类型
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function method($value, $rule)
@@ -692,8 +692,8 @@ class Validate
/**
* 验证时间和日期是否符合指定格式
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function dateFormat($value, $rule)
@@ -705,10 +705,10 @@ class Validate
/**
* 验证是否唯一
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则 格式：数据表,字段名,排除ID,主键名
* @param array $data 数据
* @param string $field 验证字段名
* @param mixed $value 字段值
* @param mixed $rule 验证规则 格式：数据表,字段名,排除ID,主键名
* @param array $data 数据
* @param string $field 验证字段名
* @return bool
*/
protected function unique($value, $rule, $data, $field)
@@ -747,9 +747,9 @@ class Validate
/**
* 使用行为类验证
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param array $data 数据
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param array $data 数据
* @return mixed
*/
protected function behavior($value, $rule, $data)
@@ -760,8 +760,8 @@ class Validate
/**
* 使用filter_var方式验证
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function filter($value, $rule)
@@ -779,9 +779,9 @@ class Validate
/**
* 验证某个字段等于某个值的时候必须
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param array $data 数据
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param array $data 数据
* @return bool
*/
protected function requireIf($value, $rule, $data)
@@ -797,9 +797,9 @@ class Validate
/**
* 通过回调方法验证某个字段是否必须
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param array $data 数据
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param array $data 数据
* @return bool
*/
protected function requireCallback($value, $rule, $data)
@@ -815,9 +815,9 @@ class Validate
/**
* 验证某个字段有值的情况下必须
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param array $data 数据
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param array $data 数据
* @return bool
*/
protected function requireWith($value, $rule, $data)
@@ -833,8 +833,8 @@ class Validate
/**
* 验证是否在范围内
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function in($value, $rule)
@@ -845,8 +845,8 @@ class Validate
/**
* 验证是否不在某个范围
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function notIn($value, $rule)
@@ -857,8 +857,8 @@ class Validate
/**
* between验证数据
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function between($value, $rule)
@@ -873,8 +873,8 @@ class Validate
/**
* 使用notbetween验证数据
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function notBetween($value, $rule)
@@ -889,8 +889,8 @@ class Validate
/**
* 验证数据长度
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function length($value, $rule)
@@ -909,8 +909,8 @@ class Validate
/**
* 验证数据最大长度
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function max($value, $rule)
@@ -922,8 +922,8 @@ class Validate
/**
* 验证数据最小长度
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function min($value, $rule)
@@ -935,8 +935,8 @@ class Validate
/**
* 验证日期
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function after($value, $rule)
@@ -947,8 +947,8 @@ class Validate
/**
* 验证日期
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function before($value, $rule)
@@ -959,8 +959,8 @@ class Validate
/**
* 验证有效期
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @param mixed $value 字段值
* @param mixed $rule 验证规则
* @return bool
*/
protected function expire($value, $rule)
@@ -982,8 +982,8 @@ class Validate
/**
* 验证IP许可
* @access protected
* @param string $value 字段值
* @param mixed $rule 验证规则
* @param string $value 字段值
* @param mixed $rule 验证规则
* @return mixed
*/
protected function allowIp($value, $rule)
@@ -994,8 +994,8 @@ class Validate
/**
* 验证IP禁用
* @access protected
* @param string $value 字段值
* @param mixed $rule 验证规则
* @param string $value 字段值
* @param mixed $rule 验证规则
* @return mixed
*/
protected function denyIp($value, $rule)
@@ -1006,8 +1006,8 @@ class Validate
/**
* 使用正则验证数据
* @access protected
* @param mixed $value 字段值
* @param mixed $rule 验证规则 正则规则或者预定义正则名
* @param mixed $value 字段值
* @param mixed $rule 验证规则 正则规则或者预定义正则名
* @return mixed
*/
protected function regex($value, $rule)
@@ -1031,8 +1031,8 @@ class Validate
/**
* 获取数据值
* @access protected
* @param array $data 数据
* @param string $key 数据标识 支持二维
* @param array $data 数据
* @param string $key 数据标识 支持二维
* @return mixed
*/
protected function getDataValue($data, $key)
@@ -1050,10 +1050,10 @@ class Validate
/**
* 获取验证规则的错误提示信息
* @access protected
* @param string $attribute 字段英文名
* @param string $title 字段描述名
* @param string $type 验证规则名称
* @param mixed $rule 验证规则数据
* @param string $attribute 字段英文名
* @param string $title 字段描述名
* @param string $type 验证规则名称
* @param mixed $rule 验证规则数据
* @return string
*/
protected function getRuleMsg($attribute, $title, $type, $rule)