PHP Class Qiniu\Storage\BucketManager

See link: http://developer.qiniu.com/docs/v6/api/reference/rs/
Show file Open project: qiniu/php-sdk Class Usage Examples

Public Methods

Method Description
__construct ( Auth $auth, Zone $zone = null )
batch ( $operations ) : array 在单次请求中进行多个资源管理操作
buckets ( ) : string[] 获取指定账号下所有的空间名。
buildBatchCopy ( $source_bucket, $key_pairs, $target_bucket )
buildBatchDelete ( $bucket, $keys )
buildBatchMove ( $source_bucket, $key_pairs, $target_bucket )
buildBatchRename ( $bucket, $key_pairs )
buildBatchStat ( $bucket, $keys )
changeMime ( $bucket, $key, $mime ) : mixed 主动修改指定资源的文件类型
copy ( $from_bucket, $from_key, $to_bucket, $to_key, $force = false ) : mixed 给资源进行重命名，本质为move操作。
delete ( $bucket, $key ) : mixed 删除指定资源
fetch ( $url, $bucket, $key = null ) : array 从指定URL抓取资源，并将该资源存储到指定空间中
listFiles ( $bucket, $prefix = null, $marker = null, $limit = 1000, $delimiter = null ) : array 列取空间的文件列表
move ( $from_bucket, $from_key, $to_bucket, $to_key, $force = false ) : mixed 将资源从一个空间到另一个空间
prefetch ( $bucket, $key ) : mixed 从镜像源站抓取资源到空间中，如果空间中已经存在，则覆盖该资源
rename ( $bucket, $oldname, $newname ) : mixed 给资源进行重命名，本质为move操作。
stat ( $bucket, $key ) : array 获取资源的元信息，但不返回文件内容

Private Methods

Method Description
get ( $url )
ioPost ( $path, $body = null )
oneKeyBatch ( $operation, $bucket, $keys )
post ( $url, $body )
rsGet ( $path )
rsPost ( $path, $body = null )
twoKeyBatch ( $operation, $source_bucket, $key_pairs, $target_bucket )

Method Details

__construct() public method

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

batch() public method

在单次请求中进行多个资源管理操作
See link: http://developer.qiniu.com/docs/v6/api/reference/rs/batch.html
public batch ( $operations ) : array
$operations 资源管理操作数组
return array 每个资源的处理情况，结果类似： [ { "code" => , "data" => }, { "code" => }, { "code" => }, { "code" => }, { "code" => , "data" => { "error": "" } }, ... ]

buckets() public method

获取指定账号下所有的空间名。
public buckets ( ) : string[]
return string[] 包含所有空间名

buildBatchCopy() public static method

public static buildBatchCopy ( $source_bucket, $key_pairs, $target_bucket )

buildBatchDelete() public static method

public static buildBatchDelete ( $bucket, $keys )

buildBatchMove() public static method

public static buildBatchMove ( $source_bucket, $key_pairs, $target_bucket )

buildBatchRename() public static method

public static buildBatchRename ( $bucket, $key_pairs )

buildBatchStat() public static method

public static buildBatchStat ( $bucket, $keys )

changeMime() public method

主动修改指定资源的文件类型
See link: http://developer.qiniu.com/docs/v6/api/reference/rs/chgm.html
public changeMime ( $bucket, $key, $mime ) : mixed
$bucket 待操作资源所在空间
$key 待操作资源文件名
$mime 待操作文件目标mimeType
return mixed 成功返回NULL，失败返回对象Qiniu\Http\Error

copy() public method

给资源进行重命名，本质为move操作。
See link: http://developer.qiniu.com/docs/v6/api/reference/rs/copy.html
public copy ( $from_bucket, $from_key, $to_bucket, $to_key, $force = false ) : mixed
$from_bucket 待操作资源所在空间
$from_key 待操作资源文件名
$to_bucket 目标资源空间名
$to_key 目标资源文件名
return mixed 成功返回NULL，失败返回对象Qiniu\Http\Error

delete() public method

删除指定资源
See link: http://developer.qiniu.com/docs/v6/api/reference/rs/delete.html
public delete ( $bucket, $key ) : mixed
$bucket 待删除资源所在的空间
$key 待删除资源的文件名
return mixed 成功返回NULL，失败返回对象Qiniu\Http\Error

fetch() public method

从指定URL抓取资源，并将该资源存储到指定空间中
See link: http://developer.qiniu.com/docs/v6/api/reference/rs/fetch.html
public fetch ( $url, $bucket, $key = null ) : array
$url 指定的URL
$bucket 目标资源空间
$key 目标资源文件名
return array 包含已拉取的文件信息。 成功时： [ [ "hash" => "", "key" => "" ], null ] 失败时： [ null, Qiniu/Http/Error ]

listFiles() public method

列取空间的文件列表
See link: http://developer.qiniu.com/docs/v6/api/reference/rs/list.html
public listFiles ( $bucket, $prefix = null, $marker = null, $limit = 1000, $delimiter = null ) : array
$bucket 空间名
$prefix 列举前缀
$marker 列举标识符
$limit 单次列举个数限制
$delimiter 指定目录分隔符
return array 包含文件信息的数组，类似：[ { "hash" => "", "key" => "", "fsize" => "", "putTime" => "" }, ... ]

move() public method

将资源从一个空间到另一个空间
See link: http://developer.qiniu.com/docs/v6/api/reference/rs/move.html
public move ( $from_bucket, $from_key, $to_bucket, $to_key, $force = false ) : mixed
$from_bucket 待操作资源所在空间
$from_key 待操作资源文件名
$to_bucket 目标资源空间名
$to_key 目标资源文件名
return mixed 成功返回NULL，失败返回对象Qiniu\Http\Error

prefetch() public method

从镜像源站抓取资源到空间中，如果空间中已经存在，则覆盖该资源
See link: http://developer.qiniu.com/docs/v6/api/reference/rs/prefetch.html
public prefetch ( $bucket, $key ) : mixed
$bucket 待获取资源所在的空间
$key 代获取资源文件名
return mixed 成功返回NULL，失败返回对象Qiniu\Http\Error

rename() public method

给资源进行重命名，本质为move操作。
public rename ( $bucket, $oldname, $newname ) : mixed
$bucket 待操作资源所在空间
$oldname 待操作资源文件名
$newname 目标资源文件名
return mixed 成功返回NULL，失败返回对象Qiniu\Http\Error

stat() public method

获取资源的元信息，但不返回文件内容
See link: http://developer.qiniu.com/docs/v6/api/reference/rs/stat.html
public stat ( $bucket, $key ) : array
$bucket 待获取信息资源所在的空间
$key 待获取资源的文件名
return array 包含文件信息的数组，类似： [ "hash" => "", "key" => "", "fsize" => "", "putTime" => "" ]