Cloud/DocumentService/Adapter/WindowsAzure.php

Show:

inherited

Classes
- \Zend_Cloud_DocumentService_Adapter_WindowsAzure

Table of Contents

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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Cloud
Subpackage: DocumentService

\Zend_Cloud_DocumentService_Adapter_WindowsAzure
jump to top

Package: Zend_Cloud\DocumentService

SimpleDB adapter for document service.

Provides functionality surrounding setting classes for each of: - document objects - document set objects - query class objects

Parent(s): \Zend_Cloud_DocumentService_Adapter_AbstractAdapter
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                ACCOUNT_NAME
                = 'storage_accountname'

 
                ACCOUNT_KEY
                = 'storage_accountkey'

 
                HOST
                = "storage_host"

 
                PROXY_HOST
                = "storage_proxy_host"

 
                PROXY_PORT
                = "storage_proxy_port"

 
                PROXY_CREDENTIALS
                = "storage_proxy_credentials"

 
                DEFAULT_PARTITION_KEY
                = "default_partition_key"

 
                PARTITION_KEY
                = 'PartitionKey'

 
                ROW_KEY
                = 'RowKey'

 
                VERIFY_ETAG
                = "verify_etag"

 
                TIMESTAMP_KEY
                = "Timestamp"

 
                DEFAULT_HOST
                = \Zend_Service_WindowsAzure_Storage::URL_CLOUD_TABLE

 
                DEFAULT_QUERY_CLASS
                = 'Zend_Cloud_DocumentService_Adapter_WindowsAzure_Query'

Properties

string $_defaultPartitionKey

Partition key to use by default when constructing document identifiers

Details

Type: string

string $_queryClass = 'Zend_Cloud_DocumentService_Adapter_WindowsAzure_Query'

Class to utilize for new query objects

Default value'Zend_Cloud_DocumentService_Adapter_WindowsAzure_Query'Details

Type: string

\Zend_Service_WindowsAzure_Storage_Table $_storageClient

Azure service instance.

Details

Type: \Zend_Service_WindowsAzure_Storage_Table

Methods

__construct(array $options = array()) : void

Constructor

Parameters

Name	Type	Description
$options	array

_getDocumentFromArray(array $document, null | string $collectionName = null) : \Zend_Cloud_DocumentService_Document

Create suitable document from array of fields

Parameters

Name	Type	Description
$document	array
$collectionName	null \| string	Collection to which this document belongs

Returns

Type	Description
\Zend_Cloud_DocumentService_Document

_resolveAttributes(\Zend_Service_WindowsAzure_Storage_TableEntity $entity) : array

Resolve table values to attributes

Parameters

Name	Type	Description
$entity	\Zend_Service_WindowsAzure_Storage_TableEntity

Returns

Type	Description
array

_validateCompositeKey(array $key) : \throws

Validate a composite key

Parameters

Name	Type	Description
$key	array

Returns

Type	Description
\throws	Zend_Cloud_DocumentService_Exception

_validateDocumentId(array | string $documentId, null | string $collectionName = false) : array

Validate a document identifier

If the identifier is an array containing a valid partition and row key, returns it. If the identifier is a string: - if a default partition key is present, it creates an identifier using that and the provided document ID - if a collection name is provided, it will use that for the partition key - otherwise, it's invalid

Parameters

Name	Type	Description
$documentId	array \| string
$collectionName	null \| string

Returns

Type	Description
array

Throws

Exception	Description
\Zend_Cloud_DocumentService_Exception

_validateFieldKey(string $key) : void

Validate an individual field name for well-formedness

Since Azure uses Atom, and fieldnames are included as part of XML element tag names, the field names must be valid XML names. While we could potentially normalize names, this could also lead to conflict with other field names -- which we should avoid. As such, invalid field names will raise an exception.

Parameters

Name	Type	Description
$key	string

Throws

Exception	Description
\Zend_Cloud_DocumentService_Exception

_validateFields(\Zend_Cloud_DocumentService_Document | array $document) : void

Validate a document's fields for well-formedness

Since Azure uses Atom, and fieldnames are included as part of XML element tag names, the field names must be valid XML names.

Parameters

Name	Type	Description
$document	\Zend_Cloud_DocumentService_Document \| array

Throws

Exception	Description
\Zend_Cloud_DocumentService_Exception

_validateKey(string $key) : void

Validate a partition or row key

Parameters

Name	Type	Description
$key	string

Throws

Exception	Description
\Zend_Cloud_DocumentService_Exception

createCollection(string $name, array $options = null) : boolean

Create collection.

Parameters

Name	Type	Description
$name	string
$options	array

Returns

Type	Description
boolean

deleteCollection(string $name, array $options = null) : boolean

Delete collection.

Parameters

Name	Type	Description
$name	string
$options	array

Returns

Type	Description
boolean

deleteDocument( $collectionName, $documentId, array $options = null) : void

Delete document.

Parameters

Name	Type	Description
$collectionName
$documentId
$options	array

fetchDocument(string $collectionName, mixed $documentId, array $options = null) : \Zend_Cloud_DocumentService_Document

Fetch single document by ID

Parameters

Name	Type	Description
$collectionName	string	Collection name
$documentId	mixed	Document ID, adapter-dependent
$options	array

Returns

Type	Description
\Zend_Cloud_DocumentService_Document

getClient() : \Zend_Service_WindowsAzure_Storage_Table

Get the concrete service client

Returns

Type	Description
\Zend_Service_WindowsAzure_Storage_Table

getDefaultPartitionKey() : null | string

Retrieve default partition key

Returns

Type	Description
null \| string

insertDocument( $collectionName, array | \Zend_Cloud_DocumentService_Document $document, array $options = null) : boolean

Insert document

Parameters

Name	Type	Description
$collectionName
$document	array \| \Zend_Cloud_DocumentService_Document
$options	array

Returns

Type	Description
boolean

listCollections(array $options = null) : array

List collections.

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
array

listDocuments(string $collectionName, null | array $options = null) : \Zend_Cloud_DocumentService_DocumentSet

List all documents in a collection

Parameters

Name	Type	Description
$collectionName	string
$options	null \| array

Returns

Type	Description
\Zend_Cloud_DocumentService_DocumentSet

query(string $collectionName, string | \Zend_Cloud_DocumentService_Adapter_WindowsAzure_Query $query, array $options = null) : array

Query for documents stored in the document service. If a string is passed in $query, the query string will be passed directly to the service.

Parameters

Name	Type	Description
$collectionName	string	Collection name
$query	string \| \Zend_Cloud_DocumentService_Adapter_WindowsAzure_Query
$options	array

Returns

Type	Description
array	Zend_Cloud_DocumentService_DocumentSet

replaceDocument( $collectionName, \Zend_Cloud_DocumentService_Document $document, array $options = null) : boolean

Replace document.

The new document replaces the existing document.

Parameters

Name	Type	Description
$collectionName
$document	\Zend_Cloud_DocumentService_Document
$options	array

Returns

Type	Description
boolean

select( $fields = null) : \Zend_Cloud_DocumentService_Query

Create query statement

Parameters

Name	Type	Description
$fields

Returns

Type	Description
\Zend_Cloud_DocumentService_Query

setDefaultPartitionKey(string $key) : \Zend_Cloud_DocumentService_Adapter_WindowsAzure

Set the default partition key

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
\Zend_Cloud_DocumentService_Adapter_WindowsAzure

updateDocument(string $collectionName, mixed | \Zend_Cloud_DocumentService_Document $documentId,  $fieldset = null, array $options = null) : boolean

Update document.

The new document is merged the existing document.

Parameters

Name	Type	Description
$collectionName	string
$documentId	mixed \| \Zend_Cloud_DocumentService_Document	Document identifier or document contaiing updates
$fieldset
$options	array

Returns

Type	Description
boolean

Cloud/DocumentService/Adapter/WindowsAzure.php

\Zend_Cloud_DocumentService_Adapter_WindowsAzurejump to top

Constants

Properties

Methods

\Zend_Cloud_DocumentService_Adapter_WindowsAzure
jump to top