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

 Methods

Creates a new Zend_Service_WindowsAzure_Storage_Queue instance

__construct(string $host = \Zend_Service_WindowsAzure_Storage::URL_DEV_QUEUE, 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()

Parameters

$host

string

Storage host name

$accountName

string

Account name for Windows Azure

$accountKey

string

Account key for Windows Azure

$usePathStyleUri

boolean

Use path-style URI's

$retryPolicy

\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract

Retry policy to use when making requests

Creates a new Zend_Service_WindowsAzure_Storage instance

__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
Inherited

Parameters

$host

string

Storage host name

$accountName

string

Account name for Windows Azure

$accountKey

string

Account key for Windows Azure

$usePathStyleUri

boolean

Use path-style URI's

$retryPolicy

\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract

Retry policy to use when making requests

Clear queue messages

clearMessages(string $queueName = ''

Parameters

$queueName

string

Queue name

Exceptions

\Zend_Service_WindowsAzure_Exception

Builds a query string from an array of elements

createQueryStringFromArray($queryString) : string
InheritedStatic

Parameters

$queryString

Returns

stringAssembled query string

Create queue

createQueue(string $queueName = '', array $metadata = array()) : object

Parameters

$queueName

string

Queue name

$metadata

array

Key/value pairs of meta data

Exceptions

\Zend_Service_WindowsAzure_Exception

Returns

objectQueue properties

Create queue if it does not exist

createQueueIfNotExists(string $queueName = '', array $metadata = array()

Parameters

$queueName

string

Queue name

$metadata

array

Key/value pairs of meta data

Exceptions

\Zend_Service_WindowsAzure_Exception

Delete queue message

deleteMessage(string $queueName = '', \Zend_Service_WindowsAzure_Storage_QueueMessage $message) 

Parameters

$queueName

string

Queue name

$message

\Zend_Service_WindowsAzure_Storage_QueueMessage

Message to delete from queue. A message retrieved using "peekMessages" can NOT be deleted!

Exceptions

\Zend_Service_WindowsAzure_Exception

Delete queue

deleteQueue(string $queueName = ''

Parameters

$queueName

string

Queue name

Exceptions

\Zend_Service_WindowsAzure_Exception

Returns the Windows Azure account name

getAccountName() : string
Inherited

Returns

string

Get base URL for creating requests

getBaseUrl() : string
Inherited

Returns

string

Get Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance

getCredentials() : \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
Inherited

Returns

\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

Retrieve HTTP client channel

getHttpClientChannel() : \Zend_Http_Client_Adapter_Interface
Inherited

Returns

\Zend_Http_Client_Adapter_Interface

Get queue messages

getMessages(string $queueName = '', string $numOfMessages = 1, integer $visibilityTimeout = null, string $peek = false) : array

Parameters

$queueName

string

Queue name

$numOfMessages

string

Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. By default, a single message is retrieved from the queue with this operation.

$visibilityTimeout

integer

Optional. An integer value that specifies the message's visibility timeout in seconds. The maximum value is 2 hours. The default message visibility timeout is 30 seconds.

$peek

string

Peek only?

Exceptions

\Zend_Service_WindowsAzure_Exception

Returns

array

Get queue

getQueue(string $queueName = '') : \Zend_Service_WindowsAzure_Storage_QueueInstance

Parameters

$queueName

string

Queue name

Exceptions

\Zend_Service_WindowsAzure_Exception

Returns

\Zend_Service_WindowsAzure_Storage_QueueInstance

Checks to see if a given queue has messages

hasMessages(string $queueName = '') : boolean

Parameters

$queueName

string

Queue name

Exceptions

\Zend_Service_WindowsAzure_Exception

Returns

boolean

Is valid metadata name?

isValidMetadataName(string $metadataName = '') : boolean
InheritedStatic

Parameters

$metadataName

string

Metadata name

Returns

boolean

Is valid queue name?

isValidQueueName(string $queueName = '') : boolean
Static

Parameters

$queueName

string

Queue name

Returns

boolean

Generate ISO 8601 compliant date string in UTC time zone

isoDate(integer $timestamp = null) : string
Inherited

Parameters

$timestamp

integer

Returns

string

List queues

listQueues(string $prefix = null, integer $maxResults = null, string $marker = null, string $include = null, integer $currentResultCount = 0) : array

Parameters

$prefix

string

Optional. Filters the results to return only queues whose name begins with the specified prefix.

$maxResults

integer

Optional. Specifies the maximum number of queues to return per call to Azure storage. This does NOT affect list size returned by this function. (maximum: 5000)

$marker

string

Optional string value that identifies the portion of the list to be returned with the next list operation.

$include

string

Optional. Include this parameter to specify that the queue's metadata be returned as part of the response body. (allowed values: '', 'metadata')

$currentResultCount

integer

Current result count (internal use)

Exceptions

\Zend_Service_WindowsAzure_Exception

Returns

array

Peek queue messages

peekMessages(string $queueName = '', string $numOfMessages = 1) : array

Parameters

$queueName

string

Queue name

$numOfMessages

string

Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. By default, a single message is retrieved from the queue with this operation.

Exceptions

\Zend_Service_WindowsAzure_Exception

Returns

array

Put message into queue

putMessage(string $queueName = '', string $message = '', integer $ttl = null

Parameters

$queueName

string

Queue name

$message

string

Message

$ttl

integer

Message Time-To-Live (in seconds). Defaults to 7 days if the parameter is omitted.

Exceptions

\Zend_Service_WindowsAzure_Exception

Check if a queue exists

queueExists(string $queueName = '') : boolean

Parameters

$queueName

string

Queue name

Returns

boolean

Set Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance

setCredentials(\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract $credentials) 
Inherited

Parameters

$credentials

\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance to use for request signing.

Set the HTTP client channel to use

setHttpClientChannel(\Zend_Http_Client_Adapter_Interface|string $adapterInstance = 'Zend_Http_Client_Adapter_Proxy'
Inherited

Parameters

$adapterInstance

\Zend_Http_Client_Adapter_Interfacestring

Adapter instance or adapter class name.

Set proxy

setProxy(boolean $useProxy = false, string $proxyUrl = '', integer $proxyPort = 80, string $proxyCredentials = ''
Inherited

Parameters

$useProxy

boolean

Use proxy?

$proxyUrl

string

Proxy URL

$proxyPort

integer

Proxy port

$proxyCredentials

string

Proxy credentials

Set retry policy to use when making requests

setRetryPolicy(\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null
Inherited

Parameters

$retryPolicy

\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract

Retry policy to use when making requests

URL encode function

urlencode(string $value) : string
InheritedStatic

Parameters

$value

string

Value to encode

Returns

stringEncoded value

Generate metadata headers

_generateMetadataHeaders(array $metadata = array()) : \HTTP
Inherited

Parameters

$metadata

array

Returns

\HTTPheaders containing metadata

Get error message from Zend_Http_Response

_getErrorMessage(\Zend_Http_Response $response, string $alternativeError = 'Unknown error.') : string

Parameters

$response

\Zend_Http_Response

Repsonse

$alternativeError

string

Alternative error message

Returns

string

Parse metadata XML

_parseMetadataElement($element = null) : array
Inherited

Parameters

$element

Returns

array

Parse metadata headers

_parseMetadataHeaders(array $headers = array()) : array
Inherited

Parameters

$headers

array

HTTP headers containing metadata

Returns

array

Parse result from Zend_Http_Response

_parseResponse(\Zend_Http_Response $response = null) : object
Inherited

Parameters

$response

\Zend_Http_Response

Response from HTTP call

Exceptions

\Zend_Service_WindowsAzure_Exception

Returns

object

Perform request using Zend_Http_Client channel

_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
Inherited

Parameters

$path

string

Path

$queryString

string

Query string

$httpVerb

string

HTTP verb the request will use

$headers

array

x-ms headers to add

$forTableStorage

boolean

Is the request for table storage?

$rawData

mixed

Optional RAW HTTP data to be sent over the wire

$resourceType

string

Resource type

$requiredPermission

string

Required permission

Returns

\Zend_Http_Response

 Properties

 

Account key for Windows Azure

$_accountKey : string

Default

''
 

Account name for Windows Azure

$_accountName : string

Default

''
 

Current API version

$_apiVersion : string

Default

'2009-09-19'
 

Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance

$_credentials : \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

Default

null
 

Storage host name

$_host : string

Default

''
 

Zend_Http_Client channel used for communication with REST services

$_httpClientChannel : \Zend_Http_Client

Default

null
 

Proxy credentials

$_proxyCredentials : string

Default

''
 

Proxy port

$_proxyPort : integer

Default

80
 

Proxy url

$_proxyUrl : string

Default

''
 

Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract instance

$_retryPolicy : \Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract

Default

null
 

Use path-style URI's

$_usePathStyleUri : boolean

Default

false
 

Use proxy?

$_useProxy : boolean

Default

false

 Constants

 

Maximal message size (in bytes)

MAX_MESSAGE_SIZE = 8388608 
 

Maximal message ttl (in seconds)

MAX_MESSAGE_TTL = 604800 
   

HTTP header prefixes

PREFIX_PROPERTIES = "x-ms-prop-" 
 

PREFIX_STORAGE_HEADER

PREFIX_STORAGE_HEADER = "x-ms-" 
 

RESOURCE_BLOB

RESOURCE_BLOB = "b" 
 

RESOURCE_CONTAINER

RESOURCE_CONTAINER = "c" 
 

RESOURCE_ENTITY

RESOURCE_ENTITY = "e" 
 

RESOURCE_QUEUE

RESOURCE_QUEUE = "q" 
 

RESOURCE_TABLE

RESOURCE_TABLE = "t" 
 

Resource types

RESOURCE_UNKNOWN = "unknown" 
 

Live storage URLS

URL_CLOUD_BLOB = "blob.core.windows.net" 
 

URL_CLOUD_QUEUE

URL_CLOUD_QUEUE = "queue.core.windows.net" 
 

URL_CLOUD_TABLE

URL_CLOUD_TABLE = "table.core.windows.net" 
 

Development storage URLS

URL_DEV_BLOB = "127.0.0.1:10000" 
 

URL_DEV_QUEUE

URL_DEV_QUEUE = "127.0.0.1:10001" 
 

URL_DEV_TABLE

URL_DEV_TABLE = "127.0.0.1:10002"