FresnsFile Command Word
getUploadToken
php
\FresnsCmdWord::plugin($unikey)->getUploadToken($wordBody)
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| type | Number | required | 1.图片 / 2.视频 / 3.音频 / 4.文档 |
| name | String | required | 本次上传的文件名 |
| expireTime | Number | required | 有效期，单位：秒 |
- 客户端凭 Token 可以通过 SDK 直接上传到云服务商。
- 存储服务商编号
Return Example
json
{
"code": 0,
"message": "ok",
"data": {
"storageId": "存储服务商编号，见字典键值",
"token": "上传 token",
"expireTime": "有效期，单位：秒" //没有则输出 null
}
}
uploadFile
php
\FresnsCmdWord::plugin($unikey)->uploadFile($wordBody)
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| platformId | Number | required | 平台编号（配置表 platforms 键名的键值） |
| usageType | Number | required | 文件用途类型 |
| tableName | String | required | 来源表名（哪个张使用） |
| tableColumn | String | required | 来源字段名（哪个字段使用） |
| tableId | Number | optional | 来源表主键 ID |
| tableKey | String | optional | 来源表键名 PrimaryHelper::fresnsPrimaryId() |
| aid | String | optional | 账号参数 file_usages > account_id存储时由 aid 转换成 accounts > id |
| uid | Number | optional | 用户参数 file_usages > user_id存储时由 uid 转换成 users > id |
| type | Number | required | 1.图片 / 2.视频 / 3.音频 / 4.文档 |
| moreJson | String | optional | 自定义 |
| file | File | required | 文件 |
tableId和tableKey二选一必传一个。
Return Example
json
{
"code": 0,
"message": "ok",
"data": {
// 文件信息
}
}
逻辑说明
- 入库方法可以调用主程序封装功能 FileUtility::saveFileInfoToDatabase($bodyInfo, $diskPath, $file)
- 如果文件类型为视频
type=2，还需处理视频封面图，对应字段为file->video_poster_path。 - 查看返回结果文件信息结构
uploadFileInfo
php
\FresnsCmdWord::plugin($unikey)->uploadFileInfo($wordBody)
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| platformId | Number | required | 平台编号（配置表 platforms 键名的键值） |
| usageType | Number | required | 文件用途类型 |
| tableName | String | required | 来源表名 |
| tableColumn | String | required | 来源字段名 |
| tableId | Number | optional | 来源表主键 ID |
| tableKey | String | optional | 来源表键名 PrimaryHelper::fresnsPrimaryId() |
| aid | String | optional | 账号参数 file_usages > account_id存储时由 aid 转换成 accounts > id |
| uid | Number | optional | 用户参数 file_usages > user_id存储时由 uid 转换成 users > id |
| type | Number | required | 1.图片 / 2.视频 / 3.音频 / 4.文档 |
| fileInfo | Array | required | 文件信息数组 |
tableId和tableKey二选一必传一个。
fileInfo Example
json
[
{
"name": "存储到 files > name",
"mime": "存储到 files > mime",
"extension": "存储到 files > extension",
"size": "存储到 files > size", // 单位 Byte
"md5": "存储到 files > md5",
"sha": "存储到 files > sha",
"shaType": "存储到 files > sha_type",
"path": "存储到 files > path",
"imageWidth": "图片专用，存储到 files > image_width",
"imageHeight": "图片专用，存储到 files > image_height",
"videoTime": "视频专用，存储到 files > video_time",
"videoPosterPath": "视频专用，存储到 files > video_poster_path",
"audioTime": "音频专用，存储到 files > audio_time",
"transcodingState": "音视频专用，存储到 files > transcoding_state",
"moreJson": {
// 扩展信息，存储到 files > more_json
},
"originalPath": "存储到 files > original_path",
"rating": "存储到 file_usages > rating",
}
]
Return Example
json
{
"code": 0,
"message": "ok",
"data": [
{
// 文件信息
},
{
// 文件信息
}
]
}
逻辑说明
- 入库方法可以调用主程序封装功能 FileUtility::uploadFileInfo($bodyInfo)
- 如果文件类型为视频
type=2，还需处理视频封面图，对应字段为file->video_poster_path。 - 查看返回结果文件信息结构
getAntiLinkFileInfo (One)
php
\FresnsCmdWord::plugin($unikey)->getAntiLinkFileInfo($wordBody)
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| type | Number | required | 1.图片 / 2.视频 / 3.音频 / 4.文档 |
| fileIdOrFid | String | optional | files > id 或者 files > fid |
Return Example
json
{
"code": 0,
"message": "ok",
"data": {
// 文件信息
}
}
逻辑说明
- 如果未开启防盗链，可使用模型中封装功能输出信息。
$file->getFileInfo();
getAntiLinkFileInfoList (Multiple)
php
\FresnsCmdWord::plugin($unikey)->getAntiLinkFileInfoList($wordBody)
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| type | Number | required | 1.图片 / 2.视频 / 3.音频 / 4.文档 |
| fileIdsOrFids | Array | optional | files > id 或者 files > fid |
Return Example
json
{
"code": 0,
"message": "ok",
"data": [
{
// 文件信息
},
{
// 文件信息
}
]
}
逻辑说明
- 如果未开启防盗链，可请求封装功能输出信息。
FileHelper::fresnsFileInfoListByIds('fileIdsOrFids');
getAntiLinkFileOriginalUrl
php
\FresnsCmdWord::plugin($unikey)->getAntiLinkFileOriginalUrl($wordBody)
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| type | Number | required | 1.图片 / 2.视频 / 3.音频 / 4.文档 |
| fileIdOrFid | String | optional | files > id 或者 files > fid |
Return Example
json
{
"code": 0,
"message": "ok",
"data": {
"originalUrl": "由 file > original_path 字段拼接",
// original_path 为空时，由 files > path 字段拼接替补
}
}
逻辑说明
- 如果未开启防盗链，可请求模型中封装功能输出信息。
$file->getFileOriginalUrl();
logicalDeletionFiles
php
\FresnsCmdWord::plugin($unikey)->logicalDeletionFiles($wordBody)
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| fileIdsOrFids | Array | required | files > id 或者 files > fid |
physicalDeletionFiles
php
\FresnsCmdWord::plugin($unikey)->physicalDeletionFiles($wordBody)
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| type | Number | required | 1.图片 / 2.视频 / 3.音频 / 4.文档 |
| fileIdsOrFids | Array | required | files > id 或者 files > fid |
fileIds或fids数组值文件类型必须属于同一个type类型的文件。