\OSSOssClient

__construct()

__construct(string  $accessKeyId, string  $accessKeySecret, string  $endpoint, boolean  $isCName = false, string  $securityToken = NULL) 

构造函数

构造函数有几种情况：

1. 一般的时候初始化使用 $ossClient = new OssClient($id, $key, $endpoint)
2. 如果使用CNAME的，比如使用的是www.testoss.com，在控制台上做了CNAME的绑定， 初始化使用 $ossClient = new OssClient($id, $key, $endpoint, true)
3. 如果使用了阿里云SecurityTokenService(STS)，获得了AccessKeyID, AccessKeySecret, Token 初始化使用 $ossClient = new OssClient($id, $key, $endpoint, false, $token)
4. 如果用户使用的endpoint是ip 初始化使用 $ossClient = new OssClient($id, $key, “1.2.3.4:8900”)

Parameters

Throws

\OSS\Core\OssException

listBuckets()

listBuckets(array  $options = NULL) : \OSS\Model\BucketListInfo

列举用户所有的Bucket[GetService], Endpoint类型为cname不能进行此操作

Parameters

Throws

\OSS\Core\OssException

Returns

createBucket()

createBucket(string  $bucket, string  $acl = self::OSS_ACL_TYPE_PRIVATE, array  $options = NULL) : null

创建bucket，默认创建的bucket的ACL是OssClient::OSS_ACL_TYPE_PRIVATE

Parameters

Returns

deleteBucket()

deleteBucket(string  $bucket, array  $options = NULL) : null

删除bucket 如果Bucket不为空（Bucket中有Object，或者有分块上传的碎片），则Bucket无法删除， 必须删除Bucket中的所有Object以及碎片后，Bucket才能成功删除。

Parameters

Returns

doesBucketExist()

doesBucketExist(string  $bucket) : boolean

判断bucket是否存在

Parameters

Throws

\OSS\Core\OssException

Returns

getBucketAcl()

getBucketAcl(string  $bucket, array  $options = NULL) : string

获取bucket的ACL配置情况

Parameters

Throws

\OSS\Core\OssException

Returns

putBucketAcl()

putBucketAcl(string  $bucket, string  $acl, array  $options = NULL) : null

设置bucket的ACL配置情况

Parameters

Throws

\OSS\Core\OssException

Returns

getObjectAcl()

getObjectAcl(string  $bucket, string  $object) : string

获取object的ACL属性

Parameters

Throws

\OSS\Core\OssException

Returns

putObjectAcl()

putObjectAcl(string  $bucket, string  $object, string  $acl) : null

设置object的ACL属性

Parameters

Throws

\OSS\Core\OssException

Returns

getBucketLogging()

getBucketLogging(string  $bucket, array  $options = NULL) : \OSS\Model\LoggingConfig

获取Bucket的访问日志配置情况

Parameters

Throws

\OSS\Core\OssException

Returns

putBucketLogging()

putBucketLogging(string  $bucket, string  $targetBucket, string  $targetPrefix, array  $options = NULL) : null

开启Bucket访问日志记录功能，只有Bucket的所有者才能更改

Parameters

Throws

\OSS\Core\OssException

Returns

deleteBucketLogging()

deleteBucketLogging(string  $bucket, array  $options = NULL) : null

关闭bucket访问日志记录功能

Parameters

Throws

\OSS\Core\OssException

Returns

putBucketWebsite()

putBucketWebsite(string  $bucket, \OSS\Model\WebsiteConfig  $websiteConfig, array  $options = NULL) : null

将bucket设置成静态网站托管模式

Parameters

Throws

\OSS\Core\OssException

Returns

getBucketWebsite()

getBucketWebsite(string  $bucket, array  $options = NULL) : \OSS\Model\WebsiteConfig

获取bucket的静态网站托管状态

Parameters

Throws

\OSS\Core\OssException

Returns

deleteBucketWebsite()

deleteBucketWebsite(string  $bucket, array  $options = NULL) : null

关闭bucket的静态网站托管模式

Parameters

Throws

\OSS\Core\OssException

Returns

putBucketCors()

putBucketCors(string  $bucket, \OSS\Model\CorsConfig  $corsConfig, array  $options = NULL) : null

在指定的bucket上设定一个跨域资源共享(CORS)的规则，如果原规则存在则覆盖原规则

Parameters

Throws

\OSS\Core\OssException

Returns

getBucketCors()

getBucketCors(string  $bucket, array  $options = NULL) : \OSS\Model\CorsConfig

获取Bucket的CORS配置情况

Parameters

Throws

\OSS\Core\OssException

Returns

deleteBucketCors()

deleteBucketCors(string  $bucket, array  $options = NULL) : null

关闭指定Bucket对应的CORS功能并清空所有规则

Parameters

Throws

\OSS\Core\OssException

Returns

addBucketCname()

addBucketCname(string  $bucket, string  $cname, array  $options = NULL) : null

为指定Bucket增加CNAME绑定

Parameters

Throws

\OSS\Core\OssException

Returns

getBucketCname()

getBucketCname(string  $bucket, array  $options = NULL) : \OSS\Model\CnameConfig

获取指定Bucket已绑定的CNAME列表

Parameters

Throws

\OSS\Core\OssException

Returns

deleteBucketCname()

deleteBucketCname(string  $bucket,   $cname, array  $options = NULL) : null

解除指定Bucket的CNAME绑定

Parameters

Throws

\OSS\Core\OssException

Returns

putBucketLiveChannel()

putBucketLiveChannel(string  $bucket,   $channelName, \OSS\Model\LiveChannelConfig  $channelConfig, array  $options = NULL) : \OSS\Model\LiveChannelInfo

为指定Bucket创建LiveChannel

Parameters

Throws

\OSS\Core\OssException

Returns

putLiveChannelStatus()

putLiveChannelStatus(string  $bucket,   $channelName,   $channelStatus, array  $options = NULL) : null

设置LiveChannel的status

Parameters

Throws

\OSS\Core\OssException

Returns

getLiveChannelInfo()

getLiveChannelInfo(string  $bucket,   $channelName, array  $options = NULL) : \OSS\GetLiveChannelInfo

获取LiveChannel信息

Parameters

Throws

\OSS\Core\OssException

Returns

getLiveChannelStatus()

getLiveChannelStatus(string  $bucket,   $channelName, array  $options = NULL) : \OSS\GetLiveChannelStatus

获取LiveChannel状态信息

Parameters

Throws

\OSS\Core\OssException

Returns

getLiveChannelHistory()

getLiveChannelHistory(string  $bucket,   $channelName, array  $options = NULL) : \OSS\GetLiveChannelHistory

获取LiveChannel推流记录

Parameters

Throws

\OSS\Core\OssException

Returns

listBucketLiveChannels()

listBucketLiveChannels(string  $bucket, array  $options = NULL) : \OSS\Model\LiveChannelListInfo

获取指定Bucket下的live channel列表

Parameters

Throws

\OSS\Core\OssException

Returns

postVodPlaylist()

postVodPlaylist(string  $bucket,   $channelName, string  $playlistName, array  $setTime) : null

为指定LiveChannel生成播放列表

Parameters

Throws

\OSS\Core\OssException

Returns

deleteBucketLiveChannel()

deleteBucketLiveChannel(string  $bucket,   $channelName, array  $options = NULL) : null

删除指定Bucket的LiveChannel

Parameters

Throws

\OSS\Core\OssException

Returns

signRtmpUrl()

signRtmpUrl(string  $bucket,   $channelName,   $timeout = 60, array  $options = NULL) : \OSS\推流地址

生成带签名的推流地址

Parameters

Throws

\OSS\Core\OssException

Returns

optionsObject()

optionsObject(string  $bucket, string  $object, string  $origin, string  $request_method, string  $request_headers, array  $options = NULL) : array

检验跨域资源请求, 发送跨域请求之前会发送一个preflight请求（OPTIONS）并带上特定的来源域， HTTP方法和header信息等给OSS以决定是否发送真正的请求。 OSS可以通过putBucketCors接口 来开启Bucket的CORS支持，开启CORS功能之后，OSS在收到浏览器preflight请求时会根据设定的 规则评估是否允许本次请求

Parameters

Throws

\OSS\Core\OssException

Returns

putBucketLifecycle()

putBucketLifecycle(string  $bucket, \OSS\Model\LifecycleConfig  $lifecycleConfig, array  $options = NULL) : null

设置Bucket的Lifecycle配置

Parameters

Throws

\OSS\Core\OssException

Returns

getBucketLifecycle()

getBucketLifecycle(string  $bucket, array  $options = NULL) : \OSS\Model\LifecycleConfig

获取Bucket的Lifecycle配置情况

Parameters

Throws

\OSS\Core\OssException

Returns

deleteBucketLifecycle()

deleteBucketLifecycle(string  $bucket, array  $options = NULL) : null

删除指定Bucket的生命周期配置

Parameters

Throws

\OSS\Core\OssException

Returns

putBucketReferer()

putBucketReferer(string  $bucket, \OSS\Model\RefererConfig  $refererConfig, array  $options = NULL) : \OSS\Http\ResponseCore

设置一个bucket的referer访问白名单和是否允许referer字段为空的请求访问 Bucket Referer防盗链具体见OSS防盗链

Parameters

Throws

null

Returns

getBucketReferer()

getBucketReferer(string  $bucket, array  $options = NULL) : \OSS\Model\RefererConfig

获取Bucket的Referer配置情况 Bucket Referer防盗链具体见OSS防盗链

Parameters

Throws

\OSS\Core\OssException

Returns

listObjects()

listObjects(string  $bucket, array  $options = NULL) : \OSS\Model\ObjectListInfo

获取bucket下的object列表

Parameters

Throws

\OSS\Core\OssException

Returns

createObjectDir()

createObjectDir(string  $bucket, string  $object, array  $options = NULL) : null

创建虚拟目录 (本函数会在object名称后增加'/', 所以创建目录的object名称不需要'/'结尾，否则，目录名称会变成'//')

暂不开放此接口

Parameters

Returns

putObject()

putObject(string  $bucket, string  $object, string  $content, array  $options = NULL) : null

上传内存中的内容

Parameters

Returns

uploadFile()

uploadFile(string  $bucket, string  $object, string  $file, array  $options = NULL) : null

上传本地文件

Parameters

Throws

\OSS\Core\OssException

Returns

appendObject()

appendObject(string  $bucket, string  $object, string  $content,   $position, array  $options = NULL) : integer

追加上传内存中的内容

Parameters

Throws

\OSS\Core\OssException

Returns

next append position

appendFile()

appendFile(string  $bucket, string  $object, string  $file,   $position, array  $options = NULL) : integer

追加上传本地文件

Parameters

Throws

\OSS\Core\OssException

Returns

next append position

copyObject()

copyObject(string  $fromBucket, string  $fromObject, string  $toBucket, string  $toObject, array  $options = NULL) : null

拷贝一个在OSS上已经存在的object成另外一个object

Parameters

Throws

\OSS\Core\OssException

Returns

getObjectMeta()

getObjectMeta(string  $bucket, string  $object, string  $options = NULL) : array

获取Object的Meta信息

Parameters

Returns

deleteObject()

deleteObject(string  $bucket, string  $object, array  $options = NULL) : null

删除某个Object

Parameters

Returns

deleteObjects()

deleteObjects(string  $bucket, array  $objects, array  $options = null) : \OSS\Http\ResponseCore

删除同一个Bucket中的多个Object

Parameters

Throws

null

Returns

getObject()

getObject(string  $bucket, string  $object, array  $options = NULL) : string

获得Object内容

Parameters

Returns

doesObjectExist()

doesObjectExist(string  $bucket, string  $object, array  $options = NULL) : boolean

检测Object是否存在 通过获取Object的Meta信息来判断Object是否存在， 用户需要自行解析ResponseCore判断object是否存在

Parameters

Returns

generateMultiuploadParts()

generateMultiuploadParts(integer  $file_size, integer  $partSize = 5242880) : array

计算文件可以分成多少个part，以及每个part的长度以及起始位置 方法必须在 <upload_part()>中调用

Parameters

Returns

An array 包含 key-value 键值对. Key 为 seekTo 和 length.

initiateMultipartUpload()

initiateMultipartUpload(string  $bucket, string  $object, array  $options = NULL) : string

初始化multi-part upload

Parameters

Throws

\OSS\Core\OssException

Returns

返回uploadid

uploadPart()

uploadPart(string  $bucket, string  $object, string  $uploadId, array  $options = null) : string

分片上传的块上传接口

Parameters

Throws

\OSS\Core\OssException

Returns

eTag

listParts()

listParts(string  $bucket, string  $object, string  $uploadId, array  $options = null) : \OSS\Model\ListPartsInfo

获取已成功上传的part

Parameters

Throws

\OSS\Core\OssException

Returns

abortMultipartUpload()

abortMultipartUpload(string  $bucket, string  $object, string  $uploadId, array  $options = NULL) : null

中止进行一半的分片上传操作

Parameters

Throws

\OSS\Core\OssException

Returns

completeMultipartUpload()

completeMultipartUpload(string  $bucket, string  $object, string  $uploadId, array  $listParts, array  $options = NULL) : null

在将所有数据Part都上传完成后，调用此接口完成本次分块上传

Parameters

Throws

\OSS\Core\OssException

Returns

listMultipartUploads()

listMultipartUploads(string  $bucket, array  $options = null) : \OSS\Model\ListMultipartUploadInfo

罗列出所有执行中的Multipart Upload事件，即已经被初始化的Multipart Upload但是未被 Complete或者Abort的Multipart Upload事件

Parameters

Throws

\OSS\Core\OssException

Returns

uploadPartCopy()

uploadPartCopy(string  $fromBucket, string  $fromObject, string  $toBucket, string  $toObject, integer  $partNumber, string  $uploadId, array  $options = NULL) : null

从一个已存在的Object中拷贝数据来上传一个Part

Parameters

Throws

\OSS\Core\OssException

Returns

multiuploadFile()

multiuploadFile(string  $bucket, string  $object, string  $file, array  $options = null) : null

multipart上传统一封装，从初始化到完成multipart，以及出错后中止动作

Parameters

Throws

\OSS\Core\OssException

Returns

uploadDir()

uploadDir(string  $bucket, string  $prefix, string  $localDirectory, string  $exclude = '.|..|.svn|.git', boolean  $recursive = false, boolean  $checkMd5 = true) : array

上传本地目录内的文件或者目录到指定bucket的指定prefix的object中

Parameters

Throws

\OSS\Core\OssException

Returns

返回两个列表 array("succeededList" => array("object"), "failedList" => array("object"=>"errorMessage"))

signUrl()

signUrl(string  $bucket, string  $object, integer  $timeout = 60, string  $method = self::OSS_HTTP_GET, array  $options = NULL) : string

支持生成get和put签名, 用户可以生成一个具有一定有效期的 签名过的url

Parameters

Throws

\OSS\Core\OssException

Returns

setMaxTries()

setMaxTries(integer  $maxRetries = 3) : void

设置最大尝试次数

Parameters

getMaxRetries()

getMaxRetries() : integer

获取最大尝试次数

Returns

setSignStsInUrl()

setSignStsInUrl(boolean  $enable) 

打开sts enable标志，使用户构造函数中传入的$sts生效

Parameters

isUseSSL()

isUseSSL() : boolean

Returns

setUseSSL()

setUseSSL(boolean  $useSSL) 

Parameters

checkEnv()

checkEnv() 

用来检查sdk所以来的扩展是否打开

Throws

\OSS\Core\OssException

setTimeout()

setTimeout(integer  $timeout) 

//* 设置http库的请求超时时间，单位秒

Parameters

setConnectTimeout()

setConnectTimeout(integer  $connectTimeout) 

设置http库的连接超时时间，单位秒

Parameters

computePartSize()

computePartSize(integer  $partSize) : integer

获取分片大小，根据用户提供的part_size，重新计算一个更合理的partsize

Parameters

Returns

precheckOptions()

precheckOptions(array  $options) 

检测options参数

Parameters

Throws

\OSS\Core\OssException

precheckBucket()

precheckBucket(string  $bucket, string  $errMsg = 'bucket is not allowed empty') 

校验bucket参数

Parameters

Throws

\OSS\Core\OssException

precheckObject()

precheckObject(string  $object) 

校验object参数

Parameters

Throws

\OSS\Core\OssException

precheckCommon()

precheckCommon(string  $bucket, string  $object, array  $options, boolean  $isCheckObject = true) 

校验bucket,options参数

Parameters

precheckParam()

precheckParam(array  $options, string  $param, string  $funcName) 

参数校验

Parameters

Throws

\OSS\Core\OssException

isCheckMD5()

isCheckMD5(array  $options) : boolean|null

检测md5

Parameters

Returns

getValue()

getValue(array  $options, string  $key, string  $default = NULL, boolean  $isCheckEmpty = false, boolean  $isCheckBool = false) : boolean|null

获取value

Parameters

Returns

getMimeType()

getMimeType(string  $object,   $file = null) : string

获取mimetype类型

Parameters

Returns

auth()

auth(array  $options) : \OSS\Http\ResponseCore

验证并且执行请求，按照OSS Api协议，执行操作

Parameters

Throws

\OSS\Core\OssException

\OSS\Http\RequestCore_Exception

Returns

authPrecheckBucket()

authPrecheckBucket(  $options) 

检查bucket名称格式是否正确，如果非法抛出异常

Parameters

Throws

\OSS\Core\OssException

authPrecheckObject()

authPrecheckObject(  $options) 

检查object名称格式是否正确，如果非法抛出异常

Parameters

Throws

\OSS\Core\OssException

authPrecheckObjectEncoding()

authPrecheckObjectEncoding(mixed  $options) 

检查object的编码，如果是gbk或者gb2312则尝试将其转化为utf8编码

Parameters

authPrecheckAcl()

authPrecheckAcl(  $options) 

检查ACL是否是预定义中三种之一，如果不是抛出异常

Parameters

Throws

\OSS\Core\OssException

generateHostname()

generateHostname(  $bucket) : string

获得档次请求使用的域名 bucket在前的三级域名，或者二级域名，如果是cname或者ip的话，则是二级域名

Parameters

Returns

剥掉协议头的域名

generateResourceUri()

generateResourceUri(  $options) : string

获得当次请求的资源定位字段

Parameters

Returns

资源定位字段

generateSignableQueryStringParam()

generateSignableQueryStringParam(array  $options) : array

生成signalbe_query_string_param, array类型

Parameters

Returns

generateSignableResource()

generateSignableResource(mixed  $options) : string

生成用于签名resource段

Parameters

Returns

generateQueryString()

generateQueryString(mixed  $options) : string

生成query_string

Parameters

Returns

stringToSignSorted()

stringToSignSorted(  $string_to_sign) 

Parameters

generateHeaders()

generateHeaders(mixed  $options, string  $hostname) : array

初始化headers

Parameters

Returns

generateUserAgent()

generateUserAgent() : string

生成请求用的UserAgent

Returns

checkEndpoint()

checkEndpoint(string  $endpoint, boolean  $isCName) : string

检查endpoint的种类 如有有协议头，剥去协议头 并且根据参数 is_cname 和endpoint本身，判定域名类型，是ip，cname，还是专有域或者官网域名

Parameters

Returns

剥掉协议头的域名