Zend Framework
1.12
|
Public Member Functions | |
setThrowExceptionOnMissingData ($value=true) | |
Throw Zend_Service_WindowsAzure_Exception when a property is not specified in Windows Azure? Defaults to true, making behaviour similar to Windows Azure StorageClient in .NET. | |
getThrowExceptionOnMissingData () | |
Throw Zend_Service_WindowsAzure_Exception when a property is not specified in Windows Azure? | |
__construct ($host=Zend_Service_WindowsAzure_Storage::URL_DEV_TABLE, $accountName=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT, $accountKey=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY, $usePathStyleUri=false, Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy=null) | |
Creates a new Zend_Service_WindowsAzure_Storage_Table instance. | |
tableExists ($tableName= '') | |
Check if a table exists. | |
listTables ($nextTableName= '') | |
List tables. | |
createTable ($tableName= '') | |
Create table. | |
createTableIfNotExists ($tableName= '') | |
Create table if it does not exist. | |
deleteTable ($tableName= '') | |
Delete table. | |
insertEntity ($tableName= '', Zend_Service_WindowsAzure_Storage_TableEntity $entity=null) | |
Insert entity into table. | |
deleteEntity ($tableName= '', Zend_Service_WindowsAzure_Storage_TableEntity $entity=null, $verifyEtag=false) | |
Delete entity from table. | |
retrieveEntityById ($tableName, $partitionKey, $rowKey, $entityClass= 'Zend_Service_WindowsAzure_Storage_DynamicTableEntity') | |
Retrieve entity from table, by id. | |
select () | |
Create a new Zend_Service_WindowsAzure_Storage_TableEntityQuery. | |
retrieveEntities ($tableName= '', $filter= '', $entityClass= 'Zend_Service_WindowsAzure_Storage_DynamicTableEntity', $nextPartitionKey=null, $nextRowKey=null) | |
Retrieve entities from table. | |
updateEntity ($tableName= '', Zend_Service_WindowsAzure_Storage_TableEntity $entity=null, $verifyEtag=false) | |
Update entity by replacing it. | |
mergeEntity ($tableName= '', Zend_Service_WindowsAzure_Storage_TableEntity $entity=null, $verifyEtag=false, $properties=array()) | |
Update entity by adding or updating properties. | |
![]() | |
setCurrentBatch (Zend_Service_WindowsAzure_Storage_Batch $batch=null) | |
Set current batch. | |
getCurrentBatch () | |
Get current batch. | |
isInBatch () | |
Is there a current batch? | |
startBatch () | |
Starts a new batch operation set. | |
performBatch ($operations=array(), $forTableStorage=false, $isSingleSelect=false, $resourceType=Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN, $requiredPermission=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ) | |
Perform batch using Zend_Http_Client channel, combining all batch operations into one request. | |
![]() | |
__construct ($host=self::URL_DEV_BLOB, $accountName=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT, $accountKey=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY, $usePathStyleUri=false, Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy=null) | |
Creates a new Zend_Service_WindowsAzure_Storage instance. | |
setHttpClientChannel ($adapterInstance= 'Zend_Http_Client_Adapter_Proxy') | |
Set the HTTP client channel to use. | |
getHttpClientChannel () | |
Retrieve HTTP client channel. | |
setRetryPolicy (Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy=null) | |
Set retry policy to use when making requests. | |
setProxy ($useProxy=false, $proxyUrl= '', $proxyPort=80, $proxyCredentials= '') | |
Set proxy. | |
getAccountName () | |
Returns the Windows Azure account name. | |
getBaseUrl () | |
Get base URL for creating requests. | |
setCredentials (Zend_Service_WindowsAzure_Credentials_CredentialsAbstract $credentials) | |
Set Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance. | |
getCredentials () | |
Get Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance. | |
isoDate ($timestamp=null) | |
Generate ISO 8601 compliant date string in UTC time zone. | |
Protected Member Functions | |
_getErrorMessage (Zend_Http_Response $response, $alternativeError= 'Unknown error.') | |
Get error message from Zend_Http_Response. | |
_changeEntity ($httpVerb=Zend_Http_Client::PUT, $tableName= '', Zend_Service_WindowsAzure_Storage_TableEntity $entity=null, $verifyEtag=false) | |
Update entity / merge entity. | |
_rfcDate () | |
Generate RFC 1123 compliant date string. | |
_fillTemplate ($templateText, $variables=array()) | |
Fill text template with variables from key/value array. | |
_generateAzureRepresentation (Zend_Service_WindowsAzure_Storage_TableEntity $entity=null) | |
Generate Azure representation from entity (creates atompub markup from properties) | |
_performRequest ($path= '/', $queryString= '', $httpVerb=Zend_Http_Client::GET, $headers=array(), $forTableStorage=false, $rawData=null, $resourceType=Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN, $requiredPermission=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ) | |
Perform request using Zend_Http_Client channel. | |
_convertToDateTime ($value= '') | |
Converts a string to a DateTime object. | |
_convertToEdmDateTime (DateTime $value) | |
Converts a DateTime object into an Edm.DaeTime value in UTC timezone, represented as a string. | |
Protected Attributes | |
$_throwExceptionOnMissingData = true | |
![]() | |
$_currentBatch = null | |
![]() | |
$_apiVersion = '2009-09-19' | |
$_host = '' | |
$_accountName = '' | |
$_accountKey = '' | |
$_usePathStyleUri = false | |
$_credentials = null | |
$_retryPolicy = null | |
$_httpClientChannel = null | |
$_useProxy = false | |
$_proxyUrl = '' | |
$_proxyPort = 80 | |
$_proxyCredentials = '' | |
Additional Inherited Members | |
![]() | |
static | urlencode ($value) |
URL encode function. | |
static | isValidMetadataName ($metadataName= '') |
Is valid metadata name? | |
static | createQueryStringFromArray ($queryString) |
Builds a query string from an array of elements. | |
![]() | |
const | URL_DEV_BLOB = "127.0.0.1:10000" |
Development storage URLS. | |
const | URL_DEV_QUEUE = "127.0.0.1:10001" |
const | URL_DEV_TABLE = "127.0.0.1:10002" |
const | URL_CLOUD_BLOB = "blob.core.windows.net" |
Live storage URLS. | |
const | URL_CLOUD_QUEUE = "queue.core.windows.net" |
const | URL_CLOUD_TABLE = "table.core.windows.net" |
const | RESOURCE_UNKNOWN = "unknown" |
Resource types. | |
const | RESOURCE_CONTAINER = "c" |
const | RESOURCE_BLOB = "b" |
const | RESOURCE_TABLE = "t" |
const | RESOURCE_ENTITY = "e" |
const | RESOURCE_QUEUE = "q" |
const | PREFIX_PROPERTIES = "x-ms-prop-" |
HTTP header prefixes. | |
const | PREFIX_METADATA = "x-ms-meta-" |
const | PREFIX_STORAGE_HEADER = "x-ms-" |
__construct | ( | $host = Zend_Service_WindowsAzure_Storage::URL_DEV_TABLE , |
|
$accountName = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT , |
|||
$accountKey = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY , |
|||
$usePathStyleUri = false , |
|||
Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract | $retryPolicy = null |
||
) |
Creates a new Zend_Service_WindowsAzure_Storage_Table instance.
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 |
Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract | $retryPolicy | Retry policy to use when making requests |
|
protected |
Update entity / merge entity.
string | $httpVerb | HTTP verb to use (PUT = update, MERGE = merge) |
string | $tableName | Table name |
Zend_Service_WindowsAzure_Storage_TableEntity | $entity | Entity to update |
boolean | $verifyEtag | Verify etag of the entity (used for concurrency) |
Zend_Service_WindowsAzure_Exception |
|
protected |
Converts a string to a DateTime object.
Returns false on failure.
string | $value | The string value to parse |
|
protected |
Converts a DateTime object into an Edm.DaeTime value in UTC timezone, represented as a string.
DateTime | $value |
|
protected |
Fill text template with variables from key/value array.
string | $templateText | Template text |
array | $variables | Array containing key/value pairs |
|
protected |
Generate Azure representation from entity (creates atompub markup from properties)
Zend_Service_WindowsAzure_Storage_TableEntity | $entity |
|
protected |
Get error message from Zend_Http_Response.
Zend_Http_Response | $response | Repsonse |
string | $alternativeError | Alternative error message |
|
protected |
Perform request using Zend_Http_Client channel.
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 |
|
protected |
Generate RFC 1123 compliant date string.
createTable | ( | $tableName = '' | ) |
createTableIfNotExists | ( | $tableName = '' | ) |
Create table if it does not exist.
string | $tableName | Table name |
Zend_Service_WindowsAzure_Exception |
deleteEntity | ( | $tableName = '' , |
|
Zend_Service_WindowsAzure_Storage_TableEntity | $entity = null , |
||
$verifyEtag = false |
|||
) |
Delete entity from table.
string | $tableName | Table name |
Zend_Service_WindowsAzure_Storage_TableEntity | $entity | Entity to delete |
boolean | $verifyEtag | Verify etag of the entity (used for concurrency) |
Zend_Service_WindowsAzure_Exception |
deleteTable | ( | $tableName = '' | ) |
getThrowExceptionOnMissingData | ( | ) |
Throw Zend_Service_WindowsAzure_Exception when a property is not specified in Windows Azure?
insertEntity | ( | $tableName = '' , |
|
Zend_Service_WindowsAzure_Storage_TableEntity | $entity = null |
||
) |
Insert entity into table.
string | $tableName | Table name |
Zend_Service_WindowsAzure_Storage_TableEntity | $entity | Entity to insert |
Zend_Service_WindowsAzure_Exception |
listTables | ( | $nextTableName = '' | ) |
List tables.
string | $nextTableName | Next table name, used for listing tables when total amount of tables is > 1000. |
Zend_Service_WindowsAzure_Exception |
mergeEntity | ( | $tableName = '' , |
|
Zend_Service_WindowsAzure_Storage_TableEntity | $entity = null , |
||
$verifyEtag = false , |
|||
$properties = array() |
|||
) |
Update entity by adding or updating properties.
string | $tableName | Table name |
Zend_Service_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. |
Zend_Service_WindowsAzure_Exception |
retrieveEntities | ( | $tableName = '' , |
|
$filter = '' , |
|||
$entityClass = 'Zend_Service_WindowsAzure_Storage_DynamicTableEntity' , |
|||
$nextPartitionKey = null , |
|||
$nextRowKey = null |
|||
) |
Retrieve entities from table.
string | $tableName,|Zend_Service_WindowsAzure_Storage_TableEntityQuery | Table name -or- Zend_Service_WindowsAzure_Storage_TableEntityQuery instance |
string | $filter | Filter condition (not applied when $tableName is a Zend_Service_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. |
Zend_Service_WindowsAzure_Exception |
retrieveEntityById | ( | $tableName, | |
$partitionKey, | |||
$rowKey, | |||
$entityClass = 'Zend_Service_WindowsAzure_Storage_DynamicTableEntity' |
|||
) |
Retrieve entity from table, by id.
string | $tableName | Table name |
string | $partitionKey | Partition key |
string | $rowKey | Row key |
string | $entityClass | Entity class name* |
Zend_Service_WindowsAzure_Exception |
select | ( | ) |
setThrowExceptionOnMissingData | ( | $value = true | ) |
Throw Zend_Service_WindowsAzure_Exception when a property is not specified in Windows Azure? Defaults to true, making behaviour similar to Windows Azure StorageClient in .NET.
boolean | $value |
tableExists | ( | $tableName = '' | ) |
Check if a table exists.
string | $tableName | Table name |
updateEntity | ( | $tableName = '' , |
|
Zend_Service_WindowsAzure_Storage_TableEntity | $entity = null , |
||
$verifyEtag = false |
|||
) |
Update entity by replacing it.
string | $tableName | Table name |
Zend_Service_WindowsAzure_Storage_TableEntity | $entity | Entity to update |
boolean | $verifyEtag | Verify etag of the entity (used for concurrency) |
Zend_Service_WindowsAzure_Exception |
|
protected |