代码规范

#代码规范（从code review总结）

1. 没有使用filterStartLimit过滤limit字段值.filterStartLimit作用是防止sql注入.  orderby, page（分页）, groupby等参数都有类似风险。

2. 代码里不应出现magic number, 应该定义常量增加可读性

3. 路由URL中的"/"应该用来体现层级而不是用来划分单词。

/offline/course/{id}/picture    #应该使用  /offline_course/{id}/picture

4. 异常需要分类 不能都简单抛出serviceException

Topxia\Common\Exception 中已经有部分Exception类型，根据业务选择

5. 检查代码的无用逻辑

如在controller层调用search时，如果searchUserCount为0，可以避免searchUsers

6. dao层sql 查询 orderby 需要限制可排序字段（防注入）。

7. search方法使用的场景是当查询条件不确定

conditions  = array( 'parentId' => 0 ); 应该使用 findXXXbyparentId（findParentXXX）

8. 变量命名冗余，enrollmentPlan => plan，增加可读性

就像在CourseController下 不是courseManageAciton 应是manageAciton,在这个语境下manage自然被理解为是管理Course。

9. ‘if-else’循环内容复杂，应当简洁，考虑使用‘key => value’。

多重循环嵌套时，可以考虑是否可以用键值对形式来实现，或者用拼接的方法实现。

$status = array(

'new' => 'admin_enrollment_declare',

'declareing' => 'admin_enrollment_audit',

'assigned' => 'admin_enrollment_update_classroom',

);

if (!empty($plan) && $plan['status'] != 'published') {

return $this->redirect($this->generateUrl($status[$plan['status']] ,array('id' => $plan['id'])));

}

10. 在Controller中，不可暴露数据库信息如”depth=> 2”

11. 字段”created_time”和”updated_time”，不应写在service（新框架不用赋值，原先框架应写在dao）

12. 数据库字段命名驼峰和下划线皆可  userId user_id

13. 方法的命名不能太笼统，要尽量有具体的含义。

validateAuthority()  修改为=> tryManageClassroomThread()