SimpleDB adapter for document service.

Provides functionality surrounding setting classes for each of:

  • document objects
  • document set objects
  • query class objects
category Zend
package Zend_Cloud
subpackage DocumentService
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Cloud_DocumentService_Adapter_AbstractAdapter

 Methods

Constructor

__construct(array|\Zend_Config $options = array()) : void

Parameters

$options

array\Zend_Config

Create collection.

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

Parameters

$name

string

$options

array

Delete collection.

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

Parameters

$name

string

$options

array

Delete document.

deleteDocument(string $collectionName, mixed $document, array $options = null) : boolean

Parameters

$collectionName

string

Collection from which to delete document

$document

mixed

Document ID or Document object.

$options

array

Returns

boolean

Fetch single document by ID

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

Parameters

$collectionName

string

Collection name

$documentId

mixed

Document ID, adapter-dependent

$options

array

Returns

\Zend_Cloud_DocumentService_Document

Get the concrete service client

getClient() : \Zend_Service_Amazon_SimpleDb

Returns

\Zend_Service_Amazon_SimpleDb

Get the class for document objects

getDocumentClass() : string
Inherited

Returns

string

Get the class for document set objects

getDocumentSetClass() : string
Inherited

Returns

string

Get the class for query objects

getQueryClass() : string
Inherited

Returns

string

Insert document

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

Parameters

$collectionName

string

Collection into which to insert document

$document

array\Zend_Cloud_DocumentService_Document

$options

array

List collections.

listCollections(array $options = null) : array

Parameters

$options

array

Returns

array

List documents

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

Returns a key/value array of document names to document objects.

Parameters

$collectionName

string

Name of collection for which to list documents

$options

arraynull

Returns

\Zend_Cloud_DocumentService_DocumentSet

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.

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

Parameters

$collectionName

string

Collection name

$query

string

$options

array

Returns

arrayZend_Cloud_DocumentService_DocumentSet

Replace an existing document with a new version

replaceDocument(string $collectionName, array|\Zend_Cloud_DocumentService_Document $document, array $options = null) : void

Parameters

$collectionName

string

$document

array\Zend_Cloud_DocumentService_Document

$options

array

Create query statement

select(string $fields = null) : \Zend_Cloud_DocumentService_Adapter_SimpleDb_Query

Parameters

$fields

string

Returns

\Zend_Cloud_DocumentService_Adapter_SimpleDb_Query

Set the class for document objects

setDocumentClass(string $class) : \Zend_Cloud_DocumentService_Adapter_AbstractAdapter
Inherited

Parameters

$class

string

Returns

\Zend_Cloud_DocumentService_Adapter_AbstractAdapter

Set the class for document set objects

setDocumentSetClass(string $class) : \Zend_Cloud_DocumentService_Adapter_AbstractAdapter
Inherited

Parameters

$class

string

Returns

\Zend_Cloud_DocumentService_Adapter_AbstractAdapter

Set the query class for query objects

setQueryClass(string $class) : \Zend_Cloud_DocumentService_Adapter_AbstractAdapter
Inherited

Parameters

$class

string

Returns

\Zend_Cloud_DocumentService_Adapter_AbstractAdapter

Update document. The new document replaces the existing document.

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

Option 'merge' specifies to add all attributes (if true) or specific attributes ("attr" => true) instead of replacing them. By default, attributes are replaced.

Parameters

$collectionName

string

$documentId

mixed\Zend_Cloud_DocumentService_Document

Document ID, adapter-dependent

$fieldset

array\Zend_Cloud_DocumentService_Document

Set of fields to update

$options

array

Returns

boolean

Create suitable document from array of fields

_getDocumentFromArray(array $document) : \Zend_Cloud_DocumentService_Document

Parameters

$document

array

Returns

\Zend_Cloud_DocumentService_Document

Create a DocumentSet from a SimpleDb resultset

_getDocumentSetFromResultSet(\Zend_Service_Amazon_SimpleDb_Page $resultSet, boolean $returnDocs = true) : \Zend_Cloud_DocumentService_DocumentSet

Parameters

$resultSet

\Zend_Service_Amazon_SimpleDb_Page

$returnDocs

boolean

Returns

\Zend_Cloud_DocumentService_DocumentSet

Convert array of key-value pairs to array of Amazon attributes

_makeAttributes(string $name, array $attributes) : array

Parameters

$name

string

$attributes

array

Returns

array

Convert array of Amazon attributes to array of key-value pairs

_resolveAttributes(array $attributes, $returnDocument = false) : array

Parameters

$attributes

array

$returnDocument

Returns

array

 Properties

 

Class to utilize for new document objects

$_documentClass : string

Default

'Zend_Cloud_DocumentService_Document'
 

Class to utilize for new document set objects

$_documentSetClass : string

Default

'Zend_Cloud_DocumentService_DocumentSet'
 

Class to utilize for new query objects

$_queryClass : string

Default

'Zend_Cloud_DocumentService_Adapter_SimpleDb_Query'
inherited_from \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::_queryClass
 

Class to utilize for new query objects

$_queryClass : string

Default

'Zend_Cloud_DocumentService_Query'
 

SQS service instance.

$_simpleDb : \Zend_Service_Amazon_SimpleDb

Default

 Constants

 

AWS_ACCESS_KEY

AWS_ACCESS_KEY = 'aws_accesskey' 
 

AWS_SECRET_KEY

AWS_SECRET_KEY = 'aws_secretkey' 
 

DEFAULT_QUERY_CLASS

DEFAULT_QUERY_CLASS = 'Zend_Cloud_DocumentService_Adapter_SimpleDb_Query' 
 

DOCUMENTSET_CLASS

DOCUMENTSET_CLASS = 'documentset_class' 
 

DOCUMENT_CLASS

DOCUMENT_CLASS = 'document_class' 
 

ITEM_NAME

ITEM_NAME = 'ItemName' 
 

MERGE_OPTION

MERGE_OPTION = "merge" 
 

QUERY_CLASS

QUERY_CLASS = 'query_class' 
 

RETURN_DOCUMENTS

RETURN_DOCUMENTS = "return_documents"