Overview

Namespaces

  • None
  • sinacloud
    • sae

Classes

  • Storage

Exceptions

  • StorageException
  • Overview
  • Namespace
  • Class

Class Storage

Namespace: sinacloud\sae
Located at Storage.php
Methods summary
public
# __construct( string $accessKey = null, string $secretKey = null, boolean $useSSL = DEFAULT_USE_SSL, string $endpoint = DEFAULT_STORAGE_ENDPOINT )

构造函数

构造函数

Parameters

$accessKey
此处需要使用"应用名:Accesskey"
$secretKey
应用 Secretkey
$useSSL
是否使用 SSL
$endpoint
新浪云 Storage 的 endpoint
public
# setEndpoint( string $host )

设置新浪云的 Storage 的 endpoint

设置新浪云的 Storage 的 endpoint

Parameters

$host
新浪云 Storage 的 hostname
public static
# setAuth( string $accessKey, string $secretKey )

设置访问的 Accesskey 和 Secretkey

设置访问的 Accesskey 和 Secretkey

Parameters

$accessKey
此处需要使用"应用名：应用 Accesskey"
$secretKey
应用 Secretkey
public static
# hasAuth( )
public static
# setSSL( boolean $enabled, boolean $validate = true )

开启或者关闭 SSL

开启或者关闭 SSL

Parameters

$enabled
是否启用 SSL
$validate
是否验证 SSL 证书
public static
# setProxy( string $host, string $user = null, string $pass = null, constant $type = CURLPROXY_SOCKS5 )

设置代理信息

设置代理信息

Parameters

$host
代理的 hostname 和端口 (localhost:1234)
$user
代理的 username
$pass
代理的 password
$type
CURL 代理类型
public static
# setExceptions( boolean $enabled = true )

设置是否使用 PHP Exception，默认使用 trigger_error

设置是否使用 PHP Exception，默认使用 trigger_error

Parameters

$enabled
Enable exceptions
public static array
# listBuckets( boolean $detailed = false )

获取 bucket 列表

获取 bucket 列表

Parameters

$detailed
设置为 true 时返回 bucket 的详细信息

Returns

array
| false
public static array
# getBucket( string $bucket, string $prefix = null, string $marker = null, string $limit = 1000, string $delimiter = null, $keyword = null )

获取 bucket 中的 object 列表

获取 bucket 中的 object 列表

Parameters

$bucket
Bucket 名称
$prefix
Object 名称的前缀
$marker
Marker （返回 marker 之后的 object 列表，不包含 marker）
$limit
最大返回的 Object 数目
$delimiter
分隔符
$keyword

Returns

array
| false
public static boolean
# putBucket( string $bucket, constant $acl = self::ACL_PRIVATE, array $metaHeaders = array() )

创建一个 Bucket

创建一个 Bucket

Parameters

$bucket
Bucket 名称
$acl
Bucket 的 ACL
$metaHeaders
x-sws-container-meta-* header 数组

Returns

boolean
public static mixed
# getBucketInfo( string $bucket, boolean $returnInfo = True )

获取一个 Bucket 的属性

获取一个 Bucket 的属性

Parameters

$bucket
Bucket 名称
$returnInfo
是否返回 Bucket 的信息

Returns

mixed
public static boolean
# postBucket( string $bucket, constant $acl = null, array $metaHeaders = array() )

修改一个 Bucket 的属性

修改一个 Bucket 的属性

Parameters

$bucket
Bucket 名称
$acl
Bucket 的 ACL，null 表示不变
$metaHeaders
x-sws-container-meta-* header 数组

Returns

boolean
public static boolean
# deleteBucket( string $bucket )

删除一个空的 Bucket

删除一个空的 Bucket

Parameters

$bucket
Bucket 名称

Returns

boolean
public static array
# inputFile( string $file, mixed $md5sum = false )

为本地文件路径创建一个可以用于 putObject() 上传的 array

为本地文件路径创建一个可以用于 putObject() 上传的 array

Parameters

$file
文件路径
$md5sum
Use MD5 hash (supply a string if you want to use your own)

Returns

array
| false
public static array
# inputResource( string & $resource, integer $bufferSize = false, string $md5sum = '' )

为打开的文件句柄创建一个可以用于 putObject() 上传的 array

为打开的文件句柄创建一个可以用于 putObject() 上传的 array

Parameters

$resource
Input resource to read from
$bufferSize
Input byte size
$md5sum
MD5 hash to send (optional)

Returns

array
| false
public static boolean
# putObject( mixed $input, string $bucket, string $uri, array $metaHeaders = array(), array $requestHeaders = array() )

上传一个 object

上传一个 object

Parameters

$input
Input data
$bucket
Bucket name
$uri
Object URI
$metaHeaders
x-sws-object-meta-* header 数组
$requestHeaders
Array of request headers or content type as a string

Returns

boolean
public static boolean
# putObjectFile( string $file, string $bucket, string $uri, constant $metaHeaders = array(), array $contentType = null, string $contentType,… )

Put an object from a file (legacy function)

Put an object from a file (legacy function)

Parameters

$file
Input file path
$bucket
Bucket name
$uri
Object URI
$metaHeaders
$acl ACL constant
$contentType
$metaHeaders Array of x-meta-* headers
$contentType,…
Content type

Returns

boolean
public static boolean
# putObjectString( string $string, string $bucket, string $uri, constant $metaHeaders = array(), array $contentType = false, string $contentType,… )

Put an object from a string (legacy function)

Put an object from a string (legacy function)

Parameters

$string
Input data
$bucket
Bucket name
$uri
Object URI
$metaHeaders
$acl ACL constant
$contentType
$metaHeaders Array of x-sws-meta-* headers
$contentType,…
Content type

Returns

boolean
public static boolean
# postObject( string $bucket, constant $uri, array $metaHeaders = array(), array $requestHeaders = Array() )

修改一个 Object 的属性

修改一个 Object 的属性

Parameters

$bucket
Bucket 名称
$uri
Object 名称
$metaHeaders
x-sws-container-meta-* header 数组
$requestHeaders
其它 header 属性

Returns

boolean
public static mixed
# getObject( string $bucket, string $uri, mixed $saveTo = false )

获取一个 Object 的内容

获取一个 Object 的内容

Parameters

$bucket
Bucket 名称
$uri
Object 名称
$saveTo
文件保存到的文件名或者句柄

Returns

mixed
返回服务端返回的 response，其中 headers 为 Object 的属性信息，body 为 Object 的内容
public static mixed
# getObjectInfo( string $bucket, string $uri, boolean $returnInfo = true )

获取一个 Object 的信息

获取一个 Object 的信息

Parameters

$bucket
Bucket 名称
$uri
Object 名称
$returnInfo
是否返回 Object 的详细信息

Returns

mixed
| false
public static mixed
# copyObject( string $srcBucket, string $srcUri, string $bucket, string $uri, array $metaHeaders = array(), array $requestHeaders = array() )

从一个 Bucket 复制一个 Object 到另一个 Bucket

从一个 Bucket 复制一个 Object 到另一个 Bucket

Parameters

$srcBucket
源 Bucket 名称
$srcUri
源 Object 名称
$bucket
目标 Bucket 名称
$uri
目标 Object 名称
$metaHeaders
Optional array of x-sws-meta-* headers
$requestHeaders
Optional array of request headers (content type, disposition, etc.)

Returns

mixed
| false
public static boolean
# setAccessControlPolicy( string $bucket, string $uri = '', array $acp = array() )

Set object or bucket Access Control Policy

Set object or bucket Access Control Policy

Parameters

$bucket
Bucket name
$uri
Object URI
$acp
Access Control Policy Data (same as the data returned from getAccessControlPolicy)

Returns

boolean
public static boolean
# deleteObject( string $bucket, string $uri )

删除一个 Object

删除一个 Object

Parameters

$bucket
Bucket 名称
$uri
Object 名称

Returns

boolean
public static string
# getUrl( string $bucket, string $uri )

获取一个 Object 的外网直接访问 URL

获取一个 Object 的外网直接访问 URL

Parameters

$bucket
Bucket 名称
$uri
Object 名称

Returns

string
public static
# getTempUrl( string $bucket, string $uri, string $method, integer $seconds )

获取一个 Object 的外网临时访问 URL

获取一个 Object 的外网临时访问 URL

Parameters

$bucket
Bucket 名称
$uri
Object 名称
$method
Http 请求的方法，有 GET, PUT, DELETE 等
$seconds
设置这个此 URL 的过期时间，单位是秒
public static string
# getCdnUrl( string $bucket, string $uri )

获取一个 Object 的 CDN 访问 URL

获取一个 Object 的 CDN 访问 URL

Parameters

$bucket
Bucket 名称
$uri
Object 名称

Returns

string
public static boolean
# postAccount( array $metaHeaders = array() )

修改账户的属性（for internal use onley）

修改账户的属性（for internal use onley）

Parameters

$metaHeaders
x-sws-account-meta-* header 数组

Returns

boolean
public static mixed
# getAccountInfo( string $bucket,… )

获取账户的属性（for internal use only）

获取账户的属性（for internal use only）

Parameters

$bucket,…
Bucket 名称

Returns

mixed
public static
# __getTime( )
public static
# __getSignature( $string )
Constants summary
string ACL_PRIVATE
# ''
string ACL_PUBLIC_READ
# '.r:*'
Properties summary
public static string $defDelimiter

默认使用的分隔符，getBucket() 等用到

默认使用的分隔符，getBucket() 等用到
# null
public static $endpoint
# DEFAULT_STORAGE_ENDPOINT
public static $proxy
# null
public static boolean $useSSL

使用 SSL 连接？

使用 SSL 连接？
# DEFAULT_USE_SSL
public static boolean $useSSLValidation

是否验证 SSL 证书

是否验证 SSL 证书
# false
public static const $useSSLVersion

使用的 SSL 版本

使用的 SSL 版本
# 1
public static boolean $useExceptions

出现错误的时候是否使用 PHP Exception（默认使用 trigger_error 纪录错误）

出现错误的时候是否使用 PHP Exception（默认使用 trigger_error 纪录错误）
# false
API documentation generated by ApiGen