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.

__construct(
string $host
=
Zend_Service_WindowsAzure_Storage, string $accountName
=
Zend_Service_WindowsAzure_Credentials_CredentialsAbstract, string $accountKey
=
Zend_Service_WindowsAzure_Credentials_CredentialsAbstract, boolean $usePathStyleUri
=
false, \Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy
=
null
)
:
void
Creates a new Zend_Service_WindowsAzure_Storage_Table instance
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, string $tableName, \Zend_Service_WindowsAzure_Storage_TableEntity $entity
=
null, boolean $verifyEtag
=
false
)
:
void
Update entity / merge entity
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) |
Exception | Description |
---|---|
\Zend_Service_WindowsAzure_Exception |

_fillTemplate(
string $templateText, array $variables
=
array
)
:
string
Fill text template with variables from key/value array
Name | Type | Description |
---|---|---|
$templateText | string | Template text |
$variables | array | Array containing key/value pairs |
Type | Description |
---|---|
string |

_generateAzureRepresentation(
\Zend_Service_WindowsAzure_Storage_TableEntity $entity
=
null
)
:
string
Generate Azure representation from entity (creates atompub markup from properties)
Name | Type | Description |
---|---|---|
$entity | \Zend_Service_WindowsAzure_Storage_TableEntity |
Type | Description |
---|---|
string |

_generateMetadataHeaders(
array $metadata
=
array
)
:
\HTTP
Generate metadata headers
Inherited from: \Zend_Service_WindowsAzure_Storage::_generateMetadataHeaders()Name | Type | Description |
---|---|---|
$metadata | array |
Type | Description |
---|---|
\HTTP | headers containing metadata |

_getErrorMessage(
\Zend_Http_Response $response, string $alternativeError
=
Unknown error.
)
:
string
Get error message from Zend_Http_Response
Name | Type | Description |
---|---|---|
$response | \Zend_Http_Response | Repsonse |
$alternativeError | string | Alternative error message |
Type | Description |
---|---|
string |

_parseMetadataElement(
$element
=
null
)
:
array
Parse metadata XML
Inherited from: \Zend_Service_WindowsAzure_Storage::_parseMetadataElement()Name | Type | Description |
---|---|---|
$element |
Type | Description |
---|---|
array |

_parseMetadataHeaders(
array $headers
=
array
)
:
array
Parse metadata headers
Inherited from: \Zend_Service_WindowsAzure_Storage::_parseMetadataHeaders()Name | Type | Description |
---|---|---|
$headers | array | HTTP headers containing metadata |
Type | Description |
---|---|
array |

_parseResponse(
\Zend_Http_Response $response
=
null
)
:
object
Parse result from Zend_Http_Response
Inherited from: \Zend_Service_WindowsAzure_Storage::_parseResponse()Name | Type | Description |
---|---|---|
$response | \Zend_Http_Response | Response from HTTP call |
Type | Description |
---|---|
object |
Exception | Description |
---|---|
\Zend_Service_WindowsAzure_Exception |

_performRequest(
string $path
=
/, string $queryString, string $httpVerb
=
Zend_Http_Client, array $headers
=
array, boolean $forTableStorage
=
false, mixed $rawData
=
null, string $resourceType
=
Zend_Service_WindowsAzure_Storage, string $requiredPermission
=
Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
)
:
\Zend_Http_Response
Perform request using Zend_Http_Client channel
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 |
Type | Description |
---|---|
\Zend_Http_Response |

createQueryStringFromArray(
array $queryString
)
:
string
Builds a query string from an array of elements
Inherited from: \Zend_Service_WindowsAzure_Storage::createQueryStringFromArray()Name | Type | Description |
---|---|---|
$queryString | array | Array of elements |
Type | Description |
---|---|
string | Assembled query string |

createTable(
string $tableName
)
:
\Zend_Service_WindowsAzure_Storage_TableInstance
Create table
Name | Type | Description |
---|---|---|
$tableName | string | Table name |
Type | Description |
---|---|
\Zend_Service_WindowsAzure_Storage_TableInstance |
Exception | Description |
---|---|
\Zend_Service_WindowsAzure_Exception |

deleteEntity(
string $tableName, \Zend_Service_WindowsAzure_Storage_TableEntity $entity
=
null, boolean $verifyEtag
=
false
)
:
void
Delete entity from table
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) |
Exception | Description |
---|---|
\Zend_Service_WindowsAzure_Exception |

deleteTable(
string $tableName
)
:
void
Delete table
Name | Type | Description |
---|---|---|
$tableName | string | Table name |
Exception | Description |
---|---|
\Zend_Service_WindowsAzure_Exception |

getAccountName(
)
:
string
Returns the Windows Azure account name
Inherited from: \Zend_Service_WindowsAzure_Storage::getAccountName()Type | Description |
---|---|
string |

getBaseUrl(
)
:
string
Get base URL for creating requests
Inherited from: \Zend_Service_WindowsAzure_Storage::getBaseUrl()Type | Description |
---|---|
string |

getCredentials(
)
:
\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
Get Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance
Inherited from: \Zend_Service_WindowsAzure_Storage::getCredentials()Type | Description |
---|---|
\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract |

getCurrentBatch(
)
:
\Zend_Service_WindowsAzure_Storage_Batch
Get current batch
Inherited from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::getCurrentBatch()Type | Description |
---|---|
\Zend_Service_WindowsAzure_Storage_Batch |

getHttpClientChannel(
)
:
\Zend_Http_Client_Adapter_Interface
Retrieve HTTP client channel
Inherited from: \Zend_Service_WindowsAzure_Storage::getHttpClientChannel()Type | Description |
---|---|
\Zend_Http_Client_Adapter_Interface |

insertEntity(
string $tableName, \Zend_Service_WindowsAzure_Storage_TableEntity $entity
=
null
)
:
\Zend_Service_WindowsAzure_Storage_TableEntity
Insert entity into table
Name | Type | Description |
---|---|---|
$tableName | string | Table name |
$entity | \Zend_Service_WindowsAzure_Storage_TableEntity | Entity to insert |
Type | Description |
---|---|
\Zend_Service_WindowsAzure_Storage_TableEntity |
Exception | Description |
---|---|
\Zend_Service_WindowsAzure_Exception |

isInBatch(
)
:
boolean
Is there a current batch?
Inherited from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::isInBatch()Type | Description |
---|---|
boolean |

isValidMetadataName(
string $metadataName
)
:
boolean
Is valid metadata name?
Inherited from: \Zend_Service_WindowsAzure_Storage::isValidMetadataName()Name | Type | Description |
---|---|---|
$metadataName | string | Metadata name |
Type | Description |
---|---|
boolean |

isoDate(
int $timestamp
=
null
)
:
string
Generate ISO 8601 compliant date string in UTC time zone
Inherited from: \Zend_Service_WindowsAzure_Storage::isoDate()Name | Type | Description |
---|---|---|
$timestamp | int |
Type | Description |
---|---|
string |

listTables(
string $nextTableName
)
:
array
List tables
Name | Type | Description |
---|---|---|
$nextTableName | string | Next table name, used for listing tables when total amount of tables is > 1000. |
Type | Description |
---|---|
array |
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
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. |
Exception | Description |
---|---|
\Zend_Service_WindowsAzure_Exception |

performBatch(
array $operations
=
array, boolean $forTableStorage
=
false, boolean $isSingleSelect
=
false, string $resourceType
=
Zend_Service_WindowsAzure_Storage, string $requiredPermission
=
Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
)
:
\Zend_Http_Response
Perform batch using Zend_Http_Client channel, combining all batch operations into one request
Inherited from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::performBatch()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 |
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
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. |
Type | Description |
---|---|
array | Array of Zend_Service_WindowsAzure_Storage_TableEntity |
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
Name | Type | Description |
---|---|---|
$tableName | string | Table name |
$partitionKey | string | Partition key |
$rowKey | string | Row key |
$entityClass | string | Entity class name* |
Type | Description |
---|---|
\Zend_Service_WindowsAzure_Storage_TableEntity |
Exception | Description |
---|---|
\Zend_Service_WindowsAzure_Exception |

select(
)
:
\Zend_Service_WindowsAzure_Storage_TableEntityQuery
Create a new Zend_Service_WindowsAzure_Storage_TableEntityQuery
Type | Description |
---|---|
\Zend_Service_WindowsAzure_Storage_TableEntityQuery |

setCredentials(
\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract $credentials
)
:
void
Set Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance
Inherited from: \Zend_Service_WindowsAzure_Storage::setCredentials()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
Set current batch
Inherited from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::setCurrentBatch()Name | Type | Description |
---|---|---|
$batch | \Zend_Service_WindowsAzure_Storage_Batch | Current batch |
Exception | Description |
---|---|
\Zend_Service_WindowsAzure_Exception |

setHttpClientChannel(
\Zend_Http_Client_Adapter_Interface|string $adapterInstance
=
Zend_Http_Client_Adapter_Proxy
)
:
void
Set the HTTP client channel to use
Inherited from: \Zend_Service_WindowsAzure_Storage::setHttpClientChannel()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
Set proxy
Inherited from: \Zend_Service_WindowsAzure_Storage::setProxy()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
Set retry policy to use when making requests
Inherited from: \Zend_Service_WindowsAzure_Storage::setRetryPolicy()Name | Type | Description |
---|---|---|
$retryPolicy | \Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract | Retry policy to use when making requests |

startBatch(
)
:
\Zend_Service_WindowsAzure_Storage_Batch
Starts a new batch operation set
Inherited from: \Zend_Service_WindowsAzure_Storage_BatchStorageAbstract::startBatch()Type | Description |
---|---|
\Zend_Service_WindowsAzure_Storage_Batch |
Exception | Description |
---|---|
\Zend_Service_WindowsAzure_Exception |

tableExists(
string $tableName
)
:
boolean
Check if a table exists
Name | Type | Description |
---|---|---|
$tableName | string | Table name |
Type | Description |
---|---|
boolean |

updateEntity(
string $tableName, \Zend_Service_WindowsAzure_Storage_TableEntity $entity
=
null, boolean $verifyEtag
=
false
)
:
void
Update entity by replacing it
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) |
Exception | Description |
---|---|
\Zend_Service_WindowsAzure_Exception |