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