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_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() |
---|
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
clearMessages(string $queueName = ''
)
string
Queue name
\Zend_Service_WindowsAzure_Exception |
---|
createQueryStringFromArray($queryString) : string
string
Assembled query stringcreateQueue(string $queueName= ''
, array $metadata= array()
) : object
string
Queue name
array
Key/value pairs of meta data
\Zend_Service_WindowsAzure_Exception |
---|
object
Queue propertiescreateQueueIfNotExists(string $queueName= ''
, array $metadata= array()
)
string
Queue name
array
Key/value pairs of meta data
\Zend_Service_WindowsAzure_Exception |
---|
deleteMessage(string $queueName = ''
, \Zend_Service_WindowsAzure_Storage_QueueMessage $message)
string
Queue name
\Zend_Service_WindowsAzure_Storage_QueueMessage
Message to delete from queue. A message retrieved using "peekMessages" can NOT be deleted!
\Zend_Service_WindowsAzure_Exception |
---|
deleteQueue(string $queueName = ''
)
string
Queue name
\Zend_Service_WindowsAzure_Exception |
---|
getAccountName() : string
string
getBaseUrl() : string
string
getCredentials() : \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
getHttpClientChannel() : \Zend_Http_Client_Adapter_Interface
\Zend_Http_Client_Adapter_Interface
getMessages(string $queueName= ''
, string $numOfMessages= 1
, integer $visibilityTimeout= null
, string $peek= false
) : array
string
Queue name
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.
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.
string
Peek only?
\Zend_Service_WindowsAzure_Exception |
---|
array
getQueue(string $queueName = ''
) : \Zend_Service_WindowsAzure_Storage_QueueInstance
string
Queue name
\Zend_Service_WindowsAzure_Exception |
---|
\Zend_Service_WindowsAzure_Storage_QueueInstance
getQueueMetadata(string $queueName = ''
) : array
string
Queue name
\Zend_Service_WindowsAzure_Exception |
---|
array
Key/value pairs of meta datahasMessages(string $queueName = ''
) : boolean
string
Queue name
\Zend_Service_WindowsAzure_Exception |
---|
boolean
isValidMetadataName(string $metadataName = ''
) : boolean
string
Metadata name
boolean
isValidQueueName(string $queueName = ''
) : boolean
string
Queue name
boolean
isoDate(integer $timestamp = null
) : string
integer
string
listQueues(string $prefix= null
, integer $maxResults= null
, string $marker= null
, string $include= null
, integer $currentResultCount= 0
) : array
string
Optional. Filters the results to return only queues whose name begins with the specified prefix.
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)
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 queue's metadata be returned as part of the response body. (allowed values: '', 'metadata')
integer
Current result count (internal use)
\Zend_Service_WindowsAzure_Exception |
---|
array
peekMessages(string $queueName= ''
, string $numOfMessages= 1
) : array
string
Queue name
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.
\Zend_Service_WindowsAzure_Exception |
---|
array
putMessage(string $queueName= ''
, string $message= ''
, integer $ttl= null
)
string
Queue name
string
Message
integer
Message Time-To-Live (in seconds). Defaults to 7 days if the parameter is omitted.
\Zend_Service_WindowsAzure_Exception |
---|
queueExists(string $queueName = ''
) : boolean
string
Queue name
boolean
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
setQueueMetadata(string $queueName= ''
, array $metadata= array()
)
Calling the Set Queue Metadata operation overwrites all existing metadata that is associated with the queue. It's not possible to modify an individual name/value pair.
string
Queue name
array
Key/value pairs of meta data
\Zend_Service_WindowsAzure_Exception |
---|
setRetryPolicy(\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null
)
\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract
Retry policy to use when making requests
urlencode(string $value) : string
string
Value to encode
string
Encoded value_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
$_usePathStyleUri : boolean
false
$_useProxy : boolean
false
MAX_MESSAGE_SIZE = 8388608
MAX_MESSAGE_TTL = 604800
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"