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