Common interface for document storage services in the cloud. This interface supports most document services and provides some flexibility for vendor-specific features and requirements via an optional $options array in each method signature. Classes implementing this interface should implement URI construction for collections and documents from the parameters given in each method and the account data passed in to the constructor. Classes implementing this interface are also responsible for security; access control isn't currently supported in this interface, although we are considering access control support in future versions of the interface.
category | Zend |
---|---|
package | Zend_Cloud |
subpackage | DocumentService |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
createCollection(string $name, array $options = null
) : array
string
array
array
deleteCollection(string $name, array $options = null
) : void
string
array
deleteDocument(string $collectionName, mixed $documentID, array $options = null
) : void
string
Collection name
mixed
Document ID, adapter-dependent
array
fetchDocument(string $collectionName, mixed $documentID, array $options = null
) : \Zend_Cloud_DocumentService_Document
Will return false if the document does not exist
string
Collection name
mixed
Document ID, adapter-dependent
array
\Zend_Cloud_DocumentService_Document
getClient()
insertDocument(string $collectionName, \Zend_Cloud_DocumentService_Document $document, array $options = null
) : boolean
string
Collection name
\Zend_Cloud_DocumentService_Document
Document to insert
array
boolean
listCollections(array $options = null
) : array
array
array
List of collection nameslistDocuments(string $collectionName, null|array $options = null
) : \Zend_Cloud_DocumentService_DocumentSet
string
null
array
\Zend_Cloud_DocumentService_DocumentSet
query(string $collectionName, string $query, array $options = null
) : array
string
Collection name
string
array
array
Array of field setsreplaceDocument(string $collectionName, \Zend_Cloud_DocumentService_Document $document, array $options = null
)
string
Collection name
\Zend_Cloud_DocumentService_Document
array
select(string $fields = null
) : \Zend_Cloud_DocumentService_Query
string
\Zend_Cloud_DocumentService_Query
updateDocument(string $collectionName, mixed|\Zend_Cloud_DocumentService_Document $documentID, array|\Zend_Cloud_DocumentService_Document $fieldset= null
, array $options= null
) : boolean
Fields not specified in the set will be left as-is.
string
mixed
\Zend_Cloud_DocumentService_Document
Document ID, adapter-dependent, or document containing updates
array
\Zend_Cloud_DocumentService_Document
Set of fields to update
array
boolean
HTTP_ADAPTER = 'http_adapter'