From c8e3fcd421f63ca3fdb9b4a34b9f520711b5eb9f Mon Sep 17 00:00:00 2001
From: huangzhhui <huangzhwork@gmail.com>
Date: Sun, 16 Jun 2019 01:48:13 +0800
Subject: [PATCH] Added paginator of db

---
 summary.md         |  1 +
 zh/db/paginator.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 55 insertions(+)
 create mode 100644 zh/db/paginator.md

diff --git a/summary.md b/summary.md
index 654d2c3fd..45d4f34dd 100644
--- a/summary.md
+++ b/summary.md
@@ -34,6 +34,7 @@
   * [快速开始](zh/db/quick-start.md)
   * [查询构造器](zh/db/querybuilder.md)
   * [模型](zh/db/model.md)
+  * [分页](zh/db/paginator.md)
   * [模型事件](zh/db/event.md)
   * [模型缓存](zh/db/model-cache.md)
   * [数据库迁移](zh/db/migration.md)
diff --git a/zh/db/paginator.md b/zh/db/paginator.md
new file mode 100644
index 000000000..0217b14e1
--- /dev/null
+++ b/zh/db/paginator.md
@@ -0,0 +1,54 @@
+# 分页
+
+在使用 [hyperf/database](https://github.com/hyperf-cloud/database) 来查询数据时，可以很方便的通过与 [hyperf/paginator](https://github.com/hyperf-cloud/paginator) 组件配合便捷地对查询结果进行分页。
+
+# 使用方法
+
+在您通过 [查询构造器](zh/db/querybuilder.md) 或 [模型](zh/db/model.md) 查询数据时，可以通过 `paginate` 方法来处理分页，该方法会自动根据用户正在查看的页面来设置限制和偏移量，默认情况下，通过当前 HTTP 请求所带的 `page` 参数的值来检测当前的页数：
+
+> 由于 Hyperf 当前并不支持视图，顾分页组件尚未支持对视图的渲染，直接返回分页结果默认会以 application/json 格式输出。
+
+## 查询构造器分页
+
+```php
+<?php
+
+namespace App\Controller;
+
+use Hyperf\DbConnection\Db;
+use Hyperf\HttpServer\Annotation\AutoController;
+
+/**
+ * @AutoController
+ */
+class UserController
+{
+    public function index()
+    {
+        // 展示应用中的所有用户，每页显示 10 条数据
+        return Db::table('users')->paginate(10);
+    }
+}
+```
+
+## 模型分页 
+
+您可以直接通过静态方法调用 `paginate` 方法来进行分页：
+
+```php
+<?php
+// 展示应用中的所有用户，每页显示 10 条数据
+return User::paginate(10);
+```
+
+当然您也可以设置查询的条件或其它查询的设置方法：
+
+```php
+<?php 
+// 展示应用中的所有用户，每页显示 10 条数据
+return User::where('gender', 1)->paginate(10);
+```
+
+## 分页器实例方法
+
+这里仅说明分页器在数据库查询上的使用方法，更多关于分页器的细节可阅读 [分页](zh/paginator.md) 章节。
\ No newline at end of file