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:2639f5b19898adf08f19b9f2713d5e76)
  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 foreign keys and entity references.
  90    *
  91    * @return array
  92    *   [CRM_Core_Reference_Interface]
  93    */
  94   public static function getReferenceColumns() {
  95     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  96       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
  97       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'component_id', 'civicrm_component', 'id');
  98       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  99     }
 100     return Civi::$statics[__CLASS__]['links'];
 101   }
 102
 103   /**
 104    * Returns all the column names of this table
 105    *
 106    * @return array
 107    */
 108   public static function &fields() {
 109     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 110       Civi::$statics[__CLASS__]['fields'] = [
 111         'id' => [
 112           'name' => 'id',
 113           'type' => CRM_Utils_Type::T_INT,
 114           'title' => ts('Cache ID'),
 115           'description' => ts('Unique table ID'),
 116           'required' => TRUE,
 117           'where' => 'civicrm_cache.id',
 118           'table_name' => 'civicrm_cache',
 119           'entity' => 'Cache',
 120           'bao' => 'CRM_Core_BAO_Cache',
 121           'localizable' => 0,
 122         ],
 123         'group_name' => [
 124           'name' => 'group_name',
 125           'type' => CRM_Utils_Type::T_STRING,
 126           'title' => ts('Group Name'),
 127           'description' => ts('group name for cache element, useful in cleaning cache elements'),
 128           'required' => TRUE,
 129           'maxlength' => 32,
 130           'size' => CRM_Utils_Type::MEDIUM,
 131           'where' => 'civicrm_cache.group_name',
 132           'table_name' => 'civicrm_cache',
 133           'entity' => 'Cache',
 134           'bao' => 'CRM_Core_BAO_Cache',
 135           'localizable' => 0,
 136         ],
 137         'path' => [
 138           'name' => 'path',
 139           'type' => CRM_Utils_Type::T_STRING,
 140           'title' => ts('Path'),
 141           'description' => ts('Unique path name for cache element'),
 142           'maxlength' => 255,
 143           'size' => CRM_Utils_Type::HUGE,
 144           'where' => 'civicrm_cache.path',
 145           'table_name' => 'civicrm_cache',
 146           'entity' => 'Cache',
 147           'bao' => 'CRM_Core_BAO_Cache',
 148           'localizable' => 0,
 149         ],
 150         'data' => [
 151           'name' => 'data',
 152           'type' => CRM_Utils_Type::T_LONGTEXT,
 153           'title' => ts('Data'),
 154           'description' => ts('data associated with this path'),
 155           'where' => 'civicrm_cache.data',
 156           'table_name' => 'civicrm_cache',
 157           'entity' => 'Cache',
 158           'bao' => 'CRM_Core_BAO_Cache',
 159           'localizable' => 0,
 160         ],
 161         'component_id' => [
 162           'name' => 'component_id',
 163           'type' => CRM_Utils_Type::T_INT,
 164           'title' => ts('Component ID'),
 165           'description' => ts('Component that this menu item belongs to'),
 166           'where' => 'civicrm_cache.component_id',
 167           'table_name' => 'civicrm_cache',
 168           'entity' => 'Cache',
 169           'bao' => 'CRM_Core_BAO_Cache',
 170           'localizable' => 0,
 171           'FKClassName' => 'CRM_Core_DAO_Component',
 172           'html' => [
 173             'type' => 'Select',
 174           ],
 175           'pseudoconstant' => [
 176             'table' => 'civicrm_component',
 177             'keyColumn' => 'id',
 178             'labelColumn' => 'name',
 179           ],
 180         ],
 181         'created_date' => [
 182           'name' => 'created_date',
 183           'type' => CRM_Utils_Type::T_TIMESTAMP,
 184           'title' => ts('Created Date'),
 185           'description' => ts('When was the cache item created'),
 186           'where' => 'civicrm_cache.created_date',
 187           'default' => 'CURRENT_TIMESTAMP',
 188           'table_name' => 'civicrm_cache',
 189           'entity' => 'Cache',
 190           'bao' => 'CRM_Core_BAO_Cache',
 191           'localizable' => 0,
 192         ],
 193         'expired_date' => [
 194           'name' => 'expired_date',
 195           'type' => CRM_Utils_Type::T_TIMESTAMP,
 196           'title' => ts('Expired Date'),
 197           'description' => ts('When should the cache item expire'),
 198           'required' => FALSE,
 199           'where' => 'civicrm_cache.expired_date',
 200           'default' => 'NULL',
 201           'table_name' => 'civicrm_cache',
 202           'entity' => 'Cache',
 203           'bao' => 'CRM_Core_BAO_Cache',
 204           'localizable' => 0,
 205         ],
 206       ];
 207       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 208     }
 209     return Civi::$statics[__CLASS__]['fields'];
 210   }
 211
 212   /**
 213    * Return a mapping from field-name to the corresponding key (as used in fields()).
 214    *
 215    * @return array
 216    *   Array(string $name => string $uniqueName).
 217    */
 218   public static function &fieldKeys() {
 219     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 220       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 221     }
 222     return Civi::$statics[__CLASS__]['fieldKeys'];
 223   }
 224
 225   /**
 226    * Returns the names of this table
 227    *
 228    * @return string
 229    */
 230   public static function getTableName() {
 231     return self::$_tableName;
 232   }
 233
 234   /**
 235    * Returns if this table needs to be logged
 236    *
 237    * @return bool
 238    */
 239   public function getLog() {
 240     return self::$_log;
 241   }
 242
 243   /**
 244    * Returns the list of fields that can be imported
 245    *
 246    * @param bool $prefix
 247    *
 248    * @return array
 249    */
 250   public static function &import($prefix = FALSE) {
 251     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'cache', $prefix, []);
 252     return $r;
 253   }
 254
 255   /**
 256    * Returns the list of fields that can be exported
 257    *
 258    * @param bool $prefix
 259    *
 260    * @return array
 261    */
 262   public static function &export($prefix = FALSE) {
 263     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'cache', $prefix, []);
 264     return $r;
 265   }
 266
 267   /**
 268    * Returns the list of indices
 269    *
 270    * @param bool $localize
 271    *
 272    * @return array
 273    */
 274   public static function indices($localize = TRUE) {
 275     $indices = [
 276       'UI_group_path_date' => [
 277         'name' => 'UI_group_path_date',
 278         'field' => [
 279           0 => 'group_name',
 280           1 => 'path',
 281           2 => 'created_date',
 282         ],
 283         'localizable' => FALSE,
 284         'unique' => TRUE,
 285         'sig' => 'civicrm_cache::1::group_name::path::created_date',
 286       ],
 287     ];
 288     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 289   }
 290
 291 }