CRM/Contact/DAO/ACLContactCache.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Contact/ACLContactCache.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:b99253b18e66856d4b6d914f2669fa30)
  10  */
  11
  12 /**
  13  * Database access object for the ACLContactCache entity.
  14  */
  15 class CRM_Contact_DAO_ACLContactCache 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_contact_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    * primary key
  33    *
  34    * @var int
  35    */
  36   public $id;
  37
  38   /**
  39    * FK to civicrm_contact (could be null for anon user)
  40    *
  41    * @var int
  42    */
  43   public $user_id;
  44
  45   /**
  46    * FK to civicrm_contact
  47    *
  48    * @var int
  49    */
  50   public $contact_id;
  51
  52   /**
  53    * What operation does this user have permission on?
  54    *
  55    * @var string
  56    */
  57   public $operation;
  58
  59   /**
  60    * Class constructor.
  61    */
  62   public function __construct() {
  63     $this->__table = 'civicrm_acl_contact_cache';
  64     parent::__construct();
  65   }
  66
  67   /**
  68    * Returns localized title of this entity.
  69    */
  70   public static function getEntityTitle() {
  71     return ts('ACLContact Caches');
  72   }
  73
  74   /**
  75    * Returns foreign keys and entity references.
  76    *
  77    * @return array
  78    *   [CRM_Core_Reference_Interface]
  79    */
  80   public static function getReferenceColumns() {
  81     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  82       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
  83       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id');
  84       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  85     }
  86     return Civi::$statics[__CLASS__]['links'];
  87   }
  88
  89   /**
  90    * Returns all the column names of this table
  91    *
  92    * @return array
  93    */
  94   public static function &fields() {
  95     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  96       Civi::$statics[__CLASS__]['fields'] = [
  97         'id' => [
  98           'name' => 'id',
  99           'type' => CRM_Utils_Type::T_INT,
 100           'title' => ts('ACL Contact Cache ID'),
 101           'description' => ts('primary key'),
 102           'required' => TRUE,
 103           'where' => 'civicrm_acl_contact_cache.id',
 104           'table_name' => 'civicrm_acl_contact_cache',
 105           'entity' => 'ACLContactCache',
 106           'bao' => 'CRM_Contact_DAO_ACLContactCache',
 107           'localizable' => 0,
 108           'add' => '3.1',
 109         ],
 110         'user_id' => [
 111           'name' => 'user_id',
 112           'type' => CRM_Utils_Type::T_INT,
 113           'title' => ts('Contact ID'),
 114           'description' => ts('FK to civicrm_contact (could be null for anon user)'),
 115           'where' => 'civicrm_acl_contact_cache.user_id',
 116           'table_name' => 'civicrm_acl_contact_cache',
 117           'entity' => 'ACLContactCache',
 118           'bao' => 'CRM_Contact_DAO_ACLContactCache',
 119           'localizable' => 0,
 120           'add' => '3.1',
 121         ],
 122         'contact_id' => [
 123           'name' => 'contact_id',
 124           'type' => CRM_Utils_Type::T_INT,
 125           'title' => ts('Contact ID'),
 126           'description' => ts('FK to civicrm_contact'),
 127           'required' => TRUE,
 128           'where' => 'civicrm_acl_contact_cache.contact_id',
 129           'table_name' => 'civicrm_acl_contact_cache',
 130           'entity' => 'ACLContactCache',
 131           'bao' => 'CRM_Contact_DAO_ACLContactCache',
 132           'localizable' => 0,
 133           'FKClassName' => 'CRM_Contact_DAO_Contact',
 134           'add' => '3.1',
 135         ],
 136         'operation' => [
 137           'name' => 'operation',
 138           'type' => CRM_Utils_Type::T_STRING,
 139           'title' => ts('Operation'),
 140           'description' => ts('What operation does this user have permission on?'),
 141           'required' => TRUE,
 142           'maxlength' => 8,
 143           'size' => CRM_Utils_Type::EIGHT,
 144           'where' => 'civicrm_acl_contact_cache.operation',
 145           'table_name' => 'civicrm_acl_contact_cache',
 146           'entity' => 'ACLContactCache',
 147           'bao' => 'CRM_Contact_DAO_ACLContactCache',
 148           'localizable' => 0,
 149           'html' => [
 150             'type' => 'Select',
 151           ],
 152           'pseudoconstant' => [
 153             'callback' => 'CRM_ACL_BAO_ACL::operation',
 154           ],
 155           'add' => '1.6',
 156         ],
 157       ];
 158       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 159     }
 160     return Civi::$statics[__CLASS__]['fields'];
 161   }
 162
 163   /**
 164    * Return a mapping from field-name to the corresponding key (as used in fields()).
 165    *
 166    * @return array
 167    *   Array(string $name => string $uniqueName).
 168    */
 169   public static function &fieldKeys() {
 170     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 171       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 172     }
 173     return Civi::$statics[__CLASS__]['fieldKeys'];
 174   }
 175
 176   /**
 177    * Returns the names of this table
 178    *
 179    * @return string
 180    */
 181   public static function getTableName() {
 182     return self::$_tableName;
 183   }
 184
 185   /**
 186    * Returns if this table needs to be logged
 187    *
 188    * @return bool
 189    */
 190   public function getLog() {
 191     return self::$_log;
 192   }
 193
 194   /**
 195    * Returns the list of fields that can be imported
 196    *
 197    * @param bool $prefix
 198    *
 199    * @return array
 200    */
 201   public static function &import($prefix = FALSE) {
 202     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'acl_contact_cache', $prefix, []);
 203     return $r;
 204   }
 205
 206   /**
 207    * Returns the list of fields that can be exported
 208    *
 209    * @param bool $prefix
 210    *
 211    * @return array
 212    */
 213   public static function &export($prefix = FALSE) {
 214     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'acl_contact_cache', $prefix, []);
 215     return $r;
 216   }
 217
 218   /**
 219    * Returns the list of indices
 220    *
 221    * @param bool $localize
 222    *
 223    * @return array
 224    */
 225   public static function indices($localize = TRUE) {
 226     $indices = [
 227       'UI_user_contact_operation' => [
 228         'name' => 'UI_user_contact_operation',
 229         'field' => [
 230           0 => 'user_id',
 231           1 => 'contact_id',
 232           2 => 'operation',
 233         ],
 234         'localizable' => FALSE,
 235         'unique' => TRUE,
 236         'sig' => 'civicrm_acl_contact_cache::1::user_id::contact_id::operation',
 237       ],
 238     ];
 239     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 240   }
 241
 242 }