# CSpeed

**Repository Path**: eemcmc/cspeed

## Basic Information

- **Project Name**: CSpeed
- **Description**: CSpeed 框架，全堆栈的轻量级C语言PHP扩展框架，以高性能、极速为目标。
- **Primary Language**: C
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 17
- **Created**: 2017-12-16
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CSpeed v2.1.8手册 #

## QQ群交流 ##

https://jq.qq.com/?_wv=1027&k=5kSunAR

CSpeed扩展官方QQ群号： **605383362**

## 最新特性 ##

**CSpeed v2.1.8特性：**

1、配置文件变更：
```shell
[db]
db.mater.type                   =  mysql                 ; 数据库类型，默认：mysql
db.mater.host                   =  localhost             ; 数据库主机地址
db.mater.port                   =  3306                  ; 数据库端口
db.mater.dbname                 =  cspeed                ; 数据库名称
db.mater.username               =  cspeed                ; 数据库用户名
db.mater.password               =  cspeed                ; 数据库密码
```
新版本配置文件：
```shell
[db]
db.master.dsn                   =  'mysql:host=localhost;port=3306;dbname=supjos'    ; 数据库类型，默认：mysql
db.master.username              =  root                                              ; 数据库用户名
db.master.password              =  3333                                              ; 数据库密码
```
变更的主要原因在与使用```PDO```形式的dsn，能够更好的兼容各种数据库：Oracle、Pg、SqlServer等

2、增加支持多数据库配置链接与切换：
```php
$di->set('db1', function(){
	/* 省略任何参数表示从ini配置文件获取 */
	return new \Cs\db\pdo\Adapter();
});

$di->set('db2', function(){
    	/* 省略的参数系统自动从ini配置文件获取 */
	return new \Cs\db\pdo\Adapter([
	'dsn' => 'mysql:host=localhost;port=3308;dbname=product',
	'username' => 'root',
	'password' => 'root'
    ]);
});
```
如上配置了两个数据库链接，如果在使用模型的过程中需要进行切换，可以使用模型的方法：
```php
/* 表示当前模型操作```db2```数据库 */
$model->setDb('db2');

/* 表示当前模型操作```db1```数据库 */
$model->setDb('db1');
```
更加方便的方式是在模型的构造函数中使用本方法：
```php
<?php

namespace app\models;

class User extends \Cs\mvc\Model
{
    public function __construct()
    {
        $this->on(User::EVENT_BEFORE_SAVE, [$this, 'beforeSave']);
        $this->setDb('db2');
    }

    function beforeSave()
    {
        echo "BeforeSave <br>";
    }

    public function tableName()
    {
        return 'www_product';
    }
}
```

注意：```\Cs\db\pdo\Adapter```类本身就表示一个数据库链接，故```\Cs\db\pdo\Adapter```不支持数据库切换，用户可以直接使用```\Cs\db\pdo\Adapter```进行数据库的操作，CSpeed引擎的```\Cs\mvc\Model```本身就是基于```\Cs\db\pdo\Adapter```进行的二次封装.

可以直接使用 ```\Cs\db\pdo\Adapter``` 分别操作数据库:
```php
$db1 = $this->di->get('db1');
$db1->query('UPDATE xxx FROM xxx SET xx=xx');
$db1->execute();
```
或者使用预处理：
```php
$db1 = $this->di->get('db1');
$db1->query('UPDATE xxx FROM xxx SET xx=?', [99]);
/* 或者如下的绑定名 */
$db1->query('UPDATE xxx FROM xxx SET id=:id', [‘id’ => 99]);
$db1->execute();
```

**CSpeed v2.1.5特性：**

新增 ```composer``` 支持。使用如下两种方式加载```composer```：

1、入口文件处
```php
$app->setComposerLoader("xxx/autoload.php");
```

2、在框架的任何位置均可使用此方法加载 ```composer```
```php
\Cs\App::getApp()->setComposerLoader("xx/autoload.php");
```

**CSpeed v2.1.4特性：**

1、修复 **Cs\rpc\Server** bug

	由于在每次请求中，RPC必须携带一个 ID 标识， 故正常情况下 `1` 标识一个正常的返回值，在2.1.4版本中，修复为返回值  `-1` 即表示请求出错.
	
2、新增 **CLI** 命令行模式支持
	
CSpeed CLI模式下，只需要在入口文件添加如下代码即可启动一个 CLI 模式的CSpeed 框架系统，以便进行需要长时间的请求或者数据处理。

假设入口文件名称为： console.php

```php
<?php

$cli = new \Cs\console\Task();

$cli->run($argv[1]);
```
其中 **$argv[1]** 表示 命令行界面的输入参数信息，添加了如上的代码后，用户只需要在入口文件的目录下启动 “终端” or “命令行”，输入如下命令，请事先设置好环境变量或者使用 **PHP** 绝对路径：

```php
php console.php index/good/info
```

就会导向到 **index** 模块 **Good** 控制器 **infoAction** 方法
命令行模式也支持使用参数，如上所示：
```php
php console.php index/good/info/name/cspeed
```
那么在 **index** 模块 **Good** 控制器 **infoAction** 方法内，可以使用全局变量 **$_GET['name']** 或者CSpeed引擎的网络模块 **\Cs\net\Request** 的 **get('name')** 来获取 命令行模式下的传入参数 **name** 的值 **cspeed**。

**CSpeed v2.1.0特性：**

1、修复现有的系统BUG，提升性能.

2、增加 **观察者模式事件模型**，如：
```php
<?php

namespace app\modules\index\controllers;

class Index extends \Cs\mvc\Controller
{
	function initialise()
	{
	    $this->on(Index::EVENT_BEFORE_ACTION, [$this, '_beforeAction']);
	    $this->on(Index::EVENT_AFTER_ACTION, function(){
		echo "After action.<br>";
	    });
	}

	function _beforeAction()
	{
	    echo '_before action<br>';
	}
}
```
**CSpeed** 引擎的事件模型继承于 **Cs\tool\Component** 类，所有需要使用事件特性的需求，需要继承父类 **\Cs\tool\Component**，父类代码如下：
```php
<?php

namespace Cs\tool;

class Component 
{
	function on($eventName, $eventCallBack);

	function off($eventName, $eventCallBack = NULL);

	function trigger($eventName);
}
```
**CSpeed** 引擎的系统类中支持事件的有：**\Cs\App**、**\Cs\mvc\Controller**、**\Cs\mvc\Model**、**\Cs\rpc\Server** 类。
    
各个类支持的事件见IDE源码。

如，在新版本的引擎中，控制器层面由于引入了事件机制，故不在提供    **__beforeAction** 与 **__afterAction** 方法，如果需要在执行方法前执行特定的方法，那么可以使用事件，如：
```php
<?php

namespace app\modules\index\controllers;

class Index extends \Cs\mvc\Controller
{
	function initialise()
	{
	   // 绑定方法执行之前的事件
	    $this->on(Index::EVENT_BEFORE_ACTION, [$this, '_beforeAction']);
	    // 绑定方法执行之后的事件
	    $this->on(Index::EVENT_AFTER_ACTION, function(){
		echo "After action.<br>";
	    });
	}

	/**
	 * 方法执行执行会执行本方法
	 */
	function _beforeAction()
	{
	    echo '_before action<br>';
	}
}
```
**CSpeed v2.0.3特性：**

1、修复模型错误，优化整体架构

2、增加JSON-RPC模块，示例如下：

客户端：
```php
$client = new \Cs\rpc\Client("http://www.xxx.com/who");

$result = $client->goods(['name' => 'apple', 'price' => '9.99']);

/* RPC 服务端返回的JSON数据 */
echo $result;
```
服务端：

CSpeed服务端JSON-RPC类Server继承于 \Cs\mvc\Controller:
故控制器如下：
```php
<?php

namespace app\modules\home\controllers;

class Goods extends \Cs\rpc\Server
{
	/* RPC类控制器只运行从父类到本类的initialise 
	 * 只需要在本方法内将本对象绑定到RPC端即可
	 */
	public function initialise()
	{
	    $this->handle($this);
	}

	/**
	 * RPC方法后缀为Rpc，方法包含有一个参数为客户端调用的参数
	 * 数据类型与客户端调用的类型一致
	 */
	function listRpc($params)
	{
	    /* 只需要将返回的数据return即可 */
	    return $params;
	}
}
```
注意： CSpeed框架的```RPC```模块使用```Linux-libcurl```库进行开发，用户需要安装```libcurl 7.10.5```版本以上的类库文件即可。

数据调用的格式如下：

客户端调用传输的格式为：
```php
{"id":3,  "method":"xx", "params":"xx", "jsonrpc":"2.0"}
```
服务端返回的数据格式为：
```php
{"jsonrpc": "2.0", "result": 19, "id": 3}
```    
如果错误则包含一个 error 错误对象：
```php
{"jsonrpc": "2.0", "error": {"code": -32700, "message": "Invalid JSON reqeust data"}, "id": -1}
```    
当前版本中，如果出错，则返回的JSON数据中 ```id``` 始终为 ```1```， 如果正确则返回请求数据的 ```id``` 与之对应。新版本中 v2.1.4中已经修复为 ```-1``` 表示出错，并且携带有 ```error```对象.

修复使用 CSpeed 框架进行 API 项目时的高并发情况下的PHP崩溃的情况。
```php
$app = new App::getApp();

$app->get('/', function(){
	echo "hello cspeed";
});
```
此情况见于 2.0.0 版本。已在新版本中予以修复。

**CSpeed v2.0.1特性：**

新版本中 **getApp()** 方法是一个单例模式控制器获取方法；不再适应于创建一个 **Cs\App** 对象,
新版本中全部更新为 构造函数形式。可以不传入任何的参数来生成一个 零 IO 消耗的 application 对象 。

控制器全部更新为命名空间形式，如路由：

    http://www.supjos.com/hello/cspeed/news
    
导向到的是 **hello** 模块中的 **Cspeed** 控制器中的 **newsAction** 方法:

控制器的格式如下：

左右的控制器都必须继承自 **Cs\mvc\Controller** 类：

    <?php
    
    namespace app\modules\hello\controllers;
    
    class Cspeed extends \Cs\mvc\Controllers
    {
    	/**
    	 * 初始化方法，如果有父类的话，则会先从顶级父类开始执行到本方法
    	 * 来完成初始化
    	 */
    	function initialise()
    	{
    	
    	}
    	
    	/**
    	 * 具体的方法
    	 */
    	function newsActon()
    	{
    	
    	}
    }

## 安装指南 ##

CSpeed扩展目前在 **Github** 与 **码云** 平台均有代码存储库，用户只需下载源码然后按照如下方法安装即可：

Github:
	
	https://github.com/liqiongfan/cspeed
	
码云：

	https://gitee.com/josinli/cspeed

安装步骤：

	1、/usr/local/php_to_path/bin/phpize
	
	２、./configure --with-php-config=/usr/local/php_to_path/bin/php-config
	
	３、make install 
	
编译完成后在　**php.ini**　配置文件添加如下内容：
	
	extension_dir = "/usr/local/php-7.1.8-nts/lib/php/extensions/no-debug-non-zts-20160303/"
	
	extension=cspeed.so

然后重启 Nginx 的 **PHP-FPM** 或者 **Apache**：
	
	４、systemctl restart php-fpm 或者 systemctl restart httpd

## 测试性能 ##

测试命令：
	
	/usr/local/httpd-2.4.29/bin/ab -c100 -n100000 http://www.supjos.com/hello/cspeed/

测试机器[特意开启旧的笔记本进行测试，未开启工作站]：

	CPU: Intel(R) Core(TM) i5-2430M CPU @ 2.40GHz
	硬盘：HDD 750GB 2009年
	内存：4G Sansung
	
测试环境：
	
	nginx 1.12.1
	php 7.1.5
	php-fpm

测试结果：

	Concurrency Level:      100
	Time taken for tests:   9.781 seconds
	Complete requests:      100000
	Failed requests:        0
	Total transferred:      18500000 bytes
	HTML transferred:       0 bytes
	Requests per second:    10223.94 [#/sec] (mean)
	Time per request:       9.781 [ms] (mean)
	Time per request:       0.098 [ms] (mean, across all concurrent requests)
	Transfer rate:          1847.10 [Kbytes/sec] received

	Connection Times (ms)
		      min  mean[+/-sd] median   max
	Connect:        0    1   0.9      0       9
	Processing:     1    9   1.8      9      25
	Waiting:        1    9   1.8      9      24
	Total:          4   10   1.3     10      28
	WARNING: The median and mean for the initial connection time are not within a normal deviation
		These results are probably not that reliable.

	Percentage of the requests served within a certain time (ms)
	  50%     10
	  66%     10
	  75%     10
	  80%     10
	  90%     11
	  95%     12
	  98%     13
	  99%     13
	 100%     28 (longest request)

测试后单次，不产生任何IO的情况下可以达到 10223reqs/s，持平于1万左右吞吐量。解析ini文件的情况下，可达到将近9千的吞吐量.

## 典型项目结构 ##

     +--cspeed                                      入口文件
        +--app                                      项目目录
            +---config                              配置目录
                |---core.ini                        配置文件
            +---models                              通用模型目录
                |---User.php                        User模型
                |---Goods.php                       Goods模型
            +---modules                             模块目录
                +---backend                         后台模块
                    +---controllers                 backend模块控制器目录
                        |---Index.php               Index控制器
                        |---About.php               About控制器
                    +---views                       视图目录
                        +---index                   Index控制器的视图目录
                            |---index.phtml         Index控制器的index方法的视图文件
                        +---about                   About控制器的视图目录
                            |---index.phtml         About控制器的index方法的视图文件
                +---home                            Home模块
                    +---controllers                 Home模块控制器目录
                        |---Index.php               Index控制器
                    +---views                       视图目录
                        +---index                   Index控制器的视图目录
                            |---index.phtml         Index控制器的index方法的视图文件
            +---bootstrap.php                       框架的初始化类Bootstrap
        +--public                                   入口目录
            |---index.php                           入口文件
            +---assets                              资源目录
                +---css                             CSS资源
                +---js                              JS资源
                +---img                             图片资源

## 简单的示例 ##

１、WEB示例

    $app = new \Cs\App("../app/config/core.ini", "dev");
    
    $app->bootstrap()->run();

Cs\App类的构造函数支持传入绝对路径或者相对路径的INI文件，第二个参数是INI配置文件的解析节点，构造函数的两个参数都可以省略来进行API框架的配置达到减少IO操作的目的.

一个复杂的**WEB应用**就只需以上两行代码就可搞定。

２、API示例

    $app = new \Cs\App();
    
    $app->get('/hello/cspeed/:any:', function($any){
        echo "<div style='text-align:center;'>Hello CSpeed User, The any value is : $any.</div>";
    });
    
**RESTful API** 项目只需要添加对应的请求方法即可。

## CSpeed引擎INI配置项 ##

	[core]
	core.application                = '../app'               ; WEB目录
	core.bootstrap                  = '../app/bootstrap.php' ; 指定bootstrap 类目录
	core.bootstrap.method.string    = '__init'               ; 指定Bootstrap类的初始化方法的前缀 
	core.router.modules             =  index,home,back       ; 注册多模块
	core.router.default.module      =  index                 ; 默认模块
	core.router.default.controller  =  Index                 ; 默认控制器
	core.router.default.action      =  index                 ; 默认方法
	core.view.ext                   =  phtml                 ; 视图文件后缀
	core.view.auto.render           =  0                     ; 是否自动渲染视图，１：自动渲染、０：不渲染

	[db]
	db.master.type                   =  mysql                 ; 数据库类型，默认：mysql
	db.master.host                   =  localhost             ; 数据库主机地址
	db.master.port                   =  3306                  ; 数据库端口
	db.master.dbname                 =  supjos                ; 数据库名称
	db.master.username               =  root                  ; 数据库用户名
	db.master.password               =  3333                  ; 数据库密码

	[dev:core]
	core.application                = '../app'               ; WEB目录
	core.bootstrap                  = '../app/bootstrap.php' ; 指定bootstrap 类目录
	core.bootstrap.method.string    = '__init'               ; 指定Bootstrap类的初始化方法的前缀 
	core.router.modules             =  index,home            ; 注册多模块
	core.router.default.module      =  index                 ; 默认模块
	core.router.default.controller  =  Index                 ; 默认控制器
	core.router.default.action      =  index                 ; 默认方法
	core.view.ext                   =  xhtml                 ; 视图文件后缀

## 典型的Bootstrap初始化类 ##

	class Bootstrap implements \Cs\Bootstrap
	{
	    /* 初始化路由与视图 */
	    function __initRouter($di, $router)
	    {
			$di->set('view', function(){
			    return new \Cs\mvc\View();
			});
			$router->add(
			    '/back/:action:/:id:',
			    '/shop/list/$1'
			);
			$router->add(
			    '/shop/:controller:/:action:/:any:',
			    '/get/\1/\2/\3'
			);
	    }
	    
            /* 初始化数据库连接 */
            function __initDb($di, $router)
            {
                $di->set('db', function(){
                    return new \Cs\db\pdo\Adapter();
                });
            }
	}

## 典型的控制器结构 ##

    <?php
    
    namespace app\modules\hello\controllers;
    
    class Cspeed extends \Cs\mvc\Controllers
    {
    	/**
    	 * 初始化方法，如果有父类的话，则会先从顶级父类开始执行到本方法
    	 * 来完成初始化
    	 */
    	function initialise()
    	{
    	
    	}
    	
    	/**
    	 * 具体的方法
    	 */
    	function newsActon()
    	{
    	
    	}
    }

## 典型的模型结构 ##

	<?php

	namespace app\models;

	class User extends \Cs\mvc\Model
	{
		function tableName()
		{
			return "www_product";
		}
	}


## API索引 ##

### Cs\App ###

    /**
     * 构造函数.
     * @param string $iniConfigPath 需要加载到引擎的配置文件路径.
     * @param string $iniNodeName  　INI配置文件节点名称
     */
    function __construct($iniConfigPath, $iniNodeName)

    /**
     * 运行框架
     */
    function run()

    /**
     * 初始化引擎
     */
    function bootstrap()
    
    /**
     * 返回App对象
     */
    function getApp()
    
    /**
     * 设置系统加载别名
     * @param $aliasKey         需要加载的别名
     * @param $aliasFullPath    别名表示的绝对路径
     */
    function setAlias($aliasKey, $aliasFullPath)

    /**
     * 匹配 GET 请求
     * @param $url          待匹配的URL
     * @param $closure      匹配成功后需要执行的回调函数
     */
    function get($url, $closure)

    /**
     * 匹配 POST 请求
     * @param $url          待匹配的URL
     * @param $closure      匹配成功后需要执行的回调函数
     */
    function post($url, $closure)

    /**
     * 匹配 PUT 请求
     * @param $url          待匹配的URL
     * @param $closure      匹配成功后需要执行的回调函数
     */
    function put($url, $closure)

    /**
     * 匹配 PATCH 请求
     * @param $url          待匹配的URL
     * @param $closure      匹配成功后需要执行的回调函数
     */
    function patch($url, $closure)

    /**
     * 匹配 DELETE 请求
     * @param $url          待匹配的URL
     * @param $closure      匹配成功后需要执行的回调函数
     */
    function delete($url, $closure)
    
    /**
     * 匹配 HEAD 请求
     * @param $url          待匹配的URL
     * @param $closure      匹配成功后需要执行的回调函数
     */
    function head($url, $closure)

    /**
     * 匹配 OPTIONS 请求
     * @param $url          待匹配的URL
     * @param $closure      匹配成功后需要执行的回调函数
     */
    function options($url, $closure)

### Cs\Bootstrap ###

    预留接口
    
### Cs\db\ModelInterface ###

    /**
     * SELECT
     * @param array|string $fields   SELECT查询的字段
     * @return \Cs\db\ModelInterface
     */
    function select($fields);

    /**
     * FROM
     * @param string $table    查询的数据表名
     * @return ModelInterface
     */
    function from($table);

    /**
     * WHERE
     * @param array|string $whereCondition    WHERE条件
     * @return ModelInterface
     */
    function where( $whereCondition);

    /**
     * GROUP BY
     * @param array|string $groupBy          GROUP BY条件
     * @return ModelInterface
     */
    function groupBy( $groupBy);

    /**
     * HAVING
     * @param array|string $having           HAVING条件
     * @return ModelInterface
     */
    function having($having);

    /**
     * ORDER BY
     * @param array|string $orderBy           ORDER BY 条件
     * @return ModelInterface
     */
    function orderBy($orderBy);

    /**
     * LIMIT
     * @param int $count        条数
     * @param int $offset       偏移量
     * @return ModelInterface
     */
    function limit($count, $offset);

    /**
     * @param $rawSql               原生SQL语句
     * @param array $bindParams     SQL语句绑定的预处理变量
     * @return ModelInterface
     */
    function query($rawSql, array $bindParams);

    /**
     * 执行query方法的语句，并返回结果
     * @return mixed
     */
    function execute();
    
### Cs\db\pdo\Adapter ###

    /**
     * PDO构造函数.
     * @param array $connectionOptions  可选连接参数,如： \PDO::ATTR_PERSISTENT.
     */
    function __construct(array $connectionOptions = [])

    /**
     * @param array|string 查询的字段
     * @return $this|Adapter
     */
    function select($fields)

    /**
     * @param string $table 表名
     * @return $this|Adapter
     */
    function from($table)
    
    /**
     * @param array|string $whereCondition　WHERE 条件
     * @return $this
     */
    function where( $whereCondition)

    /**
     * @param array|string $groupBy GROUP BY 条件
     * @return $this
     */
    function groupBy($groupBy)

    /**
     * @param array|string $having HAVING 条件
     * @return $this|Adapter
     */
    function having($having)

    /**
     * @param array|string $orderBy ORDER BY 条件，如： orderBy(['id DESC', 't ASC'])
     * @return $this|Adapter
     */
    function orderBy($orderBy)

    /**
     * @param int $count    数目
     * @param int $offset   偏移量
     * @return $this|Adapter
     */
    function limit($count, $offset) 

    /**
     * @param string $rawSql       执行的SQL原生语句
     * @param array $bindParams    绑定的预处理变量
     * @return $this|Adapter
     */
    function query($rawSql, array $bindParams)
    
    /**
     * 返回query方法的执行结果
     * @return mixed
     */
    function execute()

    /**
     * @param $whereCondition    WHERE 条件
     * @return $this|Adapter
     */
    function andWhere($whereCondition)

    /**
     * 开启SQL事务
     */
    function begin()

    /**
     * 回滚事务
     */
    function rollback()

    /**
     * 提交事务
     */
    function commit()

    /**
     * 返回最后的插入记录 ID
     * @return mixed
     */
    function lastInsertId()

    /**
     * 返回影响的行数
     */
    function rowCount()

    /**
     * 从结果集中返回一条记录
     */
    function find()

    /**
     * 返回所有的结果集
     */
    function findAll()

### Cs\di\Di ###

    /**
     * Di 构造函数
     */
    function __construct()

    /**
     * @param $key      返回注入容器的对象的关联key
     * @return object|mixed
     */
    function get($key)

    /**
     * @param $key      存入注入容器的对象对应的key索引
     * @param $closure  回调函数，回调函数的返回值存入注入容器
     */
    function set($key, $closure)

### Cs\mvc\Controller ###

    /**
     * @var $di \Cs\di\Di　Di容器对象
     */
    public $di;

    /**
     * @var $view \Cs\mvc\View　View视图对象
     */
    public $view;

    /**
     * @var $router \Cs\mvc\Router    Router路由对象
     */
    public $router;
    
    /**
     * 路由的初始化方法
     * 从父类初始化到本类
     */
    function initialise()
    
    /**
     * 在执行具体的方法之前调用
     * 不会执行父类的本方法
     */
    function __beforeAction()
    
    /**
     * 在执行完具体的方法之后调用
     * 不会执行父类的本方法
     */
    function __afterAction()

### Cs\mvc\Model ###

     * Model 模型构造函数.
     */
    public function __construct()

    /**
     * 返回需要执行 UPDATE 操作的Model对象
     * @return Model
     */
    static function find()

    /**
     * 返回模型需要操作的数据表名，默认操作当前模型对应的表名
     */
    function tableName()

    /**
     * @param array|string $fields　SELECT 条件
     * @return $this
     */
    function select($fields)

    /**
     * @param array|string $where WHERE 条件
     * @return $this
     */
    function where($where)

    /**
     * @param array|string $where    WHERE条件
     * @return $this
     */
    function andWhere($where)
    
    /**
     * @param array|string $orderBy    ORDER BY 条件
     * @return $this
     */
    function orderBy($orderBy)

    /**
     * @param array|string $groupBy    GROUP BY条件
     * @return $this
     */
    function groupBy($groupBy)

    /**
     *返回一条结果
     */
    function one()

    /**
     * 返回结果集中的所有记录
     */
    function all()

    /**
     * 执行 UPDATE|INSERT 操作，如果是new模型执行 INSERT 操作, find模型执行 UPDATE 操作
     */
    function save()

    /**
     * 执行 DELETE 操作
     */
    function delete()

### Cs\mvc\View ###

    /**
     * View 构造函数.
     */
    function __construct()

    /**
     * 渲染视图模板
     * @param $templateFileName     需要渲染的文件名称，不带后缀
     * @param $variables           需要传入模板的数据
     */
    function render($templateFileName, $variables)

    /**
     * 设置模板的后缀，默认后缀 phtml
     * @param $suffixName           需要设置的模板后缀
     */
    function setSuffix($suffixName)

    /**
     * 向模板中添加数据
     * @param $varName           变量名称
     * @param $varValue            变量值
     */
    function setVar($varName, $varValue)

    /**
     * 获取渲染的结果
     * @param $templateFileName     需要渲染的文件名称，不带后缀
     * @param $variables           需要传入模板的数据
     */
    function getRender($templateFileName, $variables)

    /**
     * 设置视图引擎渲染的模板存储目录
     * @param $viewDir            视图存储的目录
     */
    function setViewDir($viewDir)

    /**
     * 布局渲染
     * @param $templateFileName     需要渲染的文件名称，不带后缀
     * @param $variables           需要传入模板的数据
     */
    function partial($templateFileName, $variables)

### Cs\net\Request ###

    /**
     *获取 HTTP_HOST 信息
     */
    function getHttpHost()

    /**
     * 获取 HTTP USER AGENT
     */
    function getHttpUserAgent()

    /**
     * 获取 SERVER_NAME
     */
    function getServerName()

    /**
     * 获取 SERVER_ADDR
     */
    function getServerAddr()

    /**
     * 获取 REMOTE_PORT
     */
    function getRemotePort()

    /**
     * 获取 REMOTE_ADDR
     */
    function getRemoteAddr()

    /**
     * 获取 REQUEST_SCHEME
     */
    function getReqeustScheme()

    /**
     * 获取 SERVER_PROTOCOL
     */
    function getServerProtocol()

    /**
     * 获取 DOCUMENT_ROOT
     */
    function getDocumentRoot()

    /**
     * 获取 REQUEST_URI
     */
    function getRequestUri()

    /**
     * 获取 SCRIPT_NAME
     */
    function getScriptName()
    
    /**
     * 获取 PATH_INFO
     */
    function getPathInfo()

    /**
     * 获取 QUERY_STRING
     */
    function getQueryString()

    /**
     * 是否 GET 请求
     */
    function isGet()

    /**
     * 是否 PUT 请求
     */
    function isPut()

    /**
     * 是否 PATCH 请求
     */
    function isPatch()

    /**
     * 是否 DELETE 请求
     */
    function isDelete()

    /**
     * 是否 HEAD 请求
     */
    function isHead()

    /**
     * 是否 OPTIONS 请求
     */
    function isOptions()

    /**
     * 获取 $_GET 数据
     */
    function get()

    /**
     * 获取 $_POST 数据
     */
    function getPost()

### Cs\net\Response ###

    /**
     * Response 构造函数.
     */
    function __construct()

    /**
     * 设置 HTTP 头
     * 如： setHeader('Content-Type', 'application/json;charset=UTF-8');
     * @param $headerKey        HTTP 头名称
     * @param $headerValue      HTTP 头值
     */
    function setHeader($headerKey, $headerValue)

    /**
     * 删除设置的 HTTP 头信息
     * @param $headerKey       需要删除的HTTP头的名称，函数必须在调用send()前使用
     */
    function unsetHeader($headerKey)
    
    /**
     * 发送 HTTP 头信息与相应内容
     */
    function send()

    /**
     * 设置返回的响应内容为JSON格式数据
     * @param array $jsonArray
     */
    function setJsonContent(array $jsonArray)

    /**
     * 原始数据格式
     * @param $rawContent   原始数据格式
     */
    function setRawContent($rawContent)

    /**
     * 重定向到指定的URL
     * 如：redirect('/index/lists') 重定向到： http://host/index/lists
     * @param $url          要重定向的 URL
     */
    function redirect($url)

### Cs\tool\Config ###

    /**
     * 构造函数.
     */
    function __construct()

    /**
     *加载INI数据
     * @param string $configFilePath    INI文件的相对路径
     */
    function loadConfig($configFilePath)

    /**
     * 返回INI数据，解析节点
     */
    function getConfigs()

    /**
     * 返回INI数据中，对应的节点数据
     */
    function getConfig($configKey)

### Cs\mvc\Router ###

    /**
     * Router 构造函数.
     */
    function __construct()

    /**
     * 添加一条记录到Router路由
     * @param $destUrl 支持正则匹配的 URL 路由
     * @param $toUrl   匹配路由后的重定向路由
     */
    function add($destUrl, $toUrl)

    /**
     * 从 INI 配置文件添加路由
     * @param $iniFile 包含有路由的 INI 配置文件
     */
    function addFromIni($iniFile)

    /**
     * 从数组中添加路由
     * @param $arrayRouters 包含有数组的路由，数组的键是待匹配的 URL，值是匹配成功后重定向的URL
     */
    function addFromArray($arrayRouters)
    {

    }

### Cs\tool\Component ###

	/**
	 * 构造函数
	
	/**
	 * 绑定事件
	 * @param $eventName 需要绑定的事件名称
	 * @param $callBack     事件发生时调用的函数
	 */
	function on($eventName, $callBack);
	
	/**
	 * 解除已经绑定的事件
	 * @param $eventName 需要解除绑定的事件名称
	 * @param $callBack     事件绑定的函数句柄, NULL会解除所有的事件名称一致的事件消息
	 */
	function off($eventName, $callBack = NULL);
	
	/**
	 * 触发事件
	 * @param $eventName 	需要触发的事件的名称
	 */
	function trigger($eventName);