开发规范 · WeCenter开发使用文档

> 一. URL 路由 WeCenter 有一个解析能力强大的 URL 路由 **1. 动作访问:** * * * * * /模块名/控制器/动作/ID ID 为 id 查询, 例: `account/login/123`，则在 login 控制器中 `$_GET[‘id’] `的值为 123 (*) 如果使用 /模块名/控制器/动作/ID 格式 Query string 的使用可以参照兼容性的支持 (*) 如果动作在 main 控制器中可以省略, 例: `account/main/login/ `等同于 `account/login/` (*) 如果动作名为 index 可以省略, 例: `account/login/index/ `等同于 `account/login/` **2. Query string** * * * * * WeCenter 的查询字符串为使用 __ 分隔参数, 使用 – 为参数赋值, 在程序中直接使用 $_GET 取出内容常规的: `account/login/?return_url=1&callback=2` WeCenter 的: `account/login/return_url-1__callback-2` (*) 在程序中输出 URL 请使用 get_js_url 函数, 因为这样会兼容 Rewrite 是否开启两种情况 **3. 兼容性的支持** * * * * * 下面的几种 URL 形式在程序中都是被支持的: ~~~ http://domian/index.php?/question/id-320__column-log__source-doc http://domian/index.php?/question/320?column=log&source=doc http://domian/index.php?/question/?id=320&column=log&source=doc http://domian/index.php?/question/320?column-log__source-doc http://domian/index.php?/question/320&column-log__source-doc ~~~ > 二. 模板命名规则程序中所有模板的存放规则为模块/控制器/动作, 如果控制器为 main 则省略如 `account/main/login/ `对应的模板为 views/模板集`/account/login.tpl.htm` 如 `account/setting/profile/` 对应的模板为 views/模板集`/account/setting/profile.tpl.htm` > 三. 自动引入机制 WeCenter 类库, Model 的使用都是不需要事先引入文件的, 这使得在编程过程中变得方便快捷, 也避免了类库重复实例化的问题, 但是使用自动引入机制需要遵循下面的规则. (*) 所有自动引入的类库都不需要事先实例化, 直接使用即可. **1. Model** * * * * * 放在 model 目录下, 文件名: name.inc.php 文件中需要有继承 AWS_MODEL 的 name_class (*) 在程序中使用方法: $this->model(‘name’)->action(); (*) 可用范围: CONTROLLER, Model **2. System 类库** * * * * * 放在 system 目录之下, 类名相对于 system 目录, 将 / 换成 _ 例: Zend_Mail 路径: system/Zend/Mail.php 类名: Zend_Mail (*) 在程序中使用方法: new, 静态调用, load_class(‘class_name’); (*) 可用范围: 任意, 不需要带参数实例化建议使用 load_class **3. 配置文件** * * * * * 放在 system/config 目录之下, 文件内容为一个 $config 数组, 命名为配置名.php (*) 在程序中使用方法: AWS_APP::config()->get(‘配置名’)->数组下标 (*) 可用范围: 任意, 不需要带参数实例化建议使用 load_class **四. 模板机制** * * * * * WeCenter 的模板采用继承机制, 系统的 default 为主模板, 用户的自定义模板只需要更改很少的文件即可实现程序界面的定制. 继承机制原理: ~~~ 当管理员设定了一个 newstyle 模板, 用户访问首页 ⬇ 系统开始查找 views/newstyle/home/index.tpl.htm ⬇ 找到相应文件找不到文件 ⬇ ⬇ 读取内容并解析后显示 ⬅ 读取 views/default/home/index.tpl.htm ~~~ 建立模板集的方法: 1. 在 views 下面建立模板集目录 2. 在 static/css/ 下建立与模板集相同的目录, 我们建议从 static/css/default/ 拷贝一份内容到新建的模板集中, 然后开始修改工作. > 五. 常用开发指导 **JavaScript:** * * * * * 我们使用 jQuery 作为主要 framework, 载入的插件有: jQuery Form ( http://malsup.com/jquery/form/ ) AJAX Upload ( http://valums.com/ajax-upload/ ) Valums file Uploader (修改过) **jQuery.ScrollTo** * * * * * (*) 在 Javascript 中判断用户是否登录判断全局变量 G_USER_ID 是否大于 0 即可 (*) 全局变量在 header 模板中 (*) 所有 JS 请求 URL 需要加上 G_BASE_URL 前缀 (*) 全局 ajax 列表函数使用 bp_load_more **PHP:** * * * * * 关于 Zend Framwork 类库的使用方法请参考官方文档 (*) 在控制器中判断用户是否登录判断 $this->user_id 是否大于 0 即可 (*) 控制器与模板中始终可用 $this->user_id 和 $this->user_info (*) 控制器与 Model 中禁止使用构造函数, 可以用 setup() 函数替代 (*) 程序已经提供了两个中文处理函数 cjk_substr 和 cjk_strlen **Access Rule:** * * * * * ~~~ public function get_access_rule() { // 规则类型 // white: actions 里的 action 全部用户可见, 其余 action 需要登录 // black: actions 里的 action 需要登录, 其余 action 全部用户可见 $rule_action[“rule_type”] = ‘white'; $rule_action[“actions”] = array( ‘check_username’, ‘check_email’, ‘register_process’, ‘login_process’, ‘register_agreement’, ‘send_valid_mail’, ‘valid_email_active’, ‘request_find_password’, ‘find_password_modify’ ); return $rule_action; } ~~~ (*) 控制器中不加此函数, 则所有 action 必需登录可见模板: (*) 在模板可以使用 PHP 代码, 全部静态类与 function, 但是不能使用 Model (*) 模板中 $this-> 中的内容是全局通用变量, 可以在模板中引入的模板使用, 模板内部产生的变量则不能 > 六. 常用开发方法使用 **1、TPL::assign()模板赋值 ** * * * * * ~~~ 语法：TPL::assign($name, $value) 说明：$name,变量的名字，不需要加$。$value,是具体各种类型的值。使用范例： TPL::assign('name', 'WeCenter') 返回结果为：直接在模板里echo $name;就会显示值 ~~~ **2、TPL::set_meta()设置html的meta值（比如：关键词，描述） ** * * * * * ~~~ 语法：TPL::set_meta($tag, $value) 说明：$tag,为：keywords关键词，description描述。$value,是具体字符串类型的值。使用范例： TPL::set_meta('keywords', 'WeCenter'); 返回结果为：直接在模板里$this->_meta_description;就会显示值 ~~~ **3、TPL::output()模板渲染 ** * * * * * ~~~ 语法：TPL::output($template_filename, $display = true) 说明：$template_filename,为模板名字，不需要带后缀。$display,是输出还是赋值变量。使用范例： TPL::output('article/index'); 返回结果为：渲染article下面index.tpl.htm模板 ~~~ **4、TPL::is_output()判断模板中是否存在某一模板 ** * * * * * ~~~ 语法：TPL::is_output($output_filename, $template_filename) 说明：$output_filename,要查询的模板，需要带后缀。$template_filename,被查询的模板。使用范例： TPL::is_output('block/sidebar_hot_topics.tpl.htm', 'article/square'); 返回结果为：true or false ~~~ **5、H::ajax_json_output() ajax返回 ** * * * * * ~~~ 语法：H::ajax_json_output($array) 说明：$array,返回的数组。使用范例： H::ajax_json_output(AWS_APP::RSM(null, '-1', AWS_APP::lang()->_t('请输入回复内容')));返回结果为：json格式的 ~~~ **6、AWS_APP::lang() 语言转换 ** * * * * * ~~~ 语法：AWS_APP::lang()->_t('要转换的词');要在 language文件的php文件里找到对应的键值说明：$array,返回的数组。使用范例： AWS_APP::lang()->_t('注册失败'); 返回结果为：注册失败 ~~~