\BaiduPCS

Summary

Methods

Properties

Constants

__construct()
setAccessToken()
getAccessToken()
getQuota()
upload()
createSuperFile()
download()
makeDirectory()
getMeta()
getBatchMeta()
listFiles()
moveSingle()
moveBatch()
copySingle()
copyBatch()
deleteSingle()
deleteBatch()
search()
thumbnail()
diff()
downloadStream()
getStreamUri()
getStreamingUri()
listStream()
streaming()
cloudMatch()
addOfflineDownloadTask()
queryOfflineDownloadTask()
listOfflineDownloadTask()
cancelOfflineDownloadTask()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

_baseControl()

$_pcs_uri_prefixs
$_accessToken

N/A

File: core/api/BaiduPCS/BaiduPCS.class.php
Package: baidu\pcs
Class hierarchy: \BaiduPCS
Uses

Properties

$_pcs_uri_prefixs

$_pcs_uri_prefixs : array

百度PCS RESTFUL API SERVER调用地址前缀

Type

array —

$_accessToken

$_accessToken

Methods

__construct()

__construct(string  $accessToken) : mixed

初始化accessToken

Parameters

string

$accessToken

Returns

mixed —

setAccessToken()

setAccessToken(mixed  $accessToken) : \BaiduPCS

设置accessToken

Parameters

mixed

$accessToken

Returns

\BaiduPCS —

getAccessToken()

getAccessToken() : string

获取accessToken

Returns

string —

getQuota()

getQuota() : string

获取当前用户空间配额信息

Returns

string —

upload()

upload(string  $fileContent, string  $targetPath, string  $fileName, string  $newFileName = null, bool  $isCreateSuperFile = FALSE, mixed  $ondup = 'newcopy') : string

上传文件注意：此方法适用于上传不大于2G的单个文件。

Parameters

string	$fileContent	文件内容字符串
string	$targetPath	上传文件的目标保存路径
string	$fileName	文件名
string	$newFileName	新文件名
bool	$isCreateSuperFile	是否分片上传
mixed	$ondup

Returns

string —

createSuperFile()

createSuperFile(string  $targetPath, string  $fileName, array  $params, string  $newFileName = null, mixed  $ondup = 'newcopy') : string

合并分片上传的文件块注意：如果本地已有分片的文件块，可以调用upload接口按顺序上传之后，再调用createSuperFile接口将各文件块合并成文件。（此方法一般适用于超大文件，>2G）

Parameters

string	$targetPath	上传文件的目标保存路径
string	$fileName	文件名
array	$params	分片文件md5值数组
string	$newFileName	新文件名
mixed	$ondup

Returns

string —

download()

download(string  $path) : \文件内容

下载文件

Parameters

string

$path

文件路径

Returns

\文件内容 —

makeDirectory()

makeDirectory(string  $path) : string

创建文件夹

Parameters

string

$path

文件路径

Returns

string —

getMeta()

getMeta(string  $path) : string

获取单个文件/目录meta信息

Parameters

string

$path

文件路径

Returns

string —

getBatchMeta()

getBatchMeta(array  $paths) : string

批量获取文件/目录meta信息

Parameters

array

$paths

文件路径数组

Returns

string —

listFiles()

listFiles(string  $path, string  $by = 'name', string  $order = 'asc', string  $limit = '0-9') : string

获取指定文件夹下的文件列表

Parameters

string	$path	文件路径
string	$by	排序字段，缺省根据文件类型排序，time（修改时间），name（文件名），size（大小，注意目录无大小）
string	$order	asc或desc，缺省采用降序排序
string	$limit	返回条目控制，参数格式为：n1-n2。返回结果集的[n1, n2)之间的条目，缺省返回所有条目。n1从0开始。

Returns

string —

moveSingle()

moveSingle(string  $from, string  $to) : string

移动单个文件/目录

Parameters

string	$from	源路径
string	$to	目标路径

Returns

string —

moveBatch()

moveBatch(array  $from, array  $to) : string

批量移动文件/目录

Parameters

array	$from	源路径数组
array	$to	目标路径数组

Returns

string —

copySingle()

copySingle(string  $from, string  $to) : string

拷贝单个文件/目录

Parameters

string	$from	源路径
string	$to	目标路径

Returns

string —

copyBatch()

copyBatch(array  $from, array  $to) : string

批量拷贝文件/目录

Parameters

array	$from	源路径数组
array	$to	目标路径数组

Returns

string —

deleteSingle()

deleteSingle(string  $path) : string

删除单个文件/目录

Parameters

string

$path

文件路径

Returns

string —

deleteBatch()

deleteBatch(array  $paths) : string

批量删除文件/目录

Parameters

array

$paths

文件路径数组

Returns

string —

search()

search(string  $path, string  $wd, int  $re = 1) : string

按文件名搜索文件

Parameters

string	$path	文件路径
string	$wd	搜索关键字
int	$re	是否递归

Returns

string —

thumbnail()

thumbnail(string  $path, int  $width, int  $height, \int32  $quality = 100) : \文件内容

生成缩略图

Parameters

string	$path	图片路径
int	$width
int	$height
\int32	$quality

Returns

\文件内容 —

diff()

diff(string  $cursor) : string

文件增量更新操作查询

Parameters

string

$cursor

用于标记更新断点。首次调用cursor=null；非首次调用，使用最后一次调用diff接口的返回结果中的cursor

Returns

string —

downloadStream()

downloadStream(string  $path) : \文件内容

为当前用户下载一个流式文件

Parameters

string

$path

Returns

\文件内容 —

getStreamUri()

getStreamUri(string  $path) : \文件内容

为当前用户获取流式文件地址

Parameters

string

$path

Returns

\文件内容 —

getStreamingUri()

getStreamingUri(mixed  $path, mixed  $type) : mixed

Parameters

mixed	$path
mixed	$type

Returns

mixed —

listStream()

listStream(string  $type, string  $start, string  $limit = '1000', string  $filterPath = '') : string

获取应用目录下所有流式文件列表

Parameters

string	$type	取值为video，audio，image，doc四种
string	$start
string	$limit
string	$filterPath

Returns

string —

streaming()

streaming(string  $path, string  $type) : \文件播放列表URL

为当前用户进行视频转码并实现在线实时观看

Parameters

string	$path	格式必须为m3u8,m3u,asf,avi,flv,gif,mkv,mov,mp4,m4a,3gp,3g2,mj2,mpeg,ts,rm,rmvb,webm
string	$type	M3U8_320_240、M3U8_480_224、M3U8_480_360、M3U8_640_480和M3U8_854_480

Returns

\文件播放列表URL —

cloudMatch()

cloudMatch(string  $path, int  $contentLength, string  $contentMd5, string  $sliceMd5, string  $contentCrc32) : string

秒传一个文件注意事项： 1. 被秒传文件必须大于256KB（即 256*1024 B） 2. 校验段为文件的前256KB，秒传接口需要提供待秒传文件CRC32，校验段的MD5

Parameters

string	$path
int	$contentLength
string	$contentMd5
string	$sliceMd5
string	$contentCrc32

Returns

string —

addOfflineDownloadTask()

addOfflineDownloadTask(string  $savePath, string  $sourceUrl, int  $rateLimit = '', int  $timeout = 3600, string  $callback = '', int  $expires = '') : string

添加离线下载任务

Parameters

string	$savePath	离线下载数据在PCS中存放的路径
string	$sourceUrl	要下载数据的URL
int	$rateLimit	下载速度， byte/s
int	$timeout	下载的超时时间
string	$callback	回调URL，回调过程不处理302跳转
int	$expires	请求失效时间

Returns

string —

queryOfflineDownloadTask()

queryOfflineDownloadTask(string  $taskIds, int  $opType = 1, int  $expires = '') : string

精确查询离线下载任务

Parameters

string	$taskIds	要查询的task_id列表，如：'1,2,3,4'
int	$opType	0：查任务信息，1：查进度信息
int	$expires	请求失效时间

Returns

string —

listOfflineDownloadTask()

listOfflineDownloadTask(int  $start, int  $limit = 10, int  $asc, string  $sourceURL = '', string  $savePath = '', string  $createTime = '', int  $status = 1, int  $needTaskInfo = 1, int  $expires = '') : string

查询离线下载任务列表

Parameters

int	$start	起始位置
int	$limit	返回多少个
int	$asc	按开始时间升序 or 降序
string	$sourceURL	目标地址URL
string	$savePath	存放路径
string	$createTime	STARTTIMESTMAP, ENDTIMESTAMP, 如果不限制下限可写成"NULL, 1235", 不限制上线，可写成'1234,NULL'
int	$status	任务状态过滤
int	$needTaskInfo	是否需要返回任务信息
int	$expires	请求失效时间

Returns

string —

cancelOfflineDownloadTask()

cancelOfflineDownloadTask(int  $taskId, int  $expires = '') : string

取消离线下载任务

Parameters

int	$taskId	要取消的任务Id
int	$expires	请求失效时间

Returns

string —

_baseControl()

_baseControl(string  $apiMethod, mixed  $params, string  $method = 'GET', string  $headers = array()) : string

调用API

Parameters

string	$apiMethod	api方法名
mixed	$params
string	$method	HTTP请求类型
string	$headers	附加的HTTP HEADER信息

Returns

string —