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/Cache.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
f29bf4f3 | 9 | * (GenCodeChecksum:2639f5b19898adf08f19b9f2713d5e76) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the Cache entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Core_DAO_Cache 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_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 | /** |
6692f42b PN |
32 | * Unique table ID |
33 | * | |
e6ca0a57 | 34 | * @var int |
e501603b TO |
35 | */ |
36 | public $id; | |
c3fc2621 | 37 | |
e501603b TO |
38 | /** |
39 | * group name for cache element, useful in cleaning cache elements | |
40 | * | |
41 | * @var string | |
42 | */ | |
43 | public $group_name; | |
c3fc2621 | 44 | |
e501603b TO |
45 | /** |
46 | * Unique path name for cache element | |
47 | * | |
48 | * @var string | |
49 | */ | |
50 | public $path; | |
c3fc2621 | 51 | |
e501603b TO |
52 | /** |
53 | * data associated with this path | |
54 | * | |
55 | * @var longtext | |
56 | */ | |
57 | public $data; | |
c3fc2621 | 58 | |
e501603b TO |
59 | /** |
60 | * Component that this menu item belongs to | |
61 | * | |
e6ca0a57 | 62 | * @var int |
e501603b TO |
63 | */ |
64 | public $component_id; | |
c3fc2621 | 65 | |
e501603b TO |
66 | /** |
67 | * When was the cache item created | |
68 | * | |
6c2b97b7 | 69 | * @var timestamp |
e501603b TO |
70 | */ |
71 | public $created_date; | |
c3fc2621 | 72 | |
e501603b TO |
73 | /** |
74 | * When should the cache item expire | |
75 | * | |
6c2b97b7 | 76 | * @var timestamp |
e501603b TO |
77 | */ |
78 | public $expired_date; | |
c3fc2621 | 79 | |
e501603b | 80 | /** |
f41f0342 | 81 | * Class constructor. |
e501603b | 82 | */ |
c3fc2621 | 83 | public function __construct() { |
e501603b TO |
84 | $this->__table = 'civicrm_cache'; |
85 | parent::__construct(); | |
86 | } | |
c3fc2621 | 87 | |
e501603b | 88 | /** |
f41f0342 | 89 | * Returns foreign keys and entity references. |
e501603b TO |
90 | * |
91 | * @return array | |
92 | * [CRM_Core_Reference_Interface] | |
93 | */ | |
c3fc2621 | 94 | public static function getReferenceColumns() { |
346aaaba | 95 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 96 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 | 97 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'component_id', 'civicrm_component', 'id'); |
346aaaba | 98 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 99 | } |
346aaaba | 100 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 101 | } |
c3fc2621 | 102 | |
e501603b TO |
103 | /** |
104 | * Returns all the column names of this table | |
105 | * | |
106 | * @return array | |
107 | */ | |
c3fc2621 | 108 | public static function &fields() { |
346aaaba | 109 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
110 | Civi::$statics[__CLASS__]['fields'] = [ |
111 | 'id' => [ | |
e501603b TO |
112 | 'name' => 'id', |
113 | 'type' => CRM_Utils_Type::T_INT, | |
6692f42b PN |
114 | 'title' => ts('Cache ID'), |
115 | 'description' => ts('Unique table ID'), | |
c3fc2621 | 116 | 'required' => TRUE, |
a36434b9 | 117 | 'where' => 'civicrm_cache.id', |
522a26c9 | 118 | 'table_name' => 'civicrm_cache', |
119 | 'entity' => 'Cache', | |
120 | 'bao' => 'CRM_Core_BAO_Cache', | |
6a7e5e5d | 121 | 'localizable' => 0, |
c3fc2621 CW |
122 | ], |
123 | 'group_name' => [ | |
e501603b TO |
124 | 'name' => 'group_name', |
125 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 126 | 'title' => ts('Group Name'), |
215b423e | 127 | 'description' => ts('group name for cache element, useful in cleaning cache elements'), |
c3fc2621 | 128 | 'required' => TRUE, |
e501603b TO |
129 | 'maxlength' => 32, |
130 | 'size' => CRM_Utils_Type::MEDIUM, | |
a36434b9 | 131 | 'where' => 'civicrm_cache.group_name', |
522a26c9 | 132 | 'table_name' => 'civicrm_cache', |
133 | 'entity' => 'Cache', | |
134 | 'bao' => 'CRM_Core_BAO_Cache', | |
6a7e5e5d | 135 | 'localizable' => 0, |
c3fc2621 CW |
136 | ], |
137 | 'path' => [ | |
e501603b TO |
138 | 'name' => 'path', |
139 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 140 | 'title' => ts('Path'), |
215b423e | 141 | 'description' => ts('Unique path name for cache element'), |
e501603b TO |
142 | 'maxlength' => 255, |
143 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 144 | 'where' => 'civicrm_cache.path', |
522a26c9 | 145 | 'table_name' => 'civicrm_cache', |
146 | 'entity' => 'Cache', | |
147 | 'bao' => 'CRM_Core_BAO_Cache', | |
6a7e5e5d | 148 | 'localizable' => 0, |
c3fc2621 CW |
149 | ], |
150 | 'data' => [ | |
e501603b TO |
151 | 'name' => 'data', |
152 | 'type' => CRM_Utils_Type::T_LONGTEXT, | |
c3fc2621 | 153 | 'title' => ts('Data'), |
215b423e | 154 | 'description' => ts('data associated with this path'), |
a36434b9 | 155 | 'where' => 'civicrm_cache.data', |
522a26c9 | 156 | 'table_name' => 'civicrm_cache', |
157 | 'entity' => 'Cache', | |
158 | 'bao' => 'CRM_Core_BAO_Cache', | |
6a7e5e5d | 159 | 'localizable' => 0, |
c3fc2621 CW |
160 | ], |
161 | 'component_id' => [ | |
e501603b TO |
162 | 'name' => 'component_id', |
163 | 'type' => CRM_Utils_Type::T_INT, | |
6692f42b | 164 | 'title' => ts('Component ID'), |
215b423e | 165 | 'description' => ts('Component that this menu item belongs to'), |
a36434b9 | 166 | 'where' => 'civicrm_cache.component_id', |
522a26c9 | 167 | 'table_name' => 'civicrm_cache', |
168 | 'entity' => 'Cache', | |
169 | 'bao' => 'CRM_Core_BAO_Cache', | |
6a7e5e5d | 170 | 'localizable' => 0, |
e501603b | 171 | 'FKClassName' => 'CRM_Core_DAO_Component', |
c3fc2621 | 172 | 'html' => [ |
e501603b | 173 | 'type' => 'Select', |
c3fc2621 CW |
174 | ], |
175 | 'pseudoconstant' => [ | |
e501603b TO |
176 | 'table' => 'civicrm_component', |
177 | 'keyColumn' => 'id', | |
178 | 'labelColumn' => 'name', | |
e6ca0a57 | 179 | ], |
c3fc2621 CW |
180 | ], |
181 | 'created_date' => [ | |
e501603b | 182 | 'name' => 'created_date', |
6c2b97b7 | 183 | 'type' => CRM_Utils_Type::T_TIMESTAMP, |
c3fc2621 | 184 | 'title' => ts('Created Date'), |
215b423e | 185 | 'description' => ts('When was the cache item created'), |
a36434b9 | 186 | 'where' => 'civicrm_cache.created_date', |
6c2b97b7 | 187 | 'default' => 'CURRENT_TIMESTAMP', |
522a26c9 | 188 | 'table_name' => 'civicrm_cache', |
189 | 'entity' => 'Cache', | |
190 | 'bao' => 'CRM_Core_BAO_Cache', | |
6a7e5e5d | 191 | 'localizable' => 0, |
c3fc2621 CW |
192 | ], |
193 | 'expired_date' => [ | |
e501603b | 194 | 'name' => 'expired_date', |
6c2b97b7 | 195 | 'type' => CRM_Utils_Type::T_TIMESTAMP, |
c3fc2621 | 196 | 'title' => ts('Expired Date'), |
215b423e | 197 | 'description' => ts('When should the cache item expire'), |
c3fc2621 | 198 | 'required' => FALSE, |
a36434b9 | 199 | 'where' => 'civicrm_cache.expired_date', |
6c2b97b7 | 200 | 'default' => 'NULL', |
522a26c9 | 201 | 'table_name' => 'civicrm_cache', |
202 | 'entity' => 'Cache', | |
203 | 'bao' => 'CRM_Core_BAO_Cache', | |
6a7e5e5d | 204 | 'localizable' => 0, |
c3fc2621 CW |
205 | ], |
206 | ]; | |
346aaaba | 207 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 208 | } |
346aaaba | 209 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 210 | } |
c3fc2621 | 211 | |
e501603b | 212 | /** |
bd8e0b14 | 213 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
214 | * |
215 | * @return array | |
bd8e0b14 | 216 | * Array(string $name => string $uniqueName). |
e501603b | 217 | */ |
c3fc2621 | 218 | public static function &fieldKeys() { |
bd8e0b14 TO |
219 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
220 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 221 | } |
bd8e0b14 | 222 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 223 | } |
c3fc2621 | 224 | |
e501603b TO |
225 | /** |
226 | * Returns the names of this table | |
227 | * | |
228 | * @return string | |
229 | */ | |
c3fc2621 | 230 | public static function getTableName() { |
e501603b TO |
231 | return self::$_tableName; |
232 | } | |
c3fc2621 | 233 | |
e501603b TO |
234 | /** |
235 | * Returns if this table needs to be logged | |
236 | * | |
c3fc2621 | 237 | * @return bool |
e501603b | 238 | */ |
c3fc2621 | 239 | public function getLog() { |
e501603b TO |
240 | return self::$_log; |
241 | } | |
c3fc2621 | 242 | |
e501603b TO |
243 | /** |
244 | * Returns the list of fields that can be imported | |
245 | * | |
246 | * @param bool $prefix | |
247 | * | |
248 | * @return array | |
249 | */ | |
c3fc2621 CW |
250 | public static function &import($prefix = FALSE) { |
251 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'cache', $prefix, []); | |
60808919 | 252 | return $r; |
e501603b | 253 | } |
c3fc2621 | 254 | |
e501603b TO |
255 | /** |
256 | * Returns the list of fields that can be exported | |
257 | * | |
258 | * @param bool $prefix | |
259 | * | |
260 | * @return array | |
261 | */ | |
c3fc2621 CW |
262 | public static function &export($prefix = FALSE) { |
263 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'cache', $prefix, []); | |
60808919 | 264 | return $r; |
e501603b | 265 | } |
c3fc2621 | 266 | |
e7a6b91a AS |
267 | /** |
268 | * Returns the list of indices | |
c3fc2621 CW |
269 | * |
270 | * @param bool $localize | |
271 | * | |
272 | * @return array | |
e7a6b91a AS |
273 | */ |
274 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
275 | $indices = [ |
276 | 'UI_group_path_date' => [ | |
e7a6b91a | 277 | 'name' => 'UI_group_path_date', |
c3fc2621 | 278 | 'field' => [ |
e7a6b91a AS |
279 | 0 => 'group_name', |
280 | 1 => 'path', | |
281 | 2 => 'created_date', | |
c3fc2621 CW |
282 | ], |
283 | 'localizable' => FALSE, | |
284 | 'unique' => TRUE, | |
e7a6b91a | 285 | 'sig' => 'civicrm_cache::1::group_name::path::created_date', |
c3fc2621 CW |
286 | ], |
287 | ]; | |
e7a6b91a AS |
288 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
289 | } | |
c3fc2621 | 290 | |
e501603b | 291 | } |