IcePHP 框架文档

ゞ浴缸里的玫瑰 2022-08-24 05:12 178阅读 0赞

IcePHP框架文档

简介

2014年6月25日 星期三

10:27

<table> 
 <tbody> 
 <tr> 
 <td> 定位 </td> 
 <td> IcePHP是一个私有的,非开源,基于MVC结构的轻量级PHP开发框架. </td> 
 </tr> 
 <tr> 
 <td> 首要目标 </td> 
 <td> 以最低的学习成本提供了一个简单,易用,高效的PHP开发框架. 并根据具体项目需求进行裁剪,修改,增强 </td> 
 </tr> 
 <tr> 
 <td> 阅读前提 </td> 
 <td> 本手册假设阅读人员已经熟练掌握以下概念 OOP,MVC,设计模式,ORM,CRUD,单一入口 如有疑问,请百度之 </td> 
 </tr> 
 <tr> 
 <td> 环境要求 </td> 
 <td> 框架随时进化,请尽可能提供最新的稳定版开发及运行环境 开发环境推荐WAMP最新版 运行环境推荐LNMP最新稳定版 </td> 
 </tr> 
 <tr> 
 <td> 使用许可 </td> 
 <td> 仅在本人曾经工作的互联网公司曾经参与过的项目中使用. 框架随时进化,不提供向后兼容 </td> 
 </tr> 
 <tr> 
 <td> 特性 </td> 
 <td> 框架尽可能精简,清晰,以方便随时根据需求进行进化 仅支持Mysql,Mongo,不支持SQL Server,Oracle及其它不常用数据库 内建简单模板,不支持Smarty或其它模板 所有看起来高大上的功能均不支持,请开发人员自行实现 </td> 
 </tr> 
 <tr> 
 <td> 调试模式 </td> 
 <td> 框架提供调试模式与运行模式的切换功能 </td> 
 </tr> 
 </tbody> 
</table>

目录结构

2014年6月25日 星期三

10:36

一级目录

<table> 
 <tbody> 
 <tr> 
 <td> program </td> 
 <td> 程序目录,存放开发人员编写的项目代码 </td> 
 </tr> 
 <tr> 
 <td> public </td> 
 <td> 公开目录,存放所有允许Web用户访问的静态文件,上传文件以及项目入口文件 </td> 
 </tr> 
 <tr> 
 <td> run </td> 
 <td> 运行时期目录,存放框架运行时生成的缓存文件,日志文件以及编译后的视图文件 </td> 
 </tr> 
 <tr> 
 <td> system </td> 
 <td> 框架目录,存放框架系统类 </td> 
 </tr> 
 </tbody> 
</table>

程序目录

<table> 
 <tbody> 
 <tr> 
 <td> controller </td> 
 <td> 控制器目录,MVC结构中的C 当项目规模较大时,可建立一层二级目录以分别存放控制器类 但不同目录之中的控制器类不允许同名 </td> 
 </tr> 
 <tr> 
 <td> model </td> 
 <td> 数据逻辑目录,MVC结构中的M </td> 
 </tr> 
 <tr> 
 <td> view </td> 
 <td> 视图目录,MVC结构中的V </td> 
 </tr> 
 <tr> 
 <td> logical </td> 
 <td> 业务逻辑目录,除小型项目外,MVC中的M将被拆分为两部分 数据逻辑(Model)存放单一数据表内部的逻辑实现 业务逻辑(Logical)存放多个数据表之间/之上的逻辑实现 </td> 
 </tr> 
 <tr> 
 <td> unit </td> 
 <td> 逻辑单元目录,大型项目时,MVC中的M将分拆分为三部分 逻辑单元(Unit)存放与数据表无关的逻辑实现 </td> 
 </tr> 
 <tr> 
 <td> config </td> 
 <td> 配置目录,存放系统配置及项目配置 </td> 
 </tr> 
 <tr> 
 <td> lib </td> 
 <td> 外接库目录,提供与其它非框架代码库的对接功能 </td> 
 </tr> 
 </tbody> 
</table>

公开目录

<table> 
 <tbody> 
 <tr> 
 <td> static </td> 
 <td> 静态文件目录,存放所有项目中使用到的脚本文件,样式表文件,图片文件及其它静态文件 </td> 
 </tr> 
 <tr> 
 <td> upload </td> 
 <td> 上传文件目录,存放Web用户上传的文件 </td> 
 </tr> 
 <tr> 
 <td> index.php </td> 
 <td> 单一入口文件,此文件需要Apache或Nginx配置为默认文件 </td> 
 </tr> 
 </tbody> 
</table>

运行时期目录

<table> 
 <tbody> 
 <tr> 
 <td> cache </td> 
 <td> 缓存文件目录 </td> 
 </tr> 
 <tr> 
 <td> log </td> 
 <td> 日志文件目录 </td> 
 </tr> 
 <tr> 
 <td> view_c </td> 
 <td> 编译后的视图目录 </td> 
 </tr> 
 </tbody> 
</table>

系统目录

<table> 
 <tbody> 
 <tr> 
 <td> frame.system.php </td> 
 <td> 框架入口类 </td> 
 </tr> 
 <tr> 
 <td> plugin.php </td> 
 <td> 框架作为插入模式使用时的入口文件 </td> 
 </tr> 
 <tr> 
 <td> program.php </td> 
 <td> 框架作为命令行模式使用时的入口文件 </td> 
 </tr> 
 <tr> 
 <td> core </td> 
 <td> 框架核心类目录 </td> 
 </tr> 
 <tr> 
 <td> dao </td> 
 <td> 数据访问对象类目录 </td> 
 </tr> 
 <tr> 
 <td> mvc </td> 
 <td> MVC相关类目录 </td> 
 </tr> 
 <tr> 
 <td> enhance </td> 
 <td> 扩展功能类目录 </td> 
 </tr> 
 </tbody> 
</table>

静态文件目录

<table> 
 <tbody> 
 <tr> 
 <td> static/js </td> 
 <td> JS脚本文件目录 </td> 
 </tr> 
 <tr> 
 <td> static/img </td> 
 <td> 图片文件目录 </td> 
 </tr> 
 <tr> 
 <td> static/css </td> 
 <td> 样式表文件目录 </td> 
 </tr> 
 <tr> 
 <td> 其它 </td> 
 <td> 其它静态文件 </td> 
 </tr> 
 </tbody> 
</table>

命名规范

2014年6月25日 星期三

11:16

<table> 
 <tbody> 
 <tr> 
 <td> 所有文件名 </td> 
 <td> 全部由小写字母组成(不包括外接库文件) </td> 
 </tr> 
 <tr> 
 <td> 控制器类 </td> 
 <td> 以.controller.php结尾 </td> 
 </tr> 
 <tr> 
 <td> 数据逻辑类 </td> 
 <td> 以.model.php结尾 </td> 
 </tr> 
 <tr> 
 <td> 业务逻辑类 </td> 
 <td> 以.logical.php结尾 </td> 
 </tr> 
 <tr> 
 <td> 逻辑单元类 </td> 
 <td> 以.unit.php结尾 </td> 
 </tr> 
 <tr> 
 <td> 视图文件 </td> 
 <td> 以.tpl结尾(可通过配置文件修改) </td> 
 </tr> 
 <tr> 
 <td> 编译后的视图文件 </td> 
 <td> 以.php结尾 </td> 
 </tr> 
 <tr> 
 <td> 框架类 </td> 
 <td> 以.system.php结尾 </td> 
 </tr> 
 <tr> 
 <td> 日志文件 </td> 
 <td> 以.log结尾 </td> 
 </tr> 
 <tr> 
 <td> 缓存文件 </td> 
 <td> 以.cache结尾 </td> 
 </tr> 
 </tbody> 
</table>

所有文件以无BOM头的UTF-8编码格式保存

调用方法

2014年6月25日 星期三

13:57

<table> 
 <tbody> 
 <tr> 
 <td> Web模式 </td> 
 <td> …/ice/public/index.php?c=&lt;控制器名称&gt;&amp;a=&lt;动作名称&gt;&amp;…… </td> 
 <td> 默认使用参数c来指定控制器名称,使用a来指定动作名称,也可以在系统配置中修改 </td> 
 </tr> 
 <tr> 
 <td> 插入模式 </td> 
 <td> &lt;?php require_once '../../ice/system/plugin.php'; plugin('webservice','index',array('s'=&gt;'answer')); exit; </td> 
 <td> 1.包含ice/system/plugin.php 2.调用plugin方法,并指定控制器名称,动作名称,以及其它参数 </td> 
 </tr> 
 <tr> 
 <td> 命令行模式 </td> 
 <td> php ice/system/program.php "c=webservice&amp;a=test&amp;…" </td> 
 <td> 1.使用PHP启动 ice/system/program.php 2.所有参数如Web模式, 使用引号包含 </td> 
 </tr> 
 <tr> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

控制器(controller)

2014年6月25日 星期三

10:56

<table> 
 <tbody> 
 <tr> 
 <td> 类名 </td> 
 <td> 以C前缀,之后是驼峰规则,如 CIndex 与文件名对应 index.controller.php =&gt; CIndex otherprocess.controll.php =&gt; COtherProcess </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 基类 </td> 
 <td> &nbsp;SController </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 属性rawController </td> 
 <td> 原始请求的控制器名称 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 属性rawAction </td> 
 <td> 原始请求的动作名称 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 属性controller </td> 
 <td> 当前请求的控制器名称,可能与原始控制器名称不一致 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 属性action </td> 
 <td> 当前请求的动作名称,可能与原始动作名称不一致 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 属性header </td> 
 <td> &lt;!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "<a href="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" rel="nofollow">http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd</a>"&gt; &lt;html xmlns="<a href="http://www.w3.org/1999/xhtml" rel="nofollow">http://www.w3.org/1999/xhtml</a>"&gt; &lt;head&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;meta http-equiv="Content-Type" content="text/html; charset=utf-8" /&gt; </td> 
 <td> 常用于输出HTML头 </td> 
 </tr> 
 <tr> 
 <td> 属性backUrl </td> 
 <td> 本次请求的来源页面地址 </td> 
 <td> 即referer </td> 
 </tr> 
 <tr> 
 <td> 属性request </td> 
 <td> 本次请求的参数对象 </td> 
 <td> 类SRequest </td> 
 </tr> 
 <tr> 
 <td> 方法redirectTemporary </td> 
 <td> 输出一个302跳转(临时重定向) </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法redirectPermanent </td> 
 <td> 输出一个301跳转(永久重定向) </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法headerto </td> 
 <td> 重定向到指定控制器及动作(Action),利用302跳转实现 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法ajaxOk </td> 
 <td> 输出一个固定格式的JSON </td> 
 <td> 用于Ajax响应 </td> 
 </tr> 
 <tr> 
 <td> 方法ajaxError </td> 
 <td> 输出一个固定格式的JSON错误 </td> 
 <td> 用于Ajax响应 </td> 
 </tr> 
 <tr> 
 <td> 方法setBack </td> 
 <td> 记录当前地址为回退地址,以便后继使用 </td> 
 <td> 跨请求 </td> 
 </tr> 
 <tr> 
 <td> 方法getBack </td> 
 <td> 取回之前由setBack记录的回退地址,以便跳转 </td> 
 <td> 跨请求 </td> 
 </tr> 
 <tr> 
 <td> 方法goBack </td> 
 <td> 取回之前记录的回退地址,并跳转 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法cacheToday </td> 
 <td> 输出一个CDN的缓存头,指定本次输出可以缓存的时间 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法mustWWW </td> 
 <td> 限制本次请求的二级域名必须是www,利用must实现 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法must </td> 
 <td> 限制本次请求的二级域名必须是指定的二级域名,不允许Ajax请求 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 伪构造函数 </td> 
 <td> 如果控制器中存在方法 construct ,则此方法将在具体动作前执行,此时$this-&gt;request等属性已经生成. 原构造 方法__construct 时,属性尚未生成 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

数据逻辑(model)

2014年6月25日 星期三

10:56

<table> 
 <tbody> 
 <tr> 
 <td> 类名 </td> 
 <td> 以M前缀,之后是驼峰规则,如 MOttProgram 与文件名对应 ottprogram.model.php =&gt; MOttProgram program.model.php =&gt; MProgram </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 基类 </td> 
 <td> SModel </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 属性table </td> 
 <td> 相对应的表对象 </td> 
 <td> STable </td> 
 </tr> 
 <tr> 
 <td> 方法table </td> 
 <td> 获取相对应的表对象 </td> 
 <td> STable </td> 
 </tr> 
 <tr> 
 <td> 其它方法 </td> 
 <td> 请参考类 STable </td> 
 <td> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

常用定义

class <类名> extendsSModel \{

protectedstatic $handle;

/\*\*

\* 构造方法

\*/

protectedfunction \_\_construct() \{

$this->table= table ( '<对应的表名>' );

/\*\*

\* 单例化

\* @return <类名>

\*/

public staticfunction instance() \{

if (!self::$handle) \{

self::$handle= new self ();

returnself::$handle;

<其它数据逻辑方法>

常用调用

$mProgram=MProgram::instance();

$mProgram->select(……);

业务逻辑(logical)

2014年6月25日 星期三

10:56

<table> 
 <tbody> 
 <tr> 
 <td> 类名 </td> 
 <td> 以L前缀,之后是驼峰规则,如 LDeviceAuth 与文件名对应 deviceauth.logical.php =&gt; LDeviceAuth webservice.logical.php =&gt; LWebservice </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 基类 </td> 
 <td> SLogical </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 约束 </td> 
 <td> 禁止实例化,所有方法都是静态方法 </td> 
 <td> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

示例

视图(view)

2014年6月26日 星期四

10:40

简介

<table> 
 <tbody> 
 <tr> 
 <td> 模板 </td> 
 <td> 框架自建一个简单的模板系统,使用一套类PHP的语法 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 编译 </td> 
 <td> 编译后的视图文件存放在view_c目录下 </td> 
 <td> 可通过系统配置修改 </td> 
 </tr> 
 <tr> 
 <td> 自动编译 </td> 
 <td> 视图更新后,将会自动重新编译 自动编译将浪费一定效率来判断视图是否已经更新 </td> 
 <td> 可通过系统配置修改 不再自动编译 </td> 
 </tr> 
 <tr> 
 <td> 约束 </td> 
 <td> 语法紧密,不要书写多余的空格 </td> 
 <td> 将导致编译错误 </td> 
 </tr> 
 <tr> 
 <td> 约束 </td> 
 <td> 避免一行内多个模板语法 </td> 
 <td> 有时将导致编译错误 </td> 
 </tr> 
 </tbody> 
</table>

模板语法

<table> 
 <tbody> 
 <tr> 
 <td> 模板定界符 </td> 
 <td> { } </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> for循环 </td> 
 <td> {for($i=0;$i&lt;count($arr);$i++)} {endfor} </td> 
 <td> 定界符内是PHP语法 </td> 
 </tr> 
 <tr> 
 <td> foreach循环 </td> 
 <td> {foreach($arr as $k=&gt;$v)} {endforeach} </td> 
 <td> 定界符内是PHP语法 </td> 
 </tr> 
 <tr> 
 <td> while循环 </td> 
 <td> {while(条件表达式)} {endwhile} </td> 
 <td> 定界符内是PHP语法 </td> 
 </tr> 
 <tr> 
 <td> if判断 </td> 
 <td> {if($i&gt;5)} {elseif($i&gt;2)} {else} {endif} </td> 
 <td> 定界符内是PHP语法 </td> 
 </tr> 
 <tr> 
 <td> 嵌套原生代码 </td> 
 <td> {php} {/php} </td> 
 <td> 其中可以书写任意PHP代码 </td> 
 </tr> 
 <tr> 
 <td> 子模板包含 </td> 
 <td> {include('子模板',参数数组)} </td> 
 <td> 注意:子模板中使用的变量,必须在主模板中明确传递 </td> 
 </tr> 
 <tr> 
 <td> 赋值 </td> 
 <td> {assign(结果变量名=model('模型类名')-&gt;方法名(参数表))} {assign(结果变量名=逻辑类名::方法名(参数表))} </td> 
 <td> ()间是PHP语法 </td> 
 </tr> 
 <tr> 
 <td> 显示函数返回值 </td> 
 <td> {date('Y-m-d H;i:s')} {dump($var,'title',true)} </td> 
 <td> 既然是函数调用,最后就应该是')'结束 </td> 
 </tr> 
 <tr> 
 <td> 显示变量的值 </td> 
 <td> {$变量} {$对象-&gt;属性} {$数组[下标]} </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 判断是否IE浏览器 </td> 
 <td> {ifIE} {else} {endif} </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 自定义标签 </td> 
 <td> {:方法名称(参数列表)} &nbsp; </td> 
 <td> 这将调用STemplate下的静态公开方法,并显示返回结果 </td> 
 </tr> 
 <tr> 
 <td> 包含JS文件 </td> 
 <td> {js('jquery','my'[,…])} </td> 
 <td> 不需要书写后缀 可一次包含多个脚本文件 文件存储路径由系统配置文件决定,默认是 /ice/public/static/js/ </td> 
 </tr> 
 <tr> 
 <td> 包含CSS文件 </td> 
 <td> {css('main','page'[,…])} </td> 
 <td> 同上 </td> 
 </tr> 
 <tr> 
 <td> 输出图片路径 </td> 
 <td> {img} </td> 
 <td> 输出图片所在路径前缀 常用在IMG标签的SRC属性中 </td> 
 </tr> 
 <tr> 
 <td> 输出XML头 </td> 
 <td> {xml} </td> 
 <td> &lt;?xml version="1.0" encoding="utf-8"?&gt; </td> 
 </tr> 
 <tr> 
 <td> 输出上传文件路径 </td> 
 <td> {upload} </td> 
 <td> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

配置(config)

2014年6月25日 星期三

10:57

系统配置ice/program/config/system.config.php

以下为经常修改项目

<table> 
 <tbody> 
 <tr> 
 <td> path_root </td> 
 <td> 应用程序根路径 默认值为 /ice/public/ 此处需要根据Web服务器的配置决定,即访问到 ice/public/index.php 文件所需要的URL地址中的路径部分 如 Apache的documentRoot配置为 ice 目录,则此处应为 /public/ </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> config </td> 
 <td> 配置模式,当此处使用debug时,自动开启调试模式 当此处使用run时,开启运行模式 </td> 
 <td> 参考调试 </td> 
 </tr> 
 <tr> 
 <td> cachePage </td> 
 <td> 页面片段缓存的方法 , none/file/mem </td> 
 <td> 参考页面片段 </td> 
 </tr> 
 <tr> 
 <td> cacheData </td> 
 <td> 数据缓存的方法 , none/file/mem </td> 
 <td> 参考DAO </td> 
 </tr> 
 <tr> 
 <td> cacheMust </td> 
 <td> 特定缓存的方法 , none/file/mem </td> 
 <td> 参考缓存 </td> 
 </tr> 
 <tr> 
 <td> 调用方法 </td> 
 <td> config('system','&lt;配置项名称&gt;'); </td> 
 <td> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

日志配置ice/program/config/log.config.php

通常不修改

应用配置ice/program/config/\*.config.php

根据项目决定

<table> 
 <tbody> 
 <tr> 
 <td> 调用方法 </td> 
 <td> config('&lt;配置文件名&gt;','&lt;配置项名称&gt;'[,&lt;下级配置项名称&gt;]); </td> 
 <td> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

以下配置根据系统配置中的config的值分别存放在 ice/program/config/debug/目录下 及ice/program/config/run/目录下

数据库配置database.config.php

以下为经常修改项目

<table> 
 <tbody> 
 <tr> 
 <td> _default </td> 
 <td> array( 'host'=&gt;'192.168.60.24',//数据库服务器地址 'port'=&gt;'3306',&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//数据库服务端口 'user'=&gt;'root', 'password'=&gt;'', 'database'=&gt;'ronghetv',//数据库名称 ) </td> 
 <td> 此处配置默认数据库 </td> 
 </tr> 
 <tr> 
 <td> &lt;表名&gt; </td> 
 <td> 同上 </td> 
 <td> 特意指定某个表所在的数据库配置 </td> 
 </tr> 
 <tr> 
 <td> *注意 </td> 
 <td> 配置文件是一个PHP文件,这表明此处允许全部PHP语法 如果有多个表需要指定同一个非默认数据库配置 那么可以事先定义一个变量来存储数据库配置,以简化表配置 </td> 
 <td> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

Memcache配置memcache.config.php

<table> 
 <tbody> 
 <tr> 
 <td> servers </td> 
 <td> 共有多少台缓存服务器 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> &lt;N&gt; </td> 
 <td> array(&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 'host'=&gt;'127.0.0.1',//缓存服务器主机地址 'port'=&gt;'11211'&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//缓存服务端口 ) </td> 
 <td> 第N台缓存服务器的配置 </td> 
 </tr> 
 </tbody> 
</table>

文件缓存配置filecache.config.php

通常不修改

Mongo数据库配置mongo.config.php

<table> 
 <tbody> 
 <tr> 
 <td> &lt;表名&gt; </td> 
 <td> 服务地址 </td> 
 <td> mongodb://localhost/ice </td> 
 </tr> 
 </tbody> 
</table>

系统类(system)

2014年6月25日 星期三

11:10

框架常量(仅用于框架)

<table> 
 <tbody> 
 <tr> 
 <td> ICE_PHP_FRAMEWORK </td> 
 <td> 用于判断是否已经包含框架 </td> 
 <td> by liyong@nenu.edu.cn QQ:31008088 </td> 
 </tr> 
 <tr> 
 <td> DIR_ROOT </td> 
 <td> 框架根目录 </td> 
 <td> /ice/ </td> 
 </tr> 
 <tr> 
 <td> DIR_SYS </td> 
 <td> 框架系统目录 </td> 
 <td> /ice/system/ </td> 
 </tr> 
 <tr> 
 <td> DIR_CONFIG </td> 
 <td> 框架配置目录 </td> 
 <td> /ice/progra/config/ </td> 
 </tr> 
 </tbody> 
</table>

框架全局函数(为开发人员提供)

<table> 
 <tbody> 
 <tr> 
 <td> dump </td> 
 <td> 显示/返回一个复杂变量/对象的值 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> debug </td> 
 <td> 记录一个调试信息 如果在调试模式下,输出时会附带输出全部调试信息 </td> 
 <td> 由SDebug实现 </td> 
 </tr> 
 <tr> 
 <td> isDebug </td> 
 <td> 判断是否处于调试状态 </td> 
 <td> 由SDebug实现 </td> 
 </tr> 
 <tr> 
 <td> setDebug </td> 
 <td> 设置当前调试状态 </td> 
 <td> 由SDebug实现 </td> 
 </tr> 
 <tr> 
 <td> config </td> 
 <td> 获取配置 </td> 
 <td> 由SConfig实现 </td> 
 </tr> 
 <tr> 
 <td> cache </td> 
 <td> 获取缓存实例 </td> 
 <td> SCache </td> 
 </tr> 
 <tr> 
 <td> table </td> 
 <td> 创建一个标准表对象 </td> 
 <td> STable </td> 
 </tr> 
 <tr> 
 <td> mongo </td> 
 <td> 创建一个标准Mongo对象 </td> 
 <td> SMongo </td> 
 </tr> 
 <tr> 
 <td> lib </td> 
 <td> 引入一个外接库文件 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> plugin </td> 
 <td> 本框架作为插入模式使用时,主入口函数 </td> 
 <td> 由SFrame实现 </td> 
 </tr> 
 <tr> 
 <td> fragment </td> 
 <td> 显示一个页面片段,通常由View来调用 </td> 
 <td> 由SFrame实现 </td> 
 </tr> 
 <tr> 
 <td> display </td> 
 <td> 显示一个指定的视图 </td> 
 <td> 由STemplate实现 </td> 
 </tr> 
 <tr> 
 <td> fetch </td> 
 <td> 获取一个视图的结果,而不显示 </td> 
 <td> 由STemplate实现 </td> 
 </tr> 
 <tr> 
 <td> url </td> 
 <td> 创建一个URL地址 </td> 
 <td> 由STemplate实现 </td> 
 </tr> 
 <tr> 
 <td> writeLog </td> 
 <td> 写文本日志 </td> 
 <td> 由SLog实现 </td> 
 </tr> 
 <tr> 
 <td> sessionLog </td> 
 <td> 写入当前会话日志 </td> 
 <td> 由SLog实现 </td> 
 </tr> 
 <tr> 
 <td> isCliMode </td> 
 <td> 判断当前是否是命令行模式 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> mid </td> 
 <td> 字符串截取 </td> 
 <td> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

框架类(只描述开发人员可以使用的)

<table> 
 <tbody> 
 <tr> 
 <td> SFrame::checkfile </td> 
 <td> 检查本地文件是否存在 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> SFrame::timeLog </td> 
 <td> 获取当前时间/获取当前时间与指定时间的时间差 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> SFrame::getRequest </td> 
 <td> 获取当前请求的请求参数对象 </td> 
 <td> SRequest </td> 
 </tr> 
 <tr> 
 <td> SFrame::getModule </td> 
 <td> 获取当前模块名称 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> SFrame::getController </td> 
 <td> 获取当前控制器名称 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> SFrame::getAction </td> 
 <td> 获取当前动作名称 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> SFrame::getRawController </td> 
 <td> 获取原始控制器名称 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> SFrame::getRawAction </td> 
 <td> 获取原始动作名称 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> SFrame::makeDir </td> 
 <td> 根据文件名,创建必要的目录 </td> 
 <td> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

不对开发人员开放

<table> 
 <tbody> 
 <tr> 
 <td> SConfig </td> 
 <td> 实现配置文件的读取 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> SDebug </td> 
 <td> 实现调试模式及调试信息的管理 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> SArrayObj </td> 
 <td> 实现数组与对象的转换 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

请求参数(SRequest)

2014年6月25日 星期三

17:53

SRequest

<table> 
 <tbody> 
 <tr> 
 <td> 属性requests </td> 
 <td> 其中保存了$_REQUEST的数据 </td> 
 <td> 支持SArrayObj访问(见下) </td> 
 </tr> 
 <tr> 
 <td> 属性posts </td> 
 <td> 其中保存了$_POST的数据 </td> 
 <td> 同上 </td> 
 </tr> 
 <tr> 
 <td> 属性gets </td> 
 <td> 其中保存了$_GETS的数据 </td> 
 <td> 同上 </td> 
 </tr> 
 <tr> 
 <td> 属性servers </td> 
 <td> 其中保存了$_SERVER的数据 </td> 
 <td> 同上 </td> 
 </tr> 
 <tr> 
 <td> 属性env </td> 
 <td> 其中保存了$_ENV的数据 </td> 
 <td> 同上 </td> 
 </tr> 
 <tr> 
 <td> 属性files </td> 
 <td> 其中保存了$_FILE的数据 </td> 
 <td> 同上 </td> 
 </tr> 
 <tr> 
 <td> 属性cookies </td> 
 <td> 其中保存了$_COOKIE的数据 </td> 
 <td> SCookie </td> 
 </tr> 
 <tr> 
 <td> 属性sessions </td> 
 <td> 其中保存了$_SESSION的数据 </td> 
 <td> SSession </td> 
 </tr> 
 <tr> 
 <td> 属性url </td> 
 <td> 本次访问的URL </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 属性referer </td> 
 <td> 本次访问来源页面的URL </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 属性ip </td> 
 <td> 访问者的IP(去除CDN路径上的IP) </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 属性rawIp </td> 
 <td> 原始IP(完整的IP,如果经过CDN,应该是三段,如果不经过CDN,应该是一段) </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 属性curUrl </td> 
 <td> 当前访问路径 (去除域名,端口,去除参数) </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 属性https </td> 
 <td> 是否Https访问 <a href="http://|%20rel=" rel="nofollow"> </a><a href="http://|%20rel=" rel="nofollow">&nbsp;</a><a href="http://|%20rel=" rel="nofollow"> </a></td> 
 </tr> 
 <tr> 
 <td> 属性domain </td> 
 <td> 当前访问协议及域名 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 属性port </td> 
 <td> 当前访问端口 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 属性post </td> 
 <td> 当前访问域名 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 属性agent </td> 
 <td> HTTP_USER_AGENT </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 属性domains </td> 
 <td> 当前访问域名 分解 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 静态属性isAjax </td> 
 <td> 当前是否Ajax访问 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法antiHtml </td> 
 <td> 防入侵,包括IP黑名单,禁止字符,禁止词 </td> 
 <td> anti.config.php </td> 
 </tr> 
 <tr> 
 <td> 方法getRequest </td> 
 <td> 返回全部_POST及_GET&nbsp; 数组方式 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法instance </td> 
 <td> 获取一个实例 </td> 
 <td> 单例化 </td> 
 </tr> 
 <tr> 
 <td> 方法isIe </td> 
 <td> 当前请求来源浏览器是否是IE </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法isIe67 </td> 
 <td> 当前请求来源浏览器是否是IE6或者7 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法isMobile </td> 
 <td> 当前请求来源是否是手机浏览器 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法judge </td> 
 <td> 参数验证体系(尚未完善) </td> 
 <td> 通过SJudge实现 </td> 
 </tr> 
 </tbody> 
</table>

SArrayObj 提供了统一的访问接口

<table> 
 <tbody> 
 <tr> 
 <td> 方法all </td> 
 <td> 将数据以数组方式返回 </td> 
 <td> $request-&gt;all(); </td> 
 </tr> 
 <tr> 
 <td> 方法count </td> 
 <td> 计数数据的个数 </td> 
 <td> $request-&gt;count(); </td> 
 </tr> 
 <tr> 
 <td> 方法exist </td> 
 <td> 判断某个参数是否存在 </td> 
 <td> $request-&gt;exist('id'); </td> 
 </tr> 
 <tr> 
 <td> 方法get </td> 
 <td> 获取某个参数的值 </td> 
 <td> $request-&gt;get('id'); </td> 
 </tr> 
 <tr> 
 <td> 方法del </td> 
 <td> 删除某个参数 </td> 
 <td> $request-&gt;del('id'); </td> 
 </tr> 
 <tr> 
 <td> &nbsp; </td> 
 <td> 删除某个参数 </td> 
 <td> unset($request-&gt;id); </td> 
 </tr> 
 <tr> 
 <td> &nbsp; </td> 
 <td> 获取某个参数的值 </td> 
 <td> $request-&gt;id; </td> 
 </tr> 
 <tr> 
 <td> &nbsp; </td> 
 <td> 设置某个参数的值 </td> 
 <td> $request-&gt;id=&lt;something&gt; </td> 
 </tr> 
 </tbody> 
</table>

SCookie,SSession

在实现SArrayObj功能的同时,提供以下功能

<table> 
 <tbody> 
 <tr> 
 <td> 方法set </td> 
 <td> 设置某个参数的值 </td> 
 <td> $request-&gt;sessions-&gt;set('user_id',1234'); </td> 
 </tr> 
 </tbody> 
</table>

缓存(cache)

2014年6月25日 星期三

11:14

<table> 
 <tbody> 
 <tr> 
 <td> 获取缓存实例 </td> 
 <td> cache('must') </td> 
 </tr> 
 <tr> 
 <td> 方法set </td> 
 <td> 缓存一个数据 </td> 
 </tr> 
 <tr> 
 <td> 方法get </td> 
 <td> 获取一个缓存数据 </td> 
 </tr> 
 <tr> 
 <td> 方法clear </td> 
 <td> 清除全部/指定域的缓存数据 </td> 
 </tr> 
 <tr> 
 <td> 方法clearAll </td> 
 <td> 清除全部缓存数据 </td> 
 </tr> 
 <tr> 
 <td> 方法delete </td> 
 <td> 清除一个指定的缓存数据 </td> 
 </tr> 
 <tr> 
 <td> 方法enabled </td> 
 <td> 当前缓存是否可用 </td> 
 </tr> 
 <tr> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

日志(log)

2014年6月25日 星期三

11:14

<table> 
 <tbody> 
 <tr> 
 <td> 日志文件位置 </td> 
 <td> 日志根目录由系统配置决定 下面按年/月/日进行目录划分 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 记录文本日志 </td> 
 <td> log 全局函数 </td> 
 <td> 由SLog实现 </td> 
 </tr> 
 <tr> 
 <td> 记录会话日志 </td> 
 <td> sessionLog 全局函数 </td> 
 <td> 由SLog实现 </td> 
 </tr> 
 <tr> 
 <td> 清除指定日志 </td> 
 <td> SLog::clear </td> 
 <td> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

外接库(lib)

2014年6月25日 星期三

11:12

<table> 
 <tbody> 
 <tr> 
 <td> 外接库文件位置 </td> 
 <td> 由系统配置文件决定 </td> 
 </tr> 
 <tr> 
 <td> 引入外接库 </td> 
 <td> lib全局函数 </td> 
 </tr> 
 </tbody> 
</table>

DAO

2014年6月25日 星期三

15:31

表(STable)

<table> 
 <tbody> 
 <tr> 
 <td> 创建表对象 </td> 
 <td> table('表名') </td> 
 <td> 表所在的数据库配置由database配置文件决定 </td> 
 </tr> 
 <tr> 
 <td> 方法exist </td> 
 <td> 判断是否存在满足条件的记录 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法col </td> 
 <td> 获取一列数据 </td> 
 <td> 返回一个一维数组 </td> 
 </tr> 
 <tr> 
 <td> 方法count </td> 
 <td> 计数满足条件的记录数 </td> 
 <td> 返回一个自然数 </td> 
 </tr> 
 <tr> 
 <td> 方法get </td> 
 <td> 获取一行一列的值 </td> 
 <td> 返回一个单值 </td> 
 </tr> 
 <tr> 
 <td> 方法row </td> 
 <td> 获取一行数据 </td> 
 <td> 返回SRow对象 </td> 
 </tr> 
 <tr> 
 <td> 方法getPrimaryKey </td> 
 <td> 获取当前表的主键字段名 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法query </td> 
 <td> 执行一个SQL查询 参数是一个完整的SQL语句 用于解决复杂查询 </td> 
 <td> 返回SResult对象 </td> 
 </tr> 
 <tr> 
 <td> 方法execute </td> 
 <td> 执行一个SQL语句 参数是一个完整的SQL语句 用于解决复杂操作 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法increase 方法decrease </td> 
 <td> 对表中满足条件的记录的某一字段的值进行增减指定常量 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法insert </td> 
 <td> 插入一条记录 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法insertIgnore </td> 
 <td> 插入一条记录 如果原来已经存在(根据表约束判断),则放弃 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法replace </td> 
 <td> 插入一条记录 如果原来已经存在(根据表约束判断),则更新 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法update </td> 
 <td> 修改满足条件的记录 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法delete </td> 
 <td> 删除表中满足条件的记录 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法deleteAll </td> 
 <td> 删除表中全部数据 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法disableCache </td> 
 <td> 临时禁止缓存,只禁止一次 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法selectHandle </td> 
 <td> 生成一个原生的查询句柄 此方法内存占用较少,用于查询大量数据 </td> 
 <td> 参考PHP手册中的PDO::query </td> 
 </tr> 
 <tr> 
 <td> 方法select </td> 
 <td> 获取多行数据 </td> 
 <td> 返回SResult对象 </td> 
 </tr> 
 <tr> 
 <td> 方法distinct 方法fields 方法groupby 方法having 方法limit 方法orderby 方法where </td> 
 <td> 为后继Select,指定Distinct 为后继Select,指定字段 为后继Select,指定分组 为后继Select,指定分组过滤 为后继Select,指定分页 为后继Select,指定排序 为后继Select,指定条件 </td> 
 <td> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

SMongo

建设中

结果集SResult

<table> 
 <tbody> 
 <tr> 
 <td> 来源 </td> 
 <td> STable的select,query的结果 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法count </td> 
 <td> 计数本结果集的行数 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 访问方法 </td> 
 <td> 与数组相同 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> join joinMongo </td> 
 <td> 一对多关联 下一个表 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> map mapMongo </td> 
 <td> 一对一映射 下一个表 </td> 
 <td> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

行(SRow)

<table> 
 <tbody> 
 <tr> 
 <td> 来源 </td> 
 <td> STable的row的结果 SResult中的一行 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 方法exists </td> 
 <td> 判断是否存在此列 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 访问方法 </td> 
 <td> 与数组相同 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> join joinMongo </td> 
 <td> 一对多关联 下一个表 </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> map mapMongo </td> 
 <td> 一对一映射 下一个表 </td> 
 <td> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

调试(debug)

2014年6月25日 星期三