PHP Class OSS\OssClient

Object Storage Service(OSS) 的客户端类，封装了用户通过OSS API对OSS服务的各种操作， 用户通过OssClient实例可以进行Bucket，Object，MultipartUpload, ACL等操作，具体 的接口规则可以参考官方OSS API文档
Mostrar archivo Open project: HFO4/shudong-share Class Usage Examples

Public Properties

Property Type Description
$OSS_ACL_TYPES OSS ACL数组

Public Methods

Method Description
__construct ( string $accessKeyId, string $accessKeySecret, string $endpoint, boolean $isCName = false, string $securityToken = NULL ) 构造函数
abortMultipartUpload ( string $bucket, string $object, string $uploadId, array $options = NULL ) : null 中止进行一半的分片上传操作
addBucketCname ( string $bucket, string $cname, array $options = NULL ) : null 为指定Bucket增加CNAME绑定
checkEnv ( ) 用来检查sdk所以来的扩展是否打开
completeMultipartUpload ( string $bucket, string $object, string $uploadId, array $listParts, array $options = NULL ) : null 在将所有数据Part都上传完成后，调用此接口完成本次分块上传
copyObject ( string $fromBucket, string $fromObject, string $toBucket, string $toObject, array $options = NULL ) : null 拷贝一个在OSS上已经存在的object成另外一个object
createBucket ( string $bucket, string $acl = self::OSS_ACL_TYPE_PRIVATE, array $options = NULL ) : null 创建bucket，默认创建的bucket的ACL是OssClient::OSS_ACL_TYPE_PRIVATE
createObjectDir ( string $bucket, string $object, array $options = NULL ) : null 创建虚拟目录 (本函数会在object名称后增加'/', 所以创建目录的object名称不需要'/'结尾，否则，目录名称会变成'//')
deleteBucket ( string $bucket, array $options = NULL ) : null 删除bucket 如果Bucket不为空（Bucket中有Object，或者有分块上传的碎片），则Bucket无法删除， 必须删除Bucket中的所有Object以及碎片后，Bucket才能成功删除。
deleteBucketCname ( string $bucket, $cname, array $options = NULL ) : null 解除指定Bucket的CNAME绑定
deleteBucketCors ( string $bucket, array $options = NULL ) : null 关闭指定Bucket对应的CORS功能并清空所有规则
deleteBucketLifecycle ( string $bucket, array $options = NULL ) : null 删除指定Bucket的生命周期配置
deleteBucketLogging ( string $bucket, array $options = NULL ) : null 关闭bucket访问日志记录功能
deleteBucketWebsite ( string $bucket, array $options = NULL ) : null 关闭bucket的静态网站托管模式
deleteObject ( string $bucket, string $object, array $options = NULL ) : null 删除某个Object
deleteObjects ( string $bucket, array $objects, array $options = null ) : OSS\Http\ResponseCore 删除同一个Bucket中的多个Object
doesBucketExist ( string $bucket ) : boolean 判断bucket是否存在
doesObjectExist ( string $bucket, string $object, array $options = NULL ) : boolean 检测Object是否存在 通过获取Object的Meta信息来判断Object是否存在， 用户需要自行解析ResponseCore判断object是否存在
generateMultiuploadParts ( integer $file_size, integer $partSize = 5242880 ) : array 计算文件可以分成多少个part，以及每个part的长度以及起始位置 方法必须在 中调用
getBucketAcl ( string $bucket, array $options = NULL ) : string 获取bucket的ACL配置情况
getBucketCname ( string $bucket, array $options = NULL ) : OSS\Model\CnameConfig 获取指定Bucket已绑定的CNAME列表
getBucketCors ( string $bucket, array $options = NULL ) : OSS\Model\CorsConfig 获取Bucket的CORS配置情况
getBucketLifecycle ( string $bucket, array $options = NULL ) : OSS\Model\LifecycleConfig 获取Bucket的Lifecycle配置情况
getBucketLogging ( string $bucket, array $options = NULL ) : OSS\Model\LoggingConfig 获取Bucket的访问日志配置情况
getBucketReferer ( string $bucket, array $options = NULL ) : OSS\Model\RefererConfig 获取Bucket的Referer配置情况 Bucket Referer防盗链具体见OSS防盗链
getBucketWebsite ( string $bucket, array $options = NULL ) : OSS\Model\WebsiteConfig 获取bucket的静态网站托管状态
getMaxRetries ( ) : integer 获取最大尝试次数
getObject ( string $bucket, string $object, array $options = NULL ) : string 获得Object内容
getObjectAcl ( string $bucket, string $object ) : string 获取object的ACL属性
getObjectMeta ( string $bucket, string $object, string $options = NULL ) : array 获取Object的Meta信息
initiateMultipartUpload ( string $bucket, string $object, array $options = NULL ) : string 初始化multi-part upload
isUseSSL ( ) : boolean
listBuckets ( array $options = NULL ) : OSS\Model\BucketListInfo 列举用户所有的Bucket[GetService], Endpoint类型为cname不能进行此操作
listMultipartUploads ( string $bucket, array $options = null ) : OSS\Model\ListMultipartUploadInfo 罗列出所有执行中的Multipart Upload事件，即已经被初始化的Multipart Upload但是未被 Complete或者Abort的Multipart Upload事件
listObjects ( string $bucket, array $options = NULL ) : OSS\Model\ObjectListInfo 获取bucket下的object列表
listParts ( string $bucket, string $object, string $uploadId, array $options = null ) : OSS\Model\ListPartsInfo 获取已成功上传的part
multiuploadFile ( string $bucket, string $object, string $file, array $options = null ) : null multipart上传统一封装，从初始化到完成multipart，以及出错后中止动作
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请求时会根据设定的 规则评估是否允许本次请求
putBucketAcl ( string $bucket, string $acl, array $options = NULL ) : null 设置bucket的ACL配置情况
putBucketCors ( string $bucket, OSS\Model\CorsConfig $corsConfig, array $options = NULL ) : null 在指定的bucket上设定一个跨域资源共享(CORS)的规则，如果原规则存在则覆盖原规则
putBucketLifecycle ( string $bucket, OSS\Model\LifecycleConfig $lifecycleConfig, array $options = NULL ) : null 设置Bucket的Lifecycle配置
putBucketLogging ( string $bucket, string $targetBucket, string $targetPrefix, array $options = NULL ) : null 开启Bucket访问日志记录功能，只有Bucket的所有者才能更改
putBucketReferer ( string $bucket, OSS\Model\RefererConfig $refererConfig, array $options = NULL ) : OSS\Http\ResponseCore 设置一个bucket的referer访问白名单和是否允许referer字段为空的请求访问 Bucket Referer防盗链具体见OSS防盗链
putBucketWebsite ( string $bucket, OSS\Model\WebsiteConfig $websiteConfig, array $options = NULL ) : null 将bucket设置成静态网站托管模式
putObject ( string $bucket, string $object, string $content, array $options = NULL ) : null 上传内存中的内容
putObjectAcl ( string $bucket, string $object, string $acl ) : null 设置object的ACL属性
setConnectTimeout ( integer $connectTimeout ) 设置http库的连接超时时间，单位秒
setMaxTries ( integer $maxRetries = 3 ) : void 设置最大尝试次数
setSignStsInUrl ( boolean $enable ) 打开sts enable标志，使用户构造函数中传入的$sts生效
setTimeout ( integer $timeout ) 设置http库的请求超时时间，单位秒
setUseSSL ( boolean $useSSL )
signUrl ( string $bucket, string $object, integer $timeout = 60, string $method = self::OSS_HTTP_GET, array $options = NULL ) : string 支持生成get和put签名, 用户可以生成一个具有一定有效期的 签名过的url
uploadDir ( string $bucket, string $prefix, string $localDirectory, string $exclude = '.|..|.svn|.git', boolean $recursive = false, boolean $checkMd5 = true ) : array 上传本地目录内的文件或者目录到指定bucket的指定prefix的object中
uploadFile ( string $bucket, string $object, string $file, array $options = NULL ) : null 上传本地文件
uploadPart ( string $bucket, string $object, string $uploadId, array $options = null ) : string 分片上传的块上传接口
uploadPartCopy ( string $fromBucket, string $fromObject, string $toBucket, string $toObject, integer $partNumber, string $uploadId, array $options = NULL ) : null 从一个已存在的Object中拷贝数据来上传一个Part

Private Methods

Method Description
auth ( array $options ) : OSS\Http\ResponseCore 验证并且执行请求，按照OSS Api协议，执行操作
authPrecheckAcl ( $options ) 检查ACL是否是预定义中三种之一，如果不是抛出异常
authPrecheckBucket ( $options ) 检查bucket名称格式是否正确，如果非法抛出异常
authPrecheckObject ( $options ) 检查object名称格式是否正确，如果非法抛出异常
authPrecheckObjectEncoding ( mixed &$options ) 检查object的编码，如果是gbk或者gb2312则尝试将其转化为utf8编码
checkEndpoint ( string $endpoint, boolean $isCName ) : string 检查endpoint的种类 如有有协议头，剥去协议头 并且根据参数 is_cname 和endpoint本身，判定域名类型，是ip，cname，还是专有域或者官网域名
computePartSize ( integer $partSize ) : integer 获取分片大小，根据用户提供的part_size，重新计算一个更合理的partsize
generateHeaders ( mixed $options, string $hostname ) : array 初始化headers
generateHostname ( $options ) : string 获得档次请求使用的域名 bucket在前的三级域名，或者二级域名，如果是cname或者ip的话，则是二级域名
generateQueryString ( mixed $options ) : string 生成query_string
generateResourceUri ( $options ) : string 获得当次请求的资源定位字段
generateSignableQueryStringParam ( array $options ) : array 生成signalbe_query_string_param, array类型
generateSignableResource ( mixed $options ) : string 生成用于签名resource段
generateUserAgent ( ) : string 生成请求用的UserAgent
getMimeType ( string $object, $file = null ) : string 获取mimetype类型
getValue ( array $options, string $key, string $default = NULL, boolean $isCheckEmpty = false, boolean $isCheckBool = false ) : boolean | null 获取value
isCheckMD5 ( array $options ) : boolean | null 检测md5
precheckBucket ( string $bucket, string $errMsg = 'bucket is not allowed empty' ) 校验bucket参数
precheckCommon ( string $bucket, string $object, array &$options, boolean $isCheckObject = true ) 校验bucket,options参数
precheckObject ( string $object ) 校验object参数
precheckOptions ( array &$options ) 检测options参数
precheckParam ( array $options, string $param, string $funcName ) 参数校验

Method Details

__construct() public method

构造函数有几种情况： 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”)
public __construct ( string $accessKeyId, string $accessKeySecret, string $endpoint, boolean $isCName = false, string $securityToken = NULL )
$accessKeyId string 从OSS获得的AccessKeyId
$accessKeySecret string 从OSS获得的AccessKeySecret
$endpoint string 您选定的OSS数据中心访问域名，例如oss-cn-hangzhou.aliyuncs.com
$isCName boolean 是否对Bucket做了域名绑定，并且Endpoint参数填写的是自己的域名
$securityToken string

abortMultipartUpload() public method

中止进行一半的分片上传操作
public abortMultipartUpload ( string $bucket, string $object, string $uploadId, array $options = NULL ) : null
$bucket string Bucket名称
$object string Object名称
$uploadId string uploadId
$options array Key-Value数组
return null

addBucketCname() public method

为指定Bucket增加CNAME绑定
public addBucketCname ( string $bucket, string $cname, array $options = NULL ) : null
$bucket string bucket名称
$cname string
$options array
return null

checkEnv() public static method

用来检查sdk所以来的扩展是否打开
public static checkEnv ( )

completeMultipartUpload() public method

在将所有数据Part都上传完成后，调用此接口完成本次分块上传
public completeMultipartUpload ( string $bucket, string $object, string $uploadId, array $listParts, array $options = NULL ) : null
$bucket string Bucket名称
$object string Object名称
$uploadId string uploadId
$listParts array array( array("PartNumber"=> int, "ETag"=>string))
$options array Key-Value数组
return null

copyObject() public method

拷贝一个在OSS上已经存在的object成另外一个object
public copyObject ( string $fromBucket, string $fromObject, string $toBucket, string $toObject, array $options = NULL ) : null
$fromBucket string 源bucket名称
$fromObject string 源object名称
$toBucket string 目标bucket名称
$toObject string 目标object名称
$options array
return null

createBucket() public method

创建bucket，默认创建的bucket的ACL是OssClient::OSS_ACL_TYPE_PRIVATE
public createBucket ( string $bucket, string $acl = self::OSS_ACL_TYPE_PRIVATE, array $options = NULL ) : null
$bucket string
$acl string
$options array
return null

createObjectDir() public method

暂不开放此接口
public createObjectDir ( string $bucket, string $object, array $options = NULL ) : null
$bucket string bucket名称
$object string object名称
$options array
return null

deleteBucket() public method

删除bucket 如果Bucket不为空（Bucket中有Object，或者有分块上传的碎片），则Bucket无法删除， 必须删除Bucket中的所有Object以及碎片后，Bucket才能成功删除。
public deleteBucket ( string $bucket, array $options = NULL ) : null
$bucket string
$options array
return null

deleteBucketCname() public method

解除指定Bucket的CNAME绑定
public deleteBucketCname ( string $bucket, $cname, array $options = NULL ) : null
$bucket string bucket名称
$options array
return null

deleteBucketCors() public method

关闭指定Bucket对应的CORS功能并清空所有规则
public deleteBucketCors ( string $bucket, array $options = NULL ) : null
$bucket string bucket名称
$options array
return null

deleteBucketLifecycle() public method

删除指定Bucket的生命周期配置
public deleteBucketLifecycle ( string $bucket, array $options = NULL ) : null
$bucket string bucket名称
$options array
return null

deleteBucketLogging() public method

关闭bucket访问日志记录功能
public deleteBucketLogging ( string $bucket, array $options = NULL ) : null
$bucket string bucket名称
$options array 可以为空
return null

deleteBucketWebsite() public method

关闭bucket的静态网站托管模式
public deleteBucketWebsite ( string $bucket, array $options = NULL ) : null
$bucket string bucket名称
$options array
return null

deleteObject() public method

删除某个Object
public deleteObject ( string $bucket, string $object, array $options = NULL ) : null
$bucket string bucket名称
$object string object名称
$options array
return null

deleteObjects() public method

删除同一个Bucket中的多个Object
public deleteObjects ( string $bucket, array $objects, array $options = null ) : OSS\Http\ResponseCore
$bucket string bucket名称
$objects array object列表
$options array
return OSS\Http\ResponseCore

doesBucketExist() public method

判断bucket是否存在
public doesBucketExist ( string $bucket ) : boolean
$bucket string
return boolean

doesObjectExist() public method

检测Object是否存在 通过获取Object的Meta信息来判断Object是否存在， 用户需要自行解析ResponseCore判断object是否存在
public doesObjectExist ( string $bucket, string $object, array $options = NULL ) : boolean
$bucket string bucket名称
$object string object名称
$options array
return boolean

generateMultiuploadParts() public method

计算文件可以分成多少个part，以及每个part的长度以及起始位置 方法必须在 中调用
public generateMultiuploadParts ( integer $file_size, integer $partSize = 5242880 ) : array
$file_size integer 文件大小
$partSize integer part大小,默认5M
return array An array 包含 key-value 键值对. Key 为 `seekTo` 和 `length`.

getBucketAcl() public method

获取bucket的ACL配置情况
public getBucketAcl ( string $bucket, array $options = NULL ) : string
$bucket string
$options array
return string

getBucketCname() public method

获取指定Bucket已绑定的CNAME列表
public getBucketCname ( string $bucket, array $options = NULL ) : OSS\Model\CnameConfig
$bucket string bucket名称
$options array
return OSS\Model\CnameConfig

getBucketCors() public method

获取Bucket的CORS配置情况
public getBucketCors ( string $bucket, array $options = NULL ) : OSS\Model\CorsConfig
$bucket string bucket名称
$options array 可以为空
return OSS\Model\CorsConfig

getBucketLifecycle() public method

获取Bucket的Lifecycle配置情况
public getBucketLifecycle ( string $bucket, array $options = NULL ) : OSS\Model\LifecycleConfig
$bucket string bucket名称
$options array
return OSS\Model\LifecycleConfig

getBucketLogging() public method

获取Bucket的访问日志配置情况
public getBucketLogging ( string $bucket, array $options = NULL ) : OSS\Model\LoggingConfig
$bucket string bucket名称
$options array 可以为空
return OSS\Model\LoggingConfig

getBucketReferer() public method

获取Bucket的Referer配置情况 Bucket Referer防盗链具体见OSS防盗链
public getBucketReferer ( string $bucket, array $options = NULL ) : OSS\Model\RefererConfig
$bucket string bucket名称
$options array
return OSS\Model\RefererConfig

getBucketWebsite() public method

获取bucket的静态网站托管状态
public getBucketWebsite ( string $bucket, array $options = NULL ) : OSS\Model\WebsiteConfig
$bucket string bucket名称
$options array
return OSS\Model\WebsiteConfig

getMaxRetries() public method

获取最大尝试次数
public getMaxRetries ( ) : integer
return integer

getObject() public method

获得Object内容
public getObject ( string $bucket, string $object, array $options = NULL ) : string
$bucket string bucket名称
$object string object名称
$options array 该参数中必须设置ALIOSS::OSS_FILE_DOWNLOAD，ALIOSS::OSS_RANGE可选，可以根据实际情况设置；如果不设置，默认会下载全部内容
return string

getObjectAcl() public method

获取object的ACL属性
public getObjectAcl ( string $bucket, string $object ) : string
$bucket string
$object string
return string

getObjectMeta() public method

获取Object的Meta信息
public getObjectMeta ( string $bucket, string $object, string $options = NULL ) : array
$bucket string bucket名称
$object string object名称
$options string 具体参考SDK文档
return array

initiateMultipartUpload() public method

初始化multi-part upload
public initiateMultipartUpload ( string $bucket, string $object, array $options = NULL ) : string
$bucket string Bucket名称
$object string Object名称
$options array Key-Value数组
return string 返回uploadid

isUseSSL() public method

public isUseSSL ( ) : boolean
return boolean

listBuckets() public method

列举用户所有的Bucket[GetService], Endpoint类型为cname不能进行此操作
public listBuckets ( array $options = NULL ) : OSS\Model\BucketListInfo
$options array
return OSS\Model\BucketListInfo

listMultipartUploads() public method

罗列出所有执行中的Multipart Upload事件，即已经被初始化的Multipart Upload但是未被 Complete或者Abort的Multipart Upload事件
public listMultipartUploads ( string $bucket, array $options = null ) : OSS\Model\ListMultipartUploadInfo
$bucket string bucket
$options array 关联数组
return OSS\Model\ListMultipartUploadInfo

listObjects() public method

获取bucket下的object列表
public listObjects ( string $bucket, array $options = NULL ) : OSS\Model\ObjectListInfo
$bucket string
$options array 其中options中的参数如下 $options = array( 'max-keys' => max-keys用于限定此次返回object的最大数，如果不设定，默认为100，max-keys取值不能大于1000。 'prefix' => 限定返回的object key必须以prefix作为前缀。注意使用prefix查询时，返回的key中仍会包含prefix。 'delimiter' => 是一个用于对Object名字进行分组的字符。所有名字包含指定的前缀且第一次出现delimiter字符之间的object作为一组元素 'marker' => 用户设定结果从marker之后按字母排序的第一个开始返回。 ) 其中 prefix，marker用来实现分页显示效果，参数的长度必须小于256字节。
return OSS\Model\ObjectListInfo

listParts() public method

获取已成功上传的part
public listParts ( string $bucket, string $object, string $uploadId, array $options = null ) : OSS\Model\ListPartsInfo
$bucket string Bucket名称
$object string Object名称
$uploadId string uploadId
$options array Key-Value数组
return OSS\Model\ListPartsInfo

multiuploadFile() public method

multipart上传统一封装，从初始化到完成multipart，以及出错后中止动作
public multiuploadFile ( string $bucket, string $object, string $file, array $options = null ) : null
$bucket string bucket名称
$object string object名称
$file string 需要上传的本地文件的路径
$options array Key-Value数组
return null

optionsObject() public method

检验跨域资源请求, 发送跨域请求之前会发送一个preflight请求（OPTIONS）并带上特定的来源域， HTTP方法和header信息等给OSS以决定是否发送真正的请求。 OSS可以通过putBucketCors接口 来开启Bucket的CORS支持，开启CORS功能之后，OSS在收到浏览器preflight请求时会根据设定的 规则评估是否允许本次请求
See link: http://help.aliyun.com/document_detail/oss/api-reference/cors/OptionObject.html
public optionsObject ( string $bucket, string $object, string $origin, string $request_method, string $request_headers, array $options = NULL ) : array
$bucket string bucket名称
$object string object名称
$origin string 请求来源域
$request_method string 表明实际请求中会使用的HTTP方法
$request_headers string 表明实际请求中会使用的除了简单头部之外的headers
$options array
return array

putBucketAcl() public method

设置bucket的ACL配置情况
public putBucketAcl ( string $bucket, string $acl, array $options = NULL ) : null
$bucket string bucket名称
$acl string 读写权限，可选值 ['private', 'public-read', 'public-read-write']
$options array 可以为空
return null

putBucketCors() public method

在指定的bucket上设定一个跨域资源共享(CORS)的规则，如果原规则存在则覆盖原规则
public putBucketCors ( string $bucket, OSS\Model\CorsConfig $corsConfig, array $options = NULL ) : null
$bucket string bucket名称
$corsConfig OSS\Model\CorsConfig 跨域资源共享配置，具体规则参见SDK文档
$options array array
return null

putBucketLifecycle() public method

设置Bucket的Lifecycle配置
public putBucketLifecycle ( string $bucket, OSS\Model\LifecycleConfig $lifecycleConfig, array $options = NULL ) : null
$bucket string bucket名称
$lifecycleConfig OSS\Model\LifecycleConfig Lifecycle配置类
$options array
return null

putBucketLogging() public method

开启Bucket访问日志记录功能，只有Bucket的所有者才能更改
public putBucketLogging ( string $bucket, string $targetBucket, string $targetPrefix, array $options = NULL ) : null
$bucket string bucket名称
$targetBucket string 日志文件存放的bucket
$targetPrefix string 日志的文件前缀
$options array 可以为空
return null

putBucketReferer() public method

设置一个bucket的referer访问白名单和是否允许referer字段为空的请求访问 Bucket Referer防盗链具体见OSS防盗链
public putBucketReferer ( string $bucket, OSS\Model\RefererConfig $refererConfig, array $options = NULL ) : OSS\Http\ResponseCore
$bucket string bucket名称
$refererConfig OSS\Model\RefererConfig
$options array
return OSS\Http\ResponseCore

putBucketWebsite() public method

将bucket设置成静态网站托管模式
public putBucketWebsite ( string $bucket, OSS\Model\WebsiteConfig $websiteConfig, array $options = NULL ) : null
$bucket string bucket名称
$websiteConfig OSS\Model\WebsiteConfig
$options array 可以为空
return null

putObject() public method

上传内存中的内容
public putObject ( string $bucket, string $object, string $content, array $options = NULL ) : null
$bucket string bucket名称
$object string objcet名称
$content string 上传的内容
$options array
return null

putObjectAcl() public method

设置object的ACL属性
public putObjectAcl ( string $bucket, string $object, string $acl ) : null
$bucket string bucket名称
$object string object名称
$acl string 读写权限，可选值 ['default', 'private', 'public-read', 'public-read-write']
return null

setConnectTimeout() public method

设置http库的连接超时时间，单位秒
public setConnectTimeout ( integer $connectTimeout )
$connectTimeout integer

setMaxTries() public method

设置最大尝试次数
public setMaxTries ( integer $maxRetries = 3 ) : void
$maxRetries integer
return void

setSignStsInUrl() public method

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

setTimeout() public method

设置http库的请求超时时间，单位秒
public setTimeout ( integer $timeout )
$timeout integer

setUseSSL() public method

public setUseSSL ( boolean $useSSL )
$useSSL boolean

signUrl() public method

支持生成get和put签名, 用户可以生成一个具有一定有效期的 签名过的url
public signUrl ( string $bucket, string $object, integer $timeout = 60, string $method = self::OSS_HTTP_GET, array $options = NULL ) : string
$bucket string
$object string
$timeout integer
$method string
$options array Key-Value数组
return string

uploadDir() public method

上传本地目录内的文件或者目录到指定bucket的指定prefix的object中
public uploadDir ( string $bucket, string $prefix, string $localDirectory, string $exclude = '.|..|.svn|.git', boolean $recursive = false, boolean $checkMd5 = true ) : array
$bucket string bucket名称
$prefix string 需要上传到的object的key前缀，可以理解成bucket中的子目录，结尾不能是'/'，接口中会补充'/'
$localDirectory string 需要上传的本地目录
$exclude string 需要排除的目录
$recursive boolean 是否递归的上传localDirectory下的子目录内容
$checkMd5 boolean
return array 返回两个列表 array("succeededList" => array("object"), "failedList" => array("object"=>"errorMessage"))

uploadFile() public method

上传本地文件
public uploadFile ( string $bucket, string $object, string $file, array $options = NULL ) : null
$bucket string bucket名称
$object string object名称
$file string 本地文件路径
$options array
return null

uploadPart() public method

分片上传的块上传接口
public uploadPart ( string $bucket, string $object, string $uploadId, array $options = null ) : string
$bucket string Bucket名称
$object string Object名称
$uploadId string
$options array Key-Value数组
return string eTag

uploadPartCopy() public method

从一个已存在的Object中拷贝数据来上传一个Part
public uploadPartCopy ( string $fromBucket, string $fromObject, string $toBucket, string $toObject, integer $partNumber, string $uploadId, array $options = NULL ) : null
$fromBucket string 源bucket名称
$fromObject string 源object名称
$toBucket string 目标bucket名称
$toObject string 目标object名称
$partNumber integer 分块上传的块id
$uploadId string 初始化multipart upload返回的uploadid
$options array Key-Value数组
return null

Property Details

$OSS_ACL_TYPES static_oe public_oe property

OSS ACL数组
static public $OSS_ACL_TYPES