5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Contact/GroupContactCache.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:06473218afb38f81fefca8e3e1a351e1)
13 * Database access object for the GroupContactCache entity.
15 class CRM_Contact_DAO_GroupContactCache
extends CRM_Core_DAO
{
16 const EXT
= 'civicrm';
17 const TABLE_ADDED
= '2.1';
20 * Static instance to hold the table name.
24 public static $_tableName = 'civicrm_group_contact_cache';
27 * Should CiviCRM log any modifications to this table in the civicrm_log table.
31 public static $_log = FALSE;
36 * @var int|string|null
37 * (SQL type: int unsigned)
38 * Note that values will be retrieved from the database as a string.
46 * (SQL type: int unsigned)
47 * Note that values will be retrieved from the database as a string.
52 * FK to civicrm_contact
55 * (SQL type: int unsigned)
56 * Note that values will be retrieved from the database as a string.
63 public function __construct() {
64 $this->__table
= 'civicrm_group_contact_cache';
65 parent
::__construct();
69 * Returns localized title of this entity.
72 * Whether to return the plural version of the title.
74 public static function getEntityTitle($plural = FALSE) {
75 return $plural ?
ts('Group Contact Caches') : ts('Group Contact Cache');
79 * Returns foreign keys and entity references.
82 * [CRM_Core_Reference_Interface]
84 public static function getReferenceColumns() {
85 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
86 Civi
::$statics[__CLASS__
]['links'] = static::createReferenceColumns(__CLASS__
);
87 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'group_id', 'civicrm_group', 'id');
88 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'contact_id', 'civicrm_contact', 'id');
89 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
91 return Civi
::$statics[__CLASS__
]['links'];
95 * Returns all the column names of this table
99 public static function &fields() {
100 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
101 Civi
::$statics[__CLASS__
]['fields'] = [
104 'type' => CRM_Utils_Type
::T_INT
,
105 'title' => ts('Group Contact Cache ID'),
106 'description' => ts('primary key'),
108 'where' => 'civicrm_group_contact_cache.id',
109 'table_name' => 'civicrm_group_contact_cache',
110 'entity' => 'GroupContactCache',
111 'bao' => 'CRM_Contact_BAO_GroupContactCache',
120 'name' => 'group_id',
121 'type' => CRM_Utils_Type
::T_INT
,
122 'title' => ts('Group ID'),
123 'description' => ts('FK to civicrm_group'),
125 'where' => 'civicrm_group_contact_cache.group_id',
126 'table_name' => 'civicrm_group_contact_cache',
127 'entity' => 'GroupContactCache',
128 'bao' => 'CRM_Contact_BAO_GroupContactCache',
130 'FKClassName' => 'CRM_Contact_DAO_Group',
133 'label' => ts("Group"),
135 'pseudoconstant' => [
136 'table' => 'civicrm_group',
138 'labelColumn' => 'title',
143 'name' => 'contact_id',
144 'type' => CRM_Utils_Type
::T_INT
,
145 'title' => ts('Contact ID'),
146 'description' => ts('FK to civicrm_contact'),
148 'where' => 'civicrm_group_contact_cache.contact_id',
149 'table_name' => 'civicrm_group_contact_cache',
150 'entity' => 'GroupContactCache',
151 'bao' => 'CRM_Contact_BAO_GroupContactCache',
153 'FKClassName' => 'CRM_Contact_DAO_Contact',
155 'label' => ts("Contact"),
160 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
162 return Civi
::$statics[__CLASS__
]['fields'];
166 * Return a mapping from field-name to the corresponding key (as used in fields()).
169 * Array(string $name => string $uniqueName).
171 public static function &fieldKeys() {
172 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
173 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
175 return Civi
::$statics[__CLASS__
]['fieldKeys'];
179 * Returns the names of this table
183 public static function getTableName() {
184 return self
::$_tableName;
188 * Returns if this table needs to be logged
192 public function getLog() {
197 * Returns the list of fields that can be imported
199 * @param bool $prefix
203 public static function &import($prefix = FALSE) {
204 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'group_contact_cache', $prefix, []);
209 * Returns the list of fields that can be exported
211 * @param bool $prefix
215 public static function &export($prefix = FALSE) {
216 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'group_contact_cache', $prefix, []);
221 * Returns the list of indices
223 * @param bool $localize
227 public static function indices($localize = TRUE) {
229 'UI_contact_group' => [
230 'name' => 'UI_contact_group',
235 'localizable' => FALSE,
237 'sig' => 'civicrm_group_contact_cache::1::contact_id::group_id',
240 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;