• Главная
• OSS
• OssClient

PHP Класс OSS\OssClient

Object Storage Service(OSS) 的客户端类，封装了用户通过OSS API对OSS服务的各种操作， 用户通过OssClient实例可以进行Bucket，Object，MultipartUpload, ACL等操作，具体 的接口规则可以参考官方OSS API文档 Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$OSS_ACL_TYPES		OSS ACL数组

Открытые методы

Метод	Описание
__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

Приватные методы

Метод	Описание
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 )	参数校验

Описание методов

Описание свойств