Cloud/DocumentService/Adapter/AbstractAdapter.php

Show:

inherited

Classes
- \Zend_Cloud_DocumentService_Adapter_AbstractAdapter

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_AbstractAdapter
jump to top

Package: Zend\Cloud\DocumentService

Abstract document service adapter

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

Implements: \Zend_Cloud_DocumentService_Adapter
Children: \Zend_Cloud_DocumentService_Adapter_SimpleDb; \Zend_Cloud_DocumentService_Adapter_WindowsAzure
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                DOCUMENT_CLASS
                = 'document_class'

 
                DOCUMENTSET_CLASS
                = 'documentset_class'

 
                QUERY_CLASS
                = 'query_class'

 
                HTTP_ADAPTER
                = 'http_adapter'

inheritedInherited from: \Zend_Cloud_DocumentService_Adapter::HTTP_ADAPTER

Inherited_from: \Zend_Cloud_DocumentService_Adapter::HTTP_ADAPTER

Properties

string $_documentClass = 'Zend_Cloud_DocumentService_Document'

Class to utilize for new document objects

Default value'Zend_Cloud_DocumentService_Document'Details

Type: string

string $_documentSetClass = 'Zend_Cloud_DocumentService_DocumentSet'

Class to utilize for new document set objects

Default value'Zend_Cloud_DocumentService_DocumentSet'Details

Type: string

string $_queryClass = 'Zend_Cloud_DocumentService_Query'

Class to utilize for new query objects

Default value'Zend_Cloud_DocumentService_Query'Details

Type: string

Methods

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

inherited

Create collection.

Inherited from: \Zend_Cloud_DocumentService_Adapter::createCollection()

Parameters

Name	Type	Description
$name	string
$options	array

Returns

Type	Description
array

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

inherited

Delete collection.

Inherited from: \Zend_Cloud_DocumentService_Adapter::deleteCollection()

Parameters

Name	Type	Description
$name	string
$options	array

deleteDocument(string $collectionName, mixed $documentID, array $options = null) : void

inherited

Delete document

Inherited from: \Zend_Cloud_DocumentService_Adapter::deleteDocument()

Parameters

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

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

inherited

Fetch single document by ID

Inherited from: \Zend_Cloud_DocumentService_Adapter::fetchDocument()

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() : void

inherited

Get the concrete service client

Inherited from: \Zend_Cloud_DocumentService_Adapter::getClient()

getDocumentClass() : string

Get the class for document objects

Returns

Type	Description
string

getDocumentSetClass() : string

Get the class for document set objects

Returns

Type	Description
string

getQueryClass() : string

Get the class for query objects

Returns

Type	Description
string

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

inherited

Insert document

Inherited from: \Zend_Cloud_DocumentService_Adapter::insertDocument()

Parameters

Name	Type	Description
$collectionName	string	Collection name
$document	\Zend_Cloud_DocumentService_Document	Document to insert
$options	array

Returns

Type	Description
boolean

listCollections(array $options = null) : array

inherited

List collections.

Inherited from: \Zend_Cloud_DocumentService_Adapter::listCollections()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
array	List of collection names

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

inherited

List all documents in a collection

Inherited from: \Zend_Cloud_DocumentService_Adapter::listDocuments()

Parameters

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

Returns

Type	Description
\Zend_Cloud_DocumentService_DocumentSet

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

inherited

Query for documents stored in the document service.

Inherited from: \Zend_Cloud_DocumentService_Adapter::query()

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	Array of field sets

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

inherited

Replace document The new document replaces the existing document with the same ID.

Inherited from: \Zend_Cloud_DocumentService_Adapter::replaceDocument()

Parameters

Name	Type	Description
$collectionName	string	Collection name
$document	\Zend_Cloud_DocumentService_Document
$options	array

select(string $fields = null) : \Zend_Cloud_DocumentService_Query

inherited

Create query statement

Inherited from: \Zend_Cloud_DocumentService_Adapter::select()

Parameters

Name	Type	Description
$fields	string

Returns

Type	Description
\Zend_Cloud_DocumentService_Query

setDocumentClass(string $class) : \Zend_Cloud_DocumentService_Adapter_AbstractAdapter

Set the class for document objects

Parameters

Name	Type	Description
$class	string

Returns

Type	Description
\Zend_Cloud_DocumentService_Adapter_AbstractAdapter

setDocumentSetClass(string $class) : \Zend_Cloud_DocumentService_Adapter_AbstractAdapter

Set the class for document set objects

Parameters

Name	Type	Description
$class	string

Returns

Type	Description
\Zend_Cloud_DocumentService_Adapter_AbstractAdapter

setQueryClass(string $class) : \Zend_Cloud_DocumentService_Adapter_AbstractAdapter

Set the query class for query objects

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

inherited

Update document The fields of the existing documents will be updated.

Inherited from: \Zend_Cloud_DocumentService_Adapter::updateDocument()

Fields not specified in the set will be left as-is.

Parameters

Name	Type	Description
$collectionName	string
$documentID	mixed \| \Zend_Cloud_DocumentService_Document	Document ID, adapter-dependent, or document containing updates
$fieldset	array \| \Zend_Cloud_DocumentService_Document	Set of fields to update
$options	array

Returns

Type	Description
boolean

Cloud/DocumentService/Adapter/AbstractAdapter.php

\Zend_Cloud_DocumentService_Adapter_AbstractAdapterjump to top

Constants

Properties

Methods

\Zend_Cloud_DocumentService_Adapter_AbstractAdapter
jump to top