CRM/ACL/DAO/Cache.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2019
   6  *
   7  * Generated from xml/schema/CRM/ACL/Cache.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:f993d89f3a44999eed1b4c46b714b736)
  10  */
  11
  12 /**
  13  * Database access object for the Cache entity.
  14  */
  15 class CRM_ACL_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_acl_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    * Foreign Key to Contact
  40    *
  41    * @var int
  42    */
  43   public $contact_id;
  44
  45   /**
  46    * Foreign Key to ACL
  47    *
  48    * @var int
  49    */
  50   public $acl_id;
  51
  52   /**
  53    * When was this cache entry last modified
  54    *
  55    * @var timestamp
  56    */
  57   public $modified_date;
  58
  59   /**
  60    * Class constructor.
  61    */
  62   public function __construct() {
  63     $this->__table = 'civicrm_acl_cache';
  64     parent::__construct();
  65   }
  66
  67   /**
  68    * Returns foreign keys and entity references.
  69    *
  70    * @return array
  71    *   [CRM_Core_Reference_Interface]
  72    */
  73   public static function getReferenceColumns() {
  74     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  75       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
  76       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id');
  77       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'acl_id', 'civicrm_acl', 'id');
  78       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  79     }
  80     return Civi::$statics[__CLASS__]['links'];
  81   }
  82
  83   /**
  84    * Returns all the column names of this table
  85    *
  86    * @return array
  87    */
  88   public static function &fields() {
  89     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  90       Civi::$statics[__CLASS__]['fields'] = [
  91         'id' => [
  92           'name' => 'id',
  93           'type' => CRM_Utils_Type::T_INT,
  94           'title' => ts('Cache ID'),
  95           'description' => ts('Unique table ID'),
  96           'required' => TRUE,
  97           'where' => 'civicrm_acl_cache.id',
  98           'table_name' => 'civicrm_acl_cache',
  99           'entity' => 'Cache',
 100           'bao' => 'CRM_ACL_BAO_Cache',
 101           'localizable' => 0,
 102         ],
 103         'contact_id' => [
 104           'name' => 'contact_id',
 105           'type' => CRM_Utils_Type::T_INT,
 106           'title' => ts('Cache Contact'),
 107           'description' => ts('Foreign Key to Contact'),
 108           'where' => 'civicrm_acl_cache.contact_id',
 109           'table_name' => 'civicrm_acl_cache',
 110           'entity' => 'Cache',
 111           'bao' => 'CRM_ACL_BAO_Cache',
 112           'localizable' => 0,
 113           'FKClassName' => 'CRM_Contact_DAO_Contact',
 114         ],
 115         'acl_id' => [
 116           'name' => 'acl_id',
 117           'type' => CRM_Utils_Type::T_INT,
 118           'title' => ts('Cache ACL'),
 119           'description' => ts('Foreign Key to ACL'),
 120           'required' => TRUE,
 121           'where' => 'civicrm_acl_cache.acl_id',
 122           'table_name' => 'civicrm_acl_cache',
 123           'entity' => 'Cache',
 124           'bao' => 'CRM_ACL_BAO_Cache',
 125           'localizable' => 0,
 126           'FKClassName' => 'CRM_ACL_DAO_ACL',
 127         ],
 128         'modified_date' => [
 129           'name' => 'modified_date',
 130           'type' => CRM_Utils_Type::T_TIMESTAMP,
 131           'title' => ts('Cache Modified Date'),
 132           'description' => ts('When was this cache entry last modified'),
 133           'required' => FALSE,
 134           'where' => 'civicrm_acl_cache.modified_date',
 135           'table_name' => 'civicrm_acl_cache',
 136           'entity' => 'Cache',
 137           'bao' => 'CRM_ACL_BAO_Cache',
 138           'localizable' => 0,
 139         ],
 140       ];
 141       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 142     }
 143     return Civi::$statics[__CLASS__]['fields'];
 144   }
 145
 146   /**
 147    * Return a mapping from field-name to the corresponding key (as used in fields()).
 148    *
 149    * @return array
 150    *   Array(string $name => string $uniqueName).
 151    */
 152   public static function &fieldKeys() {
 153     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 154       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 155     }
 156     return Civi::$statics[__CLASS__]['fieldKeys'];
 157   }
 158
 159   /**
 160    * Returns the names of this table
 161    *
 162    * @return string
 163    */
 164   public static function getTableName() {
 165     return self::$_tableName;
 166   }
 167
 168   /**
 169    * Returns if this table needs to be logged
 170    *
 171    * @return bool
 172    */
 173   public function getLog() {
 174     return self::$_log;
 175   }
 176
 177   /**
 178    * Returns the list of fields that can be imported
 179    *
 180    * @param bool $prefix
 181    *
 182    * @return array
 183    */
 184   public static function &import($prefix = FALSE) {
 185     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'acl_cache', $prefix, []);
 186     return $r;
 187   }
 188
 189   /**
 190    * Returns the list of fields that can be exported
 191    *
 192    * @param bool $prefix
 193    *
 194    * @return array
 195    */
 196   public static function &export($prefix = FALSE) {
 197     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'acl_cache', $prefix, []);
 198     return $r;
 199   }
 200
 201   /**
 202    * Returns the list of indices
 203    *
 204    * @param bool $localize
 205    *
 206    * @return array
 207    */
 208   public static function indices($localize = TRUE) {
 209     $indices = [
 210       'index_acl_id' => [
 211         'name' => 'index_acl_id',
 212         'field' => [
 213           0 => 'acl_id',
 214         ],
 215         'localizable' => FALSE,
 216         'sig' => 'civicrm_acl_cache::0::acl_id',
 217       ],
 218     ];
 219     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 220   }
 221
 222 }