Cloud/DocumentService/QueryAdapter.php
inherited
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_QueryAdapter
This interface describes the API that concrete query adapter should implement
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. Query optimization mechanisms are also not supported in this version.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Methods
assemble() : mixedAssemble the query into a format the adapter can utilize
| Type | Description |
|---|---|
| mixed |
from(string $from) : \Zend_Cloud_DocumentService_QueryAdapterFROM clause (table name)
| Name | Type | Description |
|---|---|---|
| $from | string |
| Type | Description |
|---|---|
| \Zend_Cloud_DocumentService_QueryAdapter |
limit(int $limit) : \Zend_Cloud_DocumentService_QueryAdapterLIMIT clause (how many rows ot return)
| Name | Type | Description |
|---|---|---|
| $limit | int |
| Type | Description |
|---|---|
| \Zend_Cloud_DocumentService_QueryAdapter |
order(string $sort, string $direction = 'asc') : \Zend_Cloud_DocumentService_QueryAdapterORDER BY clause (sorting)
| Name | Type | Description |
|---|---|---|
| $sort | string | Column to sort by |
| $direction | string | Direction - asc/desc |
| Type | Description |
|---|---|
| \Zend_Cloud_DocumentService_QueryAdapter |
select(string $select) : \Zend_Cloud_DocumentService_QueryAdapterSELECT clause (fields to be selected)
| Name | Type | Description |
|---|---|---|
| $select | string |
| Type | Description |
|---|---|
| \Zend_Cloud_DocumentService_QueryAdapter |
where(string $where, mixed $value = null, string $op = 'and') : \Zend_Cloud_DocumentService_QueryAdapterWHERE clause (conditions to be used)
| Name | Type | Description |
|---|---|---|
| $where | string | |
| $value | mixed | Value or array of values to be inserted instead of ? |
| $op | string | Operation to use to join where clauses (AND/OR) |
| Type | Description |
|---|---|
| \Zend_Cloud_DocumentService_QueryAdapter |
whereId(mixed $value) : \Zend_Cloud_DocumentService_QueryAdapterWHERE clause for item ID
This one should be used when fetching specific rows since some adapters have special syntax for primary keys
| Name | Type | Description |
|---|---|---|
| $value | mixed | Row ID for the document |
| Type | Description |
|---|---|
| \Zend_Cloud_DocumentService_QueryAdapter |