init project

Author: xiajianjun

README.md

@@ -1 +1,32 @@
 #php-validate
+
+> a simple validate library of the php
+
+### Install
+
+- use composer
+
+edit `composer.json`
+
+_require_ add
+
+```
+"inhere/php-validate": "dev-master",
+```
+
+_repositories_ add 
+
+```
+"repositories": [
+    {
+      "type": "git",
+      "url": "https://git.oschina.net/inhere/php-validate"
+    }
+  ]
+```
+
+run: `composer update`
+
+### Document
+
+See [document](document.md)

composer.json

@@ -0,0 +1,26 @@
+{
+  "name": "inhere/php-validate",
+  "type": "library",
+  "description": "A Slim Framework extension",
+  "keywords": ["Slim","extensions"],
+  "homepage": "http://github.com/inhere/php-validate",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "inhere",
+      "email": "[email protected]",
+      "homepage": "http://www.yzone.net/"
+    }
+  ],
+  "require": {
+    "php": ">=5.5.0"
+  },
+  "autoload":{
+    "psr-4": {
+      "inhere\\validate\\" : "src/"
+    }
+  },
+  "suggest": {
+    "inhere/simple-print-tool": "Very lightweight data printing tools"
+  }
+}

document.md

@@ -0,0 +1,196 @@
+## simple validator
+
+### Install
+
+- use composer
+
+edit `composer.json`
+
+_require_ add
+
+```
+"inhere/php-validate": "dev-master",
+```
+
+_repositories_ add 
+
+```
+"repositories": [
+    {
+      "type": "git",
+      "url": "https://git.oschina.net/inhere/php-validate"
+    }
+  ]
+```
+
+run: `composer update`
+
+### how to use
+
+- Method 1: create a new class
+    e.g.
+    
+```
+<?php
+
+    use slimExtend\validate\Validator;
+
+    class PageRequest extends Validator
+    {
+        public function rules()
+        {
+            return [
+                ['tagId,userId,freeTime', 'required', 'msg' => '{attr} is required!'],
+                ['tagId', 'size', 'min'=>4, 'max'=>567], // 4<= tagId <=567
+                ['title', 'min', 'min' => 40],
+                ['freeTime', 'number'],
+                ['tagId', 'number', 'when' => function($data) 
+                {
+                    return isset($data['status']) && $data['status'] > 2;
+                }],
+                ['userId', 'number', 'scene' => 'scene1' ],
+                ['userId', 'int', 'scene'    => 'scene2' ],
+                ['status', function($status)
+                { 
+
+                    if ( .... ) {
+                        return true;
+                    }
+                    return false;
+                }],
+            ];
+        }
+        
+        // define field attribute's translate.
+        public function attrTrans()
+        {
+            return [
+              'userId' => '用户Id',
+            ];
+        }
+        
+        // custom validator message
+        public function messages()
+        {
+            return [
+              'required' => '{attr} 是必填项。',
+            ];
+        }
+    }
+
+//
+//  use, at other class
+
+$valid = Validator::make($_POST,)->validate();
+if ( $valid->fail() ) {
+    return $valid->getErrors();
+}
+...
+    
+```
+
+
+- Method 2: direct use
+
+```
+<?php
+    use slimExtend\validate\Validator;
+
+    class SomeClass 
+    {
+        public function demo()
+        {
+            $valid = Validator::make($_POST,[
+                // add rule
+                ['title', 'min', 'min' => 40],
+                ['freeTime', 'number'],
+            ])->validate();
+
+            if ( $valid->fail() ) {
+                return $valid->getErrors();
+            }
+
+            // 
+            // some logic ... ...
+        }
+    }
+```
+
+### keywords 
+
+- scene -- 设置验证场景
+> 如果需要让一个验证器在多个类似情形下使用,在验证时也表明要验证的场景
+
+```
+// at validator class
+<?php 
+    
+    '''
+    public function rules() 
+    {
+         return [
+            ['title', 'required' ],
+            ['userId', 'number', 'scene' => 'scene1' ],
+            ['userId', 'int',    'scene' => 'scene2' ],
+        ];
+    }
+```
+> 在下面设置了场景时，将只会使用上面的第 1 3 条规则. (第 1 条没有限制规则使用场景的，在所有场景都可用)
+
+```
+// at logic 
+<?php
+
+    ...
+    $valid = ValidatorClass::make($_POST)->setScene('scene2')->validate();
+    ...
+
+```
+
+- when -- 规则的前置条件
+> 只有在先满足了(`when`)前置条件时才会验证这条规则
+如在下面的例子中，检查到第二条规则时，会先执行闭包(`when`)，
+当其返回 `true` 验证此条规则，
+否则不会验证此条规则
+
+```
+// at validator class
+<?php 
+    
+    '''
+    public function rules() 
+    {
+         return [
+            ['title', 'required' ],
+            ['tagId', 'number', 'when' => function($data, $validator) 
+            {
+               return isset($data['status']) && $data['status'] > 2;
+            }],
+        ];
+    }
+```
+
+
+### Existing validators 
+
+validator | description | rule example
+----------|-------------|------------
+`int`   | validate int | ....
+`number`    | validate number | ....
+`bool`  | validate bool | ....
+`float` | validate float | ....
+`regexp`    | validate regexp | ....
+`url`   | validate url | ....
+`email` | validate email | ....
+`ip`    | validate ip | ....
+`required`  | validate required | ....
+`length`    | validate length | ....
+`minLength` | validate minLength | ....
+`maxLength` | validate maxLength | ....
+`size`  | validate size | ....
+`min`   | validate min | ....
+`max`   | validate max | ....
+`in`    | validate in | ....
+`string`    | validate string | ....
+`array`   | validate is Array | ....
+`callback`  | validate by custom callback | ....

example/DataModel.php

@@ -0,0 +1,7 @@
+<?php
+
+class DataModel extends \slimExtend\validate\Validator
+{
+
+
+}

example/PageRequest.php

@@ -0,0 +1,43 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: Inhere
+ * Date: 2016/2/19 0019
+ * Time: 23:35
+ */
+
+/**
+ * Class PageRequest
+ */
+class PageRequest extends \slimExtend\validate\Validator
+{
+    public function rules()
+    {
+        return [
+            ['tagId,userId,freeTime', 'required' ],
+            ['tagId', 'size', 'min'=>4, 'max'=>567], // 4<= tagId <=567
+            ['title', 'min', 'min' => 40],
+            ['freeTime', 'number', 'msg' => '{attr} is require number!'],
+            ['test', 'number', 'when' => function($data) {
+                return isset($data['status']) && $data['status'] > 2;
+            }],
+            ['userId', 'number', 'scene' => 'other' ],
+//            ['userId', function($value){ return false;}],
+        ];
+    }
+
+    public function attrTrans()
+    {
+        return [
+            'userId' => '用户Id',
+        ];
+    }
+
+    // custom validator message
+    public function messages()
+    {
+        return [
+            'required' => '{attr} 是必填项。',
+        ];
+    }
+}

example/index.php

@@ -0,0 +1,43 @@
+<?php
+
+spl_autoload_register(function($class)
+{
+    $file = __DIR__ . '/' . $class. '.php';
+
+    if (is_file($file)) {
+        include $file;
+    }
+});
+
+$data = [
+    'userId' => 'sdfdffffffffff',
+    'tagId' => '234535',
+    // 'freeTime' => 'sdfdffffffffff',
+    'distanceRequire' => 'sdfdffffffffff',
+    'note' => 'sdfdffffffffff',
+    'insertTime' => '',
+    'lastReadTime' => 'sdfdffffffffff',
+];
+
+$rules = [
+    ['tagId,userId,freeTime', 'required', 'msg' => '{field} is required!'],
+    ['note', 'email'],
+    ['tagId', 'size', 'min'=>4, 'max'=>567, 'msg' => '{field} must is big!'], // 4<= tagId <=567
+    ['freeTime', 'size', 'min'=>4, 'max'=>567, 'msg' => '{field} must is big!'], // 4<= tagId <=567
+    ['userId', function($value){ echo $value."\n"; return false;}, 'msg' => '{field} check filare!'],
+];
+
+/*
+$model = new TestModel();
+$ret = $model->load($_POST)->validate();
+*/
+$model = new DataModel($_POST,$rules);
+$ret = $model->validate([], true);
+
+// echo "<pre>";
+var_dump($ret,
+$model->firstError()
+);
+
+
+// echo "</pre>";