File indexing completed on 2024-12-22 05:36:31

 <?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
  * @package    Zend_Cloud
  * @subpackage DocumentService
  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
 
 /**
  * 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
  * @package    Zend_Cloud
  * @subpackage DocumentService
  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
 interface Zend_Cloud_DocumentService_QueryAdapter
 {
     /**
      * SELECT clause (fields to be selected)
      *
      * @param string $select
      * @return Zend_Cloud_DocumentService_QueryAdapter
      */
     public function select($select);
 
     /**
      * FROM clause (table name)
      *
      * @param string $from
      * @return Zend_Cloud_DocumentService_QueryAdapter
      */
     public function from($from);
 
     /**
      * WHERE clause (conditions to be used)
      *
      * @param string $where
      * @param mixed $value Value or array of values to be inserted instead of ?
      * @param string $op Operation to use to join where clauses (AND/OR)
      * @return Zend_Cloud_DocumentService_QueryAdapter
      */
     public function where($where, $value = null, $op = 'and');
 
     /**
      * WHERE clause for item ID
      *
      * This one should be used when fetching specific rows since some adapters
      * have special syntax for primary keys
      *
      * @param mixed $value Row ID for the document
      * @return Zend_Cloud_DocumentService_QueryAdapter
      */
     public function whereId($value);
 
     /**
      * LIMIT clause (how many rows ot return)
      *
      * @param int $limit
      * @return Zend_Cloud_DocumentService_QueryAdapter
      */
     public function limit($limit);
 
     /**
      * ORDER BY clause (sorting)
      *
      * @param string $sort Column to sort by
      * @param string $direction Direction - asc/desc
      * @return Zend_Cloud_DocumentService_QueryAdapter
      */
     public function order($sort, $direction = 'asc');
 
     /**
      * Assemble the query into a format the adapter can utilize
      *
      * @return mixed
      */
     public function assemble();
 }