init docs

Author: mrxiaozhuox

.gitignore

@@ -0,0 +1 @@
+.DS_Store

.nojekyll

@@ -0,0 +1,9 @@
+![logo](https://gitee.com/mrxzx/LyApi/raw/master/public/favicon.ico)
+
+# LyApi 2.X
+
+> LyApi Framework 全新升级！
+
+
+[OSC@Git](https://gitee.com/mrxzx/LyApi.git)
+[开始](#前言)

_coverpage.md

@@ -0,0 +1,8 @@
+* [前言](/?id=前言)
+* [项目部署](/deploy.md)
+* [路由系统](/route.md)
+* [控制器系统](/controller.md)
+* [事件监听](/event.md)
+* [数据缓存](/cache.md)
+* [数据库操作](/database.md)
+* [拓展程序](/extends/index.md)

_sidebar.md

@@ -0,0 +1,96 @@
+# 缓存系统
+
+> LyApi 2.X 相对 1.X 提供了更加强大的缓存系统。
+
+## 文件缓存
+
+> 文件缓存即为将数据写入到本地文件中，属于最方便的缓存方法。
+
+### 获取对象
+
+框架内置了两个缓存相关的类：**FileCache** 和 **Cache**
+
+它们都用于缓存的相关操作，前者为文件缓存的专属类，而后者包含了 Redis 等其他方案。
+
+当您确定要使用文件缓存时，最好使用 FileCache 类，它会减少不必要的加载和检测。
+
+```php
+// FileCache 需要先获取对象，再进行操作
+$cache = new FileCache("group_name");
+$cache->set("name","liuzhuoer");
+
+// 而 Cache 则定义了静态函数，可直接调用
+Cache::set("name","liuzhuoer");
+```
+
+Cache 对象在加载时会根据框架配置文件加载相应的设定：
+
+**Application\Config\cache.php: cache_system**
+
+你也可以使用静态函数  **Cache::system("FILE")**  切换至文件缓存。
+
+
+### 设置数据
+
+```php
+// 三个参数：Key Value Expire
+Cache::set("name","liuzhuoer",60 * 1000);
+```
+
+Key 和 Value 就不必解释了吧，这第三个参数代表数据过期时间。
+
+Expire 默认为 0 代表不过期，**60 × 1000** 则代表了一分钟。
+
+!> 当你传入的值为 **Object** 类型，系统会自动将其转换为 JSON 再写入。
+
+
+### 读取数据
+
+```php
+$my_name = Cache::get("name");
+```
+
+当数据不存在则会返回一个空字符串。（数据过期一样）
+
+!> 建议先调用 **Cache::has** 后在做获取，这是一个好的习惯。
+
+### 判断数据
+
+```php
+if (Cache::has("name")) {
+    // do some thing ...
+} else {
+    throw new Exception("数据不存在...");
+}
+```
+判断一个缓存键是否存在，在读取前判断是一个好习惯哦！
+
+### 自增数据
+
+```php
+// 参数：Key Add
+Cahce::inc("name",1);
+```
+s
+很好理解，就是让一条数据在其基础上增加一个值。默认 +1。
+
+当你想让它减少时，第二个参数给个负值即可。
+
+!> 仅限储存类型为数字，其他类型无法操作。
+
+
+### 删除数据
+
+```php
+Cache::delete("name");
+```
+
+删除一个缓存键，不需要多解释吧 😝
+
+### 清空数据
+
+```php
+Cache::clean();
+```
+
+一行代码将清空所有的缓存（仅当前分组）

cache.md

@@ -0,0 +1,72 @@
+# 控制器系统
+
+> 控制器是应用中最重要的模块，决定了每次访问将被怎么处理。
+
+## ⚽控制器基础
+
+一个控制器即为一个类文件，这个类中的函数即为控制器的最终处理程序。
+
+一个简单的控制器：
+
+```php
+class Main extends ViewCon
+{
+    public function index($req, $resp)
+    {
+        return View::render('index', []);
+    }
+}
+```
+
+它只有一个函数：“index”，这个函数的结果为渲染 index.html 的模板引擎。
+
+在大部分功能中要访问一个控制器只需要使用：**Namespace.Class.Function**
+
+当控制器位于 application/Controller 的根目录下时，命名空间不需要填写。
+
+比如在路由绑定中填写对应的控制器："**Main.index**"
+
+## 🎯控制器父类
+
+控制器所继承的类决定了本控制器最终结果将以什么模式去展现：
+
+- JSON - 接口常用
+- HTML - 网站常用
+
+以及一些自定义的结构，都可以使用控制器父类来实现。
+
+以下是系统默认的接口控制器父类实现方式：
+
+```php
+class ApiCon extends Bcontrol
+{
+    public function _export($data)
+    {
+        return View::api($data, API_STRUCTURE_INFO);
+    }
+}
+```
+
+父类也需要继承 Bcontrol 这个对象。没有理由，继承就行了。
+
+**_export** 函数则是最终结果输出的实现，如上方代码则是调用了 View 中的 API 生成器来完成结果处理。
+
+你也可以在 控制器父类 中定义一些特有的函数供控制器调用。
+
+## 🎱控制器参数
+
+每个控制器函数都需要接受至少两个参数：$req 和 $resp
+
+它们分别代表：Request 对象 和 Response 对象。
+
+其中 $req 可以使用 **$req->variable** 取得路由的动态参数。
+
+或者：
+- $req->args("name") 获取Get参数。
+- $req->form("name") 获取Post参数。
+
+而 $resp 则是基础的 **重定向、错误报出** 等功能的实现。
+
+## 🏈关于其他
+
+控制器本身的功能并不多，但是应用的所有业务逻辑都是在这里完成的，所以它非常重要！😏

controller.md

@@ -0,0 +1,174 @@
+# 数据库操作
+
+> 缺少了数据库相关的操作，后端开发将缺少了意义。
+
+## 数据库选择
+
+市面上有很多优秀的数据库，它们的存在总是有意义的，没有绝对好的系统，只有适合自己项目的系统。
+
+LyApi 2.X 采用了方便简洁的 Medoo 操作库，它支持了很多市面上热门的数据库系统：
+
+- MySQL, MariaDB -> php_pdo_mysql
+- MSSQL (Windows) -> php_pdo_sqlsrv
+- MSSQL (Liunx/UNIX) -> php_pdo_dblib / php_pdo_sqlsrv
+- Oracle -> php_pdo_oci
+- Oracle version 8 -> php_pdo_oci8
+- SQLite -> php_pdo_sqlite
+- PostgreSQL -> php_pdo_pgsql
+- Sybase -> php_pdo_dblib
+
+它们都是关系型数据库系统，但市面上还有一种非关系型的数据库类型：
+
+- MongoDB
+- Cassandra
+- Memcached
+- HBase
+- Redis
+- ...
+
+#### 关系型 和 非关系型
+
+写过 PHP 的应该都知道 MySQL 吧，它的数据都是存在一个个数据表中的，而数据表都是表项的，也就是说你只能在数据项的限制下才能插入数据：如果 “UserName” 的数据项类型为字符串，那你就不能直接将一个数字插入进去。—— 简单地说就是有严格限制格式。
+
+而非关系型数据库，如 Mongodb 则不会有很严格的限制，Mongodb是文档式的储存方式，在一条数据表下，你的每条数据的格式都是可以随意变化的。比如说一个 “user_table” 两条数据有的数据项可以完全不一样，第一条有的属性，第二条可以没有。 —— 简单说就是没限制。
+
+这两种类型的数据库不存在好与坏的区分，它们适合的是不同的项目类型。
+
+一般正常的项目使用 MySQL 足矣，但如果你的项目数据结构是在不断变化的，就可以考虑非关系型数据库了。
+
+## 数据库连接
+
+LyApi 2.X 封装了特殊的数据库连接方式，你需要在 application/Config/database.php 下进行配置：
+
+```php
+return [
+    "mydb" => [
+        'server' => '127.0.0.1',
+        'username' => 'root',
+        'password' => 'root',
+        'database_name' => 'mysql',
+        'charset' => 'utf8',
+        'database_type' => 'mysql'
+    ]
+];
+```
+
+你可以在这里返回所有会用到的数据库连接配置，框架会根据在使用时的选择自动连接到相应的数据库。
+
+通过 Connector 对象取得 Medoo 连接：
+
+```php
+
+$ctor = new Connector(); 
+$conn = $ctor->mydb;
+// --------- 分割线 --------- //
+$conn = Connector::connect("mydb");
+```
+
+上方有两种方法可以获取到数据库连接（前提是有相应 Key 的配置）
+
+
+## 数据库操作
+
+虽然说后端涉及到很多知识，但归根结底，我们所完成的任务基本上就是 **CURD** ！
+
+CURD即：Create Update Read Delete (增删改查)
+
+所以说数据库的操作在后端开发中是至关重要滴 🤠
+
+!> 下方文档仅提供简单演示，完整文档请移步：[Medoo Database Framework](https://medoo.in/doc)
+
+### 数据插入
+
+数据库中的每条数据都是程序插入（创建）的，所以它至关重要！
+
+```php
+// 第一个参数为操作的表名（Medoo 所有操作第一参数都为表名）
+$conn->insert("my_table",[
+    
+    // 第二参数则是一个数组，用于设置相关的属性
+    // 如果表结构设置可空或默认值，也可以不设置
+    
+    'username' => 'liuzhuoer',
+    'password' => '123456789'
+]);
+```
+
+### 数据查询
+
+!> 查询函数过于复杂，建议前往 [Medoo 官网](https://medoo.in/doc) 查看!
+
+先来个基础的查询操作：
+
+```php
+// 一般会使用到的有三个参数：
+
+// 第一个：表名
+// 第二个：查询字段名（即需要的结果有哪些字段）
+// 第三个：条件（相当于SQL中的 Where ）
+
+// 查询 id 为 1 的数据，只要 username 和 email 两个值
+$data = $conn->select("my_table", [
+	"username",
+	"email"
+], [
+	"id" => 1
+]);
+```
+
+接下来是稍微高级的操作：
+
+
+```php
+// 查询字段为 * 即代表取得所有字段信息
+// age[>] 相当于查询 age 大于 18 的信息
+
+$data = $conn->select("my_table", "*", [
+    "age[>]" => 18
+]);
+```
+
+select 函数可能查询多条数据，如果你只要一条，请使用 **get** 函数：
+
+```php
+// 结构和上方代码一样，但本次只取得第一条符合条件的数据
+$data = $conn->get("my_table", "*", [
+    "age[>]" => 18
+]);
+```
+
+
+### 更新数据
+
+!> 更新函数过于复杂，建议前往 [Medoo 官网](https://medoo.in/doc) 查看!
+
+```php
+
+// 第二位参数为更新的数据
+// 第三位参数同SQL Where
+
+$conn->update("my_table",[
+
+    // 先将 Email 更新为 [email protected]
+    // 然后 Age = Age + 1 （相当于自增）
+
+    "email" => "[email protected]",
+    "age[+]" => 1
+],[
+    "username" => 'liuzhuoer'
+]);
+```
+
+### 删除数据
+
+```php
+
+// 第二位参数相当于 SQL Where
+
+$conn->update("my_table",[
+
+    // 删除用户名为 liuzhuoer 的数据
+
+    "username" => 'liuzhuoer'
+]);
+```