Cloud/DocumentService/Adapter/SimpleDb.php

Show:

inherited

Classes
- \Zend_Cloud_DocumentService_Adapter_SimpleDb

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-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Cloud
Subpackage: DocumentService

\Zend_Cloud_DocumentService_Adapter_SimpleDb
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-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                AWS_ACCESS_KEY
                = 'aws_accesskey'

 
                AWS_SECRET_KEY
                = 'aws_secretkey'

 
                ITEM_NAME
                = 'ItemName'

 
                MERGE_OPTION
                = "merge"

 
                RETURN_DOCUMENTS
                = "return_documents"

 
                DEFAULT_QUERY_CLASS
                = 'Zend_Cloud_DocumentService_Adapter_SimpleDb_Query'

 
                DOCUMENT_CLASS
                = 'document_class'

inheritedInherited from: \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::DOCUMENT_CLASS

Inherited_from: \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::DOCUMENT_CLASS

 
                DOCUMENTSET_CLASS
                = 'documentset_class'

inheritedInherited from: \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::DOCUMENTSET_CLASS

Inherited_from: \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::DOCUMENTSET_CLASS

 
                QUERY_CLASS
                = 'query_class'

inheritedInherited from: \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::QUERY_CLASS

Inherited_from: \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::QUERY_CLASS

 
                HTTP_ADAPTER
                = 'http_adapter'

inheritedInherited from: \Zend_Cloud_DocumentService_Adapter::HTTP_ADAPTER \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::HTTP_ADAPTER

Inherited_from: \Zend_Cloud_DocumentService_Adapter::HTTP_ADAPTER
Inherited_from: \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::HTTP_ADAPTER

Properties

string $_documentClass = 'Zend_Cloud_DocumentService_Document'

inherited

Class to utilize for new document objects

Inherited from: \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::$$_documentClass

Default value'Zend_Cloud_DocumentService_Document'Details

Type: string
Inherited_from: \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::$$_documentClass

string $_documentSetClass = 'Zend_Cloud_DocumentService_DocumentSet'

inherited

Class to utilize for new document set objects

Inherited from: \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::$$_documentSetClass

Default value'Zend_Cloud_DocumentService_DocumentSet'Details

Type: string
Inherited_from: \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::$$_documentSetClass

string $_queryClass = 'Zend_Cloud_DocumentService_Adapter_SimpleDb_Query'

Class to utilize for new query objects

Default value'Zend_Cloud_DocumentService_Adapter_SimpleDb_Query'Details

Type: string

\Zend_Service_Amazon_SimpleDb $_simpleDb =

SQS service instance.

Details

Type: \Zend_Service_Amazon_SimpleDb

Methods

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

Constructor

Parameters

Name	Type	Description
$options	array \| \Zend_Config

_getDocumentFromArray(array $document) : \Zend_Cloud_DocumentService_Document

Create suitable document from array of fields

Parameters

Name	Type	Description
$document	array

Returns

Type	Description
\Zend_Cloud_DocumentService_Document

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

Create a DocumentSet from a SimpleDb resultset

Parameters

Name	Type	Description
$resultSet	\Zend_Service_Amazon_SimpleDb_Page
$returnDocs	bool

Returns

Type	Description
\Zend_Cloud_DocumentService_DocumentSet

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

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

Parameters

Name	Type	Description
$name	string
$attributes	array

Returns

Type	Description
array

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

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

Parameters

Name	Type	Description
$attributes	array
$returnDocument

Returns

Type	Description
array

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

Create collection.

Parameters

Name	Type	Description
$name	string
$options	array

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

Delete collection.

Parameters

Name	Type	Description
$name	string
$options	array

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

Delete document.

Parameters

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

Returns

Type	Description
boolean

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

Fetch single document by ID

Will return false if the document does not exist

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_Amazon_SimpleDb

Get the concrete service client

Returns

Type	Description
\Zend_Service_Amazon_SimpleDb

getDocumentClass() : string

inherited

Get the class for document objects

Inherited from: \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::getDocumentClass()

Returns

Type	Description
string

getDocumentSetClass() : string

inherited

Get the class for document set objects

Inherited from: \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::getDocumentSetClass()

Returns

Type	Description
string

getQueryClass() : string

inherited

Get the class for query objects

Inherited from: \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::getQueryClass()

Returns

Type	Description
string

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

Insert document

Parameters

Name	Type	Description
$collectionName	string	Collection into which to insert document
$document	array \| \Zend_Cloud_DocumentService_Document
$options	array

listCollections(array $options = null) : array

List collections.

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
array

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

List documents

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

Parameters

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

Returns

Type	Description
\Zend_Cloud_DocumentService_DocumentSet

query(string $collectionName, string $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
$options	array

Returns

Type	Description
array	Zend_Cloud_DocumentService_DocumentSet

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

Replace an existing document with a new version

Parameters

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

select(string $fields = null) : \Zend_Cloud_DocumentService_Adapter_SimpleDb_Query

Create query statement

Parameters

Name	Type	Description
$fields	string

Returns

Type	Description
\Zend_Cloud_DocumentService_Adapter_SimpleDb_Query

setDocumentClass(string $class) : \Zend_Cloud_DocumentService_Adapter_AbstractAdapter

inherited

Set the class for document objects

Inherited from: \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::setDocumentClass()

Parameters

Name	Type	Description
$class	string

Returns

Type	Description
\Zend_Cloud_DocumentService_Adapter_AbstractAdapter

setDocumentSetClass(string $class) : \Zend_Cloud_DocumentService_Adapter_AbstractAdapter

inherited

Set the class for document set objects

Inherited from: \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::setDocumentSetClass()

Parameters

Name	Type	Description
$class	string

Returns

Type	Description
\Zend_Cloud_DocumentService_Adapter_AbstractAdapter

setQueryClass(string $class) : \Zend_Cloud_DocumentService_Adapter_AbstractAdapter

inherited

Set the query class for query objects

Inherited from: \Zend_Cloud_DocumentService_Adapter_AbstractAdapter::setQueryClass()

Parameters

Name	Type	Description
$class	string

Returns

Type	Description
\Zend_Cloud_DocumentService_Adapter_AbstractAdapter

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

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

Name	Type	Description
$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

Type	Description
boolean

Cloud/DocumentService/Adapter/SimpleDb.php

\Zend_Cloud_DocumentService_Adapter_SimpleDbjump to top

Constants

Properties

Methods

\Zend_Cloud_DocumentService_Adapter_SimpleDb
jump to top