Microsoft_WindowsAzure
[ class tree: Microsoft_WindowsAzure ] [ index: Microsoft_WindowsAzure ] [ all elements ]

Class: Microsoft_WindowsAzure_Storage_Table

Source Location: /WindowsAzure/Storage/Table.php

Class Overview

Microsoft_WindowsAzure_Storage
   |
   --Microsoft_WindowsAzure_Storage_BatchStorageAbstract
      |
      --Microsoft_WindowsAzure_Storage_Table



Author(s):

Copyright:

  • Copyright (c) 2009 - 2011, RealDolmen (http://www.realdolmen.com)

Variables

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: Microsoft_WindowsAzure_Storage_BatchStorageAbstract

Microsoft_WindowsAzure_Storage_BatchStorageAbstract::getCurrentBatch()
Get current batch
Microsoft_WindowsAzure_Storage_BatchStorageAbstract::isInBatch()
Is there a current batch?
Microsoft_WindowsAzure_Storage_BatchStorageAbstract::performBatch()
Perform batch using Microsoft_Http_Client channel, combining all batch operations into one request
Microsoft_WindowsAzure_Storage_BatchStorageAbstract::setCurrentBatch()
Set current batch
Microsoft_WindowsAzure_Storage_BatchStorageAbstract::startBatch()
Starts a new batch operation set

Class: Microsoft_WindowsAzure_Storage

Microsoft_WindowsAzure_Storage::__construct()
Creates a new Microsoft_WindowsAzure_Storage instance
Microsoft_WindowsAzure_Storage::createQueryStringFromArray()
Builds a query string from an array of elements
Microsoft_WindowsAzure_Storage::getAccountName()
Returns the Windows Azure account name
Microsoft_WindowsAzure_Storage::getBaseUrl()
Get base URL for creating requests
Microsoft_WindowsAzure_Storage::getCredentials()
Get Microsoft_WindowsAzure_Credentials_CredentialsAbstract instance
Microsoft_WindowsAzure_Storage::getHttpClientChannel()
Retrieve HTTP client channel
Microsoft_WindowsAzure_Storage::isoDate()
Generate ISO 8601 compliant date string in UTC time zone
Microsoft_WindowsAzure_Storage::isValidMetadataName()
Is valid metadata name?
Microsoft_WindowsAzure_Storage::setCredentials()
Set Microsoft_WindowsAzure_Credentials_CredentialsAbstract instance
Microsoft_WindowsAzure_Storage::setHttpClientChannel()
Set the HTTP client channel to use
Microsoft_WindowsAzure_Storage::setProxy()
Set proxy
Microsoft_WindowsAzure_Storage::setRetryPolicy()
Set retry policy to use when making requests
Microsoft_WindowsAzure_Storage::urlencode()
URL encode function
Microsoft_WindowsAzure_Storage::_generateMetadataHeaders()
Generate metadata headers
Microsoft_WindowsAzure_Storage::_parseMetadataElement()
Parse metadata XML
Microsoft_WindowsAzure_Storage::_parseMetadataHeaders()
Parse metadata headers
Microsoft_WindowsAzure_Storage::_parseResponse()
Parse result from Microsoft_Http_Response
Microsoft_WindowsAzure_Storage::_performRequest()
Perform request using Microsoft_Http_Client channel

Class Details

[line 49]


Tags:

copyright:  Copyright (c) 2009 - 2011, RealDolmen (http://www.realdolmen.com)
license:  http://phpazure.codeplex.com/license


[ Top ]


Class Variables

$_throwExceptionOnMissingData =  true

[line 58]

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



Tags:

access:  protected

Type:   boolean


[ Top ]



Class Methods


constructor __construct [line 88]

Microsoft_WindowsAzure_Storage_Table __construct( [string $host = Microsoft_WindowsAzure_Storage::URL_DEV_TABLE], [string $accountName = Microsoft_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT], [string $accountKey = Microsoft_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY], [boolean $usePathStyleUri = false], [Microsoft_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null])

Creates a new Microsoft_WindowsAzure_Storage_Table instance



Tags:

access:  public


Overrides Microsoft_WindowsAzure_Storage::__construct() (Creates a new Microsoft_WindowsAzure_Storage instance)

Parameters:

string   $host   Storage host name
string   $accountName   Account name for Windows Azure
string   $accountKey   Account key for Windows Azure
boolean   $usePathStyleUri   Use path-style URI's
Microsoft_WindowsAzure_RetryPolicy_RetryPolicyAbstract   $retryPolicy   Retry policy to use when making requests

[ Top ]

method createTable [line 187]

Microsoft_WindowsAzure_Storage_TableInstance createTable( [string $tableName = ''])

Create table



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

string   $tableName   Table name

[ Top ]

method createTableIfNotExists [line 251]

void createTableIfNotExists( [string $tableName = ''])

Create table if it does not exist



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

string   $tableName   Table name

[ Top ]

method deleteEntity [line 359]

void deleteEntity( [string $tableName = ''], [Microsoft_WindowsAzure_Storage_TableEntity $entity = null], [boolean $verifyEtag = false])

Delete entity from table



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

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

[ Top ]

method deleteTable [line 264]

void deleteTable( [string $tableName = ''])

Delete table



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

string   $tableName   Table name

[ Top ]

method getThrowExceptionOnMissingData [line 74]

void getThrowExceptionOnMissingData( )

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



Tags:

access:  public


[ Top ]

method insertEntity [line 289]

Microsoft_WindowsAzure_Storage_TableEntity insertEntity( [string $tableName = ''], [Microsoft_WindowsAzure_Storage_TableEntity $entity = null])

Insert entity into table



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

string   $tableName   Table name
Microsoft_WindowsAzure_Storage_TableEntity   $entity   Entity to insert

[ Top ]

method listTables [line 129]

array listTables( [string $nextTableName = ''])

List tables



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

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

[ Top ]

method mergeEntity [line 638]

void mergeEntity( [string $tableName = ''], [Microsoft_WindowsAzure_Storage_TableEntity $entity = null], [boolean $verifyEtag = false], [array $properties = array()])

Update entity by adding or updating properties



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

string   $tableName   Table name
Microsoft_WindowsAzure_Storage_TableEntity   $entity   Entity to update
boolean   $verifyEtag   Verify etag of the entity (used for concurrency)
array   $properties   Properties to merge. All properties will be used when omitted.

[ Top ]

method retrieveEntities [line 470]

array retrieveEntities( [ $tableName = ''], [string $filter = ''], [string $entityClass = 'Microsoft_WindowsAzure_Storage_DynamicTableEntity'], [string $nextPartitionKey = null], [string $nextRowKey = null], string $tableName|Microsoft_WindowsAzure_Storage_TableEntityQuery)

Retrieve entities from table



Tags:

return:  Array of Microsoft_WindowsAzure_Storage_TableEntity
throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

string   $tableName|Microsoft_WindowsAzure_Storage_TableEntityQuery   Table name -or- Microsoft_WindowsAzure_Storage_TableEntityQuery instance
string   $filter   Filter condition (not applied when $tableName is a Microsoft_WindowsAzure_Storage_TableEntityQuery instance)
string   $entityClass   Entity class name
string   $nextPartitionKey   Next partition key, used for listing entities when total amount of entities is > 1000.
string   $nextRowKey   Next row key, used for listing entities when total amount of entities is > 1000.
   $tableName  

[ Top ]

method retrieveEntityById [line 404]

Microsoft_WindowsAzure_Storage_TableEntity retrieveEntityById( string $tableName, string $partitionKey, string $rowKey, [string $entityClass = 'Microsoft_WindowsAzure_Storage_DynamicTableEntity'])

Retrieve entity from table, by id



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

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

[ Top ]

method select [line 454]

Microsoft_WindowsAzure_Storage_TableEntityQuery select( )

Create a new Microsoft_WindowsAzure_Storage_TableEntityQuery



Tags:

access:  public


[ Top ]

method setThrowExceptionOnMissingData [line 66]

void setThrowExceptionOnMissingData( [boolean $value = true])

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



Tags:

access:  public


Parameters:

boolean   $value  

[ Top ]

method tableExists [line 105]

boolean tableExists( [string $tableName = ''])

Check if a table exists



Tags:

access:  public


Parameters:

string   $tableName   Table name

[ Top ]

method updateEntity [line 624]

void updateEntity( [string $tableName = ''], [Microsoft_WindowsAzure_Storage_TableEntity $entity = null], [boolean $verifyEtag = false])

Update entity by replacing it



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

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

[ Top ]

method _changeEntity [line 688]

void _changeEntity( [string $httpVerb = Microsoft_Http_Client::PUT], [string $tableName = ''], [Microsoft_WindowsAzure_Storage_TableEntity $entity = null], [boolean $verifyEtag = false])

Update entity / merge entity



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  protected


Parameters:

string   $httpVerb   HTTP verb to use (PUT = update, MERGE = merge)
string   $tableName   Table name
Microsoft_WindowsAzure_Storage_TableEntity   $entity   Entity to update
boolean   $verifyEtag   Verify etag of the entity (used for concurrency)

[ Top ]

method _convertToDateTime [line 869]

DateTime|boolean _convertToDateTime( [string $value = ''])

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



Tags:

access:  protected


Parameters:

string   $value   The string value to parse

[ Top ]

method _convertToEdmDateTime [line 893]

string _convertToEdmDateTime( $value)

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



Tags:

access:  protected


Parameters:

DateTime   $value  

[ Top ]

method _fillTemplate [line 776]

string _fillTemplate( string $templateText, [array $variables = array()])

Fill text template with variables from key/value array



Tags:

access:  protected


Parameters:

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

[ Top ]

method _generateAzureRepresentation [line 790]

string _generateAzureRepresentation( [Microsoft_WindowsAzure_Storage_TableEntity $entity = null])

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



Tags:

access:  protected


Parameters:


[ Top ]

method _getErrorMessage [line 669]

string _getErrorMessage( $response, [string $alternativeError = 'Unknown error.'])

Get error message from Microsoft_Http_Response



Tags:

access:  protected


Parameters:

Microsoft_Http_Response   $response   Repsonse
string   $alternativeError   Alternative error message

[ Top ]

method _performRequest [line 836]

Microsoft_Http_Response _performRequest( [string $path = '/'], [string $queryString = ''], [string $httpVerb = Microsoft_Http_Client::GET], [array $headers = array()], [boolean $forTableStorage = false], [mixed $rawData = null], [string $resourceType = Microsoft_WindowsAzure_Storage::RESOURCE_UNKNOWN], [string $requiredPermission = Microsoft_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ])

Perform request using Microsoft_Http_Client channel



Tags:

access:  protected


Overrides Microsoft_WindowsAzure_Storage::_performRequest() (Perform request using Microsoft_Http_Client channel)

Parameters:

string   $path   Path
string   $queryString   Query string
string   $httpVerb   HTTP verb the request will use
array   $headers   x-ms headers to add
boolean   $forTableStorage   Is the request for table storage?
mixed   $rawData   Optional RAW HTTP data to be sent over the wire
string   $resourceType   Resource type
string   $requiredPermission   Required permission

[ Top ]

method _rfcDate [line 764]

string _rfcDate( )

Generate RFC 1123 compliant date string



Tags:

access:  protected


[ Top ]


Documentation generated on Wed, 18 May 2011 12:06:58 +0200 by phpDocumentor 1.4.3