插件开发规范

这里主要说明框架内的开发规范,其他的如驼峰命名等常规规范不在描述。

※ 控制器开发(controller)

控制器需要继承 corecontrollerAdminBase

class Index extends AdminBase{}


※ 模板渲染与正确/错误返回

在控制器方法中输入一下代码:

return $this->error('错误说明',200,-1);//返回错误  参数分别是 错误信息,状态码 code,  一般只要输入错误信息即可 
return $this->error('发生错误');
 
return $this->success([]); //返回正确信息 参数为数组格式

return $this->view(); //渲染模板


※ 模板路径

应用插件的模板路径在

/template/站点标识/admin/应用名称(后台模板),

/template/站点标识/home/应用名称(前台模板),

/template/站点标识/uc/应用名称(用户中心模板)


※ 业务层(bll)

业务层对业务的处理,如果该业务函数需要当作模板标签使用,只需在函数上加上#[Template] 属性即可:

   
class Category
{
    #[Template]
    public function find(int $id, int $siteid): array{}
}


//前台即可使用模板标签调用此方法 cms 是应用名
$result= fc('cms:Category:find', id: 4, siteid: $siteinfo['id']);


※ 数据校验(validate)

数据校验采用的THINKPHP的验证组件,参考TP文档即可


※ 数据库表名

数据库表名规则为:数据库表前缀+应用插件名_+对应表名,如:fc_cms_model ,fc_:表前缀; cms 应用名;