Zend_Cloud_DocumentService_Adapter_SimpleDb Class Reference

Public Member Functions
	__construct ($options=array())
	Constructor.
	createCollection ($name, $options=null)
	Create collection.
	deleteCollection ($name, $options=null)
	Delete collection.
	listCollections ($options=null)
	List collections.
	listDocuments ($collectionName, array $options=null)
	List documents.
	insertDocument ($collectionName, $document, $options=null)
	Insert document.
	replaceDocument ($collectionName, $document, $options=null)
	Replace an existing document with a new version.
	updateDocument ($collectionName, $documentId, $fieldset=null, $options=null)
	Update document.
	deleteDocument ($collectionName, $document, $options=null)
	Delete document.
	fetchDocument ($collectionName, $documentId, $options=null)
	Fetch single document by ID.
	query ($collectionName, $query, $options=null)
	Query for documents stored in the document service.
	select ($fields=null)
	Create query statement.
	getClient ()
	Get the concrete service client.
Public Member Functions inherited from Zend_Cloud_DocumentService_Adapter_AbstractAdapter
	setDocumentClass ($class)
	Set the class for document objects.
	getDocumentClass ()
	Get the class for document objects.
	setDocumentSetClass ($class)
	Set the class for document set objects.
	getDocumentSetClass ()
	Get the class for document set objects.
	setQueryClass ($class)
	Set the query class for query objects.
	getQueryClass ()
	Get the class for query objects.

Public Attributes
const	AWS_ACCESS_KEY = 'aws_accesskey'
const	AWS_SECRET_KEY = 'aws_secretkey'
const	ITEM_NAME = 'ItemName'
const	MERGE_OPTION = "merge"
const	RETURN_DOCUMENTS = "return_documents"
const	DEFAULT_QUERY_CLASS = 'Zend_Cloud_DocumentService_Adapter_SimpleDb_Query'
Public Attributes inherited from Zend_Cloud_DocumentService_Adapter_AbstractAdapter
const	DOCUMENT_CLASS = 'document_class'
const	DOCUMENTSET_CLASS = 'documentset_class'
const	QUERY_CLASS = 'query_class'
Public Attributes inherited from Zend_Cloud_DocumentService_Adapter
const	HTTP_ADAPTER = 'http_adapter'

Protected Member Functions
	_makeAttributes ($name, $attributes)
	Convert array of key-value pairs to array of Amazon attributes.
	_resolveAttributes ($attributes, $returnDocument=false)
	Convert array of Amazon attributes to array of key-value pairs.
	_getDocumentFromArray ($document)
	Create suitable document from array of fields.
	_getDocumentSetFromResultSet (Zend_Service_Amazon_SimpleDb_Page $resultSet, $returnDocs=true)
	Create a DocumentSet from a SimpleDb resultset.

Protected Attributes
	$_simpleDb
	$_queryClass = 'Zend_Cloud_DocumentService_Adapter_SimpleDb_Query'
Protected Attributes inherited from Zend_Cloud_DocumentService_Adapter_AbstractAdapter
	$_documentClass = 'Zend_Cloud_DocumentService_Document'
	$_documentSetClass = 'Zend_Cloud_DocumentService_DocumentSet'
	$_queryClass = 'Zend_Cloud_DocumentService_Query'

Constructor & Destructor Documentation

__construct

(

$options = array()

)

Constructor.

Parameters

array | Zend_Config

$options

Returns

void

Member Function Documentation

_getDocumentFromArray (   $document )

protected

Create suitable document from array of fields.

Parameters

array

$document

Returns

Zend_Cloud_DocumentService_Document

_getDocumentSetFromResultSet ( Zend_Service_Amazon_SimpleDb_Page  $resultSet,   $returnDocs = true  )

protected

Create a DocumentSet from a SimpleDb resultset.

Parameters

Zend_Service_Amazon_SimpleDb_Page	$resultSet
bool	$returnDocs

Returns

Zend_Cloud_DocumentService_DocumentSet

_makeAttributes (   $name,   $attributes  )

protected

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

Parameters

string	$name
array	$attributes

Returns

array

_resolveAttributes (   $attributes,   $returnDocument = false  )

protected

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

Parameters

array

$attributes

Returns

array

createCollection	(		$name,
			$options = null
	)

Create collection.

Parameters

string	$name
array	$options

Returns

void

Implements Zend_Cloud_DocumentService_Adapter.

deleteCollection	(		$name,
			$options = null
	)

Delete collection.

Parameters

string	$name
array	$options

Returns

void

Implements Zend_Cloud_DocumentService_Adapter.

deleteDocument	(		$collectionName,
			$document,
			$options = null
	)

Delete document.

Parameters

string	$collectionName	Collection from which to delete document
mixed	$document	Document ID or Document object.
array	$options

Returns

boolean

Implements Zend_Cloud_DocumentService_Adapter.

fetchDocument	(		$collectionName,
			$documentId,
			$options = null
	)

Fetch single document by ID.

Parameters

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

Returns

Zend_Cloud_DocumentService_Document

Implements Zend_Cloud_DocumentService_Adapter.

getClient

(

)

Get the concrete service client.

Returns

Zend_Service_Amazon_SimpleDb

Implements Zend_Cloud_DocumentService_Adapter.

insertDocument	(		$collectionName,
			$document,
			$options = null
	)

Insert document.

Parameters

string	$collectionName	Collection into which to insert document
array | Zend_Cloud_DocumentService_Document	$document
array	$options

Returns

void

Implements Zend_Cloud_DocumentService_Adapter.

listCollections

(

$options = null

)

List collections.

Parameters

array

$options

Returns

array

Implements Zend_Cloud_DocumentService_Adapter.

listDocuments	(		$collectionName,
		array	$options = null
	)

List documents.

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

Parameters

string	$collectionName	Name of collection for which to list documents
array | null	$options

Returns

Zend_Cloud_DocumentService_DocumentSet

Implements Zend_Cloud_DocumentService_Adapter.

query	(		$collectionName,
			$query,
			$options = null
	)

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

string	$collectionName	Collection name
string	$query
array	$options

Returns

array Zend_Cloud_DocumentService_DocumentSet

Implements Zend_Cloud_DocumentService_Adapter.

replaceDocument	(		$collectionName,
			$document,
			$options = null
	)

Replace an existing document with a new version.

Parameters

string	$collectionName
array | Zend_Cloud_DocumentService_Document	$document
array	$options

Returns

void

Implements Zend_Cloud_DocumentService_Adapter.

select

(

$fields = null

)

Create query statement.

Parameters

string

$fields

Returns

Zend_Cloud_DocumentService_Adapter_SimpleDb_Query

Implements Zend_Cloud_DocumentService_Adapter.

updateDocument	(		$collectionName,
			$documentId,
			$fieldset = null,
			$options = null
	)

Update document.

The new document replaces the existing document.

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

Parameters

string	$collectionName
mixed | Zend_Cloud_DocumentService_Document	$documentId	Document ID, adapter-dependent
array | Zend_Cloud_DocumentService_Document	$fieldset	Set of fields to update
array	$options

Returns

boolean

Implements Zend_Cloud_DocumentService_Adapter.

Member Data Documentation

$_queryClass = 'Zend_Cloud_DocumentService_Adapter_SimpleDb_Query'

protected

$_simpleDb

protected

const AWS_ACCESS_KEY = 'aws_accesskey'

const AWS_SECRET_KEY = 'aws_secretkey'

const DEFAULT_QUERY_CLASS = 'Zend_Cloud_DocumentService_Adapter_SimpleDb_Query'

const ITEM_NAME = 'ItemName'

const MERGE_OPTION = "merge"

const RETURN_DOCUMENTS = "return_documents"