Explorar el Código

调整方法命名规范

alexzy hace 4 años
padre
commit
0aa66e957f

+ 7 - 5
src/AliOssServiceInterface.php

@@ -8,16 +8,18 @@ interface AliOssServiceInterface
 {
     /**
      * 创建oss软连接
-     * @param string $object
-     * @param string $link
+     *
+     * @param string $object 原数据路径
+     * @param string $link 软连接路径
      * @return mixed
      */
     public function putSymlink(string $object, string $link);
 
     /**
-     * 创建有效期链接
-     * @param string $object
-     * @param int $time_out
+     * 创建临时有效期带token的访问链接
+     *
+     * @param string $object 路径
+     * @param int $time_out 超时时间(秒)
      * @return mixed
      */
     public function makeSignUrl(string $object, int $time_out = 20);

+ 5 - 5
src/GameDownServiceInterface.php

@@ -7,17 +7,17 @@ namespace Yxy\Service;
 interface GameDownServiceInterface
 {
     /**
-     * 获取游戏下载token
-     * @param int $promote_id
-     * @param int $game_id
+     * 获取游戏下载token 及密码
+     * @param int $game_id 游戏ID
+     * @param int $promote_id 渠道ID 渠道ID为空则返回官方链接
      * @return mixed
      */
     public function createGameDownToken(int $game_id, int $promote_id = 0);
 
     /**
      * 获取游戏下载地址
-     * @param string $token
-     * @param string $password
+     * @param string $token 临时token
+     * @param string $password 对应密码
      * @return mixed
      */
     public function createGameDownUrl(string $token, string $password);

+ 8 - 9
src/GameServiceInterface.php

@@ -8,26 +8,25 @@ interface GameServiceInterface
 {
     /**
      * 根据游戏ID获取游戏信息
-     * @param int $id
-     * @param array $field
+     * @param int $id 游戏ID
+     * @param array $field 指定返回字段
      * @return mixed
      */
     public function getById(int $id, array $field = ['*']): array;
 
     /**
      * 根据游戏id批量获取游戏信息
-     * @param array $ids
-     * @param array|string[] $field
+     * @param array $ids 多个游戏ID
+     * @param array $field 指定返回字段
      * @return array
      */
     public function listByIds(array $ids, array $field = ['*']): array;
 
     /**
-     * 根据游戏名称查找ID数组
-     * @param string $name
-     * @param array $field
+     * 根据游戏名称模糊查找
+     * @param string $name 搜索名称
+     * @param array $field 指定返回字段
      * @return array
-     * @example
      */
-    public function listIdsByName(string $name, array $field = ['*']): array;
+    public function listByName(string $name, array $field = ['*']): array;
 }

+ 4 - 4
src/PromoteApplyServiceInterface.php

@@ -7,10 +7,10 @@ namespace Yxy\Service;
 interface PromoteApplyServiceInterface
 {
     /**
-     * 根据游戏ID和渠道ID查询打包信息
-     * @param int $game_id
-     * @param int $promote_id
-     * @param string[] $field
+     * 根据游戏ID和渠道ID查询一条打包信息
+     * @param int $game_id 游戏ID
+     * @param int $promote_id 渠道ID
+     * @param array $field 指定返回字段
      * @return mixed
      */
     public function getByGidAndPid(int $game_id, int $promote_id, array $field = ['*']): array;