5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Core/Cache.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:bafe6ce2f7fd94b2581bfc4dad813130)
13 * Database access object for the Cache entity.
15 class CRM_Core_DAO_Cache
extends CRM_Core_DAO
{
16 const EXT
= 'civicrm';
17 const TABLE_ADDED
= '2.1';
20 * Static instance to hold the table name.
24 public static $_tableName = 'civicrm_cache';
27 * Should CiviCRM log any modifications to this table in the civicrm_log table.
31 public static $_log = FALSE;
41 * group name for cache element, useful in cleaning cache elements
48 * Unique path name for cache element
55 * data associated with this path
62 * Component that this menu item belongs to
69 * When was the cache item created
76 * When should the cache item expire
85 public function __construct() {
86 $this->__table
= 'civicrm_cache';
87 parent
::__construct();
91 * Returns localized title of this entity.
94 * Whether to return the plural version of the title.
96 public static function getEntityTitle($plural = FALSE) {
97 return $plural ?
ts('Caches') : ts('Cache');
101 * Returns foreign keys and entity references.
104 * [CRM_Core_Reference_Interface]
106 public static function getReferenceColumns() {
107 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
108 Civi
::$statics[__CLASS__
]['links'] = static::createReferenceColumns(__CLASS__
);
109 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'component_id', 'civicrm_component', 'id');
110 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
112 return Civi
::$statics[__CLASS__
]['links'];
116 * Returns all the column names of this table
120 public static function &fields() {
121 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
122 Civi
::$statics[__CLASS__
]['fields'] = [
125 'type' => CRM_Utils_Type
::T_INT
,
126 'title' => ts('Cache ID'),
127 'description' => ts('Unique table ID'),
129 'where' => 'civicrm_cache.id',
130 'table_name' => 'civicrm_cache',
132 'bao' => 'CRM_Core_BAO_Cache',
137 'name' => 'group_name',
138 'type' => CRM_Utils_Type
::T_STRING
,
139 'title' => ts('Group Name'),
140 'description' => ts('group name for cache element, useful in cleaning cache elements'),
143 'size' => CRM_Utils_Type
::MEDIUM
,
144 'where' => 'civicrm_cache.group_name',
145 'table_name' => 'civicrm_cache',
147 'bao' => 'CRM_Core_BAO_Cache',
153 'type' => CRM_Utils_Type
::T_STRING
,
154 'title' => ts('Path'),
155 'description' => ts('Unique path name for cache element'),
157 'size' => CRM_Utils_Type
::HUGE
,
158 'where' => 'civicrm_cache.path',
159 'table_name' => 'civicrm_cache',
161 'bao' => 'CRM_Core_BAO_Cache',
167 'type' => CRM_Utils_Type
::T_LONGTEXT
,
168 'title' => ts('Data'),
169 'description' => ts('data associated with this path'),
170 'where' => 'civicrm_cache.data',
171 'table_name' => 'civicrm_cache',
173 'bao' => 'CRM_Core_BAO_Cache',
178 'name' => 'component_id',
179 'type' => CRM_Utils_Type
::T_INT
,
180 'title' => ts('Component ID'),
181 'description' => ts('Component that this menu item belongs to'),
182 'where' => 'civicrm_cache.component_id',
183 'table_name' => 'civicrm_cache',
185 'bao' => 'CRM_Core_BAO_Cache',
187 'FKClassName' => 'CRM_Core_DAO_Component',
191 'pseudoconstant' => [
192 'table' => 'civicrm_component',
194 'labelColumn' => 'name',
199 'name' => 'created_date',
200 'type' => CRM_Utils_Type
::T_TIMESTAMP
,
201 'title' => ts('Created Date'),
202 'description' => ts('When was the cache item created'),
203 'where' => 'civicrm_cache.created_date',
204 'default' => 'CURRENT_TIMESTAMP',
205 'table_name' => 'civicrm_cache',
207 'bao' => 'CRM_Core_BAO_Cache',
212 'name' => 'expired_date',
213 'type' => CRM_Utils_Type
::T_TIMESTAMP
,
214 'title' => ts('Expired Date'),
215 'description' => ts('When should the cache item expire'),
217 'where' => 'civicrm_cache.expired_date',
219 'table_name' => 'civicrm_cache',
221 'bao' => 'CRM_Core_BAO_Cache',
226 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
228 return Civi
::$statics[__CLASS__
]['fields'];
232 * Return a mapping from field-name to the corresponding key (as used in fields()).
235 * Array(string $name => string $uniqueName).
237 public static function &fieldKeys() {
238 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
239 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
241 return Civi
::$statics[__CLASS__
]['fieldKeys'];
245 * Returns the names of this table
249 public static function getTableName() {
250 return self
::$_tableName;
254 * Returns if this table needs to be logged
258 public function getLog() {
263 * Returns the list of fields that can be imported
265 * @param bool $prefix
269 public static function &import($prefix = FALSE) {
270 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'cache', $prefix, []);
275 * Returns the list of fields that can be exported
277 * @param bool $prefix
281 public static function &export($prefix = FALSE) {
282 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'cache', $prefix, []);
287 * Returns the list of indices
289 * @param bool $localize
293 public static function indices($localize = TRUE) {
295 'UI_group_path_date' => [
296 'name' => 'UI_group_path_date',
302 'localizable' => FALSE,
304 'sig' => 'civicrm_cache::1::group_name::path::created_date',
307 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;