CRM/Core/PrevNextCache/Interface.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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    * @param array $sqlParams
  44    *   An array of parameters to be used with $sql.
  45    *   Use the same interpolation format as CRM_Core_DAO (composeQuery/executeQuery).
  46    *   Ex: [1 => ['foo', 'String']]
  47    * @return bool
  48    * @see CRM_Core_DAO::composeQuery
  49    */
  50   public function fillWithSql($cacheKey, $sql, $sqlParams = []);
  51
  52   /**
  53    * Store the contents of an array in the cache.
  54    *
  55    * @param string $cacheKey
  56    * @param array $rows
  57    *   A list of cache records. Each record should have keys:
  58    *    - entity_id1
  59    *    - data
  60    * @return bool
  61    */
  62   public function fillWithArray($cacheKey, $rows);
  63
  64   /**
  65    * Save checkbox selections.
  66    *
  67    * @param string $cacheKey
  68    * @param string $action
  69    *   Ex: 'select', 'unselect'.
  70    * @param array|int|NULL $ids
  71    *   A list of contact IDs to (un)select.
  72    *   To unselect all contact IDs, use NULL.
  73    */
  74   public function markSelection($cacheKey, $action, $ids = NULL);
  75
  76   /**
  77    * Get the selections.
  78    *
  79    * @param string $cacheKey
  80    *   Cache key.
  81    * @param string $action
  82    *   One of the following:
  83    *   - 'get' - get only selection records
  84    *   - 'getall' - get all the records of the specified cache key
  85    *
  86    * @return array|NULL
  87    */
  88   public function getSelection($cacheKey, $action = 'get');
  89
  90   /**
  91    * Get the previous and next keys.
  92    *
  93    * @param string $cacheKey
  94    * @param int $id1
  95    *
  96    * @return array
  97    *   List of neighbors.
  98    *   [
  99    *     'foundEntry' => 1,
 100    *     'prev' => ['id1' => 123, 'data'=>'foo'],
 101    *     'next' => ['id1' => 456, 'data'=>'foo'],
 102    *   ]
 103    */
 104   public function getPositions($cacheKey, $id1);
 105
 106   /**
 107    * Delete an item from the prevnext cache table based on the entity.
 108    *
 109    * @param int $id
 110    * @param string $cacheKey
 111    */
 112   public function deleteItem($id = NULL, $cacheKey = NULL);
 113
 114   /**
 115    * Get count of matching rows.
 116    *
 117    * @param string $cacheKey
 118    * @return int
 119    */
 120   public function getCount($cacheKey);
 121
 122   /**
 123    * Fetch a list of contacts from the prev/next cache for displaying a search results page
 124    *
 125    * @param string $cacheKey
 126    * @param int $offset
 127    * @param int $rowCount
 128    * @return array
 129    *   List of contact IDs (entity_id1).
 130    */
 131   public function fetch($cacheKey, $offset, $rowCount);
 132
 133 }