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:6593794a6e82670ad992cc331c22f33e)
  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           'html' => [
 114             'type' => 'Number',
 115           ],
 116           'readonly' => TRUE,
 117           'add' => '1.6',
 118         ],
 119         'contact_id' => [
 120           'name' => 'contact_id',
 121           'type' => CRM_Utils_Type::T_INT,
 122           'title' => ts('Contact ID'),
 123           'description' => ts('Foreign Key to Contact'),
 124           'where' => 'civicrm_acl_cache.contact_id',
 125           'table_name' => 'civicrm_acl_cache',
 126           'entity' => 'ACLCache',
 127           'bao' => 'CRM_ACL_DAO_ACLCache',
 128           'localizable' => 0,
 129           'html' => [
 130             'type' => 'EntityRef',
 131             'label' => ts("Contact"),
 132           ],
 133           'add' => '1.6',
 134         ],
 135         'acl_id' => [
 136           'name' => 'acl_id',
 137           'type' => CRM_Utils_Type::T_INT,
 138           'title' => ts('ACL ID'),
 139           'description' => ts('Foreign Key to ACL'),
 140           'required' => TRUE,
 141           'where' => 'civicrm_acl_cache.acl_id',
 142           'table_name' => 'civicrm_acl_cache',
 143           'entity' => 'ACLCache',
 144           'bao' => 'CRM_ACL_DAO_ACLCache',
 145           'localizable' => 0,
 146           'FKClassName' => 'CRM_ACL_DAO_ACL',
 147           'html' => [
 148             'label' => ts("ACL"),
 149           ],
 150           'pseudoconstant' => [
 151             'table' => 'civicrm_acl',
 152             'keyColumn' => 'id',
 153             'labelColumn' => 'name',
 154           ],
 155           'add' => '1.6',
 156         ],
 157         'modified_date' => [
 158           'name' => 'modified_date',
 159           'type' => CRM_Utils_Type::T_TIMESTAMP,
 160           'title' => ts('Cache Modified Date'),
 161           'description' => ts('When was this cache entry last modified'),
 162           'required' => FALSE,
 163           'where' => 'civicrm_acl_cache.modified_date',
 164           'table_name' => 'civicrm_acl_cache',
 165           'entity' => 'ACLCache',
 166           'bao' => 'CRM_ACL_DAO_ACLCache',
 167           'localizable' => 0,
 168           'add' => '1.6',
 169         ],
 170       ];
 171       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 172     }
 173     return Civi::$statics[__CLASS__]['fields'];
 174   }
 175
 176   /**
 177    * Return a mapping from field-name to the corresponding key (as used in fields()).
 178    *
 179    * @return array
 180    *   Array(string $name => string $uniqueName).
 181    */
 182   public static function &fieldKeys() {
 183     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 184       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 185     }
 186     return Civi::$statics[__CLASS__]['fieldKeys'];
 187   }
 188
 189   /**
 190    * Returns the names of this table
 191    *
 192    * @return string
 193    */
 194   public static function getTableName() {
 195     return self::$_tableName;
 196   }
 197
 198   /**
 199    * Returns if this table needs to be logged
 200    *
 201    * @return bool
 202    */
 203   public function getLog() {
 204     return self::$_log;
 205   }
 206
 207   /**
 208    * Returns the list of fields that can be imported
 209    *
 210    * @param bool $prefix
 211    *
 212    * @return array
 213    */
 214   public static function &import($prefix = FALSE) {
 215     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'acl_cache', $prefix, []);
 216     return $r;
 217   }
 218
 219   /**
 220    * Returns the list of fields that can be exported
 221    *
 222    * @param bool $prefix
 223    *
 224    * @return array
 225    */
 226   public static function &export($prefix = FALSE) {
 227     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'acl_cache', $prefix, []);
 228     return $r;
 229   }
 230
 231   /**
 232    * Returns the list of indices
 233    *
 234    * @param bool $localize
 235    *
 236    * @return array
 237    */
 238   public static function indices($localize = TRUE) {
 239     $indices = [
 240       'index_contact_id' => [
 241         'name' => 'index_contact_id',
 242         'field' => [
 243           0 => 'contact_id',
 244         ],
 245         'localizable' => FALSE,
 246         'sig' => 'civicrm_acl_cache::0::contact_id',
 247       ],
 248       'index_acl_id' => [
 249         'name' => 'index_acl_id',
 250         'field' => [
 251           0 => 'acl_id',
 252         ],
 253         'localizable' => FALSE,
 254         'sig' => 'civicrm_acl_cache::0::acl_id',
 255       ],
 256       'index_modified_date' => [
 257         'name' => 'index_modified_date',
 258         'field' => [
 259           0 => 'modified_date',
 260         ],
 261         'localizable' => FALSE,
 262         'sig' => 'civicrm_acl_cache::0::modified_date',
 263       ],
 264     ];
 265     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 266   }
 267
 268 }