Commit | Line | Data |
---|---|---|
780fd0e3 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 5 | | |
5 | +--------------------------------------------------------------------+ | |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
780fd0e3 TO |
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 | ||
32a2c024 TO |
36 | /** |
37 | * Store the results of a SQL query in the cache. | |
38 | * | |
83068a64 | 39 | * @param string $cacheKey |
32a2c024 TO |
40 | * @param string $sql |
41 | * A SQL query. The query *MUST* be a SELECT statement which yields | |
ec192197 | 42 | * the following columns (in order): cacheKey, entity_id1, data |
2c8b42d5 | 43 | * @param array $sqlParams |
f939667b TO |
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']] | |
32a2c024 | 47 | * @return bool |
f939667b | 48 | * @see CRM_Core_DAO::composeQuery |
32a2c024 | 49 | */ |
569b8347 | 50 | public function fillWithSql($cacheKey, $sql, $sqlParams = []); |
32a2c024 | 51 | |
83068a64 TO |
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: | |
83068a64 | 58 | * - entity_id1 |
83068a64 TO |
59 | * - data |
60 | * @return bool | |
61 | */ | |
62 | public function fillWithArray($cacheKey, $rows); | |
63 | ||
0b8038a6 TO |
64 | /** |
65 | * Save checkbox selections. | |
66 | * | |
67 | * @param string $cacheKey | |
68 | * @param string $action | |
69 | * Ex: 'select', 'unselect'. | |
bab1fd32 | 70 | * @param array|int|NULL $ids |
0b8038a6 TO |
71 | * A list of contact IDs to (un)select. |
72 | * To unselect all contact IDs, use NULL. | |
0b8038a6 | 73 | */ |
bab1fd32 | 74 | public function markSelection($cacheKey, $action, $ids = NULL); |
0b8038a6 | 75 | |
b7994703 TO |
76 | /** |
77 | * Get the selections. | |
78 | * | |
79 | * @param string $cacheKey | |
80 | * Cache key. | |
81 | * @param string $action | |
40ddbe99 TO |
82 | * One of the following: |
83 | * - 'get' - get only selection records | |
84 | * - 'getall' - get all the records of the specified cache key | |
b7994703 TO |
85 | * |
86 | * @return array|NULL | |
87 | */ | |
40ddbe99 | 88 | public function getSelection($cacheKey, $action = 'get'); |
b7994703 | 89 | |
d379a6d9 TO |
90 | /** |
91 | * Get the previous and next keys. | |
92 | * | |
93 | * @param string $cacheKey | |
94 | * @param int $id1 | |
d379a6d9 TO |
95 | * |
96 | * @return array | |
ec192197 TO |
97 | * List of neighbors. |
98 | * [ | |
99 | * 'foundEntry' => 1, | |
100 | * 'prev' => ['id1' => 123, 'data'=>'foo'], | |
101 | * 'next' => ['id1' => 456, 'data'=>'foo'], | |
102 | * ] | |
d379a6d9 | 103 | */ |
ec192197 | 104 | public function getPositions($cacheKey, $id1); |
d379a6d9 | 105 | |
744b4e34 TO |
106 | /** |
107 | * Delete an item from the prevnext cache table based on the entity. | |
108 | * | |
109 | * @param int $id | |
110 | * @param string $cacheKey | |
744b4e34 | 111 | */ |
ec192197 | 112 | public function deleteItem($id = NULL, $cacheKey = NULL); |
744b4e34 | 113 | |
c93f3d19 TO |
114 | /** |
115 | * Get count of matching rows. | |
116 | * | |
117 | * @param string $cacheKey | |
118 | * @return int | |
119 | */ | |
120 | public function getCount($cacheKey); | |
121 | ||
2ca46d4d TO |
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 | ||
780fd0e3 | 133 | } |