CRM/Core/DAO/Cache.php

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