CRM/Core/PrevNextCache/Interface.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * Interface CRM_Core_PrevNextCache_Interface
  30  *
  31  * The previous/next cache is a service for tracking query results. Results
  32  * are stored in a cache, and they may be individually toggled.
  33  */
  34 interface CRM_Core_PrevNextCache_Interface {
  35
  36   /**
  37    * Store the results of a SQL query in the cache.
  38    *
  39    * @param string $cacheKey
  40    * @param string $sql
  41    *   A SQL query. The query *MUST* be a SELECT statement which yields
  42    *   the following columns (in order): cacheKey, entity_id1, data
  43    * @return bool
  44    */
  45   public function fillWithSql($cacheKey, $sql);
  46
  47   /**
  48    * Store the contents of an array in the cache.
  49    *
  50    * @param string $cacheKey
  51    * @param array $rows
  52    *   A list of cache records. Each record should have keys:
  53    *    - entity_id1
  54    *    - data
  55    * @return bool
  56    */
  57   public function fillWithArray($cacheKey, $rows);
  58
  59   /**
  60    * Save checkbox selections.
  61    *
  62    * @param string $cacheKey
  63    * @param string $action
  64    *   Ex: 'select', 'unselect'.
  65    * @param array|int|NULL $ids
  66    *   A list of contact IDs to (un)select.
  67    *   To unselect all contact IDs, use NULL.
  68    */
  69   public function markSelection($cacheKey, $action, $ids = NULL);
  70
  71   /**
  72    * Get the selections.
  73    *
  74    * @param string $cacheKey
  75    *   Cache key.
  76    * @param string $action
  77    *   One of the following:
  78    *   - 'get' - get only selection records
  79    *   - 'getall' - get all the records of the specified cache key
  80    *
  81    * @return array|NULL
  82    */
  83   public function getSelection($cacheKey, $action = 'get');
  84
  85   /**
  86    * Get the previous and next keys.
  87    *
  88    * @param string $cacheKey
  89    * @param int $id1
  90    *
  91    * @return array
  92    *   List of neighbors.
  93    *   [
  94    *     'foundEntry' => 1,
  95    *     'prev' => ['id1' => 123, 'data'=>'foo'],
  96    *     'next' => ['id1' => 456, 'data'=>'foo'],
  97    *   ]
  98    */
  99   public function getPositions($cacheKey, $id1);
 100
 101   /**
 102    * Delete an item from the prevnext cache table based on the entity.
 103    *
 104    * @param int $id
 105    * @param string $cacheKey
 106    */
 107   public function deleteItem($id = NULL, $cacheKey = NULL);
 108
 109   /**
 110    * Get count of matching rows.
 111    *
 112    * @param string $cacheKey
 113    * @return int
 114    */
 115   public function getCount($cacheKey);
 116
 117   /**
 118    * Fetch a list of contacts from the prev/next cache for displaying a search results page
 119    *
 120    * @param string $cacheKey
 121    * @param int $offset
 122    * @param int $rowCount
 123    * @return array
 124    *   List of contact IDs (entity_id1).
 125    */
 126   public function fetch($cacheKey, $offset, $rowCount);
 127
 128 }