CRM/Core/DAO/PrevNextCache.php

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