OSS/OSSClient.php

Show: PublicProtectedPrivateinherited
Table of Contents
Copyright (C) Alibaba Cloud Computing All rights reserved.

版权所有 （C）阿里云计算有限公司

\Aliyun\OSS\OSSClient
jump to top

Package: Aliyun\OSS
访问阿里云开放存储服务（Open Storage Service， OSS）的入口类。

Properties

>VPropertyprotectedarray $credentials
Details
Type
array
>VPropertyprotectedstring $endpoint
Details
Type
string
>VPropertyprotected\Aliyun\Common\Communication\ServiceClientInterface $serviceClient
Details
Type
\Aliyun\Common\Communication\ServiceClientInterface

Methods

methodprotected__construct( $config) : void

Parameters
NameTypeDescription
$config
methodpublicabortMultipartUpload(array $options) : void

撤销一个分块上传的事件

Parameters
NameTypeDescription
$optionsarray

可以包含以下Key:

  • Bucket(string, 必选) - 上传事件所在Bucket名称
  • Key(string, 必选) - 上传事件的Object的Key
  • UploadId(string, 必选) - 标识Multipart上传事件的Upload ID。

    • methodpubliccompleteMultipartUpload(array $options) : \Aliyun\OSS\Models\CompleteMultipartUploadResult

    完成分块上传

    Parameters
    NameTypeDescription
    $optionsarray

    可以包含以下Key:

  • Bucket(string, 必选) - 上传事件所在Bucket名称
  • Key(string, 必选) - 上传事件的Object的Key
  • UploadId(string, 必选) - 标识Multipart上传事件的Upload ID。
  • PartETags(array, 必选) - 返回标识上传Part结果的PartETag列表，PartETag也是一个array 里面存在两个元素，分别为PartNumber和ETag。

    • Returns
    TypeDescription
    \Aliyun\OSS\Models\CompleteMultipartUploadResult
    methodpubliccopyObject(array $options) : \Aliyun\OSS\Models\CopyObjectResult

    拷贝一个在OSS上已经存在的Object为另外一个Object。

    Parameters
    NameTypeDescription
    $optionsarray

    可以包含以下Key:

  • SourceBucket(string, 必选) - 复制的源Bucket
  • SourceKey(string, 必选) - 复制的的源Object的Key
  • DestBucket(string, 必选) - 复制的目的Bucket
  • DestKey(string, 必选) - 复制的目的Object的Key
  • ContentDisposition(string, 可选) - Content-Disposition请求头，表示MIME用户代理如何显示附加的文件。
  • CacheControl(string, 可选) - Cache-Control请求头，表示用户指定的HTTP请求/回复链的缓存行为。
  • ContentEncoding(string, 可选) - Content-Encoding请求头，表示Object内容的编码方式。
  • ContentType(string, 可选) - Content-Type请求头，表示Object内容的类型，为标准的MIME类型。
  • Expires(\DateTime, 可选) - Expires请求头，表示Object的过期时间
  • UserMetadata(array, 可选) - 用户自定义元数据，如 array('key1' => 'value1', 'key2' => 'value2')

    • 如果用户在请求中指定了任意一项Object的元数据（ContentDisposition，CacheControl，ContentEncoding，ContentType，Expires， UserMetadata） 则使用新的元数据，否则直接使用源Object的源数据。

    Returns
    TypeDescription
    \Aliyun\OSS\Models\CopyObjectResult
    methodpubliccreateBucket(array $options) : \Aliyun\OSS\Models\Bucket

    新建一个Bucket

    Parameters
    NameTypeDescription
    $optionsarray

    请求参数，可以包含以下Key:

  • Bucket(string, 必选) - 新建Bucket的名称

    • Returns
    TypeDescription
    \Aliyun\OSS\Models\Bucket
    methodpublicdeleteBucket(array $options) : void

    删除一个Bucket

    Parameters
    NameTypeDescription
    $optionsarray

    请求参数，可以包含以下Key:

  • Bucket(string, 必选) - 所要删除的Bucket的名称

    • methodpublicdeleteObject(array $options) : void

    删除一个Object

    Parameters
    NameTypeDescription
    $optionsarray

    可以包含以下Key:

  • Bucket(string, 必选) - 要删除的Object所在的Bucket
  • Key(string, 必选) - 要删除的Object的Key

    • methodprotectedexecute( $method,  $options) : void

    Parameters
    NameTypeDescription
    $method
    $options
    methodpublicfactory(array $config) : \Aliyun\OSS\OSSClient
    static

    获取OSSClient实例用以访问OSS服务

    Parameters
    NameTypeDescription
    $configarray

    Client的配置信息，可以包含下列Key：

  • Endpoint(必选) - OSS服务的Endpoint。必须以"http://"开头。
  • AccessKeyId(必选) - 访问OSS的Access Key ID。
  • AccessKeySecret(必选) - 访问OSS的Access Key Secret。

    • Returns
    TypeDescription
    \Aliyun\OSS\OSSClient
    methodpublicgeneratePresignedUrl(array $options) : mixed

    生成预签名URL

    Parameters
    NameTypeDescription
    $optionsarray

    可以包含以下Key:

  • Bucket(string, 必选) - 签名Object所在的Bucket
  • Key(string, 必选) - 签名的Object的Key
  • Expires(\DateTime, 必选) - 签名过期时间
  • ContentType(string, 可选) - 签名Object的内容类型
  • ResponseCacheControl(string, 可选) - 指定返回的Http头Cache-Control （获取Object使用）
  • ResponseContentDisposition(string, 可选) - 指定返回的Http头Content-Disposition（获取Object使用）
  • ResponseContentEncoding(string, 可选) - 指定返回的Http头Content-Encoding（获取Object使用）
  • ResponseContentLanguage(string, 可选) - 指定返回的Http头Content-Language（获取Object使用）
  • ResponseContentType(string, 可选) - 指定返回的Http头Content-Type（获取Object使用）
  • ResponseExpires(string, 可选) - 指定返回的Http头Expires（获取Object使用）
  • UserMetadata(array, 可选) - 用户自定义元数据（上传Object使用），如 array('key1' => 'value1', 'key2' => 'value2')

    • Returns
    TypeDescription
    mixed
    methodpublicgetBucketAcl(array $options) : \Aliyun\OSS\Models\AccessControlPolicy

    获取指定Bucket的访问权限

    Parameters
    NameTypeDescription
    $optionsarray

    请求参数，可以包含以下Key:

  • Bucket(string, 必选) - 指定的Bucket的名称

    • Returns
    TypeDescription
    \Aliyun\OSS\Models\AccessControlPolicy
    methodprotectedgetClientOptions() : void

    methodpublicgetCredentials() : array

    返回用户的Credentials。

    Returns
    TypeDescription
    array返回的数组中包含AccessKeyId和AccessKeySecret
    methodpublicgetEndpoint() : string

    返回访问OSS的Endpoint。

    Returns
    TypeDescription
    string
    methodpublicgetObject(array $options) : \Aliyun\OSS\Models\OSSObject

    获取一个Object

    Parameters
    NameTypeDescription
    $optionsarray

    可以包含以下Key:

  • Bucket(string, 必选) - Bucket的名称
  • Key(string, 必选) - Object的Key
  • Range(array, 可选) - 指定返回的字节范围，如设定为 array(0, 9) 则返回第0到9个字节的内容
  • SaveAs(string, 可选) - 用于指定Object保存的文件路径，此时返回的OSSObject中content为空。
  • MetaOnly(bool, 可选) - 此项为true的话则只获取Object的元信息而不获取具体内容，默认为false。
  • ModifiedSinceConstraint(\DateTime, 可选) - 如果指定的时间早于实际修改时间，则正常返回Object。
  • UnmodifiedSinceConstraint(\DateTime, 可选) - 如果传入参数中的时间等于或者晚于文件实际修改时间，则正常返回Object。
  • MatchingETagConstraints(array, 可选) - 指定一组ETag，如果传入期望的ETag和object的 ETag匹配，则正常返回Object。
  • NoMatchingETagConstraints(array, 可选) - 指定一组ETag，如果传入的ETag值和Object的ETag不匹配，则正常返回Object。
  • ResponseCacheControl(string, 可选) - 指定返回的Http头Cache-Control
  • ResponseContentDisposition(string, 可选) - 指定返回的Http头Content-Disposition
  • ResponseContentEncoding(string, 可选) - 指定返回的Http头Content-Encoding
  • ResponseContentLanguage(string, 可选) - 指定返回的Http头Content-Language
  • ResponseContentType(string, 可选) - 指定返回的Http头Content-Type
  • ResponseExpires(string, 可选) - 指定返回的Http头Expires

    • Returns
    TypeDescription
    \Aliyun\OSS\Models\OSSObject
    methodpublicgetObjectMetadata(array $options) : \Aliyun\OSS\Models\OSSObject

    获取Object的元数据，OSSObject中不包含Object的内容

    Parameters
    NameTypeDescription
    $optionsarray

    可以包含以下Key:

  • Bucket(string, 必选) - Bucket的名称
  • Key(string, 必选) - Object的Key
  • ModifiedSinceConstraint(\DateTime, 可选) - 如果指定的时间早于实际修改时间，则执行复制。
  • UnmodifiedSinceConstraint(\DateTime, 可选) - 如果传入参数中的时间等于或者晚于文件实际修改时间，则执行复制。
  • MatchingETagConstraints(array, 可选) - 指定一组ETag，如果传入期望的ETag和object的 ETag匹配，则执行复制。
  • NoMatchingETagConstraints(array, 可选) - 指定一组ETag，如果传入的ETag值和Object的ETag不匹配，则执行复制。

    • Returns
    TypeDescription
    \Aliyun\OSS\Models\OSSObject
    methodpublicinitiateMultipartUpload(array $options) : \Aliyun\OSS\Models\InitiateMultipartUploadResult

    初始化一个Multipart上传事件。

    使用Multipart模式上传数据前，必须先调用该接口来通过OSS初始化一个Multipart上传事件。 该接口会返回一个OSS服务器创建的全局唯一的Upload ID，用于标识本次Multipart上传事件。 用户可以根据这个ID来发起相关的操作，如中止、查询Multipart上传等。

    Parameters
    NameTypeDescription
    $optionsarray

    可以包含以下Key:

  • Bucket(string, 必选) - Object所要分块上传到的Bucket名称
  • Key(string, 必选) - 所要分块上传的Object的Key
  • Content(string|resource, 必选) - 所要上传Object的内容
  • ContentLength(int, 可选) - 所要上传的Object的大小，如果Content为resource类型，ContentLength为必选
  • ContentDisposition(string, 可选) - Content-Disposition请求头，表示MIME用户代理如何显示附加的文件。
  • CacheControl(string, 可选) - Cache-Control请求头，表示用户指定的HTTP请求/回复链的缓存行为。
  • ContentEncoding(string, 可选) - Content-Encoding请求头，表示Object内容的编码方式。
  • Expires(\DateTime, 可选) - Expires请求头，表示Object的过期时间
  • UserMetadata(array, 可选) - 用户自定义元数据，如 array('key1' => 'value1', 'key2' => 'value2')

    • Returns
    TypeDescription
    \Aliyun\OSS\Models\InitiateMultipartUploadResult
    methodpubliclistBuckets(array $options = array()) : array

    返回请求者拥有的所有Bucket

    Parameters
    NameTypeDescription
    $optionsarray

    默认为空

    Returns
    TypeDescription
    array返回数组包含用户所有的Bucket
    methodpubliclistMultipartUploads(array $options) : \Aliyun\OSS\Models\MultipartUploadsListing

    列出所有执行中的 Multipart上传事件。

    即已经被初始化的 Multipart Upload 但是未被完成或被终止的 Multipart上传事件。 OSS返回的罗列结果中最多会包含1000个Multipart上传事件。

    Parameters
    NameTypeDescription
    $optionsarray

    可以包含以下Key:

  • Bucket(string, 必选) - Bucket的名称
  • Delimiter(string, 可选) - 用于对Object名字进行分组的字符。所有名字包含指定的前缀且第一次出现delimiter字符之间的object作为一组元素——CommonPrefixes。
  • KeyMarker(string, 可选) - 设置一个标识表示从哪里返回列表。
  • MaxUploads(string, 可选) - 设置限制的最大返回记录数。最大值和默认值均为1000。
  • Prefix(string, 可选) - 限定返回的object key必须以prefix作为前缀。
  • UploadIdMarker(string, 可选) - 设置一个标识表示从哪里返回列表。

    • Returns
    TypeDescription
    \Aliyun\OSS\Models\MultipartUploadsListing
    methodpubliclistObjects(array $options) : \Aliyun\OSS\Models\ObjectListing

    列出指定Bucket下的Object

    Parameters
    NameTypeDescription
    $optionsarray

    可以包含以下Key:

  • Bucket(string, 必选) - Bucket的名称
  • Prefix(string, 可选) - 限定返回的Object key必须以prefix作为前缀。
  • Marker(string, 可选) - 用户设定结果从marker之后按字母排序的第一个开始返回。
  • MaxKeys(string, 可选) - 用于限定此次返回object的最大数，如果不设定，默认为100。
  • Delimiter(string, 可选) - 用于对Object名字进行分组的字符。

    • Returns
    TypeDescription
    \Aliyun\OSS\Models\ObjectListing
    methodpubliclistParts(array $options) : \Aliyun\OSS\Models\PartListing

    列出multipart上传事件中上传的所有part信息

    Parameters
    NameTypeDescription
    $optionsarray

    可以包含以下Key:

  • Bucket(string, 必选) - 上传事件所在Bucket名称
  • Key(string, 必选) - 上传事件的Object的Key
  • UploadId(string, 必选) - 标识Multipart上传事件的Upload ID。
  • MaxParts(int, 可选) - 设置一个值最大返回多少条记录。最大值和默认值均为1000。
  • PartNumberMarker(int, 可选) - 设置一个值表示从哪个Part号码开始获取列表。

    • Returns
    TypeDescription
    \Aliyun\OSS\Models\PartListing
    methodpublicputObject(array $options) : \Aliyun\OSS\Models\PutObjectResult

    上传一个Object

    Parameters
    NameTypeDescription
    $optionsarray

    可以包含以下Key:

  • Bucket(string, 必选) - Object所要上传到的Bucket名称
  • Key(string, 必选) - 所要上传Object的Key
  • Content(string|resource, 必选) - 所要上传Object的内容
  • ContentLength(int, 可选) - 所要上传的Object的大小，如果Content为resource类型，ContentLength为必选
  • ContentDisposition(string, 可选) - Content-Disposition请求头，表示MIME用户代理如何显示附加的文件。
  • CacheControl(string, 可选) - Cache-Control请求头，表示用户指定的HTTP请求/回复链的缓存行为。
  • ContentEncoding(string, 可选) - Content-Encoding请求头，表示Object内容的编码方式。
  • Expires(\DateTime, 可选) - Expires请求头，表示Object的过期时间
  • UserMetadata(array, 可选) - 用户自定义元数据，如 array('key1' => 'value1', 'key2' => 'value2')

    • Returns
    TypeDescription
    \Aliyun\OSS\Models\PutObjectResult
    methodpublicsetBucketAcl(array $options) : void

    设置指定Bucket的访问权限

    Parameters
    NameTypeDescription
    $optionsarray

    请求参数，可以包含以下Key:

  • Bucket(string, 必选) - 指定的Bucket的名称
  • ACL(string, 必选) - Bucket的访问权限，可以为下面几个权限之一： private | public-read | public-read-write

    • methodpublicuploadPart(array $options) : \Aliyun\OSS\Models\UploadPartResult

    上传一个分块（Part）到指定的的Multipart上传事件中。

    Parameters
    NameTypeDescription
    $optionsarray

    可以包含以下Key:

  • Bucket(string, 必选) - Object所要分块上传到的Bucket名称
  • Key(string, 必选) - 所要分块上传的Object的Key
  • UploadId(string, 必选) - 设置标识Multipart上传事件的Upload ID。
  • Content(string|resource, 必选) - 上传块的内容。
  • ParNumber(int, 必选) - 上传分块（Part）的标识号码
  • PartSize(int, 必选) - 本块的长度

    • Returns
    TypeDescription
    \Aliyun\OSS\Models\UploadPartResult
    Documentation was generated by phpDocumentor 2.0.0a12.