category | Zend |
---|---|
package | Zend_Service_WindowsAzure |
subpackage | Storage |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
inherited_from | \Zend_Service_WindowsAzure_Storage |
__construct(string $host= \Zend_Service_WindowsAzure_Storage::URL_DEV_BLOB
, string $accountName= \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT
, string $accountKey= \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY
, boolean $usePathStyleUri= false
, \Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy= null
)
inherited_from | \Zend_Service_WindowsAzure_Storage::__construct() |
---|
string
Storage host name
string
Account name for Windows Azure
string
Account key for Windows Azure
boolean
Use path-style URI's
\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract
Retry policy to use when making requests
__construct(string $host= self::URL_DEV_BLOB
, string $accountName= \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT
, string $accountKey= \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY
, boolean $usePathStyleUri= false
, \Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy= null
)
string
Storage host name
string
Account name for Windows Azure
string
Account key for Windows Azure
boolean
Use path-style URI's
\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract
Retry policy to use when making requests
blobExists(string $containerName= ''
, string $blobName= ''
, string $snapshotId= null
) : boolean
string
Container name
string
Blob name
string
Snapshot identifier
boolean
containerExists(string $containerName = ''
) : boolean
string
Container name
boolean
copyBlob(string $sourceContainerName= ''
, string $sourceBlobName= ''
, string $destinationContainerName= ''
, string $destinationBlobName= ''
, array $metadata= array()
, string $sourceSnapshotId= null
, string $destinationLeaseId= null
, array $additionalHeaders= array()
) : object
string
Source container name
string
Source blob name
string
Destination container name
string
Destination blob name
array
Key/value pairs of meta data
string
Source snapshot identifier
string
Destination lease identifier
array
Additional headers. See http://msdn.microsoft.com/en-us/library/dd894037.aspx for more information.
\Zend_Service_WindowsAzure_Exception |
---|
object
Partial blob propertiescreateContainer(string $containerName= ''
, array $metadata= array()
) : object
string
Container name
array
Key/value pairs of meta data
\Zend_Service_WindowsAzure_Exception |
---|
object
Container propertiescreateContainerIfNotExists(string $containerName= ''
, array $metadata= array()
)
string
Container name
array
Key/value pairs of meta data
\Zend_Service_WindowsAzure_Exception |
---|
createPageBlob(string $containerName= ''
, string $blobName= ''
, integer $size= 0
, array $metadata= array()
, string $leaseId= null
, array $additionalHeaders= array()
) : object
string
Container name
string
Blob name
integer
Size of the page blob in bytes
array
Key/value pairs of meta data
string
Lease identifier
array
Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.
\Zend_Service_WindowsAzure_Exception |
---|
object
Partial blob propertiescreateQueryStringFromArray($queryString) : string
string
Assembled query stringcreateResourceName(string $containerName= ''
, string $blobName= ''
) : string
string
Container name
string
Blob name
string
deleteBlob(string $containerName= ''
, string $blobName= ''
, string $snapshotId= null
, string $leaseId= null
, array $additionalHeaders= array()
)
string
Container name
string
Blob name
string
Snapshot identifier
string
Lease identifier
array
Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.
\Zend_Service_WindowsAzure_Exception |
---|
deleteContainer(string $containerName= ''
, array $additionalHeaders= array()
)
string
Container name
array
Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.
\Zend_Service_WindowsAzure_Exception |
---|
generateSharedAccessUrl(string $containerName= ''
, string $blobName= ''
, string $resource= 'b'
, string $permissions= 'r'
, string $start= ''
, string $expiry= ''
, string $identifier= ''
) : string
string
Container name
string
Blob name
string
Signed resource - container (c) - blob (b)
string
Signed permissions - read (r), write (w), delete (d) and list (l)
string
The time at which the Shared Access Signature becomes valid.
string
The time at which the Shared Access Signature becomes invalid.
string
Signed identifier
string
getAccountName() : string
string
getBaseUrl() : string
string
getBlob(string $containerName= ''
, string $blobName= ''
, string $localFileName= ''
, string $snapshotId= null
, string $leaseId= null
, array $additionalHeaders= array()
)
string
Container name
string
Blob name
string
Local file name to store downloaded blob
string
Snapshot identifier
string
Lease identifier
array
Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.
\Zend_Service_WindowsAzure_Exception |
---|
getBlobData(string $containerName= ''
, string $blobName= ''
, string $snapshotId= null
, string $leaseId= null
, array $additionalHeaders= array()
) : mixed
string
Container name
string
Blob name
string
Snapshot identifier
string
Lease identifier
array
Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.
\Zend_Service_WindowsAzure_Exception |
---|
mixed
Blob contentsgetBlobInstance(string $containerName= ''
, string $blobName= ''
, string $snapshotId= null
, string $leaseId= null
, array $additionalHeaders= array()
) : \Zend_Service_WindowsAzure_Storage_BlobInstance
string
Container name
string
Blob name
string
Snapshot identifier
string
Lease identifier
array
Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.
\Zend_Service_WindowsAzure_Exception |
---|
\Zend_Service_WindowsAzure_Storage_BlobInstance
getBlobMetadata(string $containerName= ''
, string $blobName= ''
, string $snapshotId= null
, string $leaseId= null
) : array
string
Container name
string
Blob name
string
Snapshot identifier
string
Lease identifier
\Zend_Service_WindowsAzure_Exception |
---|
array
Key/value pairs of meta datagetBlobProperties(string $containerName= ''
, string $blobName= ''
, string $snapshotId= null
, string $leaseId= null
) : \Zend_Service_WindowsAzure_Storage_BlobInstance
string
Container name
string
Blob name
string
Snapshot identifier
string
Lease identifier
\Zend_Service_WindowsAzure_Exception |
---|
\Zend_Service_WindowsAzure_Storage_BlobInstance
getBlockList(string $containerName= ''
, string $blobName= ''
, string $snapshotId= null
, string $leaseId= null
, integer $type= 0
) : array
string
Container name
string
Blob name
string
Snapshot identifier
string
Lease identifier
integer
Type of block list to retrieve. 0 = all, 1 = committed, 2 = uncommitted
\Zend_Service_WindowsAzure_Exception |
---|
array
getContainer(string $containerName = ''
) : \Zend_Service_WindowsAzure_Storage_BlobContainer
string
Container name
\Zend_Service_WindowsAzure_Exception |
---|
\Zend_Service_WindowsAzure_Storage_BlobContainer
getContainerAcl(string $containerName= ''
, boolean $signedIdentifiers= false
) : string
string
Container name
boolean
Display only private/blob/container or display signed identifiers?
\Zend_Service_WindowsAzure_Exception |
---|
string
Acl, to be compared with Zend_Service_WindowsAzure_Storage_Blob::ACL_*getContainerMetadata(string $containerName = ''
) : array
string
Container name
\Zend_Service_WindowsAzure_Exception |
---|
array
Key/value pairs of meta datagetCredentials() : \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
getHttpClientChannel() : \Zend_Http_Client_Adapter_Interface
\Zend_Http_Client_Adapter_Interface
getPageRegions(string $containerName= ''
, string $blobName= ''
, integer $startByteOffset= 0
, integer $endByteOffset= 0
, string $leaseId= null
) : array
string
Container name
string
Blob name
integer
Start byte offset
integer
End byte offset
string
Lease identifier
\Zend_Service_WindowsAzure_Exception |
---|
array
Array of page rangesgetWrapperClient(string $name) : \Zend_Service_WindowsAzure_Storage_Blob
string
Protocol name
\Zend_Service_WindowsAzure_Storage_Blob
isValidContainerName(string $containerName = ''
) : boolean
string
Container name
boolean
isValidMetadataName(string $metadataName = ''
) : boolean
string
Metadata name
boolean
isoDate(integer $timestamp = null
) : string
integer
string
leaseBlob(string $containerName= ''
, string $blobName= ''
, string $leaseAction= self::LEASE_ACQUIRE
, string $leaseId= null
) : \Zend_Service_WindowsAzure_Storage_LeaseInstance
string
Container name
string
Blob name
string
Lease action (Zend_Service_WindowsAzure_StorageBlob::LEASE*)
string
Lease identifier, required to renew the lease or to release the lease.
\Zend_Service_WindowsAzure_Exception |
---|
\Zend_Service_WindowsAzure_Storage_LeaseInstance
Lease instancelistBlobs(string $containerName= ''
, string $prefix= ''
, string $delimiter= ''
, integer $maxResults= null
, string $marker= null
, string $include= null
, integer $currentResultCount= 0
) : array
string
Container name
string
Optional. Filters the results to return only blobs whose name begins with the specified prefix.
string
Optional. Delimiter, i.e. '/', for specifying folder hierarchy
integer
Optional. Specifies the maximum number of blobs to return per call to Azure storage. This does NOT affect list size returned by this function. (maximum: 5000)
string
Optional string value that identifies the portion of the list to be returned with the next list operation.
string
Optional. Specifies that the response should include one or more of the following subsets: '', 'metadata', 'snapshots', 'uncommittedblobs'). Multiple values can be added separated with a comma (,)
integer
Current result count (internal use)
\Zend_Service_WindowsAzure_Exception |
---|
array
listContainers(string $prefix= null
, integer $maxResults= null
, string $marker= null
, string $include= null
, integer $currentResultCount= 0
) : array
string
Optional. Filters the results to return only containers whose name begins with the specified prefix.
integer
Optional. Specifies the maximum number of containers to return per call to Azure storage. This does NOT affect list size returned by this function. (maximum: 5000)
string
Optional string value that identifies the portion of the list to be returned with the next list operation.
string
Optional. Include this parameter to specify that the container's metadata be returned as part of the response body. (allowed values: '', 'metadata')
integer
Current result count (internal use)
\Zend_Service_WindowsAzure_Exception |
---|
array
putBlob(string $containerName= ''
, string $blobName= ''
, string $localFileName= ''
, array $metadata= array()
, string $leaseId= null
, array $additionalHeaders= array()
) : object
string
Container name
string
Blob name
string
Local file name to be uploaded
array
Key/value pairs of meta data
string
Lease identifier
array
Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.
\Zend_Service_WindowsAzure_Exception |
---|
object
Partial blob propertiesputBlobData(string $containerName= ''
, string $blobName= ''
, mixed $data= ''
, array $metadata= array()
, string $leaseId= null
, array $additionalHeaders= array()
) : object
string
Container name
string
Blob name
mixed
Data to store
array
Key/value pairs of meta data
string
Lease identifier
array
Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.
\Zend_Service_WindowsAzure_Exception |
---|
object
Partial blob propertiesputBlock(string $containerName= ''
, string $blobName= ''
, string $identifier= ''
, array $contents= ''
, string $leaseId= null
)
string
Container name
string
Blob name
string
Block ID
array
Contents of the block
string
Lease identifier
\Zend_Service_WindowsAzure_Exception |
---|
putBlockList(string $containerName= ''
, string $blobName= ''
, array $blockList= array()
, array $metadata= array()
, string $leaseId= null
, array $additionalHeaders= array()
)
string
Container name
string
Blob name
array
Array of block identifiers
array
Key/value pairs of meta data
string
Lease identifier
array
Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.
\Zend_Service_WindowsAzure_Exception |
---|
putLargeBlob(string $containerName= ''
, string $blobName= ''
, string $localFileName= ''
, array $metadata= array()
, string $leaseId= null
, array $additionalHeaders= array()
) : object
string
Container name
string
Blob name
string
Local file name to be uploaded
array
Key/value pairs of meta data
string
Lease identifier
array
Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.
\Zend_Service_WindowsAzure_Exception |
---|
object
Partial blob propertiesputPage(string $containerName= ''
, string $blobName= ''
, integer $startByteOffset= 0
, integer $endByteOffset= 0
, mixed $contents= ''
, string $writeMethod= self::PAGE_WRITE_UPDATE
, string $leaseId= null
, array $additionalHeaders= array()
)
string
Container name
string
Blob name
integer
Start byte offset
integer
End byte offset
mixed
Page contents
string
Write method (Zend_Service_WindowsAzure_Storage_Blob::PAGEWRITE*)
string
Lease identifier
array
Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.
\Zend_Service_WindowsAzure_Exception |
---|
registerAsClient(string $name) : \Zend_Service_WindowsAzure_Storage_Blob
string
Protocol name
\Zend_Service_WindowsAzure_Storage_Blob
registerStreamWrapper(string $name = 'azure'
)
string
Protocol name
setBlobMetadata(string $containerName= ''
, string $blobName= ''
, array $metadata= array()
, string $leaseId= null
, array $additionalHeaders= array()
)
Calling the Set Blob Metadata operation overwrites all existing metadata that is associated with the blob. It's not possible to modify an individual name/value pair.
string
Container name
string
Blob name
array
Key/value pairs of meta data
string
Lease identifier
array
Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.
\Zend_Service_WindowsAzure_Exception |
---|
setBlobProperties(string $containerName= ''
, string $blobName= ''
, string $leaseId= null
, array $additionalHeaders= array()
)
All available properties are listed at http://msdn.microsoft.com/en-us/library/ee691966.aspx and should be provided in the $additionalHeaders parameter.
string
Container name
string
Blob name
string
Lease identifier
array
Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.
\Zend_Service_WindowsAzure_Exception |
---|
setContainerAcl(string $containerName= ''
, boolean $acl= self::ACL_PRIVATE
, array $signedIdentifiers= array()
)
string
Container name
boolean
Zend_Service_WindowsAzure_StorageBlob::ACL*
array
Signed identifiers
\Zend_Service_WindowsAzure_Exception |
---|
setContainerMetadata(string $containerName= ''
, array $metadata= array()
, array $additionalHeaders= array()
)
Calling the Set Container Metadata operation overwrites all existing metadata that is associated with the container. It's not possible to modify an individual name/value pair.
string
Container name
array
Key/value pairs of meta data
array
Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.
\Zend_Service_WindowsAzure_Exception |
---|
setCredentials(\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract $credentials)
\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance to use for request signing.
setHttpClientChannel(\Zend_Http_Client_Adapter_Interface|string $adapterInstance = 'Zend_Http_Client_Adapter_Proxy'
)
\Zend_Http_Client_Adapter_Interface
string
Adapter instance or adapter class name.
setProxy(boolean $useProxy= false
, string $proxyUrl= ''
, integer $proxyPort= 80
, string $proxyCredentials= ''
)
boolean
Use proxy?
string
Proxy URL
integer
Proxy port
string
Proxy credentials
setRetryPolicy(\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null
)
\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract
Retry policy to use when making requests
snapshotBlob(string $containerName= ''
, string $blobName= ''
, array $metadata= array()
, array $additionalHeaders= array()
) : string
string
Container name
string
Blob name
array
Key/value pairs of meta data
array
Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.
\Zend_Service_WindowsAzure_Exception |
---|
string
Date/Time value representing the snapshot identifier.unregisterAsClient(string $name) : \Zend_Service_WindowsAzure_Storage_Blob
string
Protocol name
\Zend_Service_WindowsAzure_Storage_Blob
unregisterStreamWrapper(string $name = 'azure'
) : \Zend_Service_WindowsAzure_Storage_Blob
string
Protocol name
\Zend_Service_WindowsAzure_Storage_Blob
urlencode(string $value) : string
string
Value to encode
string
Encoded value_generateBlockId(integer $part = 0
) : string
integer
Block number
string
Windows Azure Blob Storage block number_generateMetadataHeaders(array $metadata = array()
) : \HTTP
array
\HTTP
headers containing metadata_getErrorMessage(\Zend_Http_Response $response, string $alternativeError = 'Unknown error.'
) : string
\Zend_Http_Response
Repsonse
string
Alternative error message
string
_parseMetadataElement($element = null
) : array
array
_parseMetadataHeaders(array $headers = array()
) : array
array
HTTP headers containing metadata
array
_parseResponse(\Zend_Http_Response $response = null
) : object
\Zend_Http_Response
Response from HTTP call
\Zend_Service_WindowsAzure_Exception |
---|
object
_performRequest(string $path= '/'
, string $queryString= ''
, string $httpVerb= \Zend_Http_Client::GET
, array $headers= array()
, boolean $forTableStorage= false
, mixed $rawData= null
, string $resourceType= \Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN
, string $requiredPermission= \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ
) : \Zend_Http_Response
string
Path
string
Query string
string
HTTP verb the request will use
array
x-ms headers to add
boolean
Is the request for table storage?
mixed
Optional RAW HTTP data to be sent over the wire
string
Resource type
string
Required permission
\Zend_Http_Response
$_accountKey : string
''
$_accountName : string
''
$_apiVersion : string
'2009-09-19'
$_credentials : \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
null
$_host : string
''
$_httpClientChannel : \Zend_Http_Client
null
$_proxyCredentials : string
''
$_proxyPort : integer
80
$_proxyUrl : string
''
$_retryPolicy : \Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract
null
$_sharedAccessSignatureCredentials : \Zend_Service_WindowsAzure_Credentials_SharedAccessSignature
null
$_usePathStyleUri : boolean
false
$_useProxy : boolean
false
$_wrapperClients : array
array()
ACL_PRIVATE = null
ACL_PUBLIC = 'container'
deprecated | Use ACL_PUBLIC_CONTAINER or ACL_PUBLIC_BLOB instead. |
---|
ACL_PUBLIC_BLOB = 'blob'
ACL_PUBLIC_CONTAINER = 'container'
BLOBTYPE_BLOCK = 'BlockBlob'
BLOBTYPE_PAGE = 'PageBlob'
LEASE_ACQUIRE = 'acquire'
LEASE_BREAK = 'break'
LEASE_RELEASE = 'release'
LEASE_RENEW = 'renew'
MAX_BLOB_SIZE = 67108864
MAX_BLOB_TRANSFER_SIZE = 4194304
PAGE_WRITE_CLEAR = 'clear'
PAGE_WRITE_UPDATE = 'update'
PREFIX_METADATA = "x-ms-meta-"
PREFIX_PROPERTIES = "x-ms-prop-"
PREFIX_STORAGE_HEADER = "x-ms-"
RESOURCE_BLOB = "b"
RESOURCE_CONTAINER = "c"
RESOURCE_ENTITY = "e"
RESOURCE_QUEUE = "q"
RESOURCE_TABLE = "t"
RESOURCE_UNKNOWN = "unknown"
URL_CLOUD_BLOB = "blob.core.windows.net"
URL_CLOUD_QUEUE = "queue.core.windows.net"
URL_CLOUD_TABLE = "table.core.windows.net"
URL_DEV_BLOB = "127.0.0.1:10000"
URL_DEV_QUEUE = "127.0.0.1:10001"
URL_DEV_TABLE = "127.0.0.1:10002"