3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * Interface CRM_Core_PrevNextCache_Interface
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.
34 interface CRM_Core_PrevNextCache_Interface
{
37 * Store the results of a SQL query in the cache.
39 * @param string $cacheKey
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']]
48 * @see CRM_Core_DAO::composeQuery
50 public function fillWithSql($cacheKey, $sql, $sqlParams = []);
53 * Store the contents of an array in the cache.
55 * @param string $cacheKey
57 * A list of cache records. Each record should have keys:
62 public function fillWithArray($cacheKey, $rows);
65 * Save checkbox selections.
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.
74 public function markSelection($cacheKey, $action, $ids = NULL);
79 * @param string $cacheKey
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
88 public function getSelection($cacheKey, $action = 'get');
91 * Get the previous and next keys.
93 * @param string $cacheKey
100 * 'prev' => ['id1' => 123, 'data'=>'foo'],
101 * 'next' => ['id1' => 456, 'data'=>'foo'],
104 public function getPositions($cacheKey, $id1);
107 * Delete an item from the prevnext cache table based on the entity.
110 * @param string $cacheKey
112 public function deleteItem($id = NULL, $cacheKey = NULL);
115 * Get count of matching rows.
117 * @param string $cacheKey
120 public function getCount($cacheKey);
123 * Fetch a list of contacts from the prev/next cache for displaying a search results page
125 * @param string $cacheKey
127 * @param int $rowCount
129 * List of contact IDs (entity_id1).
131 public function fetch($cacheKey, $offset, $rowCount);