首页  >  文章  >  后端开发  >  PHP 开源软件《个人管理系统》——技术规范

PHP 开源软件《个人管理系统》——技术规范

WBOY
WBOY原创
2016-07-29 08:50:191115浏览

介绍

做这个开源系统,一直没有做开发文档,有点对不住大家,今天我把技术规范写一下。

目录结构

PHP 开源软件《个人管理系统》——技术规范

访问方式

http://localhost/index.php?r=模块名称_控制器名称_方法或http://localhost/index.php?module=模块名称&c/p>

默认值是:模块名称:Default,控制器名称:Page,方法名称:index

命名规范

1)类文件都是以.class.php为后缀,使用驼峰法命名,并且首字母大写。

PHP 开源软件《个人管理系统》——技术规范

2)类名要体现文件路径

PHP 开源软件《个人管理系统》——技术规范

3)核心文件要放置在lib/Core/目录下面,这时候你不需要require里面的文件,直接使用就可以。

PHP 开源软件《个人管理系统》——技术规范

4)函数的命名使用小写字母和下划线的方式

PHP 开源软件《个人管理系统》——技术规范

5)方法的命名使用驼峰法如validClientIp,私有方法使用下划线'_',如_insertIP()。

PHP 开源软件《个人管理系统》——技术规范

6)常量以大写字母加下划线命名,如DB_HOST。

PHP 开源软件《个人管理系统》——技术规范

7)对内部变量的命名没有强制规范,可以根据个人喜好来命名。但个人建议方法参数变量我们使用驼峰法,内部参数使用小写字母和下划线命名。

如:

<ol>
<li><span><span>public</span><span> </span><span>function</span><span> validAcount(</span><span>$userName</span><span>){  </span></span></li>
<li><span> </span></li>
<li>
<span>$user_name</span><span> = </span><span>$userName</span><span>;  </span>
</li>
<li><span>} </span></li>
</ol>

8)模板文件以.tpl为后缀。

PHP 开源软件《个人管理系统》——技术规范

9)数据表和字段采用小写加下划线方式命名。如hh_ip的字段create_date

PHP 开源软件《个人管理系统》——技术规范

开发要求

1)MySQL最好使用PDO进行操作,因为安全性、性能比较高。

PHP 开源软件《个人管理系统》——技术规范

2)每次的数据库读取操作希望都使用explain进行校验,以便确认命中索引。

打开日志

PHP 开源软件《个人管理系统》——技术规范

  PHP 开源软件《个人管理系统》——技术规范查看日志

PHP 开源软件《个人管理系统》——技术规范

 PHP 开源软件《个人管理系统》——技术规范查看是否命中索引

PHP 开源软件《个人管理系统》——技术规范

3)对于inner join,建议最多使用2个表。超过2个,建议使用多个短select语句。

4)尽量用英文写注释,一是培养大家的英文能力;二是提高大家的命名能力。

总结

欢迎大家一起过来开发,开发这个项目除了创作好的产品外,主要是为了技术交流,看看大家的好的技术。如果大家有更好的规范或者方法,不妨告知一、二。

QQ群:152448006

地址:

PHP 开源软件《个人管理系统》——技术规范

原文链接:http://www.cnblogs.com/baochuan/archive/2012/09/09/2677214.html

【编辑推荐】

    1. PHP《个人管理系统》希望大家一起来开发
    2. PHP《个人管理系统》之完善登录模块
    3. 一个身居中国的法国程序员谈Python与PHP
    4. 即将成为程序员的你需要什么技能
    5. 编程赋予了我们什么样的改变

以上就介绍了PHP 开源软件《个人管理系统》——技术规范,包括了开源软件,管理系统方面的内容,希望对PHP教程有兴趣的朋友有所帮助。

声明:
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn