方法名：小驼峰命名，禁止下横线、禁止重复业务核心词
以表为基准建立Logic层

一、Code标例

  1. <?php
  2. namespace App\Module\Cms\Logic\Info;
  4. use Swork\Bean\BeanCollector;
  5. use ......
  7. /**
  8.  * 资讯内容逻辑处理
  9.  * Class InfoLogic
  10.  * @package App\Module\Cms\Logic
  11.  */
  12. class InfoLogic extends BeanCollector
  13. {
  14.     /**
  15.     * Inject()
  16.     * var CatalogLogic
  17.     */
  18.     private $catalogLogic;
  20.     /**
  21.      * 获取资讯内容翻页数据
  22.      * @param array $query 数据过滤查询字段
  23.      * @param int $idx 翻页码
  24.      * @param int $size 每页行数
  25.      * @return array
  26.      * @throws
  27.      */
  28.     public function getPager(array $query, int $idx, int $size)
  29.     {
  30.         return $list;
  31.     }
  33.     /**
  34.      * 获取资讯内容列表
  35.      * @param int $cid 分类ID
  36.      * @return mixed
  37.      * @throws
  38.      */
  39.     public function getList(int $cid)
  40.     {
  41.         return $list;
  42.     }
  44.     /**
  45.      * 获取资讯详细内容（注：通常用于展示用，如果展示和修改可以共用，则使用此方法）
  46.      * @param int $fid 资讯内容ID
  47.      * @return mixed
  48.      * @throws
  49.      */
  50.     public function getInfo(int $fid)
  51.     {
  52.         return $info;
  53.     }
  55.     /**
  56.      * 获取资讯详细内容（注：通常用于表单修改，绑定默认数据）
  57.      * @param int $fid 资讯内容ID
  58.      * @return mixed
  59.      * @throws
  60.      */
  61.     public function getDetail(int $fid)
  62.     {
  63.         return $info;
  64.     }
  66.     /**
  67.      * 保存资讯数据
  68.      * @param int $fid 资讯内容ID （新增是为空，修改时不为空）
  69.      * @param int $cid 级别类型
  70.      * @param string $title 资讯标题
  71.      * @param string $author 作者
  72.      * @param string $content 资讯详细内容
  73.      * @throws
  74.      */
  75.     public function save(int $fid, int $cid, string $title, string $author, string $content)
  76.     {
  77.         //不返回任何内容
  78.     }
  80.     /**
  81.      * 创建资讯内容数据
  82.      * @param int $cid 级别类型
  83.      * @param string $title 资讯标题
  84.      * @param string $author 作者
  85.      * @param string $content 资讯详细内容
  86.      * @throws
  87.      */
  88.     public function create(int $cid, string $title, string $author, string $content)
  89.     {
  90.         //不返回任何内容
  91.     }
  93.     /**
  94.      * 修改资讯内容数据
  95.      * @param int $fid 资讯内容ID
  96.      * @param int $cid 级别类型
  97.      * @param string $title 资讯标题
  98.      * @param string $author 作者
  99.      * @param string $content 资讯详细内容
  100.      * @throws
  101.      */
  102.     public function modify(int $fid, int $cid, string $title, string $author, string $content)
  103.     {
  104.         //不返回任何内容
  105.     }
  107.     /**
  108.      * 删除资讯内容（有引用了不能删除）
  109.      * @param int $fid 资讯内容ID
  110.      * @throws
  111.      */
  112.     public function delete(int $fid)
  113.     {
  114.         //不返回任何内容
  115.     }
  116. }

二、解析说明

  1. 每个小业务对应一个Logic文件，类名为：xxxLogic （红色为具体业务或表的关键词，蓝色固定为Logic）。
  2. 统一继承 BeanCollector，用于实现注解。
  3. 业务核心名称与通常与对应表的核心名一致，如 cms_info —> InfoLogic
  4. 类名使用大驼峰，方法名使用小驼峰，类内变量使用小驼峰（不区分全局还是私有），禁止使用下线。 | 项目 | 方式 | | —- | —- | | Class - 类名 | 大驼峰 | | Method - 方法名 | 小驼峰 | | 类内变量 | 小驼峰 |

逻辑方法的命令是要说明 做什么，一个动作词和一个内容词（可选内容词）。

  1. <?php
  2.      /**
  3.      * 做什么的描述说明
  4.      * @param ....
  5.      * @throws
  6.      */
  7.     public function 动作词内容词(...)
  8.     {
  9.         return $list;
  10.     }
  12.      /**
  13.      * 做什么的描述说明（只有动作词，如delete、add、modify）
  14.      * @param ....
  15.      * @throws
  16.      */
  17.     public function 动作词(...)
  18.     {
  19.         return $list;
  20.     }
  21. }

三、标准方法名

方法名 参数 说明
getPager (array $query, int $idx, int $size) 获取翻页数据，返回List和Pager数据
getList (根据需求而定) 获取一页数据
getInfo 获取详情数据，通常用于展示用，如果展示和修改可以共用，则使用此方法
getDetail 通常用于表单修改，绑定默认数据
getXXX 获取XXX数据（具体某个处理后的数据）
save 核心字段，单独传参；
 保存数据，对应前端新增和修改时一并使用
create 纯创建数据的保存操作
modify 纯修改原有数据的保存操作

注：1）原则上 save, create, modify 除需要把业务数据外，其它情况不需要返回，如 true, false, success 等等；
2）大部分情况是使用 save 代替 create 和 modify 操作，在save方法内通过主键区分是否更新数据；
3）所有参数都要求声明类型，如 int, array, string 等

四、错误方法命名

  1. getInfoPager()
  2. getInfoList()
  3. getInfos()
  4. updateInfo() 或InfoUpdate()
  5. deleteInfo 或 InfolDelete
  6. delete_Infol 或 Info_delete

  7. detail

    总结：在Logic大类里面已经声明是 Info 这个业务核心名，在此类内的方法，不能再出现此核心名。