Service/WindowsAzure/Storage/Queue.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
name_todo  
Package
Zend_Service_WindowsAzure  
Subpackage
Storage  
Version
$Id: Queue.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Service_WindowsAzure_Storage_Queue

Package: Zend\Service\WindowsAzure\Storage
Parent(s)
\Zend_Service_WindowsAzure_Storage
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  MAX_MESSAGE_SIZE = 8388608
Maximal message size (in bytes)
>VConstant  MAX_MESSAGE_TTL = 604800
Maximal message ttl (in seconds)
>VConstant  URL_DEV_BLOB = "127.0.0.1:10000"
inherited
Development storage URLS
Inherited from: \Zend_Service_WindowsAzure_Storage::URL_DEV_BLOB
>VConstant  URL_DEV_QUEUE = "127.0.0.1:10001"
>VConstant  URL_DEV_TABLE = "127.0.0.1:10002"
>VConstant  URL_CLOUD_BLOB = "blob.core.windows.net"
inherited
Live storage URLS
Inherited from: \Zend_Service_WindowsAzure_Storage::URL_CLOUD_BLOB
>VConstant  URL_CLOUD_QUEUE = "queue.core.windows.net"
>VConstant  URL_CLOUD_TABLE = "table.core.windows.net"
>VConstant  RESOURCE_UNKNOWN = "unknown"
inherited
Resource types
Inherited from: \Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN
>VConstant  PREFIX_PROPERTIES = "x-ms-prop-"
inherited
HTTP header prefixes
Inherited from: \Zend_Service_WindowsAzure_Storage::PREFIX_PROPERTIES
>VConstant  PREFIX_METADATA = "x-ms-meta-"
>VConstant  PREFIX_STORAGE_HEADER = "x-ms-"

Properties

>VPropertyprotectedstring $_accountKey = ''
inherited
Account key for Windows Azure
Inherited from: \Zend_Service_WindowsAzure_Storage::$$_accountKey
Default value''Details
Type
string
Inherited_from
\Zend_Service_WindowsAzure_Storage::$$_accountKey  
>VPropertyprotectedstring $_accountName = ''
inherited
Account name for Windows Azure
Inherited from: \Zend_Service_WindowsAzure_Storage::$$_accountName
Default value''Details
Type
string
Inherited_from
\Zend_Service_WindowsAzure_Storage::$$_accountName  
>VPropertyprotectedstring $_apiVersion = '2009-09-19'
inherited
Current API version
Inherited from: \Zend_Service_WindowsAzure_Storage::$$_apiVersion
Default value'2009-09-19'Details
Type
string
Inherited_from
\Zend_Service_WindowsAzure_Storage::$$_apiVersion  
>VPropertyprotected\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract $_credentials = null
inherited
Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance
Inherited from: \Zend_Service_WindowsAzure_Storage::$$_credentials
>VPropertyprotectedstring $_host = ''
inherited
Storage host name
Inherited from: \Zend_Service_WindowsAzure_Storage::$$_host
Default value''Details
Type
string
Inherited_from
\Zend_Service_WindowsAzure_Storage::$$_host  
>VPropertyprotected\Zend_Http_Client $_httpClientChannel = null
inherited
Zend_Http_Client channel used for communication with REST services
Inherited from: \Zend_Service_WindowsAzure_Storage::$$_httpClientChannel
>VPropertyprotectedstring $_proxyCredentials = ''
inherited
Proxy credentials
Inherited from: \Zend_Service_WindowsAzure_Storage::$$_proxyCredentials
Default value''Details
Type
string
Inherited_from
\Zend_Service_WindowsAzure_Storage::$$_proxyCredentials  
>VPropertyprotectedint $_proxyPort = 80
inherited
Proxy port
Inherited from: \Zend_Service_WindowsAzure_Storage::$$_proxyPort
Default value80Details
Type
int
Inherited_from
\Zend_Service_WindowsAzure_Storage::$$_proxyPort  
>VPropertyprotectedstring $_proxyUrl = ''
inherited
Proxy url
Inherited from: \Zend_Service_WindowsAzure_Storage::$$_proxyUrl
Default value''Details
Type
string
Inherited_from
\Zend_Service_WindowsAzure_Storage::$$_proxyUrl  
>VPropertyprotected\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $_retryPolicy = null
inherited
Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract instance
Inherited from: \Zend_Service_WindowsAzure_Storage::$$_retryPolicy
>VPropertyprotectedboolean $_usePathStyleUri = false
inherited
Use path-style URI's
Inherited from: \Zend_Service_WindowsAzure_Storage::$$_usePathStyleUri
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Service_WindowsAzure_Storage::$$_usePathStyleUri  
>VPropertyprotectedboolean $_useProxy = false
inherited
Use proxy?
Inherited from: \Zend_Service_WindowsAzure_Storage::$$_useProxy
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Service_WindowsAzure_Storage::$$_useProxy  

Methods

methodpublic__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) : void

Creates a new Zend_Service_WindowsAzure_Storage_Queue instance

Parameters
NameTypeDescription
$hoststring

Storage host name

$accountNamestring

Account name for Windows Azure

$accountKeystring

Account key for Windows Azure

$usePathStyleUriboolean

Use path-style URI's

$retryPolicy\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract

Retry policy to use when making requests

methodprotected_generateMetadataHeaders(array $metadata = array()) : \HTTP
inherited

Generate metadata headers

Inherited from: \Zend_Service_WindowsAzure_Storage::_generateMetadataHeaders()
Parameters
NameTypeDescription
$metadataarray
Returns
TypeDescription
\HTTPheaders containing metadata
methodprotected_getErrorMessage(\Zend_Http_Response $response, string $alternativeError = 'Unknown error.') : string

Get error message from Zend_Http_Response

Parameters
NameTypeDescription
$response\Zend_Http_Response

Repsonse

$alternativeErrorstring

Alternative error message

Returns
TypeDescription
string
methodprotected_parseMetadataElement( $element = null) : array
inherited

Parse metadata XML

Inherited from: \Zend_Service_WindowsAzure_Storage::_parseMetadataElement()
Parameters
NameTypeDescription
$element
Returns
TypeDescription
array
methodprotected_parseMetadataHeaders(array $headers = array()) : array
inherited

Parse metadata headers

Inherited from: \Zend_Service_WindowsAzure_Storage::_parseMetadataHeaders()
Parameters
NameTypeDescription
$headersarray

HTTP headers containing metadata

Returns
TypeDescription
array
methodprotected_parseResponse(\Zend_Http_Response $response = null) : object
inherited

Parse result from Zend_Http_Response

Inherited from: \Zend_Service_WindowsAzure_Storage::_parseResponse()
Parameters
NameTypeDescription
$response\Zend_Http_Response

Response from HTTP call

Returns
TypeDescription
object
Throws
ExceptionDescription
\Zend_Service_WindowsAzure_Exception
methodprotected_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

Perform request using Zend_Http_Client channel

Inherited from: \Zend_Service_WindowsAzure_Storage::_performRequest()
Parameters
NameTypeDescription
$pathstring

Path

$queryStringstring

Query string

$httpVerbstring

HTTP verb the request will use

$headersarray

x-ms headers to add

$forTableStorageboolean

Is the request for table storage?

$rawDatamixed

Optional RAW HTTP data to be sent over the wire

$resourceTypestring

Resource type

$requiredPermissionstring

Required permission

Returns
TypeDescription
\Zend_Http_Response
methodpublicclearMessages(string $queueName = '') : void

Clear queue messages

Parameters
NameTypeDescription
$queueNamestring

Queue name

Throws
ExceptionDescription
\Zend_Service_WindowsAzure_Exception
methodpubliccreateQueryStringFromArray(array $queryString) : string
staticinherited

Builds a query string from an array of elements

Inherited from: \Zend_Service_WindowsAzure_Storage::createQueryStringFromArray()
Parameters
NameTypeDescription
$queryStringarray

Array of elements

Returns
TypeDescription
stringAssembled query string
methodpubliccreateQueue(string $queueName = '', array $metadata = array()) : object

Create queue

Parameters
NameTypeDescription
$queueNamestring

Queue name

$metadataarray

Key/value pairs of meta data

Returns
TypeDescription
objectQueue properties
Throws
ExceptionDescription
\Zend_Service_WindowsAzure_Exception
methodpubliccreateQueueIfNotExists(string $queueName = '', array $metadata = array()) : void

Create queue if it does not exist

Parameters
NameTypeDescription
$queueNamestring

Queue name

$metadataarray

Key/value pairs of meta data

Throws
ExceptionDescription
\Zend_Service_WindowsAzure_Exception
methodpublicdeleteMessage(string $queueName = '', \Zend_Service_WindowsAzure_Storage_QueueMessage $message) : void

Delete queue message

Parameters
NameTypeDescription
$queueNamestring

Queue name

$message\Zend_Service_WindowsAzure_Storage_QueueMessage

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

Throws
ExceptionDescription
\Zend_Service_WindowsAzure_Exception
methodpublicdeleteQueue(string $queueName = '') : void

Delete queue

Parameters
NameTypeDescription
$queueNamestring

Queue name

Throws
ExceptionDescription
\Zend_Service_WindowsAzure_Exception
methodpublicgetAccountName() : string
inherited

Returns the Windows Azure account name

Inherited from: \Zend_Service_WindowsAzure_Storage::getAccountName()
Returns
TypeDescription
string
methodpublicgetBaseUrl() : string
inherited

Get base URL for creating requests

Inherited from: \Zend_Service_WindowsAzure_Storage::getBaseUrl()
Returns
TypeDescription
string
methodpublicgetCredentials() : \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
inherited

Get Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance

Inherited from: \Zend_Service_WindowsAzure_Storage::getCredentials()
methodpublicgetHttpClientChannel() : \Zend_Http_Client_Adapter_Interface
inherited

Retrieve HTTP client channel

Inherited from: \Zend_Service_WindowsAzure_Storage::getHttpClientChannel()
methodpublicgetMessages(string $queueName = '', string $numOfMessages = 1, int $visibilityTimeout = null, string $peek = false) : array

Get queue messages

Parameters
NameTypeDescription
$queueNamestring

Queue name

$numOfMessagesstring

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.

$visibilityTimeoutint

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.

$peekstring

Peek only?

Returns
TypeDescription
array
Throws
ExceptionDescription
\Zend_Service_WindowsAzure_Exception
methodpublicgetQueue(string $queueName = '') : \Zend_Service_WindowsAzure_Storage_QueueInstance

Get queue

Parameters
NameTypeDescription
$queueNamestring

Queue name

Returns
TypeDescription
\Zend_Service_WindowsAzure_Storage_QueueInstance
Throws
ExceptionDescription
\Zend_Service_WindowsAzure_Exception
methodpublicgetQueueMetadata(string $queueName = '') : array

Get queue metadata

Parameters
NameTypeDescription
$queueNamestring

Queue name

Returns
TypeDescription
arrayKey/value pairs of meta data
Throws
ExceptionDescription
\Zend_Service_WindowsAzure_Exception
methodpublichasMessages(string $queueName = '') : boolean

Checks to see if a given queue has messages

Parameters
NameTypeDescription
$queueNamestring

Queue name

Returns
TypeDescription
boolean
Throws
ExceptionDescription
\Zend_Service_WindowsAzure_Exception
methodpublicisValidMetadataName(string $metadataName = '') : boolean
staticinherited

Is valid metadata name?

Inherited from: \Zend_Service_WindowsAzure_Storage::isValidMetadataName()
Parameters
NameTypeDescription
$metadataNamestring

Metadata name

Returns
TypeDescription
boolean
methodpublicisValidQueueName(string $queueName = '') : boolean
static

Is valid queue name?

Parameters
NameTypeDescription
$queueNamestring

Queue name

Returns
TypeDescription
boolean
methodpublicisoDate(int $timestamp = null) : string
inherited

Generate ISO 8601 compliant date string in UTC time zone

Inherited from: \Zend_Service_WindowsAzure_Storage::isoDate()
Parameters
NameTypeDescription
$timestampint
Returns
TypeDescription
string
methodpubliclistQueues(string $prefix = null, int $maxResults = null, string $marker = null, string $include = null, int $currentResultCount = 0) : array

List queues

Parameters
NameTypeDescription
$prefixstring

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

$maxResultsint

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)

$markerstring

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

$includestring

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

$currentResultCountint

Current result count (internal use)

Returns
TypeDescription
array
Throws
ExceptionDescription
\Zend_Service_WindowsAzure_Exception
methodpublicpeekMessages(string $queueName = '', string $numOfMessages = 1) : array

Peek queue messages

Parameters
NameTypeDescription
$queueNamestring

Queue name

$numOfMessagesstring

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.

Returns
TypeDescription
array
Throws
ExceptionDescription
\Zend_Service_WindowsAzure_Exception
methodpublicputMessage(string $queueName = '', string $message = '', int $ttl = null) : void

Put message into queue

Parameters
NameTypeDescription
$queueNamestring

Queue name

$messagestring

Message

$ttlint

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

Throws
ExceptionDescription
\Zend_Service_WindowsAzure_Exception
methodpublicqueueExists(string $queueName = '') : boolean

Check if a queue exists

Parameters
NameTypeDescription
$queueNamestring

Queue name

Returns
TypeDescription
boolean
methodpublicsetCredentials(\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract $credentials) : void
inherited

Set Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance

Inherited from: \Zend_Service_WindowsAzure_Storage::setCredentials()
Parameters
NameTypeDescription
$credentials\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance to use for request signing.

methodpublicsetHttpClientChannel(\Zend_Http_Client_Adapter_Interface | string $adapterInstance = 'Zend_Http_Client_Adapter_Proxy') : void
inherited

Set the HTTP client channel to use

Inherited from: \Zend_Service_WindowsAzure_Storage::setHttpClientChannel()
Parameters
NameTypeDescription
$adapterInstance\Zend_Http_Client_Adapter_Interface | string

Adapter instance or adapter class name.

methodpublicsetProxy(boolean $useProxy = false, string $proxyUrl = '', int $proxyPort = 80, string $proxyCredentials = '') : void
inherited

Set proxy

Inherited from: \Zend_Service_WindowsAzure_Storage::setProxy()
Parameters
NameTypeDescription
$useProxyboolean

Use proxy?

$proxyUrlstring

Proxy URL

$proxyPortint

Proxy port

$proxyCredentialsstring

Proxy credentials

methodpublicsetQueueMetadata(string $queueName = '', array $metadata = array()) : void

Set queue metadata

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.

Parameters
NameTypeDescription
$queueNamestring

Queue name

$metadataarray

Key/value pairs of meta data

Throws
ExceptionDescription
\Zend_Service_WindowsAzure_Exception
methodpublicsetRetryPolicy(\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null) : void
inherited

Set retry policy to use when making requests

Inherited from: \Zend_Service_WindowsAzure_Storage::setRetryPolicy()
Parameters
NameTypeDescription
$retryPolicy\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract

Retry policy to use when making requests

methodpublicurlencode(string $value) : string
staticinherited

URL encode function

Inherited from: \Zend_Service_WindowsAzure_Storage::urlencode()
Parameters
NameTypeDescription
$valuestring

Value to encode

Returns
TypeDescription
stringEncoded value
Documentation was generated by phpDocumentor 2.0.0a12.