Skip to content
On this page

File Command Word

getUploadToken

php
\FresnsCmdWord::plugin($unikey)->getUploadToken($wordBody)
Parameter NameTypeRequiredDescription
typeNumberrequired1.图片 / 2.视频 / 3.音频 / 4.文档
nameStringrequired本次上传的文件名
expireTimeNumberrequired有效期,单位:秒
Return Example
json
{
    "code": 0,
    "message": "ok",
    "data": {
        "storageId": "存储服务商编号,见字典键值",
        "token": "上传 token",
        "expireTime": "有效期,单位:秒" //没有则输出 null
    }
}

uploadFile

php
\FresnsCmdWord::plugin($unikey)->uploadFile($wordBody)
Parameter NameTypeRequiredDescription
usageTypeNumberrequired文件用途类型
platformIdNumberrequired平台编号(配置表 platforms 键名的键值)
tableNameStringrequired来源表名(哪个张使用)
tableColumnStringrequired来源字段名(哪个字段使用)
tableIdNumberoptional来源表主键 ID
tableKeyStringoptional来源表键名 PrimaryHelper::fresnsPrimaryId()
aidStringoptional账号参数 file_usages > account_id
存储时由 aid 转换成 accounts > id
uidNumberoptional用户参数 file_usages > user_id
存储时由 uid 转换成 users > id
typeNumberrequired1.图片 / 2.视频 / 3.音频 / 4.文档
moreJsonStringoptional自定义
fileFilerequired文件
  • tableIdtableKey 二选一必传一个。
Return Example
json
{
    "code": 0,
    "message": "ok",
    "data": {
        // 文件信息
    }
}
逻辑说明

uploadFileInfo

php
\FresnsCmdWord::plugin($unikey)->uploadFileInfo($wordBody)
Parameter NameTypeRequiredDescription
usageTypeNumberrequired文件用途类型
platformIdNumberrequired平台编号(配置表 platforms 键名的键值)
tableNameStringrequired来源表名
tableColumnStringrequired来源字段名
tableIdNumberoptional来源表主键 ID
tableKeyStringoptional来源表键名 PrimaryHelper::fresnsPrimaryId()
aidStringoptional账号参数 file_usages > account_id
存储时由 aid 转换成 accounts > id
uidNumberoptional用户参数 file_usages > user_id
存储时由 uid 转换成 users > id
typeNumberrequired1.图片 / 2.视频 / 3.音频 / 4.文档
fileInfoArrayrequired文件信息数组
  • tableIdtableKey 二选一必传一个。
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",
        "videoCoverPath": "视频专用,存储到 files > video_cover_path",
        "videoGifPath": "视频专用,存储到 files > video_gif_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_cover_path,也可以处理视频动态封面图 file->video_gif_path
  • 查看返回结果文件信息结构

getAntiLinkFileInfo (One)

php
\FresnsCmdWord::plugin($unikey)->getAntiLinkFileInfo($wordBody)
Parameter NameTypeRequiredDescription
typeNumberrequired1.图片 / 2.视频 / 3.音频 / 4.文档
fileIdOrFidStringoptionalfiles > id 或者 files > fid
Return Example
json
{
    "code": 0,
    "message": "ok",
    "data": {
        // 文件信息
    }
}
逻辑说明
  • 如果未开启防盗链,可使用模型中封装功能输出信息。
  • $file->getFileInfo();

getAntiLinkFileInfoList (Multiple)

php
\FresnsCmdWord::plugin($unikey)->getAntiLinkFileInfoList($wordBody)
Parameter NameTypeRequiredDescription
typeNumberrequired1.图片 / 2.视频 / 3.音频 / 4.文档
fileIdsOrFidsArrayoptionalfiles > id 或者 files > fid
Return Example
json
{
    "code": 0,
    "message": "ok",
    "data": [
        {
            // 文件信息
        },
        {
            // 文件信息
        }
    ]
}
逻辑说明
  • 如果未开启防盗链,可请求封装功能输出信息。
  • FileHelper::fresnsFileInfoListByIds('fileIdsOrFids');

getAntiLinkFileOriginalUrl

php
\FresnsCmdWord::plugin($unikey)->getAntiLinkFileOriginalUrl($wordBody)
Parameter NameTypeRequiredDescription
typeNumberrequired1.图片 / 2.视频 / 3.音频 / 4.文档
fileIdOrFidStringoptionalfiles > 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 NameTypeRequiredDescription
fileIdsOrFidsArrayrequiredfiles > id 或者 files > fid

physicalDeletionFiles

php
\FresnsCmdWord::plugin($unikey)->physicalDeletionFiles($wordBody)
Parameter NameTypeRequiredDescription
typeNumberrequired1.图片 / 2.视频 / 3.音频 / 4.文档
fileIdsOrFidsArrayrequiredfiles > id 或者 files > fid
  • fileIdsfids 数组值文件类型必须属于同一个 type 类型的文件。

Released under the Apache-2.0 License