Service/WindowsAzure/Storage/Table.php

Show:

inherited

Classes
- \Zend_Service_WindowsAzure_Storage_Table

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: New BSD License
Package: Zend_Service_WindowsAzure
Subpackage: Storage
Version: $Id: Table.php 24697 2012-03-23 13:11:04Z ezimuel $

\Zend_Service_WindowsAzure_Storage_Table
jump to top

Package: Zend\Service\WindowsAzure\Storage

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

Constants

 
                URL_DEV_BLOB
                = "127.0.0.1:10000"

inherited

Development storage URLS

Inherited from: \Zend_Service_WindowsAzure_Storage::URL_DEV_BLOB \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::URL_DEV_BLOB

Inherited_from: \Zend_Service_WindowsAzure_Storage::URL_DEV_BLOB
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::URL_DEV_BLOB

 
                URL_DEV_QUEUE
                = "127.0.0.1:10001"

inheritedInherited from: \Zend_Service_WindowsAzure_Storage::URL_DEV_QUEUE \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::URL_DEV_QUEUE

Inherited_from: \Zend_Service_WindowsAzure_Storage::URL_DEV_QUEUE
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::URL_DEV_QUEUE

 
                URL_DEV_TABLE
                = "127.0.0.1:10002"

inheritedInherited from: \Zend_Service_WindowsAzure_Storage::URL_DEV_TABLE \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::URL_DEV_TABLE

Inherited_from: \Zend_Service_WindowsAzure_Storage::URL_DEV_TABLE
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::URL_DEV_TABLE

 
                URL_CLOUD_BLOB
                = "blob.core.windows.net"

inherited

Live storage URLS

Inherited from: \Zend_Service_WindowsAzure_Storage::URL_CLOUD_BLOB \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::URL_CLOUD_BLOB

Inherited_from: \Zend_Service_WindowsAzure_Storage::URL_CLOUD_BLOB
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::URL_CLOUD_BLOB

 
                URL_CLOUD_QUEUE
                = "queue.core.windows.net"

inheritedInherited from: \Zend_Service_WindowsAzure_Storage::URL_CLOUD_QUEUE \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::URL_CLOUD_QUEUE

Inherited_from: \Zend_Service_WindowsAzure_Storage::URL_CLOUD_QUEUE
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::URL_CLOUD_QUEUE

 
                URL_CLOUD_TABLE
                = "table.core.windows.net"

inheritedInherited from: \Zend_Service_WindowsAzure_Storage::URL_CLOUD_TABLE \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::URL_CLOUD_TABLE

Inherited_from: \Zend_Service_WindowsAzure_Storage::URL_CLOUD_TABLE
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::URL_CLOUD_TABLE

 
                RESOURCE_UNKNOWN
                = "unknown"

inherited

Resource types

Inherited from: \Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::RESOURCE_UNKNOWN

Inherited_from: \Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::RESOURCE_UNKNOWN

 
                RESOURCE_CONTAINER
                = "c"

inheritedInherited from: \Zend_Service_WindowsAzure_Storage::RESOURCE_CONTAINER \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::RESOURCE_CONTAINER

Inherited_from: \Zend_Service_WindowsAzure_Storage::RESOURCE_CONTAINER
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::RESOURCE_CONTAINER

 
                RESOURCE_BLOB
                = "b"

inheritedInherited from: \Zend_Service_WindowsAzure_Storage::RESOURCE_BLOB \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::RESOURCE_BLOB

Inherited_from: \Zend_Service_WindowsAzure_Storage::RESOURCE_BLOB
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::RESOURCE_BLOB

 
                RESOURCE_TABLE
                = "t"

inheritedInherited from: \Zend_Service_WindowsAzure_Storage::RESOURCE_TABLE \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::RESOURCE_TABLE

Inherited_from: \Zend_Service_WindowsAzure_Storage::RESOURCE_TABLE
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::RESOURCE_TABLE

 
                RESOURCE_ENTITY
                = "e"

inheritedInherited from: \Zend_Service_WindowsAzure_Storage::RESOURCE_ENTITY \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::RESOURCE_ENTITY

Inherited_from: \Zend_Service_WindowsAzure_Storage::RESOURCE_ENTITY
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::RESOURCE_ENTITY

 
                RESOURCE_QUEUE
                = "q"

inheritedInherited from: \Zend_Service_WindowsAzure_Storage::RESOURCE_QUEUE \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::RESOURCE_QUEUE

Inherited_from: \Zend_Service_WindowsAzure_Storage::RESOURCE_QUEUE
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::RESOURCE_QUEUE

 
                PREFIX_PROPERTIES
                = "x-ms-prop-"

inherited

HTTP header prefixes

Inherited from: \Zend_Service_WindowsAzure_Storage::PREFIX_PROPERTIES \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::PREFIX_PROPERTIES

Inherited_from: \Zend_Service_WindowsAzure_Storage::PREFIX_PROPERTIES
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::PREFIX_PROPERTIES

 
                PREFIX_METADATA
                = "x-ms-meta-"

inheritedInherited from: \Zend_Service_WindowsAzure_Storage::PREFIX_METADATA \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::PREFIX_METADATA

Inherited_from: \Zend_Service_WindowsAzure_Storage::PREFIX_METADATA
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::PREFIX_METADATA

 
                PREFIX_STORAGE_HEADER
                = "x-ms-"

inheritedInherited from: \Zend_Service_WindowsAzure_Storage::PREFIX_STORAGE_HEADER \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::PREFIX_STORAGE_HEADER

Inherited_from: \Zend_Service_WindowsAzure_Storage::PREFIX_STORAGE_HEADER
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::PREFIX_STORAGE_HEADER

Properties

string $_accountKey = ''

inherited

Account key for Windows Azure

Inherited from: \Zend_Service_WindowsAzure_Storage::$$_accountKey \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_accountKey

Default value''Details

Type: string
Inherited_from: \Zend_Service_WindowsAzure_Storage::$$_accountKey
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_accountKey

string $_accountName = ''

inherited

Account name for Windows Azure

Inherited from: \Zend_Service_WindowsAzure_Storage::$$_accountName \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_accountName

Default value''Details

Type: string
Inherited_from: \Zend_Service_WindowsAzure_Storage::$$_accountName
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_accountName

string $_apiVersion = '2009-09-19'

inherited

Current API version

Inherited from: \Zend_Service_WindowsAzure_Storage::$$_apiVersion \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_apiVersion

Default value'2009-09-19'Details

Type: string
Inherited_from: \Zend_Service_WindowsAzure_Storage::$$_apiVersion
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_apiVersion

\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract $_credentials = null

inherited

Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance

Inherited from: \Zend_Service_WindowsAzure_Storage::$$_credentials \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_credentials

Default valuenullDetails

Type: \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
Inherited_from: \Zend_Service_WindowsAzure_Storage::$$_credentials
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_credentials

\Zend_Service_WindowsAzure_Storage_Batch $_currentBatch = null

inherited

Current batch

Inherited from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_currentBatch

Default valuenullDetails

Type: \Zend_Service_WindowsAzure_Storage_Batch
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_currentBatch

string $_host = ''

inherited

Storage host name

Inherited from: \Zend_Service_WindowsAzure_Storage::$$_host \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_host

Default value''Details

Type: string
Inherited_from: \Zend_Service_WindowsAzure_Storage::$$_host
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_host

\Zend_Http_Client $_httpClientChannel = null

inherited

Zend_Http_Client channel used for communication with REST services

Inherited from: \Zend_Service_WindowsAzure_Storage::$$_httpClientChannel \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_httpClientChannel

Default valuenullDetails

Type: \Zend_Http_Client
Inherited_from: \Zend_Service_WindowsAzure_Storage::$$_httpClientChannel
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_httpClientChannel

string $_proxyCredentials = ''

inherited

Proxy credentials

Inherited from: \Zend_Service_WindowsAzure_Storage::$$_proxyCredentials \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_proxyCredentials

Default value''Details

Type: string
Inherited_from: \Zend_Service_WindowsAzure_Storage::$$_proxyCredentials
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_proxyCredentials

int $_proxyPort = 80

inherited

Proxy port

Inherited from: \Zend_Service_WindowsAzure_Storage::$$_proxyPort \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_proxyPort

Default value80Details

Type: int
Inherited_from: \Zend_Service_WindowsAzure_Storage::$$_proxyPort
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_proxyPort

string $_proxyUrl = ''

inherited

Proxy url

Inherited from: \Zend_Service_WindowsAzure_Storage::$$_proxyUrl \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_proxyUrl

Default value''Details

Type: string
Inherited_from: \Zend_Service_WindowsAzure_Storage::$$_proxyUrl
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_proxyUrl

\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $_retryPolicy = null

inherited

Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract instance

Inherited from: \Zend_Service_WindowsAzure_Storage::$$_retryPolicy \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_retryPolicy

Default valuenullDetails

Type: \Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract
Inherited_from: \Zend_Service_WindowsAzure_Storage::$$_retryPolicy
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_retryPolicy

boolean $_throwExceptionOnMissingData = true

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.

Default valuetrueDetails

Type: boolean

boolean $_usePathStyleUri = false

inherited

Use path-style URI's

Inherited from: \Zend_Service_WindowsAzure_Storage::$$_usePathStyleUri \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_usePathStyleUri

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Service_WindowsAzure_Storage::$$_usePathStyleUri
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_usePathStyleUri

boolean $_useProxy = false

inherited

Use proxy?

Inherited from: \Zend_Service_WindowsAzure_Storage::$$_useProxy \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_useProxy

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Service_WindowsAzure_Storage::$$_useProxy
Inherited_from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::$$_useProxy

Methods

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

Creates a new Zend_Service_WindowsAzure_Storage_Table instance

Parameters

Name	Type	Description
$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

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

Update entity / merge entity

Parameters

Name	Type	Description
$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)

Throws

Exception	Description
\Zend_Service_WindowsAzure_Exception

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

Converts a string to a DateTime object.

Returns false on failure.

Parameters

Name	Type	Description
$value	string	The string value to parse

Returns

Type	Description
\DateTime \| boolean

_convertToEdmDateTime(\DateTime $value) : string

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

Parameters

Name	Type	Description
$value	\DateTime

Returns

Type	Description
string

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

Fill text template with variables from key/value array

Parameters

Name	Type	Description
$templateText	string	Template text
$variables	array	Array containing key/value pairs

Returns

Type	Description
string

_generateAzureRepresentation(\Zend_Service_WindowsAzure_Storage_TableEntity $entity = null) : string

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

Parameters

Name	Type	Description
$entity	\Zend_Service_WindowsAzure_Storage_TableEntity

Returns

Type	Description
string

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

inherited

Generate metadata headers

Inherited from: \Zend_Service_WindowsAzure_Storage::_generateMetadataHeaders()\Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::_generateMetadataHeaders()

Parameters

Name	Type	Description
$metadata	array

Returns

Type	Description
\HTTP	headers containing metadata

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

Get error message from Zend_Http_Response

Parameters

Name	Type	Description
$response	\Zend_Http_Response	Repsonse
$alternativeError	string	Alternative error message

Returns

Type	Description
string

_parseMetadataElement( $element = null) : array

inherited

Parse metadata XML

Inherited from: \Zend_Service_WindowsAzure_Storage::_parseMetadataElement()\Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::_parseMetadataElement()

Parameters

Name	Type	Description
$element

Returns

Type	Description
array

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

inherited

Parse metadata headers

Inherited from: \Zend_Service_WindowsAzure_Storage::_parseMetadataHeaders()\Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::_parseMetadataHeaders()

Parameters

Name	Type	Description
$headers	array	HTTP headers containing metadata

Returns

Type	Description
array

_parseResponse(\Zend_Http_Response $response = null) : object

inherited

Parse result from Zend_Http_Response

Inherited from: \Zend_Service_WindowsAzure_Storage::_parseResponse()\Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::_parseResponse()

Parameters

Name	Type	Description
$response	\Zend_Http_Response	Response from HTTP call

Returns

Type	Description
object

Throws

Exception	Description
\Zend_Service_WindowsAzure_Exception

_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

Perform request using Zend_Http_Client channel

Parameters

Name	Type	Description
$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

Type	Description
\Zend_Http_Response

_rfcDate() : string

Generate RFC 1123 compliant date string

Returns

Type	Description
string

createQueryStringFromArray(array $queryString) : string

staticinherited

Builds a query string from an array of elements

Inherited from: \Zend_Service_WindowsAzure_Storage::createQueryStringFromArray()\Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::createQueryStringFromArray()

Parameters

Name	Type	Description
$queryString	array	Array of elements

Returns

Type	Description
string	Assembled query string

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

Create table

Parameters

Name	Type	Description
$tableName	string	Table name

Returns

Type	Description
\Zend_Service_WindowsAzure_Storage_TableInstance

Throws

Exception	Description
\Zend_Service_WindowsAzure_Exception

createTableIfNotExists(string $tableName = '') : void

Create table if it does not exist

Parameters

Name	Type	Description
$tableName	string	Table name

Throws

Exception	Description
\Zend_Service_WindowsAzure_Exception

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

Delete entity from table

Parameters

Name	Type	Description
$tableName	string	Table name
$entity	\Zend_Service_WindowsAzure_Storage_TableEntity	Entity to delete
$verifyEtag	boolean	Verify etag of the entity (used for concurrency)

Throws

Exception	Description
\Zend_Service_WindowsAzure_Exception

deleteTable(string $tableName = '') : void

Delete table

Parameters

Name	Type	Description
$tableName	string	Table name

Throws

Exception	Description
\Zend_Service_WindowsAzure_Exception

getAccountName() : string

inherited

Returns the Windows Azure account name

Inherited from: \Zend_Service_WindowsAzure_Storage::getAccountName()\Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::getAccountName()

Returns

Type	Description
string

getBaseUrl() : string

inherited

Get base URL for creating requests

Inherited from: \Zend_Service_WindowsAzure_Storage::getBaseUrl()\Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::getBaseUrl()

Returns

Type	Description
string

getCredentials() : \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

inherited

Get Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance

Inherited from: \Zend_Service_WindowsAzure_Storage::getCredentials()\Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::getCredentials()

Returns

Type	Description
\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

getCurrentBatch() : \Zend_Service_WindowsAzure_Storage_Batch

inherited

Get current batch

Inherited from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::getCurrentBatch()

Returns

Type	Description
\Zend_Service_WindowsAzure_Storage_Batch

getHttpClientChannel() : \Zend_Http_Client_Adapter_Interface

inherited

Retrieve HTTP client channel

Inherited from: \Zend_Service_WindowsAzure_Storage::getHttpClientChannel()\Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::getHttpClientChannel()

Returns

Type	Description
\Zend_Http_Client_Adapter_Interface

getThrowExceptionOnMissingData() : void

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

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

Insert entity into table

Parameters

Name	Type	Description
$tableName	string	Table name
$entity	\Zend_Service_WindowsAzure_Storage_TableEntity	Entity to insert

Returns

Type	Description
\Zend_Service_WindowsAzure_Storage_TableEntity

Throws

Exception	Description
\Zend_Service_WindowsAzure_Exception

isInBatch() : boolean

inherited

Is there a current batch?

Inherited from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::isInBatch()

Returns

Type	Description
boolean

isValidMetadataName(string $metadataName = '') : boolean

staticinherited

Is valid metadata name?

Inherited from: \Zend_Service_WindowsAzure_Storage::isValidMetadataName()\Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::isValidMetadataName()

Parameters

Name	Type	Description
$metadataName	string	Metadata name

Returns

Type	Description
boolean

isoDate(int $timestamp = null) : string

inherited

Generate ISO 8601 compliant date string in UTC time zone

Inherited from: \Zend_Service_WindowsAzure_Storage::isoDate()\Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::isoDate()

Parameters

Name	Type	Description
$timestamp	int

Returns

Type	Description
string

listTables(string $nextTableName = '') : array

List tables

Parameters

Name	Type	Description
$nextTableName	string	Next table name, used for listing tables when total amount of tables is > 1000.

Returns

Type	Description
array

Throws

Exception	Description
\Zend_Service_WindowsAzure_Exception

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

Update entity by adding or updating properties

Parameters

Name	Type	Description
$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.

Throws

Exception	Description
\Zend_Service_WindowsAzure_Exception

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

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

Inherited from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::performBatch()

Parameters

Name	Type	Description
$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

Type	Description
\Zend_Http_Response

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

Retrieve entities from table

Parameters

Name	Type	Description
$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.

Returns

Type	Description
array	Array of Zend_Service_WindowsAzure_Storage_TableEntity

Throws

Exception	Description
\Zend_Service_WindowsAzure_Exception

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

Retrieve entity from table, by id

Parameters

Name	Type	Description
$tableName	string	Table name
$partitionKey	string	Partition key
$rowKey	string	Row key
$entityClass	string	Entity class name*

Returns

Type	Description
\Zend_Service_WindowsAzure_Storage_TableEntity

Throws

Exception	Description
\Zend_Service_WindowsAzure_Exception

select() : \Zend_Service_WindowsAzure_Storage_TableEntityQuery

Create a new Zend_Service_WindowsAzure_Storage_TableEntityQuery

Returns

Type	Description
\Zend_Service_WindowsAzure_Storage_TableEntityQuery

setCredentials(\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract $credentials) : void

inherited

Set Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance

Inherited from: \Zend_Service_WindowsAzure_Storage::setCredentials()\Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::setCredentials()

Parameters

Name	Type	Description
$credentials	\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract	Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance to use for request signing.

setCurrentBatch(\Zend_Service_WindowsAzure_Storage_Batch $batch = null) : void

inherited

Set current batch

Inherited from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::setCurrentBatch()

Parameters

Name	Type	Description
$batch	\Zend_Service_WindowsAzure_Storage_Batch	Current batch

Throws

Exception	Description
\Zend_Service_WindowsAzure_Exception

setHttpClientChannel(\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()\Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::setHttpClientChannel()

Parameters

Name	Type	Description
$adapterInstance	\Zend_Http_Client_Adapter_Interface \| string	Adapter instance or adapter class name.

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

inherited

Set proxy

Inherited from: \Zend_Service_WindowsAzure_Storage::setProxy()\Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::setProxy()

Parameters

Name	Type	Description
$useProxy	boolean	Use proxy?
$proxyUrl	string	Proxy URL
$proxyPort	int	Proxy port
$proxyCredentials	string	Proxy credentials

setRetryPolicy(\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null) : void

inherited

Set retry policy to use when making requests

Inherited from: \Zend_Service_WindowsAzure_Storage::setRetryPolicy()\Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::setRetryPolicy()

Parameters

Name	Type	Description
$retryPolicy	\Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract	Retry policy to use when making requests

setThrowExceptionOnMissingData(boolean $value = true) : void

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.

Parameters

Name	Type	Description
$value	boolean

startBatch() : \Zend_Service_WindowsAzure_Storage_Batch

inherited

Starts a new batch operation set

Inherited from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::startBatch()

Returns

Type	Description
\Zend_Service_WindowsAzure_Storage_Batch

Throws

Exception	Description
\Zend_Service_WindowsAzure_Exception

tableExists(string $tableName = '') : boolean

Check if a table exists

Parameters

Name	Type	Description
$tableName	string	Table name

Returns

Type	Description
boolean

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

Update entity by replacing it

Parameters

Name	Type	Description
$tableName	string	Table name
$entity	\Zend_Service_WindowsAzure_Storage_TableEntity	Entity to update
$verifyEtag	boolean	Verify etag of the entity (used for concurrency)

Throws

Exception	Description
\Zend_Service_WindowsAzure_Exception

urlencode(string $value) : string

staticinherited

URL encode function

Inherited from: \Zend_Service_WindowsAzure_Storage::urlencode()\Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::urlencode()

Parameters

Name	Type	Description
$value	string	Value to encode

Returns

Type	Description
string	Encoded value

Service/WindowsAzure/Storage/Table.php

\Zend_Service_WindowsAzure_Storage_Tablejump to top

Constants

Properties

Methods

\Zend_Service_WindowsAzure_Storage_Table
jump to top