Fangcloud\Api\File\YfyFileClient | Fangcloud PHP SDK API

class YfyFileClient extends YfyBaseApiClient

Class YfyFileClient

Constants

API_PREFIX
FILE_INFO_URI
FILE_TRASH_INFO_URI
FILE_UPDATE_URI
FILE_DELETE_URI
FILE_DELETE_FROM_TRASH_URI
FILE_RESTORE_FROM_TRASH_URI
FILE_MOVE_URI
FILE_COPY_URI
FILE_UPLOAD_URI
FILE_UPLOAD_NEW_VERSION_URI
FILE_DOWNLOAD_URI
FILE_SHARE_LINKS_URI
FILE_COMMENTS_URI
FILE_VERSIONS_URI
FILE_VERSION_INFO_URI
FILE_VERSION_PROMOTE_URI
FILE_VERSION_DELETE_URI

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 $fileId)

获取文件信息

mixed

getTrashInfo(int $fileId)

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

mixed

update(int $fileId, string $name, string|null $description = null)

更新文件信息

mixed

deleteToTrash(int $fileId)

删除文件至回收站

mixed

deleteFromTrash(int $fileId)

从回收站删除文件

mixed

restoreFromTrash(int $fileId)

从回收站恢复文件

mixed

move(int $fileId, int $targetFolderId)

移动文件

mixed

copy(int $fileId, int $targetFolderId)

复制文件

mixed

listShareLinks(int $fileId)

获取文件的分享链接列表

mixed

listComments(int $fileId)

获取文件的评论列表

mixed

listVersions(int $fileId)

获取文件的所有版本列表

mixed

getVersionInfo(int $fileId, int $versionId)

获取文件的特定版本信息

mixed

promoteVersion(int $fileId, int $versionId)

设置某版本为当前版本

mixed

deleteVersion(int $fileId, int $versionId)

删除文件版本

string

getUploadFileUrl(int $parentId, string $name)

获取上传文件url

string

getUploadNewVersionUrl(int $fileId, string $name, string $remark)

获取上传文件新版本url

mixed

uploadFile(int $parentId, string $name, resource|StreamInterface|string $resource)

上传文件

mixed

uploadNewVersion(int $fileId, string $name, string $remark, resource|StreamInterface|string $resource)

上传文件新版本

string

getDownloadUrl(int $fileId)

获取下载文件的url

DownloadFile

download(string $fileId, string|null $savePath = null)

下载文件

Details

at line 47
`__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 59
`mixed getInfo(int $fileId)`

获取文件信息

Parameters

int

$fileId

文件id

Return Value

mixed

Exceptions

YfySdkException

at line 77
`mixed getTrashInfo(int $fileId)`

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

Parameters

int

$fileId

文件id

Return Value

mixed

Exceptions

YfySdkException

at line 96
`mixed update(int $fileId, string $name, string|null $description = null)`

更新文件信息

Parameters

int	$fileId	文件id
string	$name	更新的文件名
string\|null	$description	更新的描述

Return Value

mixed

at line 120
`mixed deleteToTrash(int $fileId)`

删除文件至回收站

Parameters

int

$fileId

文件id

Return Value

mixed

Exceptions

YfySdkException

at line 138
`mixed deleteFromTrash(int $fileId)`

从回收站删除文件

Parameters

int

$fileId

文件id

Return Value

mixed

Exceptions

YfySdkException

at line 156
`mixed restoreFromTrash(int $fileId)`

从回收站恢复文件

Parameters

int

$fileId

文件id

Return Value

mixed

Exceptions

YfySdkException

at line 175
`mixed move(int $fileId, int $targetFolderId)`

移动文件

Parameters

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

Return Value

mixed

Exceptions

YfySdkException

at line 198
`mixed copy(int $fileId, int $targetFolderId)`

复制文件

Parameters

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

Return Value

mixed

Exceptions

YfySdkException

at line 220
`mixed listShareLinks(int $fileId)`

获取文件的分享链接列表

Parameters

int

$fileId

文件id

Return Value

mixed

Exceptions

YfySdkException

at line 238
`mixed listComments(int $fileId)`

获取文件的评论列表

Parameters

int

$fileId

文件id

Return Value

mixed

Exceptions

YfySdkException

at line 256
`mixed listVersions(int $fileId)`

获取文件的所有版本列表

Parameters

int

$fileId

文件id

Return Value

mixed

Exceptions

YfySdkException

at line 275
`mixed getVersionInfo(int $fileId, int $versionId)`

获取文件的特定版本信息

Parameters

int	$fileId	文件id
int	$versionId	文件版本id

Return Value

mixed

Exceptions

YfySdkException

at line 295
`mixed promoteVersion(int $fileId, int $versionId)`

设置某版本为当前版本

Parameters

int	$fileId	文件id
int	$versionId	文件版本id

Return Value

mixed

Exceptions

YfySdkException

at line 315
`mixed deleteVersion(int $fileId, int $versionId)`

删除文件版本

Parameters

int	$fileId	文件id
int	$versionId	文件版本id

Return Value

mixed

Exceptions

YfySdkException

at line 335
`string getUploadFileUrl(int $parentId, string $name)`

获取上传文件url

Parameters

int	$parentId	父文件夹id
string	$name	上传文件名

Return Value

string

上传链接

Exceptions

YfySdkException

at line 363
`string getUploadNewVersionUrl(int $fileId, string $name, string $remark)`

获取上传文件新版本url

Parameters

int	$fileId	文件id
string	$name	新版本文件名
string	$remark	备注

Return Value

string

上传链接

Exceptions

YfySdkException

at line 391
`mixed uploadFile(int $parentId, string $name, resource|StreamInterface|string $resource)`

上传文件

Parameters

int	$parentId	父文件夹id
string	$name	上传文件名
resource\|StreamInterface\|string	$resource

Return Value

mixed

Exceptions

YfySdkException

at line 420
`mixed uploadNewVersion(int $fileId, string $name, string $remark, resource|StreamInterface|string $resource)`

上传文件新版本

Parameters

int	$fileId	文件id
string	$name	上传文件名
string	$remark	备注
resource\|StreamInterface\|string	$resource

Return Value

mixed

Exceptions

YfySdkException

at line 446
`string getDownloadUrl(int $fileId)`

获取下载文件的url

Parameters

int

$fileId

下载文件id

Return Value

string

下载链接

Exceptions

YfySdkException

at line 466
`DownloadFile download(string $fileId, string|null $savePath = null)`

下载文件

Parameters

string	$fileId	文件路径
string\|null	$savePath	保存的目录或者文件名

Return Value

DownloadFile

若savePath为null,返回DownloadFile,其中包含下载的文件流

Exceptions

YfySdkException

YfyFileClient

Constants

Properties

Methods

Details

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

Parameters

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

Parameters

Return Value

Exceptions

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

Parameters

Return Value

Exceptions

at line 59 mixed getInfo(int $fileId)

Parameters

Return Value

Exceptions

at line 77 mixed getTrashInfo(int $fileId)

Parameters

Return Value

Exceptions

at line 96 mixed update(int $fileId, string $name, string|null $description = null)

Parameters

Return Value

at line 120 mixed deleteToTrash(int $fileId)

Parameters

Return Value

Exceptions

at line 138 mixed deleteFromTrash(int $fileId)

Parameters

Return Value

Exceptions

at line 156 mixed restoreFromTrash(int $fileId)

Parameters

Return Value

Exceptions

at line 175 mixed move(int $fileId, int $targetFolderId)

Parameters

Return Value

Exceptions

at line 198 mixed copy(int $fileId, int $targetFolderId)

Parameters

Return Value

Exceptions

at line 220 mixed listShareLinks(int $fileId)

Parameters

Return Value

Exceptions

at line 238 mixed listComments(int $fileId)

Parameters

Return Value

Exceptions

at line 256 mixed listVersions(int $fileId)

Parameters

Return Value

Exceptions

at line 275 mixed getVersionInfo(int $fileId, int $versionId)

Parameters

Return Value

Exceptions

at line 295 mixed promoteVersion(int $fileId, int $versionId)

Parameters

Return Value

Exceptions

at line 315 mixed deleteVersion(int $fileId, int $versionId)

Parameters

Return Value

Exceptions

at line 335 string getUploadFileUrl(int $parentId, string $name)

Parameters

Return Value

Exceptions

at line 363 string getUploadNewVersionUrl(int $fileId, string $name, string $remark)

Parameters

Return Value

Exceptions

at line 391 mixed uploadFile(int $parentId, string $name, resource|StreamInterface|string $resource)

Parameters

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

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

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

at line 59
`mixed getInfo(int $fileId)`

at line 77
`mixed getTrashInfo(int $fileId)`

at line 96
`mixed update(int $fileId, string $name, string|null $description = null)`

at line 120
`mixed deleteToTrash(int $fileId)`

at line 138
`mixed deleteFromTrash(int $fileId)`

at line 156
`mixed restoreFromTrash(int $fileId)`

at line 175
`mixed move(int $fileId, int $targetFolderId)`

at line 198
`mixed copy(int $fileId, int $targetFolderId)`

at line 220
`mixed listShareLinks(int $fileId)`

at line 238
`mixed listComments(int $fileId)`

at line 256
`mixed listVersions(int $fileId)`

at line 275
`mixed getVersionInfo(int $fileId, int $versionId)`

at line 295
`mixed promoteVersion(int $fileId, int $versionId)`

at line 315
`mixed deleteVersion(int $fileId, int $versionId)`

at line 335
`string getUploadFileUrl(int $parentId, string $name)`

at line 363
`string getUploadNewVersionUrl(int $fileId, string $name, string $remark)`

at line 391
`mixed uploadFile(int $parentId, string $name, resource|StreamInterface|string $resource)`

at line 420
`mixed uploadNewVersion(int $fileId, string $name, string $remark, resource|StreamInterface|string $resource)`

at line 446
`string getDownloadUrl(int $fileId)`

at line 466
`DownloadFile download(string $fileId, string|null $savePath = null)`