Cloud/DocumentService/Adapter/AbstractAdapter.php

Show: PublicProtectedPrivateinherited
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 license@zend.com 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

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

>VConstant  DOCUMENT_CLASS = 'document_class'
>VConstant  DOCUMENTSET_CLASS = 'documentset_class'
>VConstant  QUERY_CLASS = 'query_class'
>VConstant  HTTP_ADAPTER = 'http_adapter'

Properties

>VPropertyprotectedstring $_documentClass = 'Zend_Cloud_DocumentService_Document'
Class to utilize for new document objects
Default value'Zend_Cloud_DocumentService_Document'Details
Type
string
>VPropertyprotectedstring $_documentSetClass = 'Zend_Cloud_DocumentService_DocumentSet'
Class to utilize for new document set objects
Default value'Zend_Cloud_DocumentService_DocumentSet'Details
Type
string
>VPropertyprotectedstring $_queryClass = 'Zend_Cloud_DocumentService_Query'
Class to utilize for new query objects
Default value'Zend_Cloud_DocumentService_Query'Details
Type
string

Methods

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

Create collection.

Inherited from: \Zend_Cloud_DocumentService_Adapter::createCollection()
Parameters
NameTypeDescription
$namestring
$optionsarray
Returns
TypeDescription
array
methodpublicdeleteCollection(string $name, array $options = null) : void
inherited

Delete collection.

Inherited from: \Zend_Cloud_DocumentService_Adapter::deleteCollection()
Parameters
NameTypeDescription
$namestring
$optionsarray
methodpublicdeleteDocument(string $collectionName, mixed $documentID, array $options = null) : void
inherited

Delete document

Inherited from: \Zend_Cloud_DocumentService_Adapter::deleteDocument()
Parameters
NameTypeDescription
$collectionNamestring

Collection name

$documentIDmixed

Document ID, adapter-dependent

$optionsarray
methodpublicfetchDocument(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
NameTypeDescription
$collectionNamestring

Collection name

$documentIDmixed

Document ID, adapter-dependent

$optionsarray
Returns
TypeDescription
\Zend_Cloud_DocumentService_Document
methodpublicgetClient() : void
inherited

Get the concrete service client

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

Get the class for document objects

Returns
TypeDescription
string
methodpublicgetDocumentSetClass() : string

Get the class for document set objects

Returns
TypeDescription
string
methodpublicgetQueryClass() : string

Get the class for query objects

Returns
TypeDescription
string
methodpublicinsertDocument(string $collectionName, \Zend_Cloud_DocumentService_Document $document, array $options = null) : boolean
inherited

Insert document

Inherited from: \Zend_Cloud_DocumentService_Adapter::insertDocument()
Parameters
NameTypeDescription
$collectionNamestring

Collection name

$document\Zend_Cloud_DocumentService_Document

Document to insert

$optionsarray
Returns
TypeDescription
boolean
methodpubliclistCollections(array $options = null) : array
inherited

List collections.

Inherited from: \Zend_Cloud_DocumentService_Adapter::listCollections()
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
arrayList of collection names
methodpubliclistDocuments(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
NameTypeDescription
$collectionNamestring
$optionsnull | array
Returns
TypeDescription
\Zend_Cloud_DocumentService_DocumentSet
methodpublicquery(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
NameTypeDescription
$collectionNamestring

Collection name

$querystring
$optionsarray
Returns
TypeDescription
arrayArray of field sets
methodpublicreplaceDocument(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
NameTypeDescription
$collectionNamestring

Collection name

$document\Zend_Cloud_DocumentService_Document
$optionsarray
methodpublicselect(string $fields = null) : \Zend_Cloud_DocumentService_Query
inherited

Create query statement

Inherited from: \Zend_Cloud_DocumentService_Adapter::select()
Parameters
NameTypeDescription
$fieldsstring
Returns
TypeDescription
\Zend_Cloud_DocumentService_Query
methodpublicsetDocumentClass(string $class) : \Zend_Cloud_DocumentService_Adapter_AbstractAdapter

Set the class for document objects

Parameters
NameTypeDescription
$classstring
Returns
TypeDescription
\Zend_Cloud_DocumentService_Adapter_AbstractAdapter
methodpublicsetDocumentSetClass(string $class) : \Zend_Cloud_DocumentService_Adapter_AbstractAdapter

Set the class for document set objects

Parameters
NameTypeDescription
$classstring
Returns
TypeDescription
\Zend_Cloud_DocumentService_Adapter_AbstractAdapter
methodpublicsetQueryClass(string $class) : \Zend_Cloud_DocumentService_Adapter_AbstractAdapter

Set the query class for query objects

Parameters
NameTypeDescription
$classstring
Returns
TypeDescription
\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
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
NameTypeDescription
$collectionNamestring
$documentIDmixed | \Zend_Cloud_DocumentService_Document

Document ID, adapter-dependent, or document containing updates

$fieldsetarray | \Zend_Cloud_DocumentService_Document

Set of fields to update

$optionsarray
Returns
TypeDescription
boolean
Documentation was generated by phpDocumentor 2.0.0a12.