Validate

验证器类: EasySwoole\Validate\Validate

例子

  2. <?php
  3. /**
  4.  * Created by PhpStorm.
  5.  * User: root
  6.  * Date: 18-10-11
  7.  * Time: 上午10:26
  8.  */
  10. require_once 'vendor/autoload.php';
  12. $data = [
  13.     'name' => 'blank',
  14.     'age'  => 25
  15. ];
  17. $valitor = new \EasySwoole\Validate\Validate();
  18. $valitor->addColumn('name', '名字不为空')->required('名字不为空')->lengthMin(10,'最小长度不小于10位');
  19. $bool = $valitor->validate($data);
  20. var_dump($valitor->getError()->getErrorRuleMsg()?:$valitor->getError()->getColumnErrorMsg());
  22. /* 结果：
  23.  string(26) "最小长度不小于10位"
  24. */

如何在控制器使用验证例子(demo)

  1. <?php
  2. /**
  3.  * Created by PhpStorm.
  4.  * User: root
  5.  * Date: 18-11-14
  6.  * Time: 下午2:33
  7.  */
  9. namespace App\HttpController\Validate;
  12. use App\HttpController\Base;
  13. use EasySwoole\Http\Message\Status;
  14. use EasySwoole\Validate\Validate;
  16. class Index extends Base
  17. {
  18.     function index() {
  19.         $validate = new Validate();
  20.         $validate->addColumn('name')->required('姓名必填');
  21.         $validate->addColumn('age')->required('年龄必填')->between(20, 30, '年轻只能在20岁到30岁之前');
  22.         if ($this->validate($validate)) {
  23.             $this->writeJson(Status::CODE_OK, null, 'success');
  24.         } else {
  25.             $this->writeJson(Status::CODE_BAD_REQUEST, $validate->getError()->__toString(), 'fail');
  26.         }
  27.     }
  28. }

启动服务。

访问http://localhost:9501/validate,响应结果如下：

  1. {"code":400,"result":"name姓名必填","msg":"fail"}

访问http://localhost:9501/validate?name=blank,响应结果如下：

  1. {"code":400,"result":"age年龄必填","msg":"fail"}

访问http://localhost:9501/validate?name=blank&age=12,响应结果如下：

  1. {"code":400,"result":"age年龄只能在20岁到30岁之前","msg":"fail"}

访问http://localhost:9501/validate?name=blank&age=22,响应结果如下：

  1. {"code":400,"result":"age年龄只能在20岁到30岁之前","msg":"fail"}

方法列表

获取Error：

  1. function getError():?EasySwoole\Validate\Error

给字段添加规则：

  • string name 字段key
  • string errorMsg 错误信息
    • string alias 别名
  1. public function addColumn(string $name,?string $errorMsg = null,?string $alias = null):EasySwoole\Validate\Rule

返回一个Rule对象可以添加自定义规则。

数据验证：

  • array data 数据
  1. function validate(array $data)

验证规则类

目前验证器支持的规则如下

  1. <?php
  2. /**
  3.  * Created by PhpStorm.
  4.  * User: yf
  5.  * Date: 2018/7/6
  6.  * Time: 上午12:41
  7.  */
  9. namespace EasySwoole\Validate;
  11. /**
  12.  * 校验规则
  13.  * 请以首字母排序校验方法以便后期维护
  14.  * Class Rule
  15.  * @package EasySwoole\Validate
  16.  */
  17. class Rule
  18. {
  19.     protected $ruleMap = [];
  21.     function getRuleMap(): array
  22.     {
  23.         return $this->ruleMap;
  24.     }
  26.     /**
  27.      * 给定的URL是否可以成功通讯
  28.      * @param null|string $msg
  29.      * @return $this
  30.      */
  31.     function activeUrl($msg = null)
  32.     {
  33.         $this->ruleMap['activeUrl'] = [
  34.             'arg' => null,
  35.             'msg' => $msg
  36.         ];
  37.         return $this;
  38.     }
  40.     /**
  41.      * 给定的参数是否是字母 即[a-zA-Z]
  42.      * @param null|string $msg
  43.      * @return $this
  44.      */
  45.     function alpha($msg = null)
  46.     {
  47.         $this->ruleMap['alpha'] = [
  48.             'arg' => null,
  49.             'msg' => $msg
  50.         ];
  51.         return $this;
  52.     }
  54.     function alphaNum($msg = null)
  55.     {
  56.         $this->ruleMap['alphaNum'] = [
  57.             'arg' => null,
  58.             'msg' => $msg
  59.         ];
  60.         return $this;
  61.     }
  63.     function alphaDash($msg = null)
  64.     {
  65.         $this->ruleMap['alphaDash'] = [
  66.             'arg' => null,
  67.             'msg' => $msg
  68.         ];
  69.         return $this;
  70.     }
  72.     /**
  73.      * 给定的参数是否在 $min $max 之间
  74.      * @param integer $min 最小值 不包含该值
  75.      * @param integer $max 最大值 不包含该值
  76.      * @param null|string $msg
  77.      * @return $this
  78.      */
  79.     function between($min, $max, $msg = null)
  80.     {
  81.         $this->ruleMap['between'] = [
  82.             'msg' => $msg,
  83.             'arg' => [
  84.                 $min, $max
  85.             ]
  86.         ];
  87.         return $this;
  88.     }
  90.     /**
  91.      * 给定参数是否为布尔值
  92.      * @param null|string $msg
  93.      * @return $this
  94.      */
  95.     function bool($msg = null)
  96.     {
  97.         $this->ruleMap['bool'] = [
  98.             'msg' => $msg,
  99.             'arg' => null
  100.         ];
  101.         return $this;
  102.     }
  104.     /**
  105.      * 给定参数是否为小数格式
  106.      * @param null|integer $precision 规定小数点位数 null 为不规定
  107.      * @param null $msg
  108.      * @return $this
  109.      */
  110.     function decimal(?int $precision = null, $msg = null)
  111.     {
  112.         $this->ruleMap['decimal'] = [
  113.             'msg' => $msg,
  114.             'arg' => $precision
  115.         ];
  116.         return $this;
  117.     }
  119.     /**
  120.      * 给定参数是否在某日期之前
  121.      * @param null|string $date
  122.      * @param null|string $msg
  123.      * @return $this
  124.      */
  125.     function dateBefore(?string $date = null, $msg = null)
  126.     {
  127.         $this->ruleMap['dateBefore'] = [
  128.             'msg' => $msg,
  129.             'arg' => $date
  130.         ];
  131.         return $this;
  132.     }
  134.     /**
  135.      * 给定参数是否在某日期之后
  136.      * @param null|string $date
  137.      * @param null|string $msg
  138.      * @return $this
  139.      */
  140.     function dateAfter(?string $date = null, $msg = null)
  141.     {
  142.         $this->ruleMap['dateAfter'] = [
  143.             'msg' => $msg,
  144.             'arg' => $date
  145.         ];
  146.         return $this;
  147.     }
  149.     /**
  150.      * 验证值是否相等
  151.      * @param $compare
  152.      * @param null|string $msg
  153.      * @return $this
  154.      */
  155.     function equal($compare, $msg = null)
  156.     {
  157.         $this->ruleMap['equal'] = [
  158.             'msg' => $msg,
  159.             'arg' => $compare
  160.         ];
  161.         return $this;
  162.     }
  164.     /**
  165.      * 验证值是否一个浮点数
  166.      * @param null|string $msg
  167.      * @return $this
  168.      */
  169.     function float($msg = null)
  170.     {
  171.         $this->ruleMap['float'] = [
  172.             'arg' => null,
  173.             'msg' => $msg
  174.         ];
  175.         return $this;
  176.     }
  178.     /**
  179.      * 调用自定义的闭包验证
  180.      * @param callable $func
  181.      * @param null|string $msg
  182.      * @return $this
  183.      */
  184.     function func(callable $func, $msg = null)
  185.     {
  186.         $this->ruleMap['func'] = [
  187.             'arg' => $func,
  188.             'msg' => $msg
  189.         ];
  190.         return $this;
  191.     }
  193.     /**
  194.      * 值是否在数组中
  195.      * @param array $array
  196.      * @param bool $isStrict
  197.      * @param null|string $msg
  198.      * @return $this
  199.      */
  200.     function inArray(array $array, $isStrict = false, $msg = null)
  201.     {
  202.         $this->ruleMap['inArray'] = [
  203.             'arg' => [ $array, $isStrict ],
  204.             'msg' => $msg
  205.         ];
  206.         return $this;
  207.     }
  209.     /**
  210.      * 是否一个整数值
  211.      * @param null|string $msg
  212.      * @return $this
  213.      */
  214.     function integer($msg = null)
  215.     {
  216.         $this->ruleMap['integer'] = [
  217.             'arg' => null,
  218.             'msg' => $msg
  219.         ];
  220.         return $this;
  221.     }
  223.     /**
  224.      * 是否一个有效的IP
  225.      * @param array $array
  226.      * @param null $msg
  227.      * @return $this
  228.      */
  229.     function isIp($msg = null)
  230.     {
  231.         $this->ruleMap['isIp'] = [
  232.             'arg' => null,
  233.             'msg' => $msg
  234.         ];
  235.         return $this;
  236.     }
  238.     /**
  239.      * 是否不为空
  240.      * @param null $msg
  241.      * @return $this
  242.      */
  243.     function notEmpty($msg = null)
  244.     {
  245.         $this->ruleMap['notEmpty'] = [
  246.             'arg' => null,
  247.             'msg' => $msg
  248.         ];
  249.         return $this;
  250.     }
  252.     /**
  253.      * 是否一个数字值
  254.      * @param null $msg
  255.      * @return $this
  256.      */
  257.     function numeric($msg = null)
  258.     {
  259.         $this->ruleMap['numeric'] = [
  260.             'arg' => null,
  261.             'msg' => $msg
  262.         ];
  263.         return $this;
  264.     }
  266.     /**
  267.      * 不在数组中
  268.      * @param array $array
  269.      * @param bool $isStrict
  270.      * @param null $msg
  271.      * @return $this
  272.      */
  273.     function notInArray(array $array, $isStrict = false, $msg = null)
  274.     {
  275.         $this->ruleMap['notInArray'] = [
  276.             'arg' => [ $array, $isStrict ],
  277.             'msg' => $msg
  278.         ];
  279.         return $this;
  280.     }
  282.     /**
  283.      * 验证数组或字符串的长度
  284.      * @param int $len
  285.      * @param null $msg
  286.      * @return $this
  287.      */
  288.     function length(int $len, $msg = null)
  289.     {
  290.         $this->ruleMap['length'] = [
  291.             'msg' => $msg,
  292.             'arg' => $len
  293.         ];
  294.         return $this;
  295.     }
  297.     /**
  298.      * 验证数组或字符串的长度是否超出
  299.      * @param int $lengthMax
  300.      * @param null $msg
  301.      * @return $this
  302.      */
  303.     function lengthMax(int $lengthMax, $msg = null)
  304.     {
  305.         $this->ruleMap['lengthMax'] = [
  306.             'msg' => $msg,
  307.             'arg' => $lengthMax
  308.         ];
  309.         return $this;
  310.     }
  312.     /**
  313.      * 验证数组或字符串的长度是否达到
  314.      * @param int $lengthMin
  315.      * @param null $msg
  316.      * @return $this
  317.      */
  318.     function lengthMin(int $lengthMin, $msg = null)
  319.     {
  320.         $this->ruleMap['lengthMin'] = [
  321.             'msg' => $msg,
  322.             'arg' => $lengthMin
  323.         ];
  324.         return $this;
  325.     }
  327.     /**
  328.      * 验证数组或字符串的长度是否在一个范围内
  329.      * @param null $msg
  330.      * @return $this
  331.      */
  332.     function betweenLen(int $min, int $max, $msg = null)
  333.     {
  334.         $this->ruleMap['betweenLen'] = [
  335.             'msg' => $msg,
  336.             'arg' => [
  337.                 $min,
  338.                 $max
  339.             ]
  340.         ];
  341.         return $this;
  342.     }
  344.     /**
  345.      * 验证值不大于(相等视为不通过)
  346.      * @param int $max
  347.      * @param null|string $msg
  348.      * @return Rule
  349.      */
  350.     function max(int $max, ?string $msg = null): Rule
  351.     {
  352.         $this->ruleMap['max'] = [
  353.             'arg' => $max,
  354.             'msg' => $msg
  355.         ];
  356.         return $this;
  357.     }
  359.     /**
  360.      * 验证值不小于(相等视为不通过)
  361.      * @param int $min
  362.      * @param null|string $msg
  363.      * @return Rule
  364.      */
  365.     function min(int $min, ?string $msg = null): Rule
  366.     {
  367.         $this->ruleMap['min'] = [
  368.             'arg' => $min,
  369.             'msg' => $msg
  370.         ];
  371.         return $this;
  372.     }
  374.     /**
  375.      * 验证值是合法的金额
  376.      * 100 | 100.1 | 100.01
  377.      * @param integer|null $precision 小数点位数
  378.      * @param string|null  $msg
  379.      * @return Rule
  380.      */
  381.     function money(?int $precision = null, string $msg = null): Rule
  382.     {
  383.         $this->ruleMap['money'] = [
  384.             'arg' => $precision,
  385.             'msg' => $msg
  386.         ];
  387.         return $this;
  388.     }
  390.     /**
  391.      * 设置值为可选参数
  392.      * @return $this
  393.      */
  394.     function optional()
  395.     {
  396.         $this->ruleMap['optional'] = [
  397.             'arg' => null,
  398.             'msg' => null
  399.         ];
  400.         return $this;
  401.     }
  403.     /**
  404.      * 正则表达式验证
  405.      * @param $reg
  406.      * @param null $msg
  407.      * @return $this
  408.      */
  409.     function regex($reg, $msg = null)
  410.     {
  411.         $this->ruleMap['regex'] = [
  412.             'arg' => $reg,
  413.             'msg' => $msg
  414.         ];
  415.         return $this;
  416.     }
  418.     /**
  419.      * 必须存在值
  420.      * @param null $msg
  421.      * @return $this
  422.      */
  423.     function required($msg = null)
  424.     {
  425.         $this->ruleMap['required'] = [
  426.             'arg' => null,
  427.             'msg' => $msg
  428.         ];
  429.         return $this;
  430.     }
  432.     /**
  433.      * 值是一个合法的时间戳
  434.      * @param null $msg
  435.      * @return $this
  436.      */
  437.     function timestamp($msg = null)
  438.     {
  439.         $this->ruleMap['timestamp'] = [
  440.             'arg' => null,
  441.             'msg' => $msg
  442.         ];
  443.         return $this;
  444.     }
  446.     /**
  447.      * 时间戳在某指定日期之前
  448.      * @param string $date 传入任意可被strtotime解析的字符串
  449.      * @param null $msg
  450.      * @return $this
  451.      */
  452.     function timestampBeforeDate($date, $msg = null)
  453.     {
  454.         $this->ruleMap['timestampBeforeDate'] = [
  455.             'arg' => $date,
  456.             'msg' => $msg
  457.         ];
  458.         return $this;
  459.     }
  461.     /**
  462.      * 时间戳在某指定日期之后
  463.      * @param string $date 传入任意可被strtotime解析的字符串
  464.      * @param null $msg
  465.      * @return $this
  466.      */
  467.     function timestampAfterDate($date, $msg = null)
  468.     {
  469.         $this->ruleMap['timestampAfterDate'] = [
  470.             'arg' => $date,
  471.             'msg' => $msg
  472.         ];
  473.         return $this;
  474.     }
  476.     /**
  477.      * 指定时间戳在某时间戳之前
  478.      * @param string|integer $beforeTimestamp 在该时间戳之前
  479.      * @param null $msg
  480.      * @return $this
  481.      */
  482.     function timestampBefore($beforeTimestamp, $msg = null)
  483.     {
  484.         $this->ruleMap['timestampBefore'] = [
  485.             'arg' => $beforeTimestamp,
  486.             'msg' => $msg
  487.         ];
  488.         return $this;
  489.     }
  491.     /**
  492.      * 指定时间戳在某时间戳之后
  493.      * @param string|integer $afterTimestamp 在该时间戳之后
  494.      * @param null $msg
  495.      * @return $this
  496.      */
  497.     function timestampAfter($afterTimestamp, $msg = null)
  498.     {
  499.         $this->ruleMap['timestampAfter'] = [
  500.             'arg' => $afterTimestamp,
  501.             'msg' => $msg
  502.         ];
  503.         return $this;
  504.     }
  506.     /**
  507.      * 值是一个合法的链接
  508.      * @param null $msg
  509.      * @return $this
  510.      */
  511.     function url($msg = null)
  512.     {
  513.         $this->ruleMap['url'] = [
  514.             'arg' => null,
  515.             'msg' => $msg
  516.         ];
  517.         return $this;
  518.     }
  520.     /**
  521.      * 值是一个合法的链接
  522.      * @param null $msg
  523.      * @return $this
  524.      */
  525.     function allDigital($msg = null)
  526.     {
  527.         $this->ruleMap['allDigital'] = [
  528.             'arg' => null,
  529.             'msg' => $msg
  530.         ];
  531.         return $this;
  532.     }
  533. }