首页 > 五指CMS > 正文

五指CMS开发规范&开发指南
2014-11-26 11:22:57   来源:   评论:0 点击:

命名规范:目录命名:由小写字母,下划线组成 例如:test_dir或者test文件命名: 小写字母,下划线组成 例如:test_file php或者test php文件开始需写入:版权声明:<?php +-------------------------------
命名规范:

目录命名:由小写字母,下划线组成.

例如:test_dir或者test

文件命名: 小写字母,下划线组成.

例如:test_file.php或者test.php

文件开始需写入:

版权声明:

<?php

// +----------------------------------------------------------------------

// | wuzhicms [ 五指互联网站内容管理系统 ]

// | Copyright (c) 2014-2015 http://www.wuzhicms.com All rights reserved.

// | Licensed ( http://www.wuzhicms.com/licenses/ )

// | Author: wangcanjia <phpip@qq.com>

// +----------------------------------------------------------------------

defined('IN_WZ') or exit('No direct script access allowed');

 

允许开发者修改:Author 部分。

注释:

/**

 * 该文件的功能说明,置于 defined('IN_WZ') or exit('No direct script access allowed');之下。

 */

 

注意:在所有的tpl.php后台模版文件中,仅添加

<?php defined('IN_WZ') or exit('No direct script access allowed’);?>

 

行注释说明:

通过  // 

使用范围:功能开始,功能结束,或者逻辑判断,配置说明,均可通过行注释来完成!习惯注释代码,可以为后来的开发者清楚的了解到开发逻辑。

 

 

类文件命名:文件名+.class.php
例如:admin.class.php

类文件路径:coreframe/app/content/libs/class/文件名+.class.php

content为模块路径

类名称命名规则:WUZHI_+文件名

例如:数据操作类,coreframe/app/core/libs/class/db.class.php

class WUZHI_db {

}

类的初始化:

$db = load_class(‘db’);

load_class(文件名,模块名 默认为core,初始化参数);

传递给:function __c onstruct($str) {}

类方法属性定义

通过初始化后,可以被调用的方法,使用  public。

不允许被调用的方法,使用 private

禁止外部改变的变量,通过 protected $str;定义

可以被改变和调用的变量,通过public $table;定义

禁止扩展类继承后,重写的方法,在public ,private 之前 增加 final。(最终方法)

定义静态方法:在function 之前增加 static 。静态方法不宜定义太多。

定义静态方法后,通过下面方式调用。

例如:load_class(‘form’);

echo WUZHI_form::editor();//即可显示编辑器

模块存放规范

模块全部存放到:coreframe/app/模块名称

后台文件存放规范:模块下的admin目录

例如:核心模块,coreframe/app/core/admin/

          内容模块,coreframe/app/content/admin

 

函数文件存放路径

核心函数库存放在:coreframe/app/core/libs/function/下面

函数文件文件名规则:

文件名.func.php

静态文件存放路径:

www/res/

images/图片文件

js/js文件,若是某个js框架,则采用:js框架名/所有文件

css/样式文件

静态文件调用方式:

例如:jquery调用:
<script type="text/javascript" src="<?php echo R;?>js/jquery.min.js"></script>

 

配置文件存放路径1:开发或者,安装后,可以添加配置文件的地方。

www/configs/

配置文件存放路径2: 核心文件中的配置文件

coreframe/configs/wz_config.php

文件内容:define(‘WWW_ROOT','/workspace/wwwroot/dev.phpip.cn/src/www/');

定义了,www 目录的物理路径地址,主要用于分离核心文件与用户可访问文件。该文件在安装程序后,自动生成。

 

定时脚本文件路径

coreframe/crontab/模块目录

核心功能脚本地址:coreframe/crontab/core/

调用方法:

例如:php /workspace/wwwroot/dev.phpip.cn/src/coreframe/crontab.php core cache_template

详解:
php /coreframe/crontab.php modulename file --help --dest=/var/ -result1 -result2 --option mew arf moo -z

执行后,会生成一个数组,然后传递给模块下面的脚本文件。

通过$_argv获取

Array

(

    [input] => Array

        (

            [0] => modulename

            [1] => file

        )

 

    [commands] => Array

        (

            [help] => 1

            [dest] => /var/

            [option] => mew arf moo

        )

 

    [flags] => Array

        (

            [0] => result1

            [1] => result2

            [2] => z

        )

)

 

模版更新方法:

架构采用分离来完成模版编译,提升用户在访问时的效率。特别是在大访问量,或者是批量生成静态文件的时候,避免重复检查文件的操作。同时可以防止模版被恶意修改。

php /workspace/wwwroot/dev.phpip.cn/src/coreframe/crontab.php core cache_template

架构设计: 

blob.png

路由:

http://dev.wuzhicms.com/index.php?m=core&f=index&v=login&_su=wuzhicms

 

m:模块

f:文件名

v: 视图,类的方法

相关热词搜索:开发指南

上一篇:五指cms新动向-百度实时推送接口的开发
下一篇:五指cms程序入口文件分析

分享到: 收藏