Service/WindowsAzure/Storage/Table.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service_WindowsAzure
subpackage: Storage
version: $Id$
Classes: Zend_Service_WindowsAzure_Storage_Table

Description

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.

Zend_Service_WindowsAzure_Storage_Table
jump to top

Extends from: Zend_Service_WindowsAzure_Storage_BatchStorageAbstract
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service_WindowsAzure
subpackage: Storage
Methods: __construct; tableExists; listTables; createTable; deleteTable; insertEntity; deleteEntity; retrieveEntityById; select; retrieveEntities; updateEntity; mergeEntity; _getErrorMessage; _changeEntity; _rfcDate; _fillTemplate; _generateAzureRepresentation; _performRequest

Description

Methods

__construct
jump to class

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

Creates a new Zend_Service_WindowsAzure_Storage_Table instance

Arguments

$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

Details

visibility: public
final: false
static: false

_changeEntity
jump to class

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

Update entity / merge entity

Arguments

$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)

Details

visibility: protected
final: false
static: false
throws

_fillTemplate
jump to class

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

Fill text template with variables from key/value array

Arguments

$templateText: string
Template text
$variables: array
Array containing key/value pairs

Output

string

Details

visibility: protected
final: false
static: false

_generateAzureRepresentation
jump to class

_generateAzureRepresentation(
          Zend_Service_WindowsAzure_Storage_TableEntity $entity
              =
              null
          )
        
        :
        string

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

Arguments

$entity: Zend_Service_WindowsAzure_Storage_TableEntity

Output

string

Details

visibility: protected
final: false
static: false

_getErrorMessage
jump to class

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

Get error message from Zend_Http_Response

Arguments

$response: Zend_Http_Response
Repsonse
$alternativeError: string
Alternative error message

Output

string

Details

visibility: protected
final: false
static: false

_performRequest
jump to class

_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

Arguments

$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

Output

Zend_Http_Response

Details

visibility: protected
final: false
static: false

_rfcDate
jump to class

_rfcDate(
          
          )
        
        :
        string

Generate RFC 1123 compliant date string

Output

string

Details

visibility: protected
final: false
static: false

createTable
jump to class

createTable(
          string $tableName
          )
        
        :
        Zend_Service_WindowsAzure_Storage_TableInstance

Create table

Arguments

$tableName: string
Table name

Output

Zend_Service_WindowsAzure_Storage_TableInstance

Details

visibility: public
final: false
static: false
throws

deleteEntity
jump to class

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

Delete entity from table

Arguments

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

Details

visibility: public
final: false
static: false
throws

deleteTable
jump to class

deleteTable(
          string $tableName
          )
        
        :

Delete table

Arguments

$tableName: string
Table name

Details

visibility: public
final: false
static: false
throws

insertEntity
jump to class

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

Insert entity into table

Arguments

$tableName: string
Table name
$entity: Zend_Service_WindowsAzure_Storage_TableEntity
Entity to insert

Output

Zend_Service_WindowsAzure_Storage_TableEntity

Details

visibility: public
final: false
static: false
throws

listTables
jump to class

listTables(
          string $nextTableName
          )
        
        :
        array

List tables

Arguments

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

Output

array

Details

visibility: public
final: false
static: false
throws

mergeEntity
jump to class

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

Update entity by adding or updating properties

Arguments

$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.

Details

visibility: public
final: false
static: false
throws

retrieveEntities
jump to class

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

Retrieve entities from table

Arguments

$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.

Output

array: Array of Zend_Service_WindowsAzure_Storage_TableEntity

Details

visibility: public
final: false
static: false
throws

retrieveEntityById
jump to class

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

Arguments

$tableName: string
Table name
$partitionKey: string
Partition key
$rowKey: string
Row key
$entityClass: string
Entity class name*

Output

Zend_Service_WindowsAzure_Storage_TableEntity

Details

visibility: public
final: false
static: false
throws

select
jump to class

select(
          
          )
        
        :
        Zend_Service_WindowsAzure_Storage_TableEntityQuery

Create a new Zend_Service_WindowsAzure_Storage_TableEntityQuery

Output

Zend_Service_WindowsAzure_Storage_TableEntityQuery

Details

visibility: public
final: false
static: false

tableExists
jump to class

tableExists(
          string $tableName
          )
        
        :
        boolean

Check if a table exists

Arguments

$tableName: string
Table name

Output

boolean

Details

visibility: public
final: false
static: false

updateEntity
jump to class

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

Update entity by replacing it

Arguments

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

Details

visibility: public
final: false
static: false
throws

API Documentation

Service/WindowsAzure/Storage/Table.php

Description

Zend_Service_WindowsAzure_Storage_Tablejump to top

Description

Methods

__constructjump to class

Arguments

Details

_changeEntityjump to class

Arguments

Details

_fillTemplatejump to class

Arguments

Output

Details

_generateAzureRepresentationjump to class

Arguments

Output

Details

_getErrorMessagejump to class

Arguments

Output

Details

_performRequestjump to class

Arguments

Output

Details

_rfcDatejump to class

Output

Details

createTablejump to class

Arguments

Output

Details

deleteEntityjump to class

Arguments

Details

deleteTablejump to class

Arguments

Details

insertEntityjump to class

Arguments

Output

Details

listTablesjump to class

Arguments

Output

Details

mergeEntityjump to class

Arguments

Details

retrieveEntitiesjump to class

Arguments

Output

Details

retrieveEntityByIdjump to class

Arguments

Output

Details

selectjump to class

Output

Details

tableExistsjump to class

Arguments

Output

Details

updateEntityjump to class

Arguments

Details

Zend_Service_WindowsAzure_Storage_Table
jump to top

__construct
jump to class

_changeEntity
jump to class

_fillTemplate
jump to class

_generateAzureRepresentation
jump to class

_getErrorMessage
jump to class

_performRequest
jump to class

_rfcDate
jump to class

createTable
jump to class

deleteEntity
jump to class

deleteTable
jump to class

insertEntity
jump to class

listTables
jump to class

mergeEntity
jump to class

retrieveEntities
jump to class

retrieveEntityById
jump to class

select
jump to class

tableExists
jump to class

updateEntity
jump to class