\Qiniu\StorageBucketManager

主要涉及了空间资源管理及批量操作接口的实现,具体的接口规格可以参考

Summary

Methods
Properties
Constants
__construct()
buckets()
listFiles()
stat()
delete()
rename()
copy()
move()
changeMime()
fetch()
prefetch()
batch()
buildBatchCopy()
buildBatchRename()
buildBatchMove()
buildBatchDelete()
buildBatchStat()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
rsPost()
rsGet()
ioPost()
get()
post()
oneKeyBatch()
twoKeyBatch()
$auth
$zone
N/A

Properties

$auth

$auth : 

Type

$zone

$zone : 

Type

Methods

__construct()

__construct(\Qiniu\Auth  $auth, \Qiniu\Zone  $zone = null) 

Parameters

\Qiniu\Auth $auth
\Qiniu\Zone $zone

buckets()

buckets() : array<mixed,string>

获取指定账号下所有的空间名。

Returns

array<mixed,string> —

包含所有空间名

listFiles()

listFiles(  $bucket,   $prefix = null,   $marker = null,   $limit = 1000,   $delimiter = null) : array

列取空间的文件列表

Parameters

$bucket

空间名

$prefix

列举前缀

$marker

列举标识符

$limit

单次列举个数限制

$delimiter

指定目录分隔符

Returns

array —

包含文件信息的数组,类似:[ { "hash" => "", "key" => "", "fsize" => "", "putTime" => "" }, ... ]

stat()

stat(  $bucket,   $key) : array

获取资源的元信息,但不返回文件内容

Parameters

$bucket

待获取信息资源所在的空间

$key

待获取资源的文件名

Returns

array —

包含文件信息的数组,类似: [ "hash" => "", "key" => "", "fsize" => "", "putTime" => "" ]

delete()

delete(  $bucket,   $key) : mixed

删除指定资源

Parameters

$bucket

待删除资源所在的空间

$key

待删除资源的文件名

Returns

mixed —

成功返回NULL,失败返回对象Qiniu\Http\Error

rename()

rename(  $bucket,   $oldname,   $newname) : mixed

给资源进行重命名,本质为move操作。

Parameters

$bucket

待操作资源所在空间

$oldname

待操作资源文件名

$newname

目标资源文件名

Returns

mixed —

成功返回NULL,失败返回对象Qiniu\Http\Error

copy()

copy(  $from_bucket,   $from_key,   $to_bucket,   $to_key) : mixed

给资源进行重命名,本质为move操作。

Parameters

$from_bucket

待操作资源所在空间

$from_key

待操作资源文件名

$to_bucket

目标资源空间名

$to_key

目标资源文件名

Returns

mixed —

成功返回NULL,失败返回对象Qiniu\Http\Error

move()

move(  $from_bucket,   $from_key,   $to_bucket,   $to_key) : mixed

将资源从一个空间到另一个空间

Parameters

$from_bucket

待操作资源所在空间

$from_key

待操作资源文件名

$to_bucket

目标资源空间名

$to_key

目标资源文件名

Returns

mixed —

成功返回NULL,失败返回对象Qiniu\Http\Error

changeMime()

changeMime(  $bucket,   $key,   $mime) : mixed

主动修改指定资源的文件类型

Parameters

$bucket

待操作资源所在空间

$key

待操作资源文件名

$mime

待操作文件目标mimeType

Returns

mixed —

成功返回NULL,失败返回对象Qiniu\Http\Error

fetch()

fetch(  $url,   $bucket,   $key = null) : array

从指定URL抓取资源,并将该资源存储到指定空间中

Parameters

$url

指定的URL

$bucket

目标资源空间

$key

目标资源文件名

Returns

array —

包含已拉取的文件信息。 成功时: [ [ "hash" => "", "key" => "" ], null ]

                    失败时:  [
                                     null,
                                    Qiniu/Http/Error
                             ]

prefetch()

prefetch(  $bucket,   $key) : mixed

从镜像源站抓取资源到空间中,如果空间中已经存在,则覆盖该资源

Parameters

$bucket

待获取资源所在的空间

$key

代获取资源文件名

Returns

mixed —

成功返回NULL,失败返回对象Qiniu\Http\Error

batch()

batch(  $operations) : array

在单次请求中进行多个资源管理操作

Parameters

$operations

资源管理操作数组

Returns

array —

每个资源的处理情况,结果类似: [ { "code" => , "data" => }, { "code" => }, { "code" => }, { "code" => }, { "code" => , "data" => { "error": "" } }, ... ]

buildBatchCopy()

buildBatchCopy(  $source_bucket,   $key_pairs,   $target_bucket) 

Parameters

$source_bucket
$key_pairs
$target_bucket

buildBatchRename()

buildBatchRename(  $bucket,   $key_pairs) 

Parameters

$bucket
$key_pairs

buildBatchMove()

buildBatchMove(  $source_bucket,   $key_pairs,   $target_bucket) 

Parameters

$source_bucket
$key_pairs
$target_bucket

buildBatchDelete()

buildBatchDelete(  $bucket,   $keys) 

Parameters

$bucket
$keys

buildBatchStat()

buildBatchStat(  $bucket,   $keys) 

Parameters

$bucket
$keys

rsPost()

rsPost(  $path,   $body = null) 

Parameters

$path
$body

rsGet()

rsGet(  $path) 

Parameters

$path

ioPost()

ioPost(  $path,   $body = null) 

Parameters

$path
$body

get()

get(  $url) 

Parameters

$url

post()

post(  $url,   $body) 

Parameters

$url
$body

oneKeyBatch()

oneKeyBatch(  $operation,   $bucket,   $keys) 

Parameters

$operation
$bucket
$keys

twoKeyBatch()

twoKeyBatch(  $operation,   $source_bucket,   $key_pairs,   $target_bucket) 

Parameters

$operation
$source_bucket
$key_pairs
$target_bucket