CRM/ACL/DAO/ACLCache.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/ACL/ACLCache.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:7faa5879056a56b463304bd81829afda)
  10  */
  11
  12 /**
  13  * Database access object for the ACLCache entity.
  14  */
  15 class CRM_ACL_DAO_ACLCache extends CRM_Core_DAO {
  16   const EXT = 'civicrm';
  17   const TABLE_ADDED = '1.6';
  18
  19   /**
  20    * Static instance to hold the table name.
  21    *
  22    * @var string
  23    */
  24   public static $_tableName = 'civicrm_acl_cache';
  25
  26   /**
  27    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  28    *
  29    * @var bool
  30    */
  31   public static $_log = FALSE;
  32
  33   /**
  34    * Unique table ID
  35    *
  36    * @var int
  37    */
  38   public $id;
  39
  40   /**
  41    * Foreign Key to Contact
  42    *
  43    * @var int
  44    */
  45   public $contact_id;
  46
  47   /**
  48    * Foreign Key to ACL
  49    *
  50    * @var int
  51    */
  52   public $acl_id;
  53
  54   /**
  55    * When was this cache entry last modified
  56    *
  57    * @var timestamp
  58    */
  59   public $modified_date;
  60
  61   /**
  62    * Class constructor.
  63    */
  64   public function __construct() {
  65     $this->__table = 'civicrm_acl_cache';
  66     parent::__construct();
  67   }
  68
  69   /**
  70    * Returns localized title of this entity.
  71    *
  72    * @param bool $plural
  73    *   Whether to return the plural version of the title.
  74    */
  75   public static function getEntityTitle($plural = FALSE) {
  76     return $plural ? ts('ACLCaches') : ts('ACLCache');
  77   }
  78
  79   /**
  80    * Returns foreign keys and entity references.
  81    *
  82    * @return array
  83    *   [CRM_Core_Reference_Interface]
  84    */
  85   public static function getReferenceColumns() {
  86     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  87       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
  88       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'acl_id', 'civicrm_acl', 'id');
  89       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  90     }
  91     return Civi::$statics[__CLASS__]['links'];
  92   }
  93
  94   /**
  95    * Returns all the column names of this table
  96    *
  97    * @return array
  98    */
  99   public static function &fields() {
 100     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 101       Civi::$statics[__CLASS__]['fields'] = [
 102         'id' => [
 103           'name' => 'id',
 104           'type' => CRM_Utils_Type::T_INT,
 105           'title' => ts('Cache ID'),
 106           'description' => ts('Unique table ID'),
 107           'required' => TRUE,
 108           'where' => 'civicrm_acl_cache.id',
 109           'table_name' => 'civicrm_acl_cache',
 110           'entity' => 'ACLCache',
 111           'bao' => 'CRM_ACL_DAO_ACLCache',
 112           'localizable' => 0,
 113           'add' => '1.6',
 114         ],
 115         'contact_id' => [
 116           'name' => 'contact_id',
 117           'type' => CRM_Utils_Type::T_INT,
 118           'title' => ts('Cache Contact'),
 119           'description' => ts('Foreign Key to Contact'),
 120           'where' => 'civicrm_acl_cache.contact_id',
 121           'table_name' => 'civicrm_acl_cache',
 122           'entity' => 'ACLCache',
 123           'bao' => 'CRM_ACL_DAO_ACLCache',
 124           'localizable' => 0,
 125           'html' => [
 126             'type' => 'EntityRef',
 127           ],
 128           'add' => '1.6',
 129         ],
 130         'acl_id' => [
 131           'name' => 'acl_id',
 132           'type' => CRM_Utils_Type::T_INT,
 133           'title' => ts('Cache ACL'),
 134           'description' => ts('Foreign Key to ACL'),
 135           'required' => TRUE,
 136           'where' => 'civicrm_acl_cache.acl_id',
 137           'table_name' => 'civicrm_acl_cache',
 138           'entity' => 'ACLCache',
 139           'bao' => 'CRM_ACL_DAO_ACLCache',
 140           'localizable' => 0,
 141           'FKClassName' => 'CRM_ACL_DAO_ACL',
 142           'pseudoconstant' => [
 143             'table' => 'civicrm_acl',
 144             'keyColumn' => 'id',
 145             'labelColumn' => 'name',
 146           ],
 147           'add' => '1.6',
 148         ],
 149         'modified_date' => [
 150           'name' => 'modified_date',
 151           'type' => CRM_Utils_Type::T_TIMESTAMP,
 152           'title' => ts('Cache Modified Date'),
 153           'description' => ts('When was this cache entry last modified'),
 154           'required' => FALSE,
 155           'where' => 'civicrm_acl_cache.modified_date',
 156           'table_name' => 'civicrm_acl_cache',
 157           'entity' => 'ACLCache',
 158           'bao' => 'CRM_ACL_DAO_ACLCache',
 159           'localizable' => 0,
 160           'add' => '1.6',
 161         ],
 162       ];
 163       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 164     }
 165     return Civi::$statics[__CLASS__]['fields'];
 166   }
 167
 168   /**
 169    * Return a mapping from field-name to the corresponding key (as used in fields()).
 170    *
 171    * @return array
 172    *   Array(string $name => string $uniqueName).
 173    */
 174   public static function &fieldKeys() {
 175     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 176       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 177     }
 178     return Civi::$statics[__CLASS__]['fieldKeys'];
 179   }
 180
 181   /**
 182    * Returns the names of this table
 183    *
 184    * @return string
 185    */
 186   public static function getTableName() {
 187     return self::$_tableName;
 188   }
 189
 190   /**
 191    * Returns if this table needs to be logged
 192    *
 193    * @return bool
 194    */
 195   public function getLog() {
 196     return self::$_log;
 197   }
 198
 199   /**
 200    * Returns the list of fields that can be imported
 201    *
 202    * @param bool $prefix
 203    *
 204    * @return array
 205    */
 206   public static function &import($prefix = FALSE) {
 207     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'acl_cache', $prefix, []);
 208     return $r;
 209   }
 210
 211   /**
 212    * Returns the list of fields that can be exported
 213    *
 214    * @param bool $prefix
 215    *
 216    * @return array
 217    */
 218   public static function &export($prefix = FALSE) {
 219     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'acl_cache', $prefix, []);
 220     return $r;
 221   }
 222
 223   /**
 224    * Returns the list of indices
 225    *
 226    * @param bool $localize
 227    *
 228    * @return array
 229    */
 230   public static function indices($localize = TRUE) {
 231     $indices = [
 232       'index_contact_id' => [
 233         'name' => 'index_contact_id',
 234         'field' => [
 235           0 => 'contact_id',
 236         ],
 237         'localizable' => FALSE,
 238         'sig' => 'civicrm_acl_cache::0::contact_id',
 239       ],
 240       'index_acl_id' => [
 241         'name' => 'index_acl_id',
 242         'field' => [
 243           0 => 'acl_id',
 244         ],
 245         'localizable' => FALSE,
 246         'sig' => 'civicrm_acl_cache::0::acl_id',
 247       ],
 248       'index_modified_date' => [
 249         'name' => 'index_modified_date',
 250         'field' => [
 251           0 => 'modified_date',
 252         ],
 253         'localizable' => FALSE,
 254         'sig' => 'civicrm_acl_cache::0::modified_date',
 255       ],
 256     ];
 257     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 258   }
 259
 260 }