1. class
  2. Fangcloud
  3. \
  4. Api
  5. \
  6. Folder
  7. \
  8. YfyFolderClient

YfyFolderClient

class YfyFolderClient extends YfyBaseApiClient

Class YfyFolderClient

Constants

API_PREFIX

FOLDER_INFO_URI

FOLDER_TRASH_INFO_URI

FOLDER_CREATE_URI

FOLDER_UPDATE_URI

FOLDER_DELETE_URI

FOLDER_DELETE_FROM_TRASH_URI

FOLDER_RESTORE_FROM_TRASH_URI

FOLDER_MOVE_URI

FOLDER_CHILDREN_URI

FOLDER_SHARE_LINKS

FOLDER_COLLABS

Properties

protected YfyContext $yfyContext from YfyBaseApiClient
protected YfyHttpClient $httpClient from YfyBaseApiClient
protected OAuthClient $oauthClient from YfyBaseApiClient

Methods

__construct(YfyContext $yfyContext, YfyHttpClient $httpClient, OAuthClient $oauthClient)

YfyUserClient constructor.

YfyRawResponse
execute(YfyRequest $yfyRequest)

执行请求, 调用realExecute, 封装了重试的逻辑

from YfyBaseApiClient
YfyRawResponse
realExecute(YfyRequest $yfyRequest)

真正执行请求的函数 会进行所有错误处理

from YfyBaseApiClient
mixed
getInfo(int $folderId)

获取文件夹信息

mixed
getTrashInfo(int $folderId)

获取在回收站中的文件夹信息

mixed
create(string $name, int $parentId)

创建文件夹

mixed
update(int $folderId, string $name)

更新文件夹

mixed
deleteToTrash(int $folderId)

删除文件夹至回收站

mixed
deleteFromTrash(int $folderId)

从回收站删除文件夹

mixed
restoreFromTrash(int $folderId)

从回收站恢复文件夹

mixed
move(int $folderId, int $targetFolderId)

移动文件夹

mixed
listChildren(int $folderId, int $pageId, int $pageCapacity = 20, string $type = YfyItemType::ITEM)

获取文件夹的单层子文件和文件夹列表

mixed
listShareLinks(int $folderId)

获取文件夹的分享链接列表

mixed
listCollabs(int $folderId)

获取文件夹的协作信息

Details

at line 41
__construct(YfyContext $yfyContext, YfyHttpClient $httpClient, OAuthClient $oauthClient)

YfyUserClient constructor.

Parameters

YfyContext $yfyContext
YfyHttpClient $httpClient
OAuthClient $oauthClient

in YfyBaseApiClient at line 61
protected YfyRawResponse execute(YfyRequest $yfyRequest)

执行请求, 调用realExecute, 封装了重试的逻辑

Parameters

YfyRequest $yfyRequest

Return Value

YfyRawResponse

Exceptions

YfySdkException

in YfyBaseApiClient at line 93
protected YfyRawResponse realExecute(YfyRequest $yfyRequest)

真正执行请求的函数 会进行所有错误处理

Parameters

YfyRequest $yfyRequest

Return Value

YfyRawResponse

Exceptions

YfyAuthorizationRequiredException
YfyInvalidTokenException
YfyRateLimitException
YfySdkException
YfyServerException

at line 53
mixed getInfo(int $folderId)

获取文件夹信息

Parameters

int $folderId 文件夹id

Return Value

mixed

Exceptions

YfySdkException

at line 71
mixed getTrashInfo(int $folderId)

获取在回收站中的文件夹信息

Parameters

int $folderId 文件夹id

Return Value

mixed

Exceptions

YfySdkException

at line 90
mixed create(string $name, int $parentId)

创建文件夹

Parameters

string $name 文件夹名称
int $parentId 父文件夹id

Return Value

mixed

Exceptions

YfySdkException

at line 113
mixed update(int $folderId, string $name)

更新文件夹

Parameters

int $folderId 文件夹id
string $name 更新的文件夹名称

Return Value

mixed

Exceptions

YfySdkException

at line 135
mixed deleteToTrash(int $folderId)

删除文件夹至回收站

Parameters

int $folderId 文件夹id

Return Value

mixed

Exceptions

YfySdkException

at line 153
mixed deleteFromTrash(int $folderId)

从回收站删除文件夹

Parameters

int $folderId 文件夹id

Return Value

mixed

Exceptions

YfySdkException

at line 171
mixed restoreFromTrash(int $folderId)

从回收站恢复文件夹

Parameters

int $folderId 文件夹id

Return Value

mixed

Exceptions

YfySdkException

at line 190
mixed move(int $folderId, int $targetFolderId)

移动文件夹

Parameters

int $folderId 文件夹id
int $targetFolderId 目标文件夹id

Return Value

mixed

Exceptions

YfySdkException

at line 218
mixed listChildren(int $folderId, int $pageId, int $pageCapacity = 20, string $type = YfyItemType::ITEM)

获取文件夹的单层子文件和文件夹列表

Parameters

int $folderId 文件夹id
int $pageId 页码
int $pageCapacity 页容量
string $type 搜索文件类型, 只能是Fangcloud\Constant\YfyItemType中定义的常量

Return Value

mixed

Exceptions

YfySdkException
InvalidArgumentException

See also

YfyItemType

获取文件夹的分享链接列表

Parameters

int $folderId 文件夹id

Return Value

mixed

Exceptions

YfySdkException

at line 263
mixed listCollabs(int $folderId)

获取文件夹的协作信息

Parameters

int $folderId 文件夹id

Return Value

mixed

Exceptions

YfySdkException