Difeye框架开发手册

Difeye框架开发手册作者：周胜军前言Difeye是一款超轻量级PHP框架，对Kohana框架做了精简和部分修改，主要特点有：数据库连接做自动主从读写分离配置，适合单机和分布式站点部署；引入成熟的Smarty模板机制；改进了Kohana的路由风格，完全分离页面和动作，仿C#页面加载自动执行Page_Load入口函数；摒弃了Kohana的部分功能和扩展模块，包括DB类和view视图等。保留了Kohana的session，Profiler，Request，Route等基础类。如果您在使用过程中，有任何问题反馈请联系我们：@gmail.commathcn2011年1月1日■目录■目录.................................................................................................................................................3第一章DIFEYE1.0入门..........................................................................................................................51.1.命名规则约定..................................................................................................................................51.2文件系统结构..................................................................................................................................131.3SYSTEM目录....................................................................................................................................141.4MODULE目录...................................................................................................................................151.5DO目录............................................................................................................................................161.6请求流程..........................................................................................................................................18第二章DIFEYE1.0配置开发................................................................................................................202.1.基础配置........................................................................................................................................202.2.COOKIE及SESSION使用................................................................................................................212.3.DIFEYE数据库连接配置...................................................................................................................232.4.配置并使用SMARTY模板...............................................................................................................262.5.配置并使用多语言........................................................................................................................28第三章DIFEYE1.0API参数手册.........................................................................................................293.1.API参数...........................................................................................................................................29周胜军：2008年，毕业于大连理工计算数学系，硕士。曾任香港理工短期RA助理、信产部CSIP微软dynamics产品技术顾问；擅长windows,linux平台web架构开发。联系方式:Email:[e-mail]418806107第一章Difeye1.0入门1.1.命名规则约定约定鼓励大家遵循BSD/Allmanstyle的编码样式。类名和文件位置在Difeye系统中类名严格遵循命名约定才能够自动加载。类名的首字母必须大写，且使用下划线连接单词，千万要注意下划线的重要性，因为它直接关系到文件在文件系统中所存放的位置。请遵循以下约定：1.类名不允许使用骆驼命名法，除非需要创建新一级的目录文件。2.所有的类文件的文件名和目录名都必须是小写。3.所有的类文件都应该存放在classes目录下面，它可以是在级联文件系统的任何一级。所有的类都存放在classes/目录，既可以是完全静态的辅助函数(helpers)或对象形式的类库(libraries)。你可以使用任意形式的设计模式的类库：静态，单例，适配器等。实例请大家记着一点在类文件中，类名到下划线意味着是一个新的目录，参考下面例子:类名文件路径Controller_Templateclasses/controller/template.phpModel_Userclasses/model/user.phpDatabaseclasses/database.phpDatabase_Queryclasses/database/query.php命名约定Difeye使用下划线连接命名，而不是驼峰命名。类//控制器类，使用Controller_作前缀classController_AppleextendsController{//模型类，使用_Model作前缀classModel_CheeseextendsModel{//普通类classPeanut{当你实例化一个不需要附带参数的类时不需要使用圆括号://正确:$db=newDatabase;//错误:$db=newDatabase();函数和方法函数尽量全小写，并使用下划线分割单词:functiondrink_beverage($beverage){变量所有变量尽量全小写，并使用下划线分割单词而不是驼峰://正确:$foo='bar';$long_example='usesunderscores';//错误:$weDontWantThis='understood?';缩进代码在逻辑上缩进使用制表符(TAB)代替空格。垂直间距(即多行)使用空格。制表符并不适用于垂直间距主要是因为不同的人可能设置类不同的制表符宽度。$text='thisisalongtextblockthatiswrapped.Normally,weaimfor'.'wrappingat80chars.Verticalalignmentisveryimportantfor'.'codereadability.Rememberthatallindentationisdonewithtabs,'.'butverticalalignmentshouldbecompletedwithspaces,after'.'indentingwithtabs.';字符串连接不要在连接符左右使用空格://正确:$str='one'.$var.'two';//错误:$str='one'.$var.'two';$str='one'.$var.'two';单行表达式单行IF表达式仅用于破坏正常执行的情况(比如，return或continue)://可接受:if($foo==$bar)return$foo;if($foo==$bar)continue;if($foo==$bar)break;if($foo==$bar)thrownewException('Youscrewedup!');//不可接受:if($baz==$bun)$baz=$bar+2;比较操作使用OR和AND作为比较符://正确:if(($fooAND$bar)OR($bAND$c))//错误:if(($foo&&$bar)||($b&&$c))请使用elseif而不是elseif://正确:elseif($bar)//错误:elseif($bar)Switch结构每个case，break和default都应该是独立的一行。每个case或default里面必须使用一个制表符(TAB)。switch($var){case'bar':case'foo':echo'hello';break;case1:echo'one';break;default:echo'bye';break;}括号Thereshouldbeonespaceafterstatementname,followedbyaparenthesis.The!(bang)charactermusthaveaspaceoneithersidetoensuremaximumreadability.Exceptinthecaseofabangortypecasting,thereshouldbenowhitespaceafteranopeningparenthesisorbeforeaclosingparenthesis.//正确:if($foo==$bar)if(!$foo)//错误:if($foo==$bar)if(!$foo)if((int)$foo)if($foo==$bar)if(!$foo)三元操作所有的三元操作都应该遵循一种标准格式。表达式左右使用括号，而变量则不需要。$foo=($bar==$foo)?$foo:$bar;$foo=$bar?$foo:$bar;所有的比较和操作都必须使用括号括起来作为一个组:$foo=(