CRM/Contact/DAO/GroupContactCache.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2019
   6  *
   7  * Generated from xml/schema/CRM/Contact/GroupContactCache.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:98cff858204d34551eec0b9bee6e24af)
  10  */
  11
  12 /**
  13  * Database access object for the GroupContactCache entity.
  14  */
  15 class CRM_Contact_DAO_GroupContactCache extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   static $_tableName = 'civicrm_group_contact_cache';
  23
  24   /**
  25    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  26    *
  27    * @var bool
  28    */
  29   static $_log = FALSE;
  30
  31   /**
  32    * primary key
  33    *
  34    * @var int unsigned
  35    */
  36   public $id;
  37
  38   /**
  39    * FK to civicrm_group
  40    *
  41    * @var int unsigned
  42    */
  43   public $group_id;
  44
  45   /**
  46    * FK to civicrm_contact
  47    *
  48    * @var int unsigned
  49    */
  50   public $contact_id;
  51
  52   /**
  53    * Class constructor.
  54    */
  55   public function __construct() {
  56     $this->__table = 'civicrm_group_contact_cache';
  57     parent::__construct();
  58   }
  59
  60   /**
  61    * Returns foreign keys and entity references.
  62    *
  63    * @return array
  64    *   [CRM_Core_Reference_Interface]
  65    */
  66   public static function getReferenceColumns() {
  67     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  68       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  69       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'group_id', 'civicrm_group', 'id');
  70       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id');
  71       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  72     }
  73     return Civi::$statics[__CLASS__]['links'];
  74   }
  75
  76   /**
  77    * Returns all the column names of this table
  78    *
  79    * @return array
  80    */
  81   public static function &fields() {
  82     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  83       Civi::$statics[__CLASS__]['fields'] = [
  84         'id' => [
  85           'name' => 'id',
  86           'type' => CRM_Utils_Type::T_INT,
  87           'title' => ts('Group Contact Cache ID'),
  88           'description' => ts('primary key'),
  89           'required' => TRUE,
  90           'table_name' => 'civicrm_group_contact_cache',
  91           'entity' => 'GroupContactCache',
  92           'bao' => 'CRM_Contact_BAO_GroupContactCache',
  93           'localizable' => 0,
  94         ],
  95         'group_id' => [
  96           'name' => 'group_id',
  97           'type' => CRM_Utils_Type::T_INT,
  98           'title' => ts('Group'),
  99           'description' => ts('FK to civicrm_group'),
 100           'required' => TRUE,
 101           'table_name' => 'civicrm_group_contact_cache',
 102           'entity' => 'GroupContactCache',
 103           'bao' => 'CRM_Contact_BAO_GroupContactCache',
 104           'localizable' => 0,
 105           'FKClassName' => 'CRM_Contact_DAO_Group',
 106           'html' => [
 107             'type' => 'Select',
 108           ],
 109           'pseudoconstant' => [
 110             'table' => 'civicrm_group',
 111             'keyColumn' => 'id',
 112             'labelColumn' => 'title',
 113           ]
 114         ],
 115         'contact_id' => [
 116           'name' => 'contact_id',
 117           'type' => CRM_Utils_Type::T_INT,
 118           'title' => ts('Contact ID'),
 119           'description' => ts('FK to civicrm_contact'),
 120           'required' => TRUE,
 121           'table_name' => 'civicrm_group_contact_cache',
 122           'entity' => 'GroupContactCache',
 123           'bao' => 'CRM_Contact_BAO_GroupContactCache',
 124           'localizable' => 0,
 125           'FKClassName' => 'CRM_Contact_DAO_Contact',
 126         ],
 127       ];
 128       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 129     }
 130     return Civi::$statics[__CLASS__]['fields'];
 131   }
 132
 133   /**
 134    * Return a mapping from field-name to the corresponding key (as used in fields()).
 135    *
 136    * @return array
 137    *   Array(string $name => string $uniqueName).
 138    */
 139   public static function &fieldKeys() {
 140     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 141       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 142     }
 143     return Civi::$statics[__CLASS__]['fieldKeys'];
 144   }
 145
 146   /**
 147    * Returns the names of this table
 148    *
 149    * @return string
 150    */
 151   public static function getTableName() {
 152     return self::$_tableName;
 153   }
 154
 155   /**
 156    * Returns if this table needs to be logged
 157    *
 158    * @return bool
 159    */
 160   public function getLog() {
 161     return self::$_log;
 162   }
 163
 164   /**
 165    * Returns the list of fields that can be imported
 166    *
 167    * @param bool $prefix
 168    *
 169    * @return array
 170    */
 171   public static function &import($prefix = FALSE) {
 172     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'group_contact_cache', $prefix, []);
 173     return $r;
 174   }
 175
 176   /**
 177    * Returns the list of fields that can be exported
 178    *
 179    * @param bool $prefix
 180    *
 181    * @return array
 182    */
 183   public static function &export($prefix = FALSE) {
 184     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'group_contact_cache', $prefix, []);
 185     return $r;
 186   }
 187
 188   /**
 189    * Returns the list of indices
 190    *
 191    * @param bool $localize
 192    *
 193    * @return array
 194    */
 195   public static function indices($localize = TRUE) {
 196     $indices = [
 197       'UI_contact_group' => [
 198         'name' => 'UI_contact_group',
 199         'field' => [
 200           0 => 'contact_id',
 201           1 => 'group_id',
 202         ],
 203         'localizable' => FALSE,
 204         'unique' => TRUE,
 205         'sig' => 'civicrm_group_contact_cache::1::contact_id::group_id',
 206       ],
 207     ];
 208     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 209   }
 210
 211 }