YrPHP

KO | EN

gitlite — search

#hacktoberfest #react #go #android #machine-learning #rust #nodejs #windows #kubernetes #vue #pytorch #security #mcp #openai

(★ 11)

YrPHP is PHP framework

YrPHP Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

* [简介](#简介)
   * [安装YrPHP](#安装yrphp)
      * [通过 Composer Create-Project](#通过-composer-create-project)
      * [Git安装](#git安装)
      * [测试](#测试)
   * [目录结构](#目录结构)
   * [入口文件](#入口文件)
   * [应用目录](#应用目录)
      * [系统核心常量](#系统核心常量)
   * [核心](#核心)
      * [路由](#路由)
         * [基本路由](#基本路由)
            * [为多重动作注册路由](#为多重动作注册路由)
         * [基础路由参数](#基础路由参数)
         * [可选的路由参数](#可选的路由参数)
         * [正则表达式限制参数](#正则表达式限制参数)
            * [全局限制](#全局限制)
      * [命名路由](#命名路由)
         * [路由群组和命名路由](#路由群组和命名路由)
         * [对命名路由生成 URLs](#对命名路由生成-urls)
      * [路由群组](#路由群组)
         * [中间件](#中间件)
         * [命名空间](#命名空间)
         * [路由前缀](#路由前缀)
      * [RESTful 资源控制器](#restful-资源控制器)
         * [由资源控制器处理的行为](#由资源控制器处理的行为)
         * [部分资源路由](#部分资源路由)
         * [命名资源路由](#命名资源路由)
         * [嵌套资源](#嵌套资源)
         * [附加资源控制器](#附加资源控制器)
      * [隐式控制器](#隐式控制器)
         * [分派路由名称](#分派路由名称)
      * [路由缓存](#路由缓存)
      * [URI](#uri)
      * [添加 URL 后缀](#添加-url-后缀)
   * [cli命令行模式](#cli命令行模式)
      * [实现代码提示、跟踪和自动补全](#实现代码提示跟踪和自动补全)
   * [中间件](#中间件-1)
      * [创建一个中间件](#创建一个中间件)
      * [调用](#调用)
      * [规则](#规则)
   * [依赖注入](#依赖注入)
   * [配置](#配置)
      * [读取配置](#读取配置)
      * [动态配置](#动态配置)
      * [批量设置：](#批量设置)
      * [加载配置文件](#加载配置文件)
   * [视图](#视图)
      * [配置](#配置-1)
         * [加载视图](#加载视图)
         * [给视图添加动态数据](#给视图添加动态数据)
         * [视图缓存](#视图缓存)
   * [模版](#模版)
      * [模版继承](#模版继承)
         * [控制器中调用](#控制器中调用)
         * [定义页面布局layout.php](#定义页面布局layoutphp)
         * [继承页面布局 index.php](#继承页面布局-indexphp)
         * [test.php](#testphp)
         * [最后解析成：](#最后解析成)
      * [变量输出](#变量输出)
      * [输出函数返回值](#输出函数返回值)
      * [运算符](#运算符)
      * [包含文件](#包含文件)
      * [赋值](#赋值)
         * [将函数赋值](#将函数赋值)
      * [判断](#判断)
      * [循环](#循环)
         * [for](#for)
         * [while](#while)
      * [使用php代码](#使用php代码)
      * [自定义标签](#自定义标签)
         * [使用](#使用)
         * [在模版中调用](#在模版中调用)
      * [表单](#表单)
         * [实例：](#实例)
         * [开启表单](#开启表单)
         * [CSRF 保护](#csrf-保护)
         * [标签（Label）](#标签label)
         * [文字字段](#文字字段)
         * [多行文本域](#多行文本域)
         * [密码字段](#密码字段)
         * [隐藏域](#隐藏域)
         * [复选框、单选按钮](#复选框单选按钮)
         * [下拉框](#下拉框)
         * [按钮](#按钮)
   * [模型](#模型)
      * [数据库配置](#数据库配置)
      * [模型定义](#模型定义)
      * [模型实例化](#模型实例化)
         * [M(['模型名']);](#m模型名)
      * [CURL](#curl)
         * [Active Record 模式](#active-record-模式)
            * [删除数据DELETE](#删除数据delete)
            * [修改数据](#修改数据)
            * [查询数据](#查询数据)
      * [事务](#事务)
      * [错误调试](#错误调试)
      * [数据缓存](#数据缓存)
      * [数据库缓存](#数据库缓存)
          * [在配置文件中配置数据库相关配置](#在配置文件中配置数据库相关配置)
      * [使用多数据库连接](#使用多数据库连接)
      * [数据预处理——访问器和修改器](#数据预处理访问器和修改器)
          * [定义一个访问器](#定义一个访问器)
          * [定义一个修改器](#定义一个修改器)
   * [表单验证](#表单验证)
   * [系统函数](#系统函数)
   * [创造自己的类库](#创造自己的类库)
      * [loadClass($className)以单例模式实例化类](#loadclassclassname以单例模式实例化类)
   * [系统类库(YrPHP/Libs)](#系统类库yrphplibs)
      * [加密类     Crypt](#加密类-----crypt)
          * [配置密钥](#配置密钥)
          * [加密解密](#加密解密)
      * [数组类](#数组类)
      * [文件处理类 File](#文件处理类-file)
      * [文件上传类 Uoload](#文件上传类-uoload)
          * [上传配置设置](#上传配置设置)
          * [init($config)参数初始化](#initconfig参数初始化)
          * [uploadFile($field)文件上传](#uploadfilefield文件上传)
          * [getFileInfo($inputName=null);获得上传文件相关属性](#getfileinfoinputnamenull获得上传文件相关属性)
          * [getError($errorCode = null)](#geterrorerrorcode--null)
      * [图像处理类 Image](#图像处理类-image)
      * [CURL类     Curl](#curl类-----curl)
      * [验证码类   VerifyCode](#验证码类---verifycode)
      * [分页类](#分页类)
      * [验证类     Validate](#验证类-----validate)
      * [购物车类   Cart](#购物车类---cart)
      * [Email 类   PHPMailer](#email-类---phpmailer)

# 简介

yrPHP运用大量的单例及工厂模式，确保用最少的资源做最多的事，采用了composer自动加载，无需手动加载类库文件，还集成了缓存技术及页面静态化技术，确保运行速度及响应速度

# 安装YrPHP

#### 通过 Composer Create-Project

```
composer create-project kwin/yrphp yrphp
```

#### Git安装

> YrPHP拆分为多个仓库，主要包括：
>
> 之所以设计为应用和核心仓库分离，是为了支持`Composer`单独更新核心框架。

应用项目：https://github.com/kwinH/YrPHP
核心框架：https://github.com/kwinH/YrPHP-Core

首先克隆下载应用项目仓库

```
git clone https://github.com/kwinH/YrPHP blog
```

然后切换到`blog`目录下面，再克隆核心框架仓库：

```
git clone https://github.com/kwinH/YrPHP-Core YrPHP
```

#### 测试

```
php -S localhost:8000 -t blog
```

在浏览器中输入地址：

```
http://localhost:8000
```

会自动生成以下目录结构

至此，YrPHP已经安装成功。

# 目录结构

```
├─index.php       入口文件
├─README.md       README文件
├─App     应用目录
├─public          资源文件目录
└─YrPHP           框架目录
│  ├─Common      核心公共函数目录
│  ├─Config      核心配置目录
│  ├─Lang        核心语言包目录
│  ├─Libs        框架类库目录
│  ├─resource    核心资源文件目录

```

# 入口文件
index.php
```php
    <?php
    //是否开启调试模式,默认不开启
    define('DEBUG',true);
    //定义项目目录
    define("APP", 'App');
    //框架入口文件
    include 'App.php';
```

> 注意：APP的定义必须是当前目录下的文件名,不需要标明路径
> 系统会在第一次调用时 自动生成项目目录结构

# 应用目录

```
├─index.php       入口文件

├─App     应用目录
│  ├─Controls    默认控制器目录
│  ├─Models      默认模型目录
│  ├─views      默认视图目录
│  ├─Common      自定义公共函数目录
│  ├─Config      自定义配置目录
│  ├─Lang        自定义语言包目录
│  ├─Libs        自定义类库目录
│  ├─Runtime    缓存目录
.
.
.
```

### 系统核心常量

| 常量      | 描述                           |
| --------- | ------------------------------ |
| ROOT_PATH | 项目根路径绝对路径             |
| BASE_PATH | 框架目录绝对路径               |
| APP_PATH  | 用户项目目录绝对路径           |
| CORE_PATH | 框架核心类库目录绝对路径       |
| LIBS_PATH | 框架集成常用类库目录绝对路径   |
| APP_MODE  | 应用模式                       |
| DEBUG     | 是否开启调试模式 （默认false） |

# 核心

## 路由

### 基本路由

你可以在 `Config/routes.php` 文件中定义应用程序的大多数路由，最基本的YrPHP 路由仅接受 URI 和一个`闭包`：

```PHP
Route::get('/', function () {
    return 'Hello World';
});

Route::post('foo/bar', function () {
    return 'Hello World';
});

Route::put('foo/bar', function () {
    //
});

Route::delete('foo/bar', function () {
    //
});
```

#### 为多重动作注册路由

有时候你可能需要注册一个可响应多个 HTTP 动作的路由。这时可通过 `Route` 的 `match` 方法来实现：

```php
Route::match(['get', 'post'], '/', function () {
    return 'Hello World';
});
```

或者，你甚至可以通过 `any` 方法来使用注册路由并响应所有的 HTTP 动作：

```php
Route::any('foo', function () {
    return 'Hello World';
});
```

### 基础路由参数

有时候你可能需要从 URI 中获取一些参数。例如，从 URL 获取用户的 ID。这时可通过自定义路由参数来获取：

```PHP
Route::get('user/{id}', function ($id) {
    return 'User '.$id;
});
```

你可以依照路由需要，定义任意数量的路由参数：

```PHP
Route::get('posts/{post}/comments/{comment}', function ($postId, $commentId) {
    //
});
```

路由的参数都会被放在「大括号」内。当运行路由时，参数会通过路由`闭包`来传递。

### 可选的路由参数

有时候你需要指定路由参数的默认值，可以在参数名称后面加上 `='value'` 来实现：

```PHP
//return "kwin"
Route::get('user/{name=kwin}', function ($name) {
    return $name;
});

```

### 正则表达式限制参数

你可以使用 `pattern` 参数来限制路由参数格式。`pattern`  参数为一个数组，以名称为key，以定义参数应该如何被限制的正则表达式为value：

```php
Route::get('user/{name}', [
  	'pattern'=>['name'=>'[A-Za-z]+']
    'uses'=>function ($name) {
    //
}
]);

Route::get('user/{id}', [
  	'pattern'=>['id'=>'[0-9]+']
    'uses'=>function ($id) {
    //
}
]);

Route::get('user/{id}/{name}', [
  	'pattern'=>['id'=>'[0-9]+', 'name' => '[a-z]+']]
    'uses'=>function ($id, $name) {
    //
}
]);

```

#### 全局限制

如果你希望路由参数可以总是遵循正则表达式，则可以使用 `pattern` 方法。

模式一旦被定义，便会自动应用到所有后续使用该参数名称的路由上：

```php
Route::pattern('id', '[0-9]+');
Route::get('user/{id}', function ($id) {
    // Only called if {id} is numeric.
});
```

## 命名路由

命名路由让你可以更方便的为特定路由生成 URL 或进行重定向。你可以使用 `as` 数组键指定名称到路由上：

```PHP
Route::get('user/profile', [
  'as' => 'profile', 
  'uses' => function () {
    //
}
]);
```

还可以指定路由名称到控制器动作：

```PHP
Route::get('user/profile', [
    'as' => 'profile',
    'uses' => 'UserController@showProfile'
]);
```

#### 路由群组和命名路由

如果你使用了 [路由群组]，那么你可以在路由群组的属性数组中指定一个 `as` 关键字，这将允许你为路由群组中的所有路由设置相同的前缀名称：

```PHP
Route::group(['as' => 'admin::'], function () {
    Route::get('dashboard', [
    'as' => 'dashboard', 
    'uses' => function () {
        // 路由名称为「admin::dashboard」
    }]);
});
```

#### 对命名路由生成 URLs

一旦你在指定的路由中分配了名称，则可通过 `route` 函数来使用路由名称生成 URLs 或重定位：

```php
$url = Route::url('profile');
```

如果路由定义了参数，那么你可以把参数作为第二个参数传递给 `route` 方法。指定的参数将自动加入到 URL 中：

```php
Route::get('user/{id}/profile', [
  'as' => 'profile', 
  'uses' =>function ($id) {
    //
}
]);

$url = Route::rul('profile', ['id' => 1]);
```

## 路由群组

路由群组允许你共用路由属性，例如：中间件、命名空间，你可以利用路由群组统一为多个路由设置共同属性，而不需在每个路由上都设置一次。共用属性被指定为数组格式，当作 `Route::group` 方法的第一个参数。

为了了解更多路由群组的相关内容，我们可通过几个常用样例来熟悉这些特性。

### 中间件

指定中间件到所有群组内的路由中，则可以在群组属性数组里使用 `middleware` 参数。中间件将会依照列表内指定的顺序运行：

```php
Route::group(['middleware' => 'auth'], function () {
    Route::get('/', function ()    {
        // 使用 Auth 中间件
    });

Route::get('user/profile', function () {
        // 使用 Auth 中间件
    });
});
```

### 命名空间

另一个常见的例子是，指定相同的 PHP 命名空间给控制器群组。可以使用 `namespace` 参数来指定群组内所有控制器的命名空间：

```PHP
Route::group(['namespace' => 'Admin'], function()
{
    // 控制器在「App\Controllers\Admin」命名空间

Route::group(['namespace' => 'User'], function()
    {
        // 控制器在「App\Controllers\Admin\User」命名空间
    });
});
```

请记住，默认你不用指定完整的`App\Controllers` 命名空间前缀就能注册控制器路由。所以，我们只需要指定在基底 `App\Controllers`根命名空间之后的部分命名空间。

### 路由前缀

通过路由群组数组属性中的 `prefix`，在路由群组内为每个路由指定的 URI 加上前缀。例如，你可能想要在路由群组中将所有的路由 URIs 加上前缀 `admin`：

```php
Route::group(['prefix' => 'admin'], function () {
    Route::get('users', function ()    {
        // 符合「/admin/users」URL
    });
});
```

你也可以使用 `prefix` 参数去指定路由群组中共用的参数：

```php
Route::group(['prefix' => 'accounts/{account_id}'], function () {
    Route::get('detail', function ($account_id)    {
        // 符合 accounts/{account_id}/detail URL
    });
});
```

## RESTful 资源控制器

```php
Route::resource('photos', 'PhotosController');
```

这一条路由声明会创建多个路由，用来处理各式各样和相片资源相关的的 RESTful 行为。同样地，生成的控制器有着各种和这些行为绑定的方法，包含要处理的 URI 及方法对应的注释。

#### 由资源控制器处理的行为

| 动词      | 路径                   | 行为（方法） | 路由名称      |
| --------- | ---------------------- | ------------ | ------------- |
| GET       | `/photos`              | index        | photos.index  |
| GET       | `/photos/create`       | create       | photos.create |
| POST      | `/photos`              | save         | photos.save   |
| GET       | `/photos/{photo}`      | show         | photos.show   |
| GET       | `/photos/{photo}/edit` | edit         | photos.edit   |
| PUT/PATCH | `/photos/{photo}`      | update       | photos.update |
| DELETE    | `/photos/{photo}`      | delete       | photos.delete |

#### 部分资源路由

声明资源路由时，你可以指定让此路由仅处理一部分的行为：

```php
Route::resource('photos', 'PhotosController',
                ['only' => ['index', 'show']]);

Route::resource('photos', 'PhotosController',
                ['except' => ['create', 'store', 'update', 'destroy']]);
```

#### 命名资源路由

所有的资源控制器行为默认都有路由名称；不过你可以在选项中传递一个 `names` 数组来重写这些名称：

```PHP
Route::resource('photos', 'PhotosController',
                ['names' => ['create' => 'photo.build']]);
```

#### 嵌套资源

有时你可能会需要定义「嵌套」资源路由。例如，相片资源可能会附带多个「评论」。要「嵌套」此资源控制器，可在路由声明中使用「点」记号：

```PHP
Route::resource('photos.comments', 'PhotoCommentController');
```

此路由会注册一个「嵌套」资源，可通过类似的 URL 来访问它：`photos/{photos}/comments/{comments}`。

```php
<?php

namespace App\Controllers;

use YrPHP\Controller;

class PhotoCommentController extends Controller
{
    /**
     * 显示指定相片的评论。
     *
     * @param  int  $photoId
     * @param  int  $commentId
     * @return Response
     */
    public function show($photoId, $commentId)
    {
        //
    }
}
```

#### 附加资源控制器

如果想在资源控制器中默认的资源路由之外加入其它额外路由，则应该在调用 `Route::resource` **之前** 定义这些路由。否则，由 `resource` 方法定义的路由可能会不小心覆盖你附加的路由：

```php
Route::get('photos/popular', 'PhotosController@method');

Route::resource('photos', 'PhotosController');
```

## 隐式控制器

YrPHP让你能够轻易地通过定义单个路由来处理控制器类中的各种行为。首先，使用 `Route::controller` 方法来定义路由。`controller` 方法接受两个参数。第一个参数是控制器所处理的基本 URI，第二个是控制器的类名称：

```PHP
Route::controller('users', 'UserController');
```

接下来，只要在控制器中加入方法。方法的名称应由它们所响应的 HTTP 动词作为开头，紧跟着首字母大写的 URI 所组成：

```PHP
<?php

namespace App\Controllers;

use YrPHP\Controller;

class UserController extends Controller
{
    /**
     * 响应对 GET /users 的请求
     * 响应对 GET /users/index 的请求（PS:当有参数时必须带上`/index`）
     */
    public function getIndex()
    {
        //
    }

/**
     * 响应对 GET /users/info/1 的请求
     * 		 GET /users/info 默认$id为1
     */
    public function getInfo($id=1)
    {
        //
    }

/**
     * 响应对 POST /users/info 的请求
     */
    public function postInfo()
    {
        //
    }
  
     /**
     * 响应对 put /users/info/1 的请求
     */
    public function putInfo($id)
    {
        //
    }

/**
     * 响应对 patch /users/info/1 的请求
     */
    public function patchInfo($id)
    {
        //
    }
  
     /**
     * 响应对 DETELE /users/info/1 的请求
     */
    public function deleteInfo($id)
    {
        //
    }
  
     /**
     * 响应对 GET /users/info 的请求
     * 响应对 GET /users/info/1 的请求
     * 响应对 POST /users/info/1 的请求
     * 响应对 put /users/info/1 的请求
     * 响应对 patch /users/info/1 的请求
     * 响应对 delete /users/info/1 的请求
     */
    public function anyInfo($id=null)
    {
        //
    }
}
```

正如你在上述例子中所看到的，`index` 方法会响应控制器所处理的根 URI，在这个例子中是 `users`。

> YrPHP的Route会从上至下解析，直到找到方法就不会继续解析其他方法，所以要注意方法的顺序。

#### 分派路由名称

如果你想要 `命名` 控制器中的某些路由，你可以在 `controller` 方法中传入一个名称数组作为第三个参数：

```PHP
Route::controller('users', 'UserController', [
    'getShow' => 'user.show',
]);
```

## 路由缓存

若你的应用程序完全通过控制器使用路由，你可以利用 YrPHP的路由缓存。使用路由缓存可以大幅降低注册全部路由所需的时间。在某些情况下，你的路由注册甚至可以快上一百倍！要生成路由缓存，只要运行 `route cache` 此 Artisan 命令：

```
php artisan route cache
```

这就可以了！现在你的缓存路由文件将被用来代替 `Config/routes.php` 这一文件。请记得，若你添加了任何新的路由，就必须生成新的路由缓存。因此你可能希望只在你的项目部署时才运行 `route cache` 这一命令。

要移除缓存路由文件而不生成新的缓存，请使用 `route clear` 命令：

```
php artisan route clear
```

## URI

####获得URL
>getUrl($url,$indexPage);//如果参数为空 则返回现在所在所在的根目录如`http://example.com/index.php/news/index/id`
>则返回 `http://example.com/`
>否则返回拼接后的URL
>`/**`
>`* @param string $url URL表达式，格式：'[模块/控制器/操作#锚点@域名]?参数1=值1&参数2=值2...'`
>`* @param bool|true $indexPage 如果是REWRITE重写模式 可以不必理会 否则默认显示index.php`
>`* @return string`
>`*/`

默认情况下，index.php 文件将被包含在你的 URL 中：
   example.com/index.php/news/article/my_article

你可以很容易的通过 .htaccess 文件来设置一些简单的规则删除它。下面是一个例子，使用“negative”方法将非指定内容进行重定向：

```
RewriteEngine on

RewriteCond %{REQUEST_FILENAME} !-f

RewriteRule .* index.php
```

在上面的例子中，可以实现任何非 index.php、images 和 robots.txt 的 HTTP 请求都被指向 index.php。

## 添加 URL 后缀

通过设置 config/config.php 文件，你可以为 yrphp 生成的 URL 添加一个指定的文件后缀。举例来说，如果 URL 是这样的：

***example.com/index.php/products/view/shoes***

你可以随意添加一个后缀，例如 .html，使其显示为：

example.com/index.php/products/view/shoes.html

你只需修改config/config.php 文件中

```php
$config['urlSuffix'] = '.html';
```

#  cli命令行模式

## 实现代码提示、跟踪和自动补全

```shell
$ php artisan ide-help generate
```

> 参数必须是3个及以上，artisan是入口文件，ide-help是config/commands.php中类的key值（也可以说是类别名），也可以是控制器名（多目录用`/`分开）。generate是方法名，其他参数都做为调用的方法的参数

# 中间件

HTTP 中间件提供了一个方便的机制来过滤进入应用程序的 HTTP 请求，在一个请求真正处理前，我们可能会对请求做各种各样的判断，然后才可以让它继续传递到更深层次中。

## 创建一个中间件

> 中间件一般放在App/Middleware目录下，如下就要一个名为App/Middleware/Auth.php的中间件，该中间件实现了如果用户还没登录，则跳转到登录页面，否则调用`$next($request)`继续执行（相当于允许通过中间件）

```php
<?php
/**
 * Project: YrPHP.
 * Author: Kwin
 * QQ:284843370
 * Email:kwinwong@hotmail.com
 */
namespace App\Middleware;

use Closure;
use Response;
use YrPHP\IMiddleware;
use YrPHP\Request;

class Auth implements IMiddleware
{
    public function handler(Request $request, Closure $next)
    {
        if (!session('admin')) {
            Response::errorBackTo('您还没有登录，请先登录', '/admin/manager/login');
        }

$next($request);
    }
}
```

## 调用

1、你可以在App/Config/config.php文件中配置

```php
<?php 
//.....
    /*--------------------以下是全局中间件配置---------------------------------------*/
    'middleware' => [
        //在实例化控制器之前
        'before' => [
            YrPHP\Middleware\VerifyCsrfToken::class,
        ],
        //在实例化控制器实例化之后，未调用方法之前
        'middle' => [

],
        //调用方法之后
        'after' => [

],
    ],

//....
```

2、也可以在控制器中单独调用

```php
<?php
/**
 * Created by PhpStorm.
 * User: TOYOTA
 * Date: 2017/3/16 0016
 * Time: 14:05
 */

namespace App\Controllers\Admin;

use YrPHP\Controller;
class User extends Controller
{
    function __construct()
    {
        parent::__construct();
        $this->middleware('Auth',['except'=>['login']]);
    }
  
  	//....
  
    }
```

> middleware(\$middleware, array \$options = []) \$middleware参数为中间件名，\$options 为过滤条件，['except'=>['login']]代表调用login方法不调用该中间件，其他都要调用该中间件，['only'=>['content']]代表仅调用content方法时调用该中间件，其他都不要调用该中间件。

#控制器

例子：创造一个控制器
在APP目录下的controls目录下创建一个名为:
Test.class.php的文件

```php
<?php
use YrPHP\Controller;

class Test extends Controller
{
    function __construct()
    {
        parent::__construct();
    }

function  index()
    {
      echo "Hello World";
    }
```

接着我们用浏览器打开 example.com/index.php/test
就可以看到 Hello World

##命名空间
```php
use YrPHP\Controller;
```

表示引入 YrPHP\Controller 命名空间便于直接使用。所以，

```php
use YrPHP\Controller;

class Test extends Controller
```

等同于使用：

```php
class Test extends YrPHP\Controller
```

## 规则
1. 文件名必须是：***类名***.class.php
2. ***类名首字母必须大写***
3. 必须继承Controller类，可以重写Controller类（这在扩展中再说）

# 依赖注入
```php
<?php
use YrPHP\Controller;

class Test extends Controller
{
    function __construct()
    {
        parent::__construct();
    }

function  index(Request $request,$id,$name)
    {
      $data=$request->get();
      var_export($data);
      echo $id.$name;
    }
```
>当调用控制器时会自动填充参数，如上$request为Request类，$id为URL多于字段的第一个，$name为多于字段第二个，以此类推
>如访问example.com//test/index/1/kwin?s=2&page=3 $data=['s'=>2,'page'=>3],$id=1,$name='kwin'

# 配置

默认的配置文件在BASE_PATH/config/config.php
如需修改相关配置

如果设置了***APP_MODE***
则在APP_PATH/config***_APP_MODE***.php中修改相关配置
否则
在APP_PATH/config_APP.php中修改相关配置

yrPHP框架中所有配置文件的定义格式均采用返回**PHP数组**的方式，格式为：
```php
 //项目配置文件
return [
  'urlType'  => '2', //URL访问模式
   'defaultCtl' => 'Index', // 默认控制器名称
   //更多配置参数
   //...
  ];
```

## 读取配置

无论何种配置文件，定义了配置文件之后，都统一使用系统提供的C方法（可以借助Config单词来帮助记忆）来读取已有的配置。

获取已经设置的参数值：**C('参数名称')**

> 除config.php文件外，其他文件可以用C('fileName.param')获取

```php
$charset = C('charset');//获得配置中的编码格式 =>YrPHP\Config::get('charset');两者等同
```

如果`charset`尚未存在设置，则返回NULL。

> 支持设置默认值例如：

```php
C('my_config','default_config');
```

>如果不传参数 则返回所有配置信息

```php
$config = C();//return array;
```

## 动态配置

>设置新的值 如果存在则覆盖，否则新建：

```php
YrPHP\Config::set('参数名称','新的参数值');

YrPHP\Config::set("openCache",false);//关闭数据库缓存，只在该次请求有效
```

## 批量设置：

```php
YrPHP\Config::set(array(key=>value,key1=>value1));
```

## 加载配置文件
```php
YrPHP\Config::load('config_test');//=>APP_PATH . 'config/config_test.php'
```

# 视图

## 配置
```php
'modelDir' =>  "Models", //设置模型目录位置

/--------------------以下是模版配置---------------------------------------/

'setTemplateDir' => APP_PATH . "views/", //设置模板目录位置

'setCompileDir' => APP_PATH . "runtime/compile_tpl/", //设置模板被编译成PHP文件后的文件位置

'auto_literal' => false, //忽略限定符周边的空白

'caching' => 1, //缓存开关 1开启，0为关闭

'setCacheDir' => (APP_PATH . "runtime/cache/"), //设置缓存的目录

'cacheLifetime' => 60 * 60 * 24 * 7, //设置缓存的时间 0表示永久

'leftDelimiter' => "{", //模板文件中使用的“左”分隔符号

'rightDelimiter' => "}", //模板文件中使用的“右”分隔符号

```

### 加载视图
display($fileName, $tplVars = '', $cacheId = '');

>$fileName 提供模板文件的文件名
>$tpl_var 动态数据
>$cacheId 当$cacheId为false时，不会生成缓存文件，其他情况做为缓存ID,当有个文件有多个缓存时，$cacheId不能为空，否则会重复覆盖

```php
return \view::display('name');
```

>上面的 <var>name</var> 便是你的视图文件的名字 如 index.html。

### 给视图添加动态数据
```php
\view::assign('name','yrPHP');//赋值单个数据

//等同于

return \view::display('name',array('name'=>'yrPHP'));
```

### 视图缓存
>以下参数可用于视图缓存

```php
protected $caching = true;   //bool 设置缓存是否开启 配置中可设置

protected $cacheLifeTime = 3600;  //定义缓存时间 配置中可设置

protected $cacheDir;      //定义生成的缓存文件路径 配置中可设置

protected $cacheSubDir;   //定义生成的缓存文件的子目录默认为控制器名

protected $cacheFileName; //定义生成的缓存文件名 默认为方法名

private $cacheFile;      //最后形成的缓存完整路径 根据前面参数生成
```

# 模版
## 模版继承

#### 控制器中调用

```
<?php
/**
 * Created by YrPHP.
 * User: Kwin
 * QQ:284843370
 * Email:kwinwong@hotmail.com
 */
namespace App\Controllers;

use YrPHP\Controller;

class Index extends Controller
{
    function __construct()
    {
        parent::__construct();

}

function index()
    {
        $m = M('users');
        $all =$m->all();
       return \view::display('index',['data'=>$all]);

}
}
```

#### 定义页面布局layout.php

```php
<!doctype html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport"
          content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Document</title>
</head>
<body>

{yield body}

</body>
</html>
```

#### 继承页面布局 index.php

```php
{extends layout}

{section body}
{require test}
{endsection}

{section test}
123456
{endsection}
```

>由于layout中没有test内容区块 所以section test中的内容不会显示

####  test.php

```php
<h1>hello world</h1>

<div>
    {foreach($data as $k=>$v)}
    {=$v->userName}
    {/foreach}
</div>
```

#### 最后解析成：

<div>
    <?php foreach($data as $k=>$v){?>
    <?php echo $v->userName;?>
    <?php } ?>
</div>

</body>
</html>
```

## 变量输出

在模板中输出变量的方法很简单，例如，在控制器中我们给模板变量赋值：

```php
{=$test}
```

模板编译后的结果就是：

```php
<?php echo $test;?>
```

## 输出函数返回值

```php
{=getUrl('public/css/style.css')}
```

>注意模板标签的`{`和`=`之间不能有任何的空格，否则标签无效。

## 运算符
```php
{$i++}

{$i--}

{--$i}

{++$i}

```

## 包含文件
```php
{include header.html}

{require footer.html}
```

## 赋值

```php
{assign $name='yrPHP'}

{$name}
```

>注意模板标签的`assign`和`$`之间必须有空格，否则标签无效。

#### 将函数赋值
```php
{assign $config = C()}
```

## 判断
```php
{assign $i=10}

{if($i>=90)}

优秀

{elseif($i>=80)}

良

{else if( $i >= 60 )}

及格

{else}

不及格

{/if}

```

## 循环
####foreach
```php
{assign $config = C()}

{foreach (config as k=>$v)}

<tr>
{if ($k=='openCache')}
{break}
{/if}
<td>{=$k}</td>
<td>{=$v}---</td>
</tr>

{/foreach}

```

### for
```php
{for(i=0;i<10;$i++)}

{if($i==5)}

{continue}

{/if}

{=$i}

<br/>

{/for}
```

### while
```php
{assign $i=10}

{while($i)}

{=$i}

</br>

{$i--}

{/while}

```

## 使用php代码
```php
<?php echo "Hello World";?>
```

## 自定义标签
####在配置文件tabLib.php文件中自定义标签
```php
/*

系统将自动添加定界符，其他同正则表达式

如下 在模版中调用方式为 {=dump $a}

return array(

'=dump\s(.)\s*' => "<?php var_dump( \1);?>",

);
```

#### 使用
```php
<?php

use YrPHP\Controller;

class MyController extends Controller

{

function __construct()
{
    parent::__construct();
}

function index()
{

$data['arr'] = array(1,2,3,4,5,6);

return \view::display('index.html',$data);

}

```

#### 在模版中调用
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>TEST</title>
</head>

</html>
```

## 表单

#### 实例：

```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>TEST</title>
</head>

<body>
{=form::open(['url' => 'index.php', 'method' => 'get', 'class' => 'form', 'id' => 'form-article'], $data)}
{=form::text('name', ['class'=>'input-text'],'默认值')}
{=form::password('password', ['class'=>'input-text'])}
{=form::submit('提交')}
{=form::close()}
</body>

</html>
```

#### 开启表单

```
{=form::open(['url' => 'index.php', 'method' => 'get', 'class' => 'form', 'id' => 'form-article'], $data)}

{=form::close()}
```

默认表单使用 POST 方法，当然您也可以指定传参其他表单的方法

当填写第二个参数$data（模型）时，当您产生表单元素时，如 text 字段，模型的值将会自动比对到字段名称，并设定此字段值，举例来说，用户模型的 `email` 属性，将会设定到名称为 `email` 的 text 字段的字段值，不仅如此，当 Session 中有与字段名称相符的名称， Session 的值将会优先于模型的值，而优先顺序如下：

1. Session 的数据 (旧的输入值)
2. 明确传递的数据
3. 模型属性数据

这样可以允许您快速地建立表单，不仅是绑定模型数据，也可以在服务器端数据验证错误时，轻松的回填用户输入的旧数据！

#### CSRF 保护

YrPHP提供了一个简易的方法，让您可以保护您的应用程序不受到 CSRF (跨网站请求伪造) 攻击。首先YrPHP会自动在用户的 session中放置随机的token，别担心这些会自动完成。如果你调用了=form::open方法，这个 CSRF 参数会用隐藏字段的方式自动加到您的表单中。另外，您也可以使用 token 方法去产生这个隐藏的 CSRF 字段的 HTML 标签：

```
{=form::token()}
```

#### 标签（Label）

```
{=form::label('name', '姓名', array('class' => 'name'))}
```

> **注意：** 在建立标签时，任何您建立的表单元素名称与标签相符时，将会自动在 ID 属性建立与标签名称相同的 ID。

#### 文字字段

```
{=form::text('name', array('class' => 'input-text'), '默认值')}
```
> 默认ID为字段名，如上如果没有在第二个参数中指定ID，则ID为name

#### 多行文本域

```
{=form::textarea('desc', array('class' => 'input-text','size'=>50,10), '默认值')}
```
>size 50为cols,10为rows，cols和rows默认就是50*10

#### 密码字段

```
{=form::password('name', array('class' => 'input-text'))}
```

#### 隐藏域

```
{=form::hidden('name', '默认值' , array('class' => 'input-text'))}
```

#### 复选框、单选按钮

```
{=form::checkbox('name', 'value',array('class' => 'input-checkbox'),true)}
{=form::radio('name', 'value',array('class' => 'input-radio'),true)}
```
>第四个参数为是否默认选中

#### 下拉框

```
{=form::select($name, $list = [], $options = ['class'=>'input-select'], $selected = null)}
```

#### 按钮

```
{=form::reset('name',['class'=>'button'])}
{=form::submit('name',['class'=>'button'])}
{=form::button('name',['class'=>'button'])}
```

# 模型

## 数据库配置

```php
<?php

/**

- Created by YrPHP.
- User: Kwin
- QQ:284843370
- Email:kwinwong@hotmail.com
    */

//数据库配置例子 请将该文件复制到你的项目下的config文件夹下 不允许直接在该文件下配置

return [
'defaultConnection' => 'default',
  'default' => [
    //主服务器
    'masterServer' => [
        'dsn' => 'mysql:host=localhost;dbname=huobucuo',
        'dbDriver' => 'pdo', // 数据库类型
        'dbType' => 'mysql', // 数据库类型
        'dbHost' => 'localhost', // 服务器地址
        'dbName' => 'test', // 数据库名
        'dbUser' => 'root', // 用户名
        'dbPwd' => 'root', // 密码
        'dbPort' => '3306', // 端口
        'tablePrefix' => 'drp_', // 数据库表前缀
        'charset' => 'utf8',
    ],
    //从服务器可以配置多个,也可以不配置，不做读写分离
    /*
    'slaveServer'  => [
        [
            'dsn'         => '',
            'dbDriver'    => 'pdo', // 数据库类型
            'dbType'      => 'mysql', // 数据库类型
            'dbHost'      => '', // 服务器地址
            'dbName'      => '', // 数据库名
            'dbUser'      => '', // 用户名
            'dbPwd'       => '', // 密码
            'dbPort'      => '3306', // 端口
            'charset'     => 'utf8',
        ],
        [
            'dsn'         => '',
            'dbDriver'    => 'pdo', // 数据库类型
            'dbType'      => 'mysql', // 数据库类型
            'dbHost'      => '', // 服务器地址
            'dbName'      => '', // 数据库名
            'dbUser'      => '', // 用户名
            'dbPwd'       => '', // 密码
            'dbPort'      => '3306', // 端口
            'charset'     => 'utf8',
        ],
    ],
    */
]
  ];
```

>数据库配置模版文件在BASE_PATH/config/database.php
>如需修改相关配置
>
>如果设置了***APP_MODE***
>则在APP_PATH/database**__APP_MODE**.php中修改相关配置
>否则
>在APP_PATH/database.php中修改相关配置

## 模型定义

> 模型类并非必须定义，只有当存在独立的业务逻辑或者属性的时候才需要定义。
> 文件名为**模型名.class.php**  UserModel的文件名为**UserModel.class.php**

模型类通常需要继承系统的YrPHP\Model类或其子类，下面是一个Model\UserModel类的定义：

```php
<?php
namespace App\Model;
use YrPHP\Model;

class UserModel extends Model
{

public function __construct()
    {
        parent::__construct('users');
  }

}
```

## 模型实例化

##### M(['模型名']);
>模型名是为选填 如果为空则实例化父类。

```php
M('UserModel');//实例化UserModel模型
```

>实例化请确保参数确定 区分大小写
>如果模型UserModel不存在，则实例化父类 表为user_model

## CURL
### Active Record 模式

####添加数据INSERT
> **$this->insert([添加的数据]);**

```php
namespace App\Model;
use YrPHP\Model;
class UserModel extends Model
{
    public function __construct()
    {
        parent::__construct('users');//操作users表
  }

public function userInsert()
    {
      return $this->insert(['name'=>'kwin','age'=>'18']);
       //return int 受影响行数
  }
  
  
      public function userInserts()
    {
      return $this->inserts([
        ['name'=>'kwin','age'=>'18'],
        ['name'=>'nathan','age'=>'26']
      ]);
       //return int 受影响行数
  }
}
```
>添加的数据如果为空,则获取$_POST数据，默认开启验证，如果字段数据库不存在 则过滤
>如果有临时关闭则 $this->setOptions(array('_validate'=>false));
>
>inserts支付批量添加

------------

#### 删除数据DELETE

> **$this->delete(条件);**

**在自定义模型在调用**
```php
<?php
namespace App\Model;
use YrPHP\Model;
class UserModel extends Model
{

public function __construct()
    {
        parent::__construct('users');
  }

public function userDelete()
    {
     return $this->delete(['id <'=>3]);
     //return int 受影响行数
  }
}
```
>条件为array|string 推荐array

------------

***在控制器在调用***
```php
    <?php
    use core\Controller;
    
    class Users extends Controller
    {
        function __construct()
        {
            parent::__construct();
        }
    
       //直接调用父类model，操作users表
        function  model()
        {
         $db = M('users');
         $db->delete([是否自动添加前缀bool]);
    
        }
       //实例化刚才创建的模型，操作其方法
        function  userModel()
        {
         $db = M('UserModel');
         $db->userDelete();
        }
```

#### 修改数据
```php
$this->update(array 数据，array 条件);
//return int 受影响行数
```
>条件为array|string 推荐array

#### 查询数据

**FIND**
>**find($id = 0, $assoc = false)
>string|int $id 查询的条件主键值
>bool|false $assoc 当该参数为 TRUE 时，将返回 array 而非 object
>以主键为条件 查询

------------
```php
$db = M('users');
$db->find(1);
//生成的SQL语句
//select * from `users` where id=1;
```

**ALL**
>**all($assoc = false, $tableName = "", $auto = true)
>bool|false $assoc 当该参数为 TRUE 时，将返回 array 而非 object
>以主键为条件 查询

------------
```php
$db = M('users');
$db->find(1);
//生成的SQL语句
//select * from `users` where id=1;
```

**GET**
>**get(\$tableName = "", $auto = true)**
>
>生产最后的SQL一句
>
>string $tableName 表名
>$auto 是否自动添加表前缀

------------
```php
$this->get([表名]，[是否自动添加前缀bool]);
//生成的SQL语句
//select * from `tableName`;
```

**SELECT|FIELD**

>**select($field =[],[...])**
>
>$field string|array 字段 ,多个参数

------------

**EXCEPT**

>**except($field = [])**
>查询tableName表（默认$this->tableName）除了$field外所有字段
>$field array 字段

------------

```php
$this->select('field1,field2,field3')->all();
//生成的SQL语句
//select `field1`,`field2`,`field3` from `tableName`;

$this->select(['field1','field2','field3'])->all();
//生成的SQL语句
//select `field1`,`field2`,`field3` from `tableName`;

```

**LIMIT**

>**limit($offset, $length = null)
>$offset 起始位置
>$length 查询数量**

------------

```php
//查询一条数据
$this->limit(1)->all();
//生成的SQL语句
//select * from `tableName` limit 1;
```

**WHERE**
>where($where = '', $logical = "and")
>
>@param $logical 与前一个条件的连接符
>@param $where string|array
>string "id>'100'"   `->`     where id>'100'**
>
>array($field=>$value)
>
>例：
>['id'=>1,'or id'=>2,'age >'=>15,'or id in'=>[1,2,3,4,5]]
>
>$value 值 array|string|int|null|‘not null’
>field可以用空格分开，与连接符、字段名、运算符组成
>运算符 =|!=|<>|>|<|like|is|between|not between|in|not in
>连接符 or|and 与前一个条件的连接符 默认调用`$logical`
>

```php

$this->where("id='100'")->all();
//生成的SQL语句
//select * from `tableName` where （id = '100'）;

$this->->where("id='1659'")->where(array('id !='=>'1113','name like'=>'%nathan%'))->get('users');//前缀在config/database.php 设置 tablePrefix
//生成的SQL语句
//SELECT  *  FROM  `yrp_users` where (id='1659') or ( `id` != '1113'  or  `name` like '%nathan%' )

$this->where("id='1596'")->where(array('id !='=>'1113','or fullname like'=>'%nathan%',
'and update_time between'=>array(10000 , 100000000)))->get('users');
//前缀在config/database.php 设置 tablePrefix
//生成的SQL语句
//SELECT  *  FROM  `yrp_users` where (id='1596') and ( `id` != '1113'  or  `fullname` like '%nathan%'  and  `update_time` between '10000' and '100000000' )

$this->where(array('id in'=>array(1,2,3,4,5,6,7,8,9,10)))->get('users');
//生成的SQL语句
//SELECT  *  FROM  `yrp_users` where ( `id` in(1,2,3,4,5,6,7,8,9,10))
```
>where 可以用连贯查询 一组where会用()包含

**ORDER**
```php
$this->order('id desc')->all();
//生成的SQL语句
 SELECT  *  FROM  `yrp_users` ORDER BY `id` desc
```

**GROUP**
```php
$this->order('ip')->all();
//生成的SQL语句
//SELECT  *  FROM  `yrp_users` `GROUP BY `ip`
```

**HAVING**
>同WHERE

```php
$this->group('id')->having(array('id >'=>'2000'))->get('users');
//生成的SQL语句
//SELECT  *  FROM  `yrp_users` GROUP BY `id` having ( `id` > '2000' )
```

**JOIN**
>**join($table, $cond, $type = '', $auto = true)
>@param $table 表名
>@param $cond  连接条件 同where
>@param string $type 连接方式
>@param bool $auto 是否自动添加表前缀**

```php
$this->join('users as b', ['a.id'=>'b.id'], 'left')->get('users as a');
//生成的SQL语句
//SELECT  *  FROM  `yrp_users` as `a` LEFT JOIN `yrp_users` as `b` ON `a`.`id`=`b`.`id`
```

##计算

**统计COUNT**
>**count($tableName,$auto = true)
>$tableName 表名
>$auto 是否自动添加前缀 bool 默认true**

```php
$this->count('users');
//同
$this->select('count(*) as count')->get('users')->row()->count;
//生成的SQL语句
//SELECT COUNT(*) as `count` FROM  `yrp_users`
```

**最大值MAX**
>**max($tableName,$field,$auto = true)
>$tableName 表名
>$field 字段名 不能为空
>$auto 是否自动添加前缀 bool 默认true**

```php
$this->max('users','id');
//同
$this->select('max(id) as max')->get('users')->row()->max;
//生成的SQL语句
//SELECT MAX(id) as `max` FROM  `yrp_users`
```

**最小值MIN**
>**min($tableName,$field,$auto = true)
>$tableName 表名
>$field 字段名 不能为空
>$auto 是否自动添加前缀 bool 默认true**

```php
$this->min('users','id');
//同
$this->select('min(id) as min')->get('users')->row()->min;
//生成的SQL语句
//SELECT MIN(id) as `min` FROM  `yrp_users`
```

**累计值SUM**
>**sum($tableName,$field,$auto = true)
>$tableName 表名
>$field 字段名 不能为空
>$auto 是否自动添加前缀 bool 默认true**

```php
$this->sum('users','id');
//同
$this->select('sum(id) as sum')->get('users');
//生成的SQL语句
//SELECT SUM(id) as `sum` FROM  `yrp_users`
```

**平均值SUM**
>**sum($tableName,$field,$auto = true)
>$tableName 表名
>$field 字段名 不能为空
>$auto 是否自动添加前缀 bool 默认true**

```php
$this->avg('users','id');
//同
$this->select('avg(id) as avg')->get('users');
//生成的SQL语句
//SELECT AVG(id) as `avg` FROM  `yrp_users`
```
##查询结果返回

####row($assoc = false) 查询一条结果
>**@param bool|false $assoc 当该参数为 TRUE 时，将返回 array 而非 object  当查询价格为空时 返回false
>**

```php
//查询一条数据 返回对象格式
$this->select('id')->where(array('id'=>1))->get('users')->row();
//返还一条数据 当查询结果为空时 返回false
//stdClass::__set_state(array( 'id' => '231', ))

//查询一条数据 返回数组格式
$this->select('id')->where(array('id'=>1))->get('users')->row(true);
//返还一条数据 当查询结果为空时 返回false
//array(1) { ["id"]=> string(3) "231" }
```

------------

####result($assoc = false) 查询一条结果
>**@param bool|false $assoc 当该参数为 TRUE 时，将返回 array 而非 object  当查询价格为空时 返回一个空的数组array()
>**

```php
//查询所有数据 返回对象格式
$this->select('id')->get('users')->result();
//返还一条数据 当查询结果为空时 返回一个空的数组array()
//array ( 0 => stdClass::__set_state(array( 'id' => '1', )), 1 => stdClass::__set_state(array( 'id' => '2', )), 2 => stdClass::__set_state(array( 'id' => '3', )), .....)

//查询所有数据 返回数组格式
$this->select('id')->get('users')->result(true);
//返还所以数据 当查询结果为空时 返回一个空的数组array()
//array ( 0 => array ( 'id' => '1', ), 1 => array ( 'id' => '2', ), 2 => array ( 'id' => '3', ),....)
```

####rowCount() — 返回受上一个 SQL 语句影响的行数

```php
$db = M();
$re = $db->select('id')->get('users')->result();
echo  $db->rowCount();//输出查询结果总条数
```

##query 操作SQL
```php
$db = M();
$re = $db->query("select * from yrp_users")->result();
//查询 同 $db->get('yrp_users')

$re = $db->query("update yrp_users name='nathan' where id=500")->rowCount();
//修改 返回受影响的行数
```

## 事务

####要使用事务来运行你的查询, 你可以使用如下方法:
1. startTrans(); 开启事务
2. transComplete(); 自动判断错误 提交或则回滚
3. commit(); 事务提交
4. rollback(); 事务回滚

####属性
**public $transStatus;bool 事务是否发生错误**

```php
$m = M('users');
$t= $m->transaction(function () use($m) {
  $m->insert(['name' => 'q1']);

$m->insert(['name' => 'q17567']);
   $m->insert(['name1' => 'q3', 'age' => 24]);

})->transStatus;
var_export($t);

```

**或则**

```php
try{
$this->startTrans();
$this->query('一条SQL查询...');

$this->query('另一条查询...');
  
re = this->query('还有一条查询...');
$this->commit();
}catch (\Exception $e){
$m->rollback();
}
```

## 错误调试
```php
$db = M();
$error = $db->error();//返回的是一个数组array
var_export($error);
```

## 数据缓存
```php
//获得缓存实例 $dbCacheType 缓存驱动，有file memcache、memcached、redis,默认为file
$cache = core\cache::getInstance($dbCacheType = null);

/**
* 设置缓存
* @param string $key 要设置值的key
* @param string $val 要存储的数据
* @param null $timeout 有效期单位秒 0代表永久 默认为配置文件中的cacheLifetime
* @return bool
  */

$cache->set($key, $val, $timeout = null);

/**
* 获取缓存
* @param $key
* @return mixed
  */
  $cache->get($key = null);

/**
* 根据key值删除缓存
* @param string $key
  */
  $cache->del($key = null);

/**
* 清空所有缓存 慎用
* @return mixed
  */
  $cache->clear();

```

## 数据库缓存

#### 在配置文件中配置数据库相关配置

```php
return array(
/*--------------------以下是数据库配置---------------------------------------*/
'openCache' => true, //是否开启缓存
'defaultFilter' => 'htmlspecialchars', // 默认参数过滤方法 用于I函数过滤 多个用|分割stripslashes|htmlspecialchars
'dbCacheTime' => 0, //数据缓存时间0表示永久
'dbCacheType' => 'file', //数据缓存类型 file|memcache|memcached|redis
//单个item大于1M的数据存memcache和读取速度比file
'dbCachePath' => APP_PATH . 'runtime/data/',//数据缓存文件地址(仅对file有效)
'dbCacheExt' => 'php',//生成的缓存文件后缀(仅对file有效)

'memcache' => '127.0.0.1:11211',//string|array多个用数组传递 array('127.0.0.1:11211','127.0.0.1:1121')

'redis' =>'127.0.0.1:6379',//string|array多个用数组传递 array('127.0.0.1:6379','127.0.0.1:6378')
);
```

```php
$this->setCache(false);
//默认配置文件中openCache = true，临时关闭 可以用setCache 仅当前请求有效
```

##lastQuery() 查询上一条SQL语句
```php
$db = M();
$re = $db->get('users')->result();
echo $db->lastQuery();
//select * from `yrp_users`
```

## 使用多数据库连接

当你使用了多个连接时，则可以通过  `connection` 方法来访问每个连接。传递给 `connection` 方法的 `name` 必须对应至 `config/database.php` 配置文件中的连接列表的其中一个：

```php
$users = M()->connection('foo')->select(...);
```

## 数据预处理——访问器和修改器

### 定义一个访问器

若要定义一个访问器，则必须在你的模型上创建一个 `getFooAttribute` 方法。要访问的 `Foo` 字段需使用「驼峰式」来命名。在这个例子中，我们将为 `first_name` 属性定义一个访问器。当 Eloquent 尝试获取 `first_name` 的值时，将会自动调用此访问器：

```php
<?PHP
namespace App\Models;

use YrPHP\Model;

class User extends Model
{
    function __construct()
    {
        parent::__construct();
        $this->tableName = 'user';
    }
    
    /**
     * 获取用户的名字。
     *
     * @param  string  $value
     * @return string
     */
    public function getFirstNameAttribute($value)
    {
        return ucfirst($value);
    }
}
```

如你所见的，字段原始的值被传递到访问器中，让你可以操作并返回结果。如果要访问被修改的值，则可以像这样来访问 `first_name` 属性：

```php
$user = M('User')->find(1);

$firstName = $user->first_name;

//closePreProcess方法可以临时关闭访问器和修改器
$user = M('User')->closePreProcess()->find(1);
```

### 定义一个修改器

若要定义一个修改器，则必须在模型上定义一个 `setFooAttribute` 方法。要访问的 `Foo` 字段需使用「驼峰式」来命名。让我们再来定义 `first_name` 属性的修改器。当我们尝试在模型上设置 `first_name` 的值时，将会自动调用此修改器：

```php
<?php

namespace App\Models;

use YrPHP\Model;

class User extends Model
{
    /**
     * 设置用户的名字。
     *
     * @param  string  $value
     * @return string
     */
    public function setFirstNameAttribute($value)
    {
       return strtolower($value);
    }
}
```

修改器会获取属性已经被设置的值，让你可以操作该值并将其设置到 Eloquent 模型内部的 `$attributes` 属性上。举个例子，如果我们尝试将 `first_name` 属性设置成 `Sally`：

```php
$user = Model('User')->insert(['first_name'=>'Sally'])；
  
  //closePreProcess方法可以临时关闭访问器和修改器
$user = M('User')->closePreProcess()->insert(['first_name'=>'Sally'])；
```

在这个例子中，`setFirstNameAttribute` 函数将会使用 `Sally` 作为参数来调用。修改器会对该名字使用`strtolower` 函数并将其值返回。

------------

# 表单验证

```php
namespace App;

use YrPHP\FormRequest;

class TestRequest extends FormRequest
{

/**
     * 设置验证规则
     * @return array
     */
    function rules()
    {
    /**
     * array('字段名' => array(array('验证规则', ['错误提示'],[ '值域','值域',...])));
     * 验证规则:
     * required: 字段不能为空
     * equal:值域:string|null 当值与之相等时，通过验证
     * notequal:值域:string|null 当值与之不相等时 通过验证
     * in:值域:array(1,2,3)|1,2,3 当值存在指定范围时 通过验证
     * notin: 值域:array(1,2,3)|1,2,3  当不存在指定范围时 通过验证
     * between: 值域:array(1,30)|1,30 当存在指定范围时 通过验证
     * notbetween:值域:array(1,30)|1,30 当不存在指定范围时 通过验证
     * length:值域:array(10,30)|10,30 当字符长度大于等于10，小于等于30时 通过验证 || array(30)|30 当字符等于30时 通过验证
     * unique:值域:string 当该字段在数据库中不存在该值时 通过验证
     * email：  当值为email格式时 通过验证
     * url：  当值为url格式时 通过验证
     * number:  当值为数字格式时 通过验证
     * regex:值域:正则表达式 //当符合正则表达式时 通过验证
     * phone：判断是否为手机号码
     * verifyCode：值域:session验证码key值（默认verify）  判断验证码的确与否
     * extend：值域：匿名函数 function(表单值,[ '值域'])
     *
     */
        return ['id' => [[10, '', 'equal']]];
    }

}
```

```php
<?php
/**
 * Created by YrPHP.
 * User: Kwin
 * QQ:284843370
 * Email:kwinwong@hotmail.com
 */
namespace App\Controllers;

use App;
use App\TestRequest;
use YrPHP\Controller;

class Index extends Controller
{
    function __construct()
    {
        parent::__construct();
    }

function index(TestRequest $request, $id)
    {
		//如果TestRequest验证没通过，则会将错误信息写入session 如果是post提交则返回上一页,如果是ajax，则返回{error:{}}, 获取错误信息：session('errors')
    }
```

# 系统函数

```php
<?php

/**
 * 访问控制器的原始资源
 * 返回当前实例控制器对象
 * $app =& getInstance();
 * @return Controller 资源
 */
function &getInstance(){}

/**
* 获取配置参数
* @param string|array $name 配置变量 
* @param mixed $default 默认值
* @return mixed
*/
   function C($name = null,  $default = null){}

/**********************************************************/
/**
* @param string $url URL表达式，格式：'[模块/控制器/操作#锚点@域名]?参数1=值1&参数2=值2...'
* @param bool|true $indexPage 如果是REWRITE重写模式 可以不必理会 否则默认显示index.php
* @return string
    */
   getUrl($url = '', $indexPage = true){}

/**********************************************************/
/**
* 获取语言 支持批量定义
* @param null $key 语言关键词
* @param null $value 配置值
* @return array|null
    */
    function getLang($key = null, $value = null){}

/**********************************************************/
/**
* 以单例模式实例化类
* loadClass($className [, mixed $parameter [, mixed $... ]])
* @param $className 需要得到单例对象的类名
* @param $parameter $args 0个或者更多的参数，做为类实例化的参数。
* @return  object
    */
    function loadClass(){}

/**********************************************************/
/**
* 如果存在自定义的模型类，则实例化自定义模型类，如果不存在，则会实例化Model基类,同时对于已实例化过的模型，不会重复去实例化。
* @param string $modelName 模型类名
* @return object
    */
    function M($modelName = ""){}

/**********************************************************/
/**
* 管理session
* @param string $key
* @param string $val
* @return bool
    */
   session($key='',$val=''){};

//添加单个session
session('id','15');//$_SESSION['id'] = 15
//批量添加session
session(array('id'=>15,'name'=>'LiLei'));

//获得session
session('id');

//删除
session('id',null);

//清空session
session(null);

/**********************************************************/
/**
* 管理cookie
* @param string $key
* @param string $val
* @return bool
    */
   cookie($key='',$val=''){};

//添加单个session
cookie('id','15');
//批量添加session
cookie(array('id'=>15,'name'=>'LiLei'));

//获得session
cookie('id');

//删除
cookie('id',null);

/**********************************************************/
/**
* 优化的require_once
* @param string $filename 文件地址
* @return boolean
    */
   function requireCache($filename){}

/**********************************************************/
/**
 *base64编码压缩序列化数据
* @param $obj
* @return string
    */
    function mySerialize($obj = ''){}

/**********************************************************/
/**
* 反序列化
* @param $txt
* @return mixed
    */
   function myUnSerialize($txt = ''){}

/**********************************************************/
/**
 *404跳转
* @param string $msg 提示字符串
* @param string $url 跳转URL
* @param int $time 指定时间跳转
    */
    function error404($msg = '', $url = '', $time = 3){}

/**
 * 下载一个远程文件到客户端
 * 例  clientDown('http://img.bizhi.sogou.com/images/2012/02/13/66899.jpg');
 * @param $url 一个远程文件
 * @return bool
 */
function clientDown($url){}

/**
 * 获取某个月第一天与最后一天的时间戳
 * @param  [type] $month [description]
 * @param  string $year [description]
 * @return [type]        [description]
 */
function getMonthTime($month, $year = ''){}

/**
 * http://www.php100.com/html/php/lei/2013/0904/3819.html
 * 获取客户端真实IP
 * @return mixed
 */
function getClientIp(){}

/**
 * //新浪根据IP获得地址
 * @param string $ip
 * @return mixed|string
 * array ( 'ret' => 1, 'start' => -1, 'end' => -1, 'country' => '中国', 'province' => '浙江', 'city' => '杭州', 'district' => '', 'isp' => '', 'type' => '', 'desc' => '', )
 */
function Ip2Area($ip = ''){}

/**
 * 生成随机字符
 * @param  string $type w：英文字符 d：数字 wd: dw:数字加英文字符
 * @param  integer $len [description]
 * @return [type]        [description]
 */
function randStr($len = 8, $type = 'wd'){}

/**
 * 发送HTTP状态
 * @param integer $code 状态码
 * @return void
 */
function sendHttpStatus($code){}

/**
 * 页面跳转
 * @param string $url
 */
function gotoUrl($url = ''){}

/**
 * 数据脱敏处理隐私数据的安全保护
 * @param string $str
 * @param int $start
 * @param int $length
 * @param string $replacement
 * @return mixed
 */
function desensitize($str = '', $start = 0, $length = 0, $replacement = '*'){}

/**
 * 返回一个旧的输入值
 * @param string $inputName
 * @param null $default
 * @return string|null
 */
function old($inputName = '', $default = null){}

/**
 * CSRF Token，该Token可用于验证登录用户和发起请求者是否是同一人，如果不是则请求失败。
 * @return bool|string
 */
function csrfToken(){}

/**
 * 生成一个包含CSRF Token值的隐藏域
 * @return string
 */
function csrfField(){}

/**
 * 命名规则转换
 * @param string $name
 * @param int $type 0、小驼峰法、1、大驼峰法、2、蛇形命名法
 * @return mixed|string
 */
function parseNaming($name = '', $type = 0){}
```

------------
# 创造自己的类库
将你自己的 .php 文件放入`APP_PATH`/Libs
文件的命名规则为`类名.php`,类名不能与系统类库（`LIBS_PATH`）下的类重名

####例：

>在`APP_PATH`/Libs文件夹中新建一个名问MyPage.class.php的类文件

```php
    <?php
    namespace App\Libs;
    
    class MyPage
    {
        function __construct()
        {
            parent::__construct();
        }
    
        function  index()
        {
          echo "Hello World";
        }
```

>在控制器中调用

```php
    <?php
     namespace App\Controllers;
    
    use YrPHP\Controller;
    
    class Test extends MyController
    {
        function __construct()
        {
            parent::__construct();
        }
    
        function  index()
        {
         $class = loadClass('App\Libs\MyPage');
         $class->index();
        }
```

## loadClass($className)以单例模式实例化类
>请确保类名正确 **区分大小写**

# 系统类库(YrPHP/Libs)
> **所有系統类都注冊了别名，可以直接在控制器中用`别名::方法名()`来调用**
> **如： `crypt::encrypt($str)`**
>
> **当然自定义的类，在Config/class_alias.php中注册了别名，也可以这样调用**

## 加密类     Crypt

#### 配置密钥
>在`APP_PATH`.config/config.php下配置

```PHP
<?PHP
    return
    array('cryptMode' => 'des3',//现在加密方式只有DES3
          'cryptKey' => '123456789',//密钥
          'cryptIv' =>  '123456789',//初始向量
    );
```

#### 加密解密
```PHP
<?PHP
  $crypt = loadClass('YrPHP\Crypt');
  $crypt->encrypt($str);//加密数据
  $crypt->decrypt($str);//解密数据
```

## 数组类

```php
<?php
/**
 * Created by YrPHP.
 * User: Kwin
 * QQ:284843370
 * Email:kwinwong@hotmail.com
 * GitHub:https://github.com/kwinH/YrPHP
 */
namespace YrPHP;

class Arr
{
    /**
     * 不区分大小写的in_array实现
     * @param string $value
     * @param array $array
     * @return bool
     */
    public static function inIArray($value = '', $array = []){}

/**
     * 在数组中搜索给定的值（不区分大小写），如果成功则返回相应的键名
     * @param $needle
     * @param $haystack
     * @param bool $strict
     * @return mixed
     */
    public static function arrayISearch($needle, $haystack, $strict = false){}

/**
     * 不区分key值大小写获取数组中的值
     * @param array $arr
     * @param string $key
     * @return mixed
     */
    public static function arrayIGet(array $arr = [], $key = ''){}

/**
     * 多维数组转一维数组
     * @param array $multi
     * @return array
     */
    public static function arrToOne(array $multi = []){}

/**
     *  判断是不是索引数组
     * @param array $array
     * @return bool true ? 索引数组 : 不是索引数组
     */

public static function isAssoc(array  $array = []){}

/**
     * 使用“点”符号从数组中获取一个项。
     * @param array $arr
     * @param string $key
     * @param null $default
     * @return mixed
     */
    public static function get(array $arr = [], $key = '', $default = null){}

/**
     * 返回数组中指定的数组项
     * @param array $arr 指定数组
     * @param $onlyKey 可以为多个参数或则单个数组格式
     * @return array
     */
    public static function only(array &$arr = [], $onlyKey){}

/**
     * 过滤数组中指定的数组项,并返回
     * @param array $arr 指定数组
     * @param $exceptKey 可以为多个参数或则单个数组格式
     * @return array
     */
    public static function except(array &$arr = [], $exceptKey){}

}
```

## 文件处理类 File

```php
<?php
/**
* 建立文件
  *
* @param  string $aimUrl 文件地址
* @param  boolean $overWrite 该参数控制是否覆盖原文件
* @return  boolean
  */
  YrPHP\File::createFile($aimUrl, $overWrite = false);

/**
* 递归删除文件夹或文件
* @param  string $aimDir 文件地址
* @return  boolean
    */
   YrPHP\File::rm($aimDir);

/**
* 建立文件夹
* @param  string $aimUrl 文件地址
* @param  int    $mode 权限
* @return  viod
    */
   YrPHP\File::mkDir($aimUrl, $mode = 0777);

/**
* 移动文件夹或文件
* @param  string $oldDir 原地址
* @param  string $aimDir 目标地址
* @param  boolean $overWrite 该参数控制是否覆盖原文件
* @return  boolean
    */
   YrPHP\File::mv($oldDir, $aimDir, $overWrite = false)；

/**
* 复制文件或则文件夹
* @param  string $oldDir
* @param  string $aimDir
* @param  boolean $overWrite 该参数控制是否覆盖原文件
* @return  boolean
    */
   YrPHP\File::cp($oldDir, $aimDir, $overWrite = false)；

/**
* 修改文件名
    *$path 需要修改的文件路径
    *$name 修改后的文件路径及文件名
* @return    boolean
    */
   YrPHP\File::rename($path, $name)；

/**
* 将字符串写入文件
* @param  string $filename 文件路径
* @param  boolean $str 待写入的字符数据
    */
   YrPHP\File::vi($filename, $str);

/**
* 将整个文件内容读出到一个字符串中
* @param  string $filename 文件路径
* @return string
    */
   YrPHP\File::readsFile($filename);

/**
* 将文件内容读出到一个数组中
* @param  string $filename 文件名
* @return array
    */
   YrPHP\File::readFile2array($filename);

/**
* 根据关键词列出目录下所有文件
* @param    string $path 路径
* @param    string $key 关键词
* @param    array $list 增加的文件列表
* @return    array    所有满足条件的文件
* 返回一个索引为结果集列名的数组
    */
   YrPHP\File::dirList($path, $key = '', $list = array())；

/**
* 根据关键词列出目录下所有文件
    *
* @param    string $path 路径
* @param    string $key 关键词
* @param    array $list 增加的文件列表
* @return    array    所有满足条件的文件
* 返回一个索引为结果集列名和以0开始的列号的数组
    */
   YrPHP\File::search($path, $key = '', $list = array())；

/**
* 获取文件名后缀
* @param    string $filename 文件路径
* @return    string
    */
   YrPHP\File::fileExt($filename)；

/**
* 获得文件相关信息
* @param $filename 文件路径
* @return array|bool
* 将会返回包括以下单元的数组 array ：dirname(文件实在目录)、basename(文件名带后缀)、extension（文件后缀
* 如果有）、filename(文件名不带后缀)、dev(设备名)、ino(inode 号码)、mode(inode 保护模式)、nlink(被连接数
* 目)、uid(所有者的用户 id)、gid(所有者的组 id)、rdev(设备类型，如果是 inode 设备的话)、size(文件大小的
* 字节数)、atime(上次访问时间（Unix 时间戳）)、ctime(上次改变时间（Unix 时间戳）)、blksize(文件系统 IO
* 的块大小)、blocks(所占据块的数目)。
    */
   YrPHP\File::getFileInfo($filename);

/**
* 统计目录大小
* @param    string $dirname 目录
* @return    string      比特B
    */
   YrPHP\File::getDirSize($dirname)；

/**
* 将字节转换成Kb或者Mb...
* @param $size为字节大小
    */
   YrPHP\File::bitSize($size)；

/**
* 返回当前目录层级下所有文件及目录列表
* @param    string $dir 路径
* @return    array    返回目录列表
   array (
   App
   2 => 'public',
   YrPHP
   )

*/
YrPHP\File::dirNodeTree($dir);

/**
* 递归循环目录列表，并返回关系层级
* @param    string $dir 路径
* @param    int $parentid 父id
* @param    array $dirs 传入的目录
* @return    array    返回目录及子目录列表

array (
  1 =>
  array (
    'id' => 1,
    'parentid' => 0,
    App
    App
  ),
  2 =>
  array (
    'id' => 2,
    'parentid' => 1,
    Common
    Common
  ),
  ）
 */
YrPHP\File::dirTree($dir, $parentid = 0, $dirs = array())；
```

## 文件上传类 Uoload
>支持多文件上传

#### 上传配置设置
| key          | 值选项  | 说明                                                         |
| ------------ | ------- | ------------------------------------------------------------ |
| maxSize      | int     | 最大的上传文件 KB 默认为0 不限制 　　注意：通常PHP也有这项限制，可以在php.ini文件中指定。通常默认为2MB。 |
| savePath     | `/`     | 上传目录 默认`/`根目录                                       |
| fileName     | None    | 自定义上传文件后的名称，不含文件后缀                         |
| allowedTypes | array() | 允许上传文件的后缀列表默认空数组为允许所有                   |
| isRandName   | BOOL    | 设置是否随机重命名文件， false不随机 默认 true               |
| overwrite    | BOOL    | 是否覆盖。true则覆盖，false则重命名 　默认false              |

------------

#### init($config)参数初始化

#### uploadFile($field)文件上传
>@param 表单名称 $field，上传文件的表单名称  如果为空则上传 $_FILES数组中所有文件

#### getFileInfo($inputName=null);获得上传文件相关属性
>inputName 表单名 如果为多文件上传 则在表单名后面跟下标
>如果inputName==null 则返回一个以表单名为键的多维数组 return array(inputName1=>array(),inputName2=>array(),...)
>
>如果inputName表单名不为空 则返回该表单上传的文件信息 如果表单名错误 则 返回false
>
>如果上传文件有错误 则return array('errorCode'=>错误代码)
>
>否则 return 包括以下单元的数组 array ：fileName(最终文件名包含后缀)、fileType(文件mime类型)、filePath(包含文件名的完整路径)、origName(上传前的文件名)、fileExt(文件后缀)、 fileSize(文件大小KB)、isImage(是否是图片bool)、imgWidth(图片宽度)、imgHeight(图片高度)

#### getError($errorCode = null)
>$errorCode 根据错误代码获得上传出错信息

```php
<?php
 $config = $config = array(
 'maxSize'=>100,
 'savePath'=>'/ttt',
 'isRandName'=>false,
 'allowedTypes'=>array('jpg','png')
 );
 //参数配置可以在实例化时就传入
        $up = loadClass('YrPHP\\upload',$config);
        $re = $up->uploadFile('file123');

//参数配置也可以在init方法中传入
        $up = loadClass('YrPHP\\upload');
        $re = $up->init($config)->uploadFile('file123');

```

## 图像处理类 Image
>支持连贯操作

####缩略图
```php
/**
缩略图
**/
$img = loadClass('YrPHP\Image','D:/test.jpg');//实例化 并打开test.jpg图片，也可以用open方法打开图片

/**
* 获得图片的基本信息
* @return array(dirname,basename,extension,filename,width,height,type,mime)
  */
  var_dump($img->getInfo());

$img=$img->thumb(array('width'=>100,'height'=>100,'pre'=>0.5));//如果设置了$config['per']则按照$config['per']比例缩放 否则按给定宽高

/**
* 直接在浏览器显示图片
* @param null $type 图像类型（gif,jpeg,jpg,png） 为空则按原图类型
* @return bool
  */
  $img->show($type = null);//显示图片

/**
* 保存图像
* @param  string $imgname 图像保存名称
* @param  string $type 图像类型（gif,jpeg,jpg,png） 为空则按原图类型
* @param  integer $quality 图像质量
* @param  boolean $interlace 是否对JPEG类型图像设置隔行扫描
  */
  $img->save($imgPath='test1.jpg', $type = null, $quality = 80, $interlace = true);

/**
* 客服端下载
* @param null $downFileName 文件名 默认为原文件名
* @param null $type 图像类型（gif,jpeg,jpg,png） 为空则按原图类型
  */
  $img->down($downFileName = null, $type = null);
```
####水印
```php
$img = loadClass('YrPHP\Image');//实例化
$img->open('D:/test.jpg');//并打开test.jpg图片

/**
* 为图片添加文字水印
* @param    string $water array('str'=>'ok','font'=>'msyh.ttf','color'=>'#ffffff','size'=>20,'angle'=>0,)
* str水印文字为必填 font字体 color默认黑色 size文字大小默认20，angle文字倾斜度默认0 暂只支持GIF,JPG,PNG格式
* @param    int $position 水印位置，有10种状态，0为随机位置；
* 1为顶端居左，2为顶端居中，3为顶端居右；
* 4为中部居左，5为中部居中，6为中部居右；
* 7为底端居左，8为底端居中，9为底端居右；
* 指定位置 array(100,100) | array('x'=>100,'y'=>100)
* @return    mixed
  */
  $img->text($water = array(), $position = 0);
  //其他 显示 下载 保存同上
  /*************************************************************/

$img = loadClass('YrPHP\Image','D:/test.jpg');//实例化 并打开test.jpg图片

/**
* 添加水印图片
* @param  string $water 水印图片路径
* @param  integer|array $position 水印位置
* @param    int $position 水印位置，有10种状态，0为随机位置；
* 1为顶端居左，2为顶端居中，3为顶端居右；
* 4为中部居左，5为中部居中，6为中部居右；
* 7为底端居左，8为底端居中，9为底端居右；
* 指定位置 array(100,100) | array('x'=>100,'y'=>100)
* @param  integer $alpha 水印透明度
* @param  integer $waterConf array('width'=>100,'height'=>100) 调整水印大小 默认调用原图
  */
  $img->watermark($water, $position = 0, $alpha = 100, $waterConf = array())；
  //其他 显示 下载 保存同上
```
####剪辑
```php
$img = loadClass('YrPHP\Image','D:/test.jpg');//实例化 并打开test.jpg图片

/**
* 裁剪图像
* @param  integer $w 裁剪区域宽度
* @param  integer $h 裁剪区域高度
* @param  integer|array $position 裁剪起始位置 有10种状态，0为随机位置；
* 1为顶端居左，2为顶端居中，3为顶端居右；
* 4为中部居左，5为中部居中，6为中部居右；
* 7为底端居左，8为底端居中，9为底端居右；
* 指定位置 array(100,100) | array('x'=>100,'y'=>100)
* @param  integer $width 图像保存宽度 默认为裁剪区域宽度
* @param  integer $height 图像保存高度 默认为裁剪区域高度
  */
  $img->cut($w, $h, $position = 1, $width = null, $height = null);
  //其他 显示 下载 保存同上
```

## CURL类     Curl
>支持连贯操作

```php
//GET请求
$curl = loadClass('YrPHP\Curl');

//设置需要获取的URL地址
$curl = $curl->setUrl($url . 'https://api.weixin.qq.com/sns/oauth2/access_token');

/**
* 启用时会发送一个常规的GET请求
* @param array|string $data array('user'=>'admin','pass'=>'admin') | admin&admin
* @return $this
  */
  $curl = $curl->get('appid=' . $AppID . '&secret=' . $AppSecret . '&code=' . $code . '&grant_type=authorization_code')；

/**
* 执行一个cURL会话 返回执行的结果
* @param bool $debug 是否开启调试模式 如果为true将打印调试信息
* @return mixed
  */
   $curl =$curl->exec();
```

```php
//POST请求
$curl = loadClass('YrPHP\Curl');

//设置需要获取的URL地址
$curl = $curl->setUrl($url . 'https://127.0.0.1/test.php');

/**
* 启用时会发送一个常规的POST请求，默认类型为：application/x-www-form-urlencoded，就像表单提交的一样
* @param array|string $data
* @param string $enctype application|multipart  默认为application，文件上传请用multipart
  */
  $curl = $curl->post(array('name' => 'test', 'sex'=>1,'birth'=>'20101010'))；

/**
* 执行一个cURL会话 返回执行的结果
* @param bool $debug 是否开启调试模式 如果为true将打印调试信息
* @return mixed
  */
   $curl =$curl->exec();
```

```php
//获取Cookie模拟登陆
$cookie_file = tempnam('./temp','cookie');

$curl = loadClass('YrPHP\Curl');

//设置需要获取的URL地址
$curl = $curl->setUrl($url . 'https://127.0.0.1/login.php');

/**
* 获得cookies
* @param string $path 定义Cookie存储路径 必须使用绝对路径
  */
  $curl = $curl->getCookie($cookie_file);

/**
* 执行一个cURL会话 返回执行的结果
* @param bool $debug 是否开启调试模式 如果为true将打印调试信息
* @return mixed
  */
   $curl =$curl->exec();

$curl = $curl->setUrl($url . 'https://127.0.0.1/getUserInfo.php');

/**
* 取出cookie，一起提交给服务器
* @param string $path 定义Cookie存储路径 必须使用绝对路径
  */
  $data = $curl->setCookieFile($cookie_file)->exec();

/**
* 设定HTTP请求中"Cookie: "部分的内容。多个cookie用分号分隔，分号后带一个空格(例如， "fruit=apple; colour=red")。
* @param string|array $cookies 定义Cookie的值
  */
  $curl = $curl->setCookie(array('name'=>'admin','passwd'=>'123456'));

$data = $curl->exec();
var_dump($data);

//清理cookie文件
unlink($cookie_file);
```

```php
$headers['Referer'] = 'http://www.baidu.com';
$headers['CLIENT-IP'] = '202.103.229.40';
$headers['X-FORWARDED-FOR'] = '202.103.229.40';

$curl = loadClass('YrPHP\Curl');

//设置需要获取的URL地址
$curl = $curl->setUrl($url . 'https://127.0.0.1/login.php');

/**
* @param bool $verify 是否验证证书 默认false不验证
* @param string $path 验证证书时，证书路径
* @return $this
  */
  $curl = $curl->sslVerify(false);

/**
* 传递一个连接中需要的用户名和密码
* @param array|string $userPassword 格式为：array('userName','password') 或则, "username:password"
  */

$curl = $curl->setUserPassword(array('admin','123456'));

//setHeader(array())设置请求头
$curl->setHeader($headers)->get()->exec();
var_dump($data);
```

## 验证码类   VerifyCode
```php
//配置，以下均为默认值
$conf= array(
'width' =>100;//图片宽度
'height' =>40;//图片高度
'size' =>21;//字体大小
'font'=>'yrphp/resource/font/1.ttf';//字体
'len' =>4;//随机字符串长度
'type';//默认是大小写数字混合型，1 2 3 分别表示 小写、大写、数字型
'backColor' => '#eeeeee';     //背景色，默认是浅灰色
'pixelNum' => 666; //干扰点个数
'lineNum'=> 10; //干扰线条数
);

/**
* @param string $code 验证码key,用于session获取，默认verify
* @param bool $line 是否显示干扰线
* @param bool $pixel 是否显示干扰点
    */
   //参数可以在实例化时传入 也可以调用init方法初始化时调用
   loadClass('YrPHP\VerifyCode',$conf)->show($code = 'verify', $line = true, $pixel = true);
```

## 分页类

```php
//配置，以下均为默认值
        $config = array(
            'totalRows' => 100,// 总行数
            'listRows' => 12,// 列表每页显示行数 默认12
            'rollPage' => 6,// 分页栏每页显示的页数 默认8
            'p' => 'p',
            'url' => 'http://example.com/test/page/',//跳转链接URL,不配置 默认为当前页
            'urlParam' => array('key' => 'hello'),// 分页跳转时要带的参数
    
            //添加封装标签
            'fullTagOpen' => '<div>',//整个分页周围围绕一些标签开始标签
            'fullTagClose' => '</div>',//整个分页周围围绕一些标签结束标签
    
            //自定义“当前页”链接
            'nowPage' => 3,//当前页，默认为'1'第一页
            'nowTagOpen' => '<strong>',//在当前页外围包裹开始标签 默认<strong>
            'nowTagClose' => '</strong>',//在当前页外围包裹结束标签
    
            //自定义起始链接
            'firstTagOpen' => '',//在首页外围包裹开始标签
            'firstLink' => '首页',//你希望在分页中显示“首页”链接的名字  如果不想显示该标签 则设置为FALSE即可
            'firstTagClose' => '',//在首页外围包裹标签结束标签
    
            //自定义结束链接
            'lastTagOpen' => '',//在尾页外围包裹开始标签
            'lastLink' => '尾页',//你希望在分页中显示“尾页”链接的名字  如果不想显示该标签 则设置为FALSE即可
            'lastTagClose' => '',//在尾页外围包裹标签结束标签
    
            //自定义“上一页”链接
            'prevTagOpen' => '',//在上一页外围包裹开始标签
            'prevLink' => '上一页',//上一页显示文字  如果不想显示该标签 则设置为FALSE即可
            'prevTagClose' => '',//在上一页外围包裹标签结束标签
    
            //自定义“下一页”链接
            'nextTagOpen' => '',//在下一页外围包裹开始标签
            'nextLink' => '下一页',//你希望在分页中显示“下一页”链接的名字 如果不想显示该标签 则设置为FALSE即可
            'nextTagClose' => '',//在下一页外围包裹标签结束标签
    
            //自定义“数字”链接  如果不想显示该标签 将rollPage设置为0即可
            'otherTagOpen' => '',//在其他“数字”链接外围包裹开始标签
            'otherTagClose' => '',//在其他“数字”链接外围包裹标签结束标签
    
            //自定义“select下拉跳转”
            'gotoPage' => false,//是否显示select下拉跳转,默认不显示
            'gotoTagOpen' => '',//在select下拉跳转外围包裹标签
            'gotoTagClose' => '',//在select下拉跳转外围包裹标签闭合
    
        );
    
        //实例化分页类 参数也可以通过init方法初始化
        $page = loadClass('YrPHP\page', $config);
        //输出分页的html
        echo $page->show();
```
**生成样式**
<div><a href="http://example.com/test/page/?key=hello&amp;p=1">首页</a><a href="http://example.com/test/page/?key=hello&amp;p=4">上一页</a><a href="http://example.com/test/page/?key=hello&amp;p=2">2</a><a href="http://example.com/test/page/?key=hello&amp;p=3">3</a><a href="http://example.com/test/page/?key=hello&amp;p=4">4</a><strong><a href="http://example.com/test/page/?key=hello&amp;p=5">5</a></strong><a href="http://example.com/test/page/?key=hello&amp;p=6">6</a><a href="http://example.com/test/page/?key=hello&amp;p=7">7</a><a href="http://example.com/test/page/?key=hello&amp;p=6">下一页</a><a href="http://example.com/test/page/?key=hello&amp;p=9">尾页</a></div>

## 验证类     Validate
```php
<?php
    /**
     * 判断是否为空值，当数据不为空时 return true
     * @param null $data
     * @return bool
     */
        YrPHP\Validate::required(null);//return false
         
       /**
         * 当两个值相等时 return true
         * @param string $data
         * @param string $val
         * @return bool
         */
        YrPHP\Validate::equal(20, 10);//false
        YrPHP\Validate::equal(20, 20);//true
        /**
         * 当两个不值相等时 return true
         * @param string $data
         * @param string $val
         * @return bool
         */
    
        YrPHP\Validate::notEqual(20, 10);//true
        YrPHP\Validate::notEqual(20, 20);//false
        /**
         * 当存在指定范围时return true
         * @param string $data
         * @param array|string $range
         * @return bool
         */
        YrPHP\Validate::in(2, '2,8');//true
        YrPHP\Validate::in(10, array(2, 8));//false
    
        /**
         * 当不存在指定范围时return true
         * @param string $data
         * @param array|string $range
         * @return bool
         */
        YrPHP\Validate::notIn(2, '2,8');//false
        YrPHP\Validate::notIn(10, array(2, 8));//true

/**
         * 当存在指定范围时return true
         * @param null $data
         * @param array|string $range
         * @return bool
         */
        YrPHP\Validate::between(10, '10,20');//true
        YrPHP\Validate::between(10, array(20, 15));//false

/**
         * 当不存在指定范围时return true
         * @param null $data
         * @param array|string $range
         * @return bool
         */
        YrPHP\Validate::notBetween(10, '10,20');//false
        YrPHP\Validate::notBetween(10, array(20, 15));//true

/**
         * 当数据库中值存在时 return false
         * @param $tableName 表名
         * @param $field 字段名
         * @param $val 值
         * @return bool
         */
        YrPHP\Validate::unique($tableName, $field, $val);
    
        /**
         * 当字符长度存在指定范围时return true
         * @param null $data 字符串
         * @param array|string $range 范围
         * @return bool
         * length('abc',3); strlen('abc') ==3
         * length('abc',array(5,3))==length('abc',array(3,5)) => strlen('abc') >=3 && strlen('abc') <=5
         */
        YrPHP\Validate::length($data = '', $range = '');

/**
         * Email格式验证
         * @param    string $value 需要验证的值
         */
        YrPHP\Validate::email('5463@qq.com');//true
    
        /**
         * URL格式验证
         * @param    string $value 需要验证的值
         */
        YrPHP\Validate::url('https://www.baidu.com');//true
    
        /**
         * 数字格式验证
         * @param    string $value 需要验证的值
         */
        YrPHP\Validate::number(100); //true;
    
        /**
         * 使用自定义的正则表达式进行验证
         * @param    string $value 需要验证的值
         * @param    string $rules 正则表达式
         */
        YrPHP\Validate::regex($value, $rules);
    
        /**
         * 判断是否为手机号码
         * @param    string $value 手机号码
         */
        YrPHP\Validate::phone($value = '');
    
        /**
         * 判断验证码的确与否
         * @param string $value 值
         * @param string $code session中的key 默认'verify'
         * @return bool
         */
        YrPHP\Validate::verifyCode($value, $code);
        
        /**
        自定义匿名函数
        */
     YrPHP\Validate::extend('test', function ($key, $val) {
      if ($key > $val) return true;
      return false;
      });
      var_dump(YrPHP\Validate::test(3, 2)); //true
```
## 购物车类   Cart
```php
<?php
//配置参数
$conf = array(
'saveMode' = 'session'，//存储方式，有cookie和session，默认session
'mallMode'=>false,//商城模式 true多商家 false单商家,默认false单商家
'key'=>'cartContents',//保存在session或者cookie中的key
);
//实例化购物车类 配置参数也可以通过init方法初始化
$cart = loadClass('YrPHP\Cart',$conf);

//添加一个产品到购物车
/**
六个保留的索引分别是:
id - 你的商店里的每件商品都必须有一个唯一的标识符(identifier)
qty - 购买的数量(quantity)。
price - 商品的价格(price)。
name - 商品的名称(name)。
options - 标识商品的任何附加属性。必须通过数组来传递。
seller - 卖家标识ID，多商家模式必须设置
id, qty, price 和name是必需的，options是可选的
除以上六个索引外，还有两个保留字：rowId 和 subtotal。它们是购物车类内部使用的，因此，往购物车中插入数据时，请不要使用这些词作为索引。

其他可自行扩展
 */
      $items = array(
               'id'      => 'sku_123ABC',
               'qty'     => 1,
               'price'   => 39.95,
               'name'    => 'T-Shirt',
               'options' => array('Size' => 'L', 'Color' => 'Red')
            );
/**
* 添加单条或多条购物车项目
* @param array $items 添加多个可为二维数组
* @param bool $accumulation 是否累加,默认累计
* @return bool|string
  */
  $cart->insert($items);

/**
* 返回一个包含了购物车中所有信息的数组
* @param null $mallMode 商城模式 true多商家(二维数组) false单商家（一维数组）默认为配置中的模式,当为单商家时，不管设置什么都返回一维数组
* @param null $seller 返回指定商家下的所以产品，默认为null，返回所以商家，单商家下无效
* @return array
  */
  $cartList = $cart->getContents()；

/**
* 获得一条购物车的项目
* @param null $rowId
* @return bool|array
  */
  $rowId = n'b99ccdf16028f015540f341130b6d8ec';
  $item = $cart->getItem($rowId);

/**
* 显示购物车中总共的商品数量
* @param null $seller 商家标识符 单商家模式下无效
* @return int
  */
  $totalQty = $cart->totalQty();

/**
* 显示购物车中的总计金额  商家标识符 单商家模式下无效
* @return int
  */
  $priceTotal = $cart->total();

/**
* 显示购物车中总共的项目数量
* @param null $seller 商家标识符 单商家模式下无效
* @return int
  */
  $totalItems =$cart->totalItems();

/**
* 更新购物车中的项目 必须包含 rowId
* @param $item 修改多个可为二维数组
* @return bool
  */

$items = array(
'rowId'=> 'b99ccdf16028f015540f341130b6d8ec',
'qty'=>6,
)
$cart->update($items);

/**
* 删除一条购物车中的项目  必须包含 rowId
* @param null|array $rowId
* @return bool
  */
  $rowId = n'b99ccdf16028f015540f341130b6d8ec';
  $cart->remove($rowId);

/**
*删除多条用数组
*/
$rowId = array(
'b99ccdf16028f015540f341130b6d8ec',
'qweuyrf16028f985640f341130b6d66c'
);
$cart->remove($rowId);

/**
* 销毁购物车
  */
  $cart->destroy()；

/**
* 根据rowId 查找商家
* @param $key
* @return bool|int|string  当为单商家模式时直接返回false,当找不到时也返回false，否则返回商家标识符
  */
  $rowId = 'b99ccdf16028f015540f341130b6d8ec';
  $seller = $cart->searchSeller($rowId);
  ?>
```

## Email 类   PHPMailer
````

````

YrPHP

YrPHP Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

YrPHP

YrPHP Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README