Commit | Line | Data |
---|---|---|
e501603b | 1 | <?php |
c3fc2621 | 2 | |
e501603b TO |
3 | /** |
4 | * @package CRM | |
ca5cec67 | 5 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
e501603b TO |
6 | * |
7 | * Generated from xml/schema/CRM/Core/PrevNextCache.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
a9d0587b | 9 | * (GenCodeChecksum:3e1ec2353f61b542cca9c3c9efc73e80) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the PrevNextCache entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Core_DAO_PrevNextCache extends CRM_Core_DAO { |
c3fc2621 | 16 | |
e501603b | 17 | /** |
f41f0342 | 18 | * Static instance to hold the table name. |
e501603b TO |
19 | * |
20 | * @var string | |
21 | */ | |
fa45b5b9 | 22 | public static $_tableName = 'civicrm_prevnext_cache'; |
c3fc2621 | 23 | |
e501603b | 24 | /** |
f41f0342 | 25 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
e501603b | 26 | * |
c3fc2621 | 27 | * @var bool |
e501603b | 28 | */ |
fa45b5b9 | 29 | public static $_log = FALSE; |
c3fc2621 | 30 | |
e501603b | 31 | /** |
e6ca0a57 | 32 | * @var int |
e501603b TO |
33 | */ |
34 | public $id; | |
c3fc2621 | 35 | |
e501603b TO |
36 | /** |
37 | * physical tablename for entity being joined to discount, e.g. civicrm_event | |
38 | * | |
39 | * @var string | |
40 | */ | |
41 | public $entity_table; | |
c3fc2621 | 42 | |
e501603b TO |
43 | /** |
44 | * FK to entity table specified in entity_table column. | |
45 | * | |
e6ca0a57 | 46 | * @var int |
e501603b TO |
47 | */ |
48 | public $entity_id1; | |
c3fc2621 | 49 | |
e501603b TO |
50 | /** |
51 | * FK to entity table specified in entity_table column. | |
52 | * | |
e6ca0a57 | 53 | * @var int |
e501603b TO |
54 | */ |
55 | public $entity_id2; | |
c3fc2621 | 56 | |
e501603b TO |
57 | /** |
58 | * Unique path name for cache element of the searched item | |
59 | * | |
60 | * @var string | |
61 | */ | |
783b4b21 | 62 | public $cachekey; |
c3fc2621 | 63 | |
e501603b TO |
64 | /** |
65 | * cached snapshot of the serialized data | |
66 | * | |
67 | * @var longtext | |
68 | */ | |
69 | public $data; | |
c3fc2621 | 70 | |
e501603b | 71 | /** |
e6ca0a57 | 72 | * @var bool |
e501603b TO |
73 | */ |
74 | public $is_selected; | |
c3fc2621 | 75 | |
e501603b | 76 | /** |
f41f0342 | 77 | * Class constructor. |
e501603b | 78 | */ |
c3fc2621 | 79 | public function __construct() { |
e501603b TO |
80 | $this->__table = 'civicrm_prevnext_cache'; |
81 | parent::__construct(); | |
82 | } | |
c3fc2621 | 83 | |
449c4e6b CW |
84 | /** |
85 | * Returns localized title of this entity. | |
86 | */ | |
87 | public static function getEntityTitle() { | |
88 | return ts('Prev Next Caches'); | |
89 | } | |
90 | ||
e501603b TO |
91 | /** |
92 | * Returns all the column names of this table | |
93 | * | |
94 | * @return array | |
95 | */ | |
c3fc2621 | 96 | public static function &fields() { |
346aaaba | 97 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
98 | Civi::$statics[__CLASS__]['fields'] = [ |
99 | 'id' => [ | |
e501603b TO |
100 | 'name' => 'id', |
101 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 CW |
102 | 'title' => ts('Prev Next Cache ID'), |
103 | 'required' => TRUE, | |
a36434b9 | 104 | 'where' => 'civicrm_prevnext_cache.id', |
522a26c9 | 105 | 'table_name' => 'civicrm_prevnext_cache', |
106 | 'entity' => 'PrevNextCache', | |
107 | 'bao' => 'CRM_Core_BAO_PrevNextCache', | |
6a7e5e5d | 108 | 'localizable' => 0, |
a9d0587b | 109 | 'add' => '3.4', |
c3fc2621 CW |
110 | ], |
111 | 'entity_table' => [ | |
e501603b TO |
112 | 'name' => 'entity_table', |
113 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 114 | 'title' => ts('Prev Next Entity Table'), |
215b423e | 115 | 'description' => ts('physical tablename for entity being joined to discount, e.g. civicrm_event'), |
e501603b TO |
116 | 'maxlength' => 64, |
117 | 'size' => CRM_Utils_Type::BIG, | |
a36434b9 | 118 | 'where' => 'civicrm_prevnext_cache.entity_table', |
522a26c9 | 119 | 'table_name' => 'civicrm_prevnext_cache', |
120 | 'entity' => 'PrevNextCache', | |
121 | 'bao' => 'CRM_Core_BAO_PrevNextCache', | |
6a7e5e5d | 122 | 'localizable' => 0, |
a9d0587b | 123 | 'add' => '3.4', |
c3fc2621 CW |
124 | ], |
125 | 'entity_id1' => [ | |
e501603b TO |
126 | 'name' => 'entity_id1', |
127 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 128 | 'title' => ts('Prev Next Entity ID 1'), |
215b423e | 129 | 'description' => ts('FK to entity table specified in entity_table column.'), |
c3fc2621 | 130 | 'required' => TRUE, |
a36434b9 | 131 | 'where' => 'civicrm_prevnext_cache.entity_id1', |
522a26c9 | 132 | 'table_name' => 'civicrm_prevnext_cache', |
133 | 'entity' => 'PrevNextCache', | |
134 | 'bao' => 'CRM_Core_BAO_PrevNextCache', | |
6a7e5e5d | 135 | 'localizable' => 0, |
a9d0587b | 136 | 'add' => '3.4', |
c3fc2621 CW |
137 | ], |
138 | 'entity_id2' => [ | |
e501603b TO |
139 | 'name' => 'entity_id2', |
140 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 141 | 'title' => ts('Prev Next Entity ID 2'), |
215b423e | 142 | 'description' => ts('FK to entity table specified in entity_table column.'), |
230a9938 | 143 | 'required' => FALSE, |
a36434b9 | 144 | 'where' => 'civicrm_prevnext_cache.entity_id2', |
522a26c9 | 145 | 'table_name' => 'civicrm_prevnext_cache', |
146 | 'entity' => 'PrevNextCache', | |
147 | 'bao' => 'CRM_Core_BAO_PrevNextCache', | |
6a7e5e5d | 148 | 'localizable' => 0, |
a9d0587b | 149 | 'add' => '3.4', |
c3fc2621 | 150 | ], |
783b4b21 SL |
151 | 'cachekey' => [ |
152 | 'name' => 'cachekey', | |
e501603b | 153 | 'type' => CRM_Utils_Type::T_STRING, |
c3fc2621 | 154 | 'title' => ts('Cache Key'), |
215b423e | 155 | 'description' => ts('Unique path name for cache element of the searched item'), |
e501603b TO |
156 | 'maxlength' => 255, |
157 | 'size' => CRM_Utils_Type::HUGE, | |
783b4b21 | 158 | 'where' => 'civicrm_prevnext_cache.cachekey', |
522a26c9 | 159 | 'table_name' => 'civicrm_prevnext_cache', |
160 | 'entity' => 'PrevNextCache', | |
161 | 'bao' => 'CRM_Core_BAO_PrevNextCache', | |
6a7e5e5d | 162 | 'localizable' => 0, |
a9d0587b | 163 | 'add' => '3.4', |
c3fc2621 CW |
164 | ], |
165 | 'data' => [ | |
e501603b TO |
166 | 'name' => 'data', |
167 | 'type' => CRM_Utils_Type::T_LONGTEXT, | |
c3fc2621 | 168 | 'title' => ts('Prev Next Data'), |
215b423e | 169 | 'description' => ts('cached snapshot of the serialized data'), |
a36434b9 | 170 | 'where' => 'civicrm_prevnext_cache.data', |
522a26c9 | 171 | 'table_name' => 'civicrm_prevnext_cache', |
172 | 'entity' => 'PrevNextCache', | |
173 | 'bao' => 'CRM_Core_BAO_PrevNextCache', | |
6a7e5e5d | 174 | 'localizable' => 0, |
2a5c9b4d | 175 | 'serialize' => self::SERIALIZE_PHP, |
a9d0587b | 176 | 'add' => '3.4', |
c3fc2621 CW |
177 | ], |
178 | 'is_selected' => [ | |
e501603b TO |
179 | 'name' => 'is_selected', |
180 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 181 | 'title' => ts('Is Selected'), |
a36434b9 | 182 | 'where' => 'civicrm_prevnext_cache.is_selected', |
45a83e42 | 183 | 'default' => '0', |
522a26c9 | 184 | 'table_name' => 'civicrm_prevnext_cache', |
185 | 'entity' => 'PrevNextCache', | |
186 | 'bao' => 'CRM_Core_BAO_PrevNextCache', | |
6a7e5e5d | 187 | 'localizable' => 0, |
a9d0587b | 188 | 'add' => '4.2', |
c3fc2621 CW |
189 | ], |
190 | ]; | |
346aaaba | 191 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 192 | } |
346aaaba | 193 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 194 | } |
c3fc2621 | 195 | |
e501603b | 196 | /** |
bd8e0b14 | 197 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
198 | * |
199 | * @return array | |
bd8e0b14 | 200 | * Array(string $name => string $uniqueName). |
e501603b | 201 | */ |
c3fc2621 | 202 | public static function &fieldKeys() { |
bd8e0b14 TO |
203 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
204 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 205 | } |
bd8e0b14 | 206 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 207 | } |
c3fc2621 | 208 | |
e501603b TO |
209 | /** |
210 | * Returns the names of this table | |
211 | * | |
212 | * @return string | |
213 | */ | |
c3fc2621 | 214 | public static function getTableName() { |
e501603b TO |
215 | return self::$_tableName; |
216 | } | |
c3fc2621 | 217 | |
e501603b TO |
218 | /** |
219 | * Returns if this table needs to be logged | |
220 | * | |
c3fc2621 | 221 | * @return bool |
e501603b | 222 | */ |
c3fc2621 | 223 | public function getLog() { |
e501603b TO |
224 | return self::$_log; |
225 | } | |
c3fc2621 | 226 | |
e501603b TO |
227 | /** |
228 | * Returns the list of fields that can be imported | |
229 | * | |
230 | * @param bool $prefix | |
231 | * | |
232 | * @return array | |
233 | */ | |
c3fc2621 CW |
234 | public static function &import($prefix = FALSE) { |
235 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'prevnext_cache', $prefix, []); | |
60808919 | 236 | return $r; |
e501603b | 237 | } |
c3fc2621 | 238 | |
e501603b TO |
239 | /** |
240 | * Returns the list of fields that can be exported | |
241 | * | |
242 | * @param bool $prefix | |
243 | * | |
244 | * @return array | |
245 | */ | |
c3fc2621 CW |
246 | public static function &export($prefix = FALSE) { |
247 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'prevnext_cache', $prefix, []); | |
60808919 | 248 | return $r; |
e501603b | 249 | } |
c3fc2621 | 250 | |
e7a6b91a AS |
251 | /** |
252 | * Returns the list of indices | |
c3fc2621 CW |
253 | * |
254 | * @param bool $localize | |
255 | * | |
256 | * @return array | |
e7a6b91a AS |
257 | */ |
258 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
259 | $indices = [ |
260 | 'index_all' => [ | |
e7a6b91a | 261 | 'name' => 'index_all', |
c3fc2621 | 262 | 'field' => [ |
783b4b21 | 263 | 0 => 'cachekey', |
e7a6b91a AS |
264 | 1 => 'entity_id1', |
265 | 2 => 'entity_id2', | |
266 | 3 => 'entity_table', | |
267 | 4 => 'is_selected', | |
c3fc2621 CW |
268 | ], |
269 | 'localizable' => FALSE, | |
783b4b21 | 270 | 'sig' => 'civicrm_prevnext_cache::0::cachekey::entity_id1::entity_id2::entity_table::is_selected', |
c3fc2621 CW |
271 | ], |
272 | ]; | |
e7a6b91a AS |
273 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
274 | } | |
c3fc2621 | 275 | |
e501603b | 276 | } |