API Documentation

Cloud/DocumentService/Adapter/AbstractAdapter.php

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 license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Cloud  
subpackage
DocumentService  

\Zend_Cloud_DocumentService_Adapter_AbstractAdapter

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
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Cloud  
subpackage
DocumentService  

Constants

Constant  DOCUMENT_CLASS = 'document_class'
Constant  DOCUMENTSET_CLASS = 'documentset_class'
Constant  QUERY_CLASS = 'query_class'

Properties

Propertyprotectedstring  $_documentClass= 'Zend_Cloud_DocumentService_Document'

Class to utilize for new document objects

Default valueZend_Cloud_DocumentService_DocumentDetails
Type
string
Propertyprotectedstring  $_documentSetClass= 'Zend_Cloud_DocumentService_DocumentSet'

Class to utilize for new document set objects

Default valueZend_Cloud_DocumentService_DocumentSetDetails
Type
string
Propertyprotectedstring  $_queryClass= 'Zend_Cloud_DocumentService_Query'

Class to utilize for new query objects

Default valueZend_Cloud_DocumentService_QueryDetails
Type
string

Methods

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

Create collection.

Inherited from: \Zend_Cloud_DocumentService_Adapter::createCollection()
Parameters
Name Type Description
$name string
$options array
Returns
Type Description
array
methodpublicdeleteCollection( string $name, array $options = null ) : void

Delete collection.

Inherited from: \Zend_Cloud_DocumentService_Adapter::deleteCollection()
Parameters
Name Type Description
$name string
$options array
methodpublicdeleteDocument( string $collectionName, mixed $documentID, array $options = null ) : void
Parameters
Name Type Description
$collectionName string Collection name
$documentID mixed

Document ID, adapter-dependent

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

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

Get the concrete service client

Inherited from: \Zend_Cloud_DocumentService_Adapter::getClient()
methodpublicgetDocumentClass( ) : string

Get the class for document objects

Returns
Type Description
string
methodpublicgetDocumentSetClass( ) : string

Get the class for document set objects

Returns
Type Description
string
methodpublicgetQueryClass( ) : string

Get the class for query objects

Returns
Type Description
string
methodpublicinsertDocument( string $collectionName, \Zend_Cloud_DocumentService_Document $document, array $options = null ) : boolean
Parameters
Name Type Description
$collectionName string Collection name
$document \Zend_Cloud_DocumentService_Document Document to insert
$options array
Returns
Type Description
boolean
methodpubliclistCollections( array $options = null ) : array

List collections.

Inherited from: \Zend_Cloud_DocumentService_Adapter::listCollections()
Parameters
Name Type Description
$options array
Returns
Type Description
array List of collection names
methodpubliclistDocuments( string $collectionName, null|array $options = null ) : \Zend_Cloud_DocumentService_DocumentSet

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
methodpublicquery( 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.

Inherited from: \Zend_Cloud_DocumentService_Adapter::query()
Parameters
Name Type Description
$collectionName string Collection name
$query string
$options array
Returns
Type Description
array Array of field sets
methodpublicreplaceDocument( string $collectionName, \Zend_Cloud_DocumentService_Document $document, array $options = null ) : void

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
methodpublicselect( string $fields = null ) : \Zend_Cloud_DocumentService_Query

Create query statement

Inherited from: \Zend_Cloud_DocumentService_Adapter::select()
Parameters
Name Type Description
$fields string
Returns
Type Description
\Zend_Cloud_DocumentService_Query
methodpublicsetDocumentClass( 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
methodpublicsetDocumentSetClass( 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
methodpublicsetQueryClass( 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
methodpublicupdateDocument( string $collectionName, mixed|\Zend_Cloud_DocumentService_Document $documentID, array|\Zend_Cloud_DocumentService_Document $fieldset = null, array $options = null ) : boolean

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
Documentation was generated by DocBlox 0.13.3.