Microsoft_WindowsAzure
[ class tree: Microsoft_WindowsAzure ] [ index: Microsoft_WindowsAzure ] [ all elements ]
Packages:
Microsoft_WindowsAzure
Microsoft
Microsoft_Http
Microsoft_WindowsAzure_Storage


Files:
Credentials.php
SharedAccessSignatureCredentials.php
SharedKeyCredentials.php
SharedKeyLiteCredentials.php

subpackage Exception
Exception.php

subpackage RetryPolicy
Exception.php
NoRetry.php
RetryN.php
RetryPolicy.php

subpackage Session
SessionHandler.php

subpackage Storage
Batch.php
BatchStorage.php
Blob.php
BlobContainer.php
BlobInstance.php
DynamicTableEntity.php
Queue.php
QueueInstance.php
QueueMessage.php
SignedIdentifier.php
Storage.php
Table.php
TableEntity.php
TableEntityQuery.php
TableInstance.php

Classes:
Storage
   Microsoft_WindowsAzure_Storage
   Microsoft_WindowsAzure_Storage_Batch
   Microsoft_WindowsAzure_Storage_BatchStorage
   Microsoft_WindowsAzure_Storage_Blob
   Microsoft_WindowsAzure_Storage_BlobContainer
   Microsoft_WindowsAzure_Storage_BlobInstance
   Microsoft_WindowsAzure_Storage_DynamicTableEntity
   Microsoft_WindowsAzure_Storage_Queue
   Microsoft_WindowsAzure_Storage_QueueInstance
   Microsoft_WindowsAzure_Storage_QueueMessage
   Microsoft_WindowsAzure_Storage_SignedIdentifier
   Microsoft_WindowsAzure_Storage_Table
   Microsoft_WindowsAzure_Storage_TableEntity
   Microsoft_WindowsAzure_Storage_TableEntityQuery
   Microsoft_WindowsAzure_Storage_TableInstance
Microsoft_WindowsAzure_Credentials
Microsoft_WindowsAzure_SharedAccessSignatureCredentials
Microsoft_WindowsAzure_SharedKeyCredentials
Microsoft_WindowsAzure_SharedKeyLiteCredentials
Exception
   Microsoft_WindowsAzure_Exception
RetryPolicy
   Microsoft_WindowsAzure_RetryPolicy
   Microsoft_WindowsAzure_RetryPolicy_Exception
   Microsoft_WindowsAzure_RetryPolicy_NoRetry
   Microsoft_WindowsAzure_RetryPolicy_RetryN
Session
   Microsoft_WindowsAzure_SessionHandler

Class: Microsoft_WindowsAzure_Storage_Table

Source Location: /WindowsAzure/Storage/Table.php

Class Overview

Microsoft_WindowsAzure_Storage
   |
   --Microsoft_WindowsAzure_Storage_BatchStorage
      |
      --Microsoft_WindowsAzure_Storage_Table



Author(s):

Copyright:

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

Methods

Inherited Constants

Class: Microsoft_WindowsAzure_Storage

Microsoft_WindowsAzure_Storage::RESOURCE_BLOB
Microsoft_WindowsAzure_Storage::RESOURCE_CONTAINER
Microsoft_WindowsAzure_Storage::RESOURCE_ENTITY
Microsoft_WindowsAzure_Storage::RESOURCE_QUEUE
Microsoft_WindowsAzure_Storage::RESOURCE_TABLE
Microsoft_WindowsAzure_Storage::RESOURCE_UNKNOWN
Microsoft_WindowsAzure_Storage::URL_CLOUD_BLOB
Microsoft_WindowsAzure_Storage::URL_CLOUD_QUEUE
Microsoft_WindowsAzure_Storage::URL_CLOUD_TABLE
Microsoft_WindowsAzure_Storage::URL_DEV_BLOB
Microsoft_WindowsAzure_Storage::URL_DEV_QUEUE
Microsoft_WindowsAzure_Storage::URL_DEV_TABLE

Inherited Variables

Class: Microsoft_WindowsAzure_Storage_BatchStorage

Microsoft_WindowsAzure_Storage_BatchStorage::$_currentBatch

Class: Microsoft_WindowsAzure_Storage

Microsoft_WindowsAzure_Storage::$_accountKey
Microsoft_WindowsAzure_Storage::$_accountName
Microsoft_WindowsAzure_Storage::$_apiVersion
Microsoft_WindowsAzure_Storage::$_credentials
Microsoft_WindowsAzure_Storage::$_host
Microsoft_WindowsAzure_Storage::$_proxyCredentials
Microsoft_WindowsAzure_Storage::$_proxyPort
Microsoft_WindowsAzure_Storage::$_proxyUrl
Microsoft_WindowsAzure_Storage::$_retryPolicy
Microsoft_WindowsAzure_Storage::$_usePathStyleUri
Microsoft_WindowsAzure_Storage::$_useProxy

Inherited Methods

Class: Microsoft_WindowsAzure_Storage_BatchStorage

Microsoft_WindowsAzure_Storage_BatchStorage::getCurrentBatch()
Get current batch
Microsoft_WindowsAzure_Storage_BatchStorage::isInBatch()
Is there a current batch?
Microsoft_WindowsAzure_Storage_BatchStorage::performBatch()
Perform batch using Microsoft_Http_Transport channel, combining all batch operations into one request
Microsoft_WindowsAzure_Storage_BatchStorage::setCurrentBatch()
Set current batch
Microsoft_WindowsAzure_Storage_BatchStorage::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::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 instance
Microsoft_WindowsAzure_Storage::isoDate()
Generate ISO 8601 compliant date string in UTC time zone
Microsoft_WindowsAzure_Storage::parseResponse()
Parse result from Microsoft_Http_Response
Microsoft_WindowsAzure_Storage::performRequest()
Perform request using Microsoft_Http_Transport channel
Microsoft_WindowsAzure_Storage::setCredentials()
Set Microsoft_WindowsAzure_Credentials instance
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

Class Details

[line 109]


Tags:

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


[ Top ]

Class Methods

constructor __construct [line 120]

Microsoft_WindowsAzure_Storage_Table __construct( [string $host = Microsoft_WindowsAzure_Storage::URL_DEV_TABLE], [string $accountName = Microsoft_WindowsAzure_Credentials::DEVSTORE_ACCOUNT], [string $accountKey = Microsoft_WindowsAzure_Credentials::DEVSTORE_KEY], [boolean $usePathStyleUri = false], [Microsoft_WindowsAzure_RetryPolicy $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   $retryPolicy   Retry policy to use when making requests

[ Top ]

method changeEntity [line 739]

void changeEntity( [string $httpVerb = Microsoft_Http_Transport::VERB_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 createTable [line 225]

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

Create table



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

string   $tableName   Table name

[ Top ]

method deleteEntity [line 390]

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 291]

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

Delete table



Tags:

throws:  Microsoft_WindowsAzure_Exception
access:  public


Parameters:

string   $tableName   Table name

[ Top ]

method fillTemplate [line 834]

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 849]

string generateAzureRepresentation( [Microsoft_WindowsAzure_Storage_TableEntity $entity = null])

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



Tags:

access:  protected


Parameters:

Microsoft_WindowsAzure_Storage_TableEntity   $entity  

[ Top ]

method getErrorMessage [line 721]

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 insertEntity [line 316]

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 160]

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 688]

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 501]

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 438]

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 rfcDate [line 822]

string rfcDate( )

Generate RFC 1123 compliant date string



Tags:

access:  protected


[ Top ]

method select [line 485]

Microsoft_WindowsAzure_Storage_TableEntityQuery select( )

Create a new Microsoft_WindowsAzure_Storage_TableEntityQuery



Tags:

access:  public


[ Top ]

method tableExists [line 137]

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

Check if a table exists



Tags:

access:  public


Parameters:

string   $tableName   Table name

[ Top ]

method updateEntity [line 674]

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 ]

Documentation generated on Thu, 26 Nov 2009 08:05:33 +0100 by phpDocumentor 1.4.3