重构&编写文档

Author: cmpan

README.md

@@ -2,3 +2,9 @@ Windwork 工具组件
 ===============
 
 TODO
+
+<br />
+<br />
+> ### 要了解更多？
+> - [官方完整文档首页](http://docs.windwork.org/manual/)
+> - [官方源码首页](https://github.com/windwork

docs/validator.md

@@ -1,23 +1,66 @@
 字符串格式验证类
 ======================
+本类用于验证字符串格式是否为预期的值。
+
+支持的验证方法：
+
+方法 |  函数说明 
+---------------------------| ----------------
+Validator::date($str)     | 是否为YYYY-mm-dd或YYY/mm/dd或YYYY年日期
+Validator::datetime($str) | 是否为到秒的时间格式（YYYY-mm-dd HH:ii:ss 或 YYYY/mm/dd HH:ii:ss）
+Validator::year($str)     | 参数类型是否为年的格式(1-32767)
+Validator::month($str)    | 参数类型是否为月格式（1-12）
+Validator::day($str)      | 参数类型是否为日期的日格式（1-31）
+Validator::hour($str)     | 小时，0-23
+Validator::minute($str)   | 分钟，0-59
+Validator::second($str)   | 秒钟，0-59
+Validator::week($str)     | 否为星期范围内的值
+Validator::email($str)    | 邮箱
+Validator::equal($str)    | 值等于（==）
+Validator::equalAll($str) | 值全等于（===）
+Validator::hex($str)      | 是否为16进制字符
+Validator::idCard($str)   | 中国身份证号码
+Validator::ip($str)          | 是否为IP地址
+Validator::max($str, $max)   | 值不大于 $max，如果$max为数组，结构为： <pre> $max = ['max' => 值, 'msg' => '匹配错误提示信息']</pre>
+Validator::min($str, $max)   | 值不小于 $min，如果$min为数组，结构为： <pre> $min = ['min' => 值, 'msg' => '匹配错误提示信息']</pre>
+Validator::len($str, $len)         | 值长度等于 $len，如果$len为数组，结构为： <pre> $min = ['min' => 值, 'msg' => '匹配错误提示信息']</pre>
+Validator::minLen($str, $minLen)   | 值长度不小于 $minLen，如果传入数组，结构为： <pre> $minLen = ['minLen' => 值, 'msg' => '匹配错误提示信息']</pre>
+Validator::maxLen($str, $maxLen)   | 值长度不大于 $maxLen，如果传入数组，结构为： <pre> $maxLen = ['maxLen' => 值, 'msg' => '匹配错误提示信息']</pre>
+Validator::preg($str, $preg)       | 自定义验证规则，$preg 可直接传入正则，如果传入数组，结构为 <pre> ['preg' => '正则规则', 'msg' => '匹配错误提示信息']</pre>
+Validator::mobile($str)      | 中国大陆手机号码
+Validator::money($str)       | 货币，两位小数的浮点数，小数点前面必须有数字
+Validator::number($str)      | 数字
+Validator::safeString($str)  | 安全字符串（只包含字母、数字、下划线）
+Validator::url($str)         | 网址
+
 
 ## 批量验证
 
 ```
 $rules = [
     'user_name' => [
         // 验证方法只有一个参数
-        'isNotEmpty'   => '请输入用户名', 
-        'isSafeString' => '用户名只允许输入字母、数字和下划线',
+        'required'   => '请输入用户名', 
+        'safeString' => '用户名只允许输入字母、数字和下划线',
 
         // 验证方法需要多个参数
         'minLen'       => ['msg' => '用户名不能小于3个字符', 'minLen' => 3],
-        'maxLen'       => ['msg' => '用户名不能超过20个字符', 'maxLen' => 20],
+        'maxLen'       => ['msg' => '用户名不能超过24个字符', 'maxLen' => 24],
     ],
     'email'    => [
-        'isNotEmpty'   => '请输入邮箱', 
+        'required'   => '请输入邮箱', 
         'email'        => '邮箱格式错误',
     ]
-]
-
+];
+$data = [
+    'user_name' => 'my_name_is_han_mei_mei',
+    'password'  => '123456',
+    'email'     => 'hanmeimei@windwork.org',
+];
+$validator = new \wf\util\Validator();
+if(!$validator->validate($data, $rules)) {
+    // 如果匹配错误，获取错误信息并进行处理
+    $err = $validator->getLastError();
+    // do sth.
+}
 ```

lib/Tree.php

@@ -15,39 +15,40 @@
  * 树结点的结构 array('结点编号', '父结点编号', ... )
  * 
  * 术语：
- *   tree 树
- *   subTree 子数
- *   node 结点
- *   degree 结点的度
- *   leaf 叶子，度为0的结点
- *   child 孩子，结点子树的根
- *   parent 结点的上层结点
- *   level 结点的层次
- *   depth 数的深度，树中结点最大层次数
- *   ancestor 祖先，树叶的顶层父结点
+ *   tree       树
+ *   subTree    子树
+ *   node       结点
+ *   degree     结点的度
+ *   leaf       叶子，度为0的结点
+ *   child      孩子，结点子树的根
+ *   parent     结点的上层结点
+ *   level      结点的层次
+ *   depth      数的深度，树中结点最大层次数
+ *   ancestor   祖先，树叶的顶层父结点
  *   descendant 树的子孙，结点的祖先和子孙不包含结点 本身
- *   path 路径，一个结点到达另一个结点经过的结点
+ *   path       路径，一个结点到达另一个结点经过的结点
  *   
- *   这里用不上sibling、forest
+ *   我们这个类没用上sibling、forest
  * 
  * @package     wf.util
  * @author      cm <cmpan@qq.com>
  * @since       0.1.0
  */
-class Tree {
+class Tree
+{
 	/**
 	 * 要处理的结点的数组
 	 *
 	 * @var array
 	 */
-	protected $inNodes = array();
+	protected $inNodes = [];
 
 	/**
 	 * 处理后的结点的数组
 	 *
 	 * @var array
 	 */
-	protected $outNodes = array();
+	protected $outNodes = [];
 
 	/**
 	 * 结点中表示该结点的父结点id的属性名（下标）
@@ -76,59 +77,41 @@ class Tree {
 	 * @var int
 	 */
 	public $depth = 0;
-
-	//public function __construct() {}
-	
-	public function setParentNodeIdKey($key) {
-		$this->nodeParentIdKey = $key;
-	}
-	
-	public function setNodeIdKey($key) {
-		$this->nodeIdKey = $key;
-	}
 
 	/**
-	 * 填充要计算的数组
+	 * 在构造设置要计算的数组
 	 *
 	 * @param array $var
 	 * @param string $id
 	 * @param string $parentId
 	 */
-	public function set($vars, $id = 'id', $parentId = 'parent_id') {
-		if(!is_array($vars)) throw new \Exception("错误的数据类型");
+	public function __construct(array $vars, $id = 'id', $parentId = 'parent_id')
+	{		
 		foreach ($vars as $var) {
 			$this->inNodes[$var[$id]] = $var;
 		}
 
 		$this->nodeIdKey = $id;
 		$this->nodeParentIdKey = $parentId;
 	}
-	
-	/**
-	 * 添加结点
-	 *
-	 * @param array $node 结点
-	 * @param string $key = null 结点的下标
-	 */
-	public function add($node, $key = null) {
-		$node = $key ? array($key => $node) : array($node);
-		$this->inNodes = array_merge($this->inNodes, $node);
-	}
 
 	/**
 	 * 获取子结点,子结点将按父结点id和结点id来排序
 	 *
 	 * @param int $id 结点的id
 	 * @param bool $isReturnSelf 是否返回自己
-	 * @param array $unReturnFields 不返回的属性，可设置：[isLeaf, ancestorIdArr, descendantIdArr, descendantId, childArr, isLastNode, icon]
+	 * @param array $unReturnFields 设置不返回的属性，可设置：[isLeaf, ancestorIdArr, descendantIdArr, descendantId, childArr, isLastNode, icon]
 	 * @return array
 	 */
-	public function get($id = 0, $isReturnSelf = true, array $unReturnFields = []) {
+	public function get($id = 0, $isReturnSelf = true, array $unReturnFields = [])
+	{
 		// 层次排序
-		$this->levelOrder(0);
+		$this->parse(0);
 
 		// 设置缩进图标/形状
-		empty($unReturnFields['icon']) && $this->setLevelIcon();
+		if(empty($unReturnFields['icon'])) {
+		    $this->parseLevelIcon();
+		}
 
 		$cats = $this->outNodes;
 		if($id && isset($cats[$id])) {
@@ -157,10 +140,11 @@ public function get($id = 0, $isReturnSelf = true, array $unReturnFields = []) {
 	}
 
 	/**
-	 * 设置树的层次缩进图标/形状
+	 * 提取树的层次缩进图标/形状
 	 * 
 	 */
-	private function setLevelIcon() {
+	private function parseLevelIcon()
+	{
 	    $nodes  = $this->outNodes;
 	    $fidName = $this->nodeParentIdKey;
 
@@ -208,7 +192,8 @@ private function setLevelIcon() {
 	 *
 	 * @param int|string $id 结点id
 	 */
-	protected function levelOrder($id) {
+	protected function parse($id)
+	{
 		foreach($this->inNodes as $node) {
 			$nodeId   = $node[$this->nodeIdKey];  // 结点ID
 			$nodeFid  = $node[$this->nodeParentIdKey];  // 结点的父结点的id 		
@@ -253,16 +238,11 @@ protected function levelOrder($id) {
 				//$this->addChildMark($nodeId, $nodeFid);
 				$this->depth = ($this->depth > $this->outNodes[$nodeId]['level']) ? $this->depth : $this->outNodes[$nodeId]['level'];
 				if($nodeId) {
-					$this->levelOrder($nodeId);				
+					$this->parse($nodeId);				
 				}
 				//unset($this->inNodes[$nodeId]);
 			}
 		}
 	}
-	
-	public function __destruct() {
-		unset($this->inNodes);
-		unset($this->outNodes);
-	}	
 }