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::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
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
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 |

_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 |

_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
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 |

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 |

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 |

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 |

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 |

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 |