优化注释

src/Service/Interfaces/BaseInfoServiceInterface.php

@@ -11,16 +11,6 @@ namespace Meibuyu\Micro\Service\Interfaces;
 interface BaseInfoServiceInterface
 {
 
-    /**
-     * 通过单个id获取岗位信息
-     * @param int $id 职位id
-     * @param array $relations 职位的关联信息 支持["position_level","users","parent"
-     * ,"children","perms"] 分别是 岗位职级，岗位用户，岗位父级，岗位子集，岗位对应的权限
-     * @param array $columns 默认显示所有字段
-     * @return array|null
-     */
-    public function getPositionById(int $id, array $relations = [], array $columns = ['*']);
-
     /**
      * 通过单个id获取岗位数组
      * @param int $id
@@ -32,36 +22,46 @@ interface BaseInfoServiceInterface
 
     /**
      * 通过id数组获取国家数组
-     * @param array $idList
+     * @param array $idList 默认去重
      * @param array $columns
-     * @return array
+     * @return array 默认keyBY('id')
      */
     public function getCountryListByIdList(array $idList, array $columns = ['*']): array;
 
     /**
      * 通过id数组获取团队数组
-     * @param array $idList
+     * @param array $idList 默认去重
      * @param array $columns
-     * @return array
+     * @return array 默认keyBY('id')
      */
     public function getTeamListByIdList(array $idList, array $columns = ['id', 'name']): array;
 
     /**
      * 通过id数组获取站点数组
-     * @param array $idList
+     * @param array $idList 默认去重
      * @param array $columns
-     * @return array
+     * @return array 默认keyBY('id')
      */
     public function getSiteListByIdList(array $idList, array $columns = ['id', 'name']): array;
 
     /**
      * 通过id数组获取货币数组
-     * @param array $idList
+     * @param array $idList 默认去重
      * @param array $columns
-     * @return array
+     * @return array 默认keyBY('id')
      */
     public function getCurrencyListByIdList(array $idList, array $columns = ['id', 'name']): array;
 
+    /**
+     * 通过单个id获取岗位信息
+     * @param int $id 职位id
+     * @param array $relations 职位的关联信息 支持["position_level","users","parent"
+     * ,"children","perms"] 分别是 岗位职级，岗位用户，岗位父级，岗位子集，岗位对应的权限
+     * @param array $columns 默认显示所有字段
+     * @return array|null
+     */
+    public function getPositionById(int $id, array $relations = [], array $columns = ['*']);
+
     /**
      * 根据id获取单个数据
      * @param int $id 货币id
@@ -82,10 +82,10 @@ interface BaseInfoServiceInterface
      * 获取单个团队数据
      * @param int $id
      * @param array $relations 支持的关联关系 ['leader', 'sites', "users", "parent", "children"] 分别代表 负责人、团队下的站点、团队成员、父级团队，再级团队
-     * @param array $columns 要显示的字段 默认['id', 'pid', "name", "leader_user_id", "leader_user_id", "department_id"]
+     * @param array $columns 要显示的字段 默认['id', 'pid', "name", "leader_user_id",  "department_id"]
      * @return array|null
      */
-    public function getTeamById($id, array $relations = [], array $columns = ['id', 'pid', "name", "leader_user_id", "leader_user_id", "department_id"]);
+    public function getTeamById($id, array $relations = [], array $columns = ['id', 'pid', "name", "leader_user_id", "department_id"]);
 
     /**
      * 获取单个站点数据
@@ -107,10 +107,11 @@ interface BaseInfoServiceInterface
 
     /**
      * 返回所有货币数据
-     * @param array $columns 显示的字段名称 默认 ['id', 'name', 'code', 'symbol']
-     * @return array
+     * @param array $columns 要显示的字段
+     * $columns = ['id', 'name', 'code', 'symbol'];
+     * @return array 默认已keyBy('id')
      */
-    public function currencies(array $columns = ['id', 'name', 'code', 'symbol']): array;
+    public function currencies(array $columns = ['id', 'name']): array;
 
     /**
      * 获取所有国家数据
@@ -123,10 +124,11 @@ interface BaseInfoServiceInterface
     /**
      * 获取所有团队数据
      * @param array $relations 支持的关联关系 ['leader', 'sites', "users", "parent", "children"] 分别代表 负责人、团队下的站点、团队成员、父级团队，再级团队
-     * @param array $columns 要显示的字段 默认['id', 'pid', "name", "leader_user_id", "leader_user_id", "department_id"]
-     * @return array
+     * @param array $columns 要显示的字段
+     * $columns = ['id', 'pid', "name", "leader_user_id", "leader_user_id", "department_id"];
+     * @return array 默认已keyBy('id')
      */
-    public function teams(array $relations = [], array $columns = ['id', 'pid', "name", "leader_user_id", "leader_user_id", "department_id"]): array;
+    public function teams(array $relations = [], array $columns = ['id', 'pid', "name", "leader_user_id", "department_id"]): array;
 
     /**
      * 获取所有站点的数据

src/Service/Interfaces/Product/PlatformProductChildServiceInterface.php

@@ -14,7 +14,7 @@ interface PlatformProductChildServiceInterface
     /**
      * 获取单个数据
      * @param int $id 平台产品id
-     * @param array $relations 平台子产品的关联关系，支持：["platform_product","product_child"]
+     * @param array $relations 平台子产品的关联关系，支持：["platform_product","product_child","weight"]
      * @param array $columns 平台子产品表的字段，默认全部字段
      * ['id','platform_product_id','product_child_id','platform_product_child_sku','asin','fnsku','is_sale']
      * @return array|null
@@ -23,11 +23,11 @@ interface PlatformProductChildServiceInterface
 
     /**
      * 通过id列表获取平台子产品数组
-     * @param array $idList 平台子产品id的列表
-     * @param array $relations 平台子产品的关联关系，支持：["platform_product","product_child"]
+     * @param array $idList 平台子产品id的列表, 默认去重
+     * @param array $relations 平台子产品的关联关系，支持：["platform_product","product_child","weight"]
      * @param array $columns 平台子产品表的字段，默认全部字段
      * ['id','platform_product_id','product_child_id','platform_product_child_sku','asin','fnsku','is_sale']
-     * @return array
+     * @return array 默认keyBy('id')
      */
     public function getByIdList(array $idList, array $relations = [], $columns = ['*']): array;
 
@@ -35,7 +35,7 @@ interface PlatformProductChildServiceInterface
      * 获取单个数据
      * @param string $sku 平台子产品sku
      * @param int $siteId 平台子产品所属站点
-     * @param array $relations 平台子产品的关联关系，支持：["platform_product","product_child"]
+     * @param array $relations 平台子产品的关联关系，支持：["platform_product","product_child","weight"]
      * @param array $columns 平台子产品表的字段，默认全部字段
      * ['id','platform_product_id','product_child_id','platform_product_child_sku','asin','fnsku','is_sale']
      * @return array
@@ -44,12 +44,12 @@ interface PlatformProductChildServiceInterface
 
     /**
      * 通过sku列表获取平台子产品数组
-     * @param array $skuList 平台子产品sku的列表
+     * @param array $skuList 平台子产品sku的列表, 默认去重
      * @param int $siteId 平台子产品所属站点
-     * @param array $relations 平台子产品的关联关系，支持：["platform_product","product_child"]
+     * @param array $relations 平台子产品的关联关系，支持：["platform_product","product_child","weight"]
      * @param array $columns 平台子产品表的字段，默认全部字段
      * ['id','platform_product_id','product_child_id','platform_product_child_sku','asin','fnsku','is_sale']
-     * @return array
+     * @return array 默认keyBy('platform_product_child_sku')
      */
     public function getBySkuList(array $skuList, $siteId, array $relations = [], $columns = ['*']): array;
 

src/Service/Interfaces/Product/PlatformProductServiceInterface.php

@@ -24,12 +24,12 @@ interface PlatformProductServiceInterface
 
     /**
      * 通过id列表获取平台产品数组
-     * @param array $idList 平台产品id的列表
+     * @param array $idList 平台产品id的列表, 默认去重
      * @param array $relations 平台产品的关联关系，
      * 支持：["status","product","amazon_warehouse","platform_product_children","brand","category","ingredient","product_name","images","price_info","property"]
      * @param array $columns 平台产品表的字段，默认全部字段
      * ['id', 'sku', 'product_id', 'name', 'team_id', 'site_id', 'price', 'currency_id', 'platform_product_status_id', 'creator_id', 'asin', 'amazon_warehouse_id', 'info_completed']
-     * @return array
+     * @return array 默认keyBy('id')
      */
     public function getByIdList(array $idList, array $relations = [], $columns = ['*']): array;
 

src/Service/Interfaces/Product/ProductChildServiceInterface.php

@@ -22,18 +22,18 @@ interface ProductChildServiceInterface
 
     /**
      * 通过id列表获取产品数组
-     * @param array $idList 子SKUid的列表
+     * @param array $idList 子SKUid的列表, 默认去重
      * @param array $columns 子SKU表的字段，默认显示全部
      * @param array $relations 子SKU的关联关系,可传入['brand', 'category', 'product_name', 'images', 'cost']
-     * @return array
+     * @return array 默认keyBy('id')
      */
     public function getByIdList(array $idList, array $columns = ['*'], array $relations = []): array;
 
     /**
      * 通过sku列表获取子产品列表
-     * @param array $skuList
+     * @param array $skuList 默认去重
      * @param array $columns
-     * @return array
+     * @return array 默认keyBy('child_sku')
      */
     public function getListBySkuList(array $skuList, array $columns = ['id']);
 

src/Service/Interfaces/Product/ProductServiceInterface.php

@@ -15,7 +15,7 @@ interface ProductServiceInterface
      * 获取单个数据
      * @param int $id 产品id
      * @param array $relations 产品的关联关系，支持：["brand","category","ingredient","product_name","status","type","images","price_info","product_children"]
-     * @param array $columns 产品表的字段，默认全部字段
+     * @param array $columns 产品表的字段，默认
      * ['id', 'sku', 'name', 'en_name', 'brand_id', 'team_id', 'hs_code', 'origin_country_id', 'production_address',
      * 'unit', 'category_id', 'ingredient_id', 'product_name_id', 'type_id', 'status_id', 'style', 'info_completed'
      * , 'bar_code', 'bar_code_image', 'creator_id', 'hot']
@@ -25,17 +25,16 @@ interface ProductServiceInterface
 
     /**
      * 通过id列表获取产品数组
-     * @param array $idList 产品id的列表
+     * @param array $idList 产品id的列表, 默认去重
      * @param array $relations 产品的关联关系，支持["brand","category","ingredient","product_name","status","type","images","price_info","product_children"]
      * @param array $columns 产品表的字段，默认['id', 'sku', 'name', 'en_name', 'brand_id'
      * , 'team_id', 'hs_code', 'origin_country_id', 'production_address', 'unit', 'category_id'
      * , 'ingredient_id', 'product_name_id', 'type_id', 'status_id', 'style', 'info_completed'
      * , 'bar_code', 'bar_code_image', 'creator_id', 'hot']
-     * @return array
+     * @return array 默认keyBy('id')
      */
     public function getByIdList(array $idList, array $relations = [], array $columns = ['*']): array;
 
-
     /**
      * 获取全部尺码列表
      * @param array $columns 默认['id', 'name']

src/Service/Interfaces/ProductChildServiceInterface.php

@@ -22,18 +22,18 @@ interface ProductChildServiceInterface
 
     /**
      * 通过id列表获取产品数组
-     * @param array $idList 子SKUid的列表
+     * @param array $idList 子SKUid的列表, 默认去重
      * @param array $columns 子SKU表的字段，默认显示全部
      * @param array $relations 子SKU的关联关系,可传入['brand', 'category', 'product_name', 'images', 'cost']
-     * @return array
+     * @return array 默认keyBy('id')
      */
     public function getByIdList(array $idList, array $columns = ['*'], array $relations = []): array;
 
     /**
      * 通过sku列表获取子产品列表
-     * @param array $skuList
+     * @param array $skuList 默认去重
      * @param array $columns
-     * @return array
+     * @return array 默认keyBy('child_sku')
      */
     public function getListBySkuList(array $skuList, array $columns = ['id']);
 

src/Service/Interfaces/UserServiceInterface.php

@@ -30,25 +30,25 @@ interface UserServiceInterface
 
     /**
      * 获取全部数据
-     * @param array $columns
+     * @param array $columns 默认['id', 'name']
      * @param array $relations 可传入['teams', 'departments', 'position', 'assessment_plan'],分别是团队,部门,岗位和考核方案
      * @return array
      */
-    public function all(array $columns = ['*'], array $relations = []): array;
+    public function all(array $columns = ['id', 'name'], array $relations = []): array;
 
     /**
      * 通过id列表获取用户数组
-     * @param array $idList
+     * @param array $idList 默认去重
      * @param array $columns
      * @param array $relations 可传入['teams', 'departments', 'position', 'assessment_plan'],分别是团队,部门,岗位和考核方案
-     * @return mixed
+     * @return mixed 默认keyBY('id')
      */
-    public function getByIdList(array $idList, array $columns = ['*'], array $relations = []);
+    public function getByIdList($idList, $columns = ['*'], $relations = []);
 
     /**
      * 通过部门id列表获取用户数组(包括子部门用户)
      * @param array $deptIds
-     * @param array $columns 用户字段,默认['id', 'name', 'department_id']
+     * @param array $columns 用户字段,默认['id', 'name']
      * @return array
      */
     public function getListByDeptIds(array $deptIds, $columns = []);
@@ -90,10 +90,10 @@ interface UserServiceInterface
 
     /**
      * 获取带有领导真实信息的用户列表
-     * @param int $userId
+     * @param int $userId 默认去重
      * @param array $idList 可包含[-1,-2,-3]
      * @param array $columns
-     * @return array
+     * @return array 默认keyBY('id')
      */
     public function getListWithLeader(int $userId, array $idList = [], array $columns = ['id', 'name']): array;