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_BatchStorageAbstract

 Methods

Creates a new Zend_Service_WindowsAzure_Storage_Table instance

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

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

Builds a query string from an array of elements

createQueryStringFromArray($queryString) : string
InheritedStatic

Parameters

$queryString

Returns

stringAssembled query string

Create table

createTable(string $tableName = '') : \Zend_Service_WindowsAzure_Storage_TableInstance

Parameters

$tableName

string

Table name

Exceptions

\Zend_Service_WindowsAzure_Exception

Returns

\Zend_Service_WindowsAzure_Storage_TableInstance

Create table if it does not exist

createTableIfNotExists(string $tableName = ''

Parameters

$tableName

string

Table name

Exceptions

\Zend_Service_WindowsAzure_Exception

Delete entity from table

deleteEntity(string $tableName = '', \Zend_Service_WindowsAzure_Storage_TableEntity $entity = null, boolean $verifyEtag = false

Parameters

$tableName

string

Table name

$entity

\Zend_Service_WindowsAzure_Storage_TableEntity

Entity to delete

$verifyEtag

boolean

Verify etag of the entity (used for concurrency)

Exceptions

\Zend_Service_WindowsAzure_Exception

Delete table

deleteTable(string $tableName = ''

Parameters

$tableName

string

Table 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

Get current batch

getCurrentBatch() : \Zend_Service_WindowsAzure_Storage_Batch
Inherited

Returns

\Zend_Service_WindowsAzure_Storage_Batch

Retrieve HTTP client channel

getHttpClientChannel() : \Zend_Http_Client_Adapter_Interface
Inherited

Returns

\Zend_Http_Client_Adapter_Interface

Throw Zend_Service_WindowsAzure_Exception when a property is not specified in Windows Azure?

getThrowExceptionOnMissingData() 

Insert entity into table

insertEntity(string $tableName = '', \Zend_Service_WindowsAzure_Storage_TableEntity $entity = null) : \Zend_Service_WindowsAzure_Storage_TableEntity

Parameters

$tableName

string

Table name

$entity

\Zend_Service_WindowsAzure_Storage_TableEntity

Entity to insert

Exceptions

\Zend_Service_WindowsAzure_Exception

Returns

\Zend_Service_WindowsAzure_Storage_TableEntity

Is there a current batch?

isInBatch() : boolean
Inherited

Returns

boolean

Is valid metadata name?

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

Parameters

$metadataName

string

Metadata 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 tables

listTables(string $nextTableName = '') : array

Parameters

$nextTableName

string

Next table name, used for listing tables when total amount of tables is > 1000.

Exceptions

\Zend_Service_WindowsAzure_Exception

Returns

array

Update entity by adding or updating properties

mergeEntity(string $tableName = '', \Zend_Service_WindowsAzure_Storage_TableEntity $entity = null, boolean $verifyEtag = false, array $properties = array()

Parameters

$tableName

string

Table name

$entity

\Zend_Service_WindowsAzure_Storage_TableEntity

Entity to update

$verifyEtag

boolean

Verify etag of the entity (used for concurrency)

$properties

array

Properties to merge. All properties will be used when omitted.

Exceptions

\Zend_Service_WindowsAzure_Exception

Perform batch using Zend_Http_Client channel, combining all batch operations into one request

performBatch(array $operations = array(), boolean $forTableStorage = false, boolean $isSingleSelect = false, string $resourceType = \Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN, string $requiredPermission = \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ) : \Zend_Http_Response
Inherited

Parameters

$operations

array

Operations in batch

$forTableStorage

boolean

Is the request for table storage?

$isSingleSelect

boolean

Is the request a single select statement?

$resourceType

string

Resource type

$requiredPermission

string

Required permission

Returns

\Zend_Http_Response

Retrieve entities from table

retrieveEntities($tableName = '', string $filter = '', string $entityClass = 'Zend_Service_WindowsAzure_Storage_DynamicTableEntity', string $nextPartitionKey = null, string $nextRowKey = null) : array

Parameters

$tableName

$filter

string

Filter condition (not applied when $tableName is a Zend_Service_WindowsAzure_Storage_TableEntityQuery instance)

$entityClass

string

Entity class name

$nextPartitionKey

string

Next partition key, used for listing entities when total amount of entities is > 1000.

$nextRowKey

string

Next row key, used for listing entities when total amount of entities is > 1000.

Exceptions

\Zend_Service_WindowsAzure_Exception

Returns

arrayArray of Zend_Service_WindowsAzure_Storage_TableEntity

Retrieve entity from table, by id

retrieveEntityById(string $tableName, string $partitionKey, string $rowKey, string $entityClass = 'Zend_Service_WindowsAzure_Storage_DynamicTableEntity') : \Zend_Service_WindowsAzure_Storage_TableEntity

Parameters

$tableName

string

Table name

$partitionKey

string

Partition key

$rowKey

string

Row key

$entityClass

string

Entity class name*

Exceptions

\Zend_Service_WindowsAzure_Exception

Returns

\Zend_Service_WindowsAzure_Storage_TableEntity

Create a new Zend_Service_WindowsAzure_Storage_TableEntityQuery

select() : \Zend_Service_WindowsAzure_Storage_TableEntityQuery

Returns

\Zend_Service_WindowsAzure_Storage_TableEntityQuery

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 current batch

setCurrentBatch(\Zend_Service_WindowsAzure_Storage_Batch $batch = null
Inherited

Parameters

$batch

\Zend_Service_WindowsAzure_Storage_Batch

Current batch

Exceptions

\Zend_Service_WindowsAzure_Exception

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

Throw Zend_Service_WindowsAzure_Exception when a property is not specified in Windows Azure? Defaults to true, making behaviour similar to Windows Azure StorageClient in .NET.

setThrowExceptionOnMissingData(boolean $value = true

Parameters

$value

boolean

Starts a new batch operation set

startBatch() : \Zend_Service_WindowsAzure_Storage_Batch
Inherited

Exceptions

\Zend_Service_WindowsAzure_Exception

Returns

\Zend_Service_WindowsAzure_Storage_Batch

Check if a table exists

tableExists(string $tableName = '') : boolean

Parameters

$tableName

string

Table name

Returns

boolean

Update entity by replacing it

updateEntity(string $tableName = '', \Zend_Service_WindowsAzure_Storage_TableEntity $entity = null, boolean $verifyEtag = false

Parameters

$tableName

string

Table name

$entity

\Zend_Service_WindowsAzure_Storage_TableEntity

Entity to update

$verifyEtag

boolean

Verify etag of the entity (used for concurrency)

Exceptions

\Zend_Service_WindowsAzure_Exception

URL encode function

urlencode(string $value) : string
InheritedStatic

Parameters

$value

string

Value to encode

Returns

stringEncoded value

Update entity / merge entity

_changeEntity(string $httpVerb = \Zend_Http_Client::PUT, string $tableName = '', \Zend_Service_WindowsAzure_Storage_TableEntity $entity = null, boolean $verifyEtag = false

Parameters

$httpVerb

string

HTTP verb to use (PUT = update, MERGE = merge)

$tableName

string

Table name

$entity

\Zend_Service_WindowsAzure_Storage_TableEntity

Entity to update

$verifyEtag

boolean

Verify etag of the entity (used for concurrency)

Exceptions

\Zend_Service_WindowsAzure_Exception

Converts a string to a DateTime object. Returns false on failure.

_convertToDateTime(string $value = '') : \DateTime | boolean

Parameters

$value

string

The string value to parse

Returns

\DateTimeboolean

Converts a DateTime object into an Edm.DaeTime value in UTC timezone, represented as a string.

_convertToEdmDateTime(\DateTime $value) : string

Parameters

$value

\DateTime

Returns

string

Fill text template with variables from key/value array

_fillTemplate(string $templateText, array $variables = array()) : string

Parameters

$templateText

string

Template text

$variables

array

Array containing key/value pairs

Returns

string

Generate Azure representation from entity (creates atompub markup from properties)

_generateAzureRepresentation(\Zend_Service_WindowsAzure_Storage_TableEntity $entity = null) : string

Parameters

$entity

\Zend_Service_WindowsAzure_Storage_TableEntity

Returns

string

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

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

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

Generate RFC 1123 compliant date string

_rfcDate() : string

Returns

string

 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
 

Current batch

$_currentBatch : \Zend_Service_WindowsAzure_Storage_Batch

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
 

Throw Zend_Service_WindowsAzure_Exception when a property is not specified in Windows Azure? Defaults to true, making behaviour similar to Windows Azure StorageClient in .NET.

$_throwExceptionOnMissingData : boolean

Default

true
 

Use path-style URI's

$_usePathStyleUri : boolean

Default

false
 

Use proxy?

$_useProxy : boolean

Default

false

 Constants

   

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"