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/Group.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
7b66c3b5 | 9 | * (GenCodeChecksum:9d3fc8fbc20e3b8068d5989828341c66) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the Group entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Contact_DAO_Group extends CRM_Core_DAO { |
929a1c14 CW |
16 | const EXT = 'civicrm'; |
17 | const TABLE_ADDED = '1.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'; |
c3fc2621 | 25 | |
449c4e6b CW |
26 | /** |
27 | * Icon associated with this entity. | |
28 | * | |
29 | * @var string | |
30 | */ | |
31 | public static $_icon = 'fa-users'; | |
32 | ||
e501603b | 33 | /** |
f41f0342 | 34 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
e501603b | 35 | * |
c3fc2621 | 36 | * @var bool |
e501603b | 37 | */ |
fa45b5b9 | 38 | public static $_log = TRUE; |
c3fc2621 | 39 | |
e501603b TO |
40 | /** |
41 | * Group ID | |
42 | * | |
e6ca0a57 | 43 | * @var int |
e501603b TO |
44 | */ |
45 | public $id; | |
c3fc2621 | 46 | |
e501603b TO |
47 | /** |
48 | * Internal name of Group. | |
49 | * | |
50 | * @var string | |
51 | */ | |
52 | public $name; | |
c3fc2621 | 53 | |
e501603b TO |
54 | /** |
55 | * Name of Group. | |
56 | * | |
57 | * @var string | |
58 | */ | |
59 | public $title; | |
c3fc2621 | 60 | |
e501603b TO |
61 | /** |
62 | * Optional verbose description of the group. | |
63 | * | |
64 | * @var text | |
65 | */ | |
66 | public $description; | |
c3fc2621 | 67 | |
e501603b TO |
68 | /** |
69 | * Module or process which created this group. | |
70 | * | |
71 | * @var string | |
72 | */ | |
73 | public $source; | |
c3fc2621 | 74 | |
e501603b TO |
75 | /** |
76 | * FK to saved search table. | |
77 | * | |
e6ca0a57 | 78 | * @var int |
e501603b TO |
79 | */ |
80 | public $saved_search_id; | |
c3fc2621 | 81 | |
e501603b TO |
82 | /** |
83 | * Is this entry active? | |
84 | * | |
e6ca0a57 | 85 | * @var bool |
e501603b TO |
86 | */ |
87 | public $is_active; | |
c3fc2621 | 88 | |
e501603b TO |
89 | /** |
90 | * In what context(s) is this field visible. | |
91 | * | |
92 | * @var string | |
93 | */ | |
94 | public $visibility; | |
c3fc2621 | 95 | |
e501603b TO |
96 | /** |
97 | * the sql where clause if a saved search acl | |
98 | * | |
99 | * @var text | |
100 | */ | |
101 | public $where_clause; | |
c3fc2621 | 102 | |
e501603b TO |
103 | /** |
104 | * the tables to be included in a select data | |
105 | * | |
106 | * @var text | |
107 | */ | |
108 | public $select_tables; | |
c3fc2621 | 109 | |
e501603b TO |
110 | /** |
111 | * the tables to be included in the count statement | |
112 | * | |
113 | * @var text | |
114 | */ | |
115 | public $where_tables; | |
c3fc2621 | 116 | |
e501603b TO |
117 | /** |
118 | * FK to group type | |
119 | * | |
120 | * @var string | |
121 | */ | |
122 | public $group_type; | |
c3fc2621 | 123 | |
e501603b TO |
124 | /** |
125 | * Date when we created the cache for a smart group | |
126 | * | |
127 | * @var timestamp | |
128 | */ | |
129 | public $cache_date; | |
c3fc2621 | 130 | |
e501603b TO |
131 | /** |
132 | * Date and time when we need to refresh the cache next. | |
133 | * | |
134 | * @var timestamp | |
135 | */ | |
136 | public $refresh_date; | |
c3fc2621 | 137 | |
e501603b TO |
138 | /** |
139 | * IDs of the parent(s) | |
140 | * | |
141 | * @var text | |
142 | */ | |
143 | public $parents; | |
c3fc2621 | 144 | |
e501603b TO |
145 | /** |
146 | * IDs of the child(ren) | |
147 | * | |
148 | * @var text | |
149 | */ | |
150 | public $children; | |
c3fc2621 | 151 | |
e501603b TO |
152 | /** |
153 | * Is this group hidden? | |
154 | * | |
e6ca0a57 | 155 | * @var bool |
e501603b TO |
156 | */ |
157 | public $is_hidden; | |
c3fc2621 | 158 | |
e501603b | 159 | /** |
e6ca0a57 | 160 | * @var bool |
e501603b TO |
161 | */ |
162 | public $is_reserved; | |
c3fc2621 | 163 | |
e501603b TO |
164 | /** |
165 | * FK to contact table. | |
166 | * | |
e6ca0a57 | 167 | * @var int |
e501603b TO |
168 | */ |
169 | public $created_id; | |
c3fc2621 | 170 | |
e501603b TO |
171 | /** |
172 | * FK to contact table. | |
173 | * | |
e6ca0a57 | 174 | * @var int |
e501603b TO |
175 | */ |
176 | public $modified_id; | |
c3fc2621 | 177 | |
e501603b | 178 | /** |
f41f0342 | 179 | * Class constructor. |
e501603b | 180 | */ |
c3fc2621 | 181 | public function __construct() { |
e501603b TO |
182 | $this->__table = 'civicrm_group'; |
183 | parent::__construct(); | |
184 | } | |
c3fc2621 | 185 | |
449c4e6b CW |
186 | /** |
187 | * Returns localized title of this entity. | |
7b66c3b5 AH |
188 | * |
189 | * @param bool $plural | |
190 | * Whether to return the plural version of the title. | |
449c4e6b | 191 | */ |
7b66c3b5 AH |
192 | public static function getEntityTitle($plural = FALSE) { |
193 | return $plural ? ts('Groups') : ts('Group'); | |
449c4e6b CW |
194 | } |
195 | ||
e501603b | 196 | /** |
f41f0342 | 197 | * Returns foreign keys and entity references. |
e501603b TO |
198 | * |
199 | * @return array | |
200 | * [CRM_Core_Reference_Interface] | |
201 | */ | |
c3fc2621 | 202 | public static function getReferenceColumns() { |
346aaaba | 203 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 204 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 CW |
205 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'saved_search_id', 'civicrm_saved_search', 'id'); |
206 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'created_id', 'civicrm_contact', 'id'); | |
207 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'modified_id', 'civicrm_contact', 'id'); | |
346aaaba | 208 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 209 | } |
346aaaba | 210 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 211 | } |
c3fc2621 | 212 | |
e501603b TO |
213 | /** |
214 | * Returns all the column names of this table | |
215 | * | |
216 | * @return array | |
217 | */ | |
c3fc2621 | 218 | public static function &fields() { |
346aaaba | 219 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
220 | Civi::$statics[__CLASS__]['fields'] = [ |
221 | 'id' => [ | |
e501603b TO |
222 | 'name' => 'id', |
223 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 224 | 'title' => ts('Group ID'), |
215b423e | 225 | 'description' => ts('Group ID'), |
c3fc2621 | 226 | 'required' => TRUE, |
a36434b9 | 227 | 'where' => 'civicrm_group.id', |
522a26c9 | 228 | 'table_name' => 'civicrm_group', |
229 | 'entity' => 'Group', | |
230 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 231 | 'localizable' => 0, |
a9d0587b | 232 | 'add' => '1.1', |
c3fc2621 CW |
233 | ], |
234 | 'name' => [ | |
e501603b TO |
235 | 'name' => 'name', |
236 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 237 | 'title' => ts('Group Name'), |
215b423e | 238 | 'description' => ts('Internal name of Group.'), |
e501603b TO |
239 | 'maxlength' => 64, |
240 | 'size' => CRM_Utils_Type::BIG, | |
a36434b9 | 241 | 'where' => 'civicrm_group.name', |
522a26c9 | 242 | 'table_name' => 'civicrm_group', |
243 | 'entity' => 'Group', | |
244 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 245 | 'localizable' => 0, |
a9d0587b | 246 | 'add' => '1.1', |
c3fc2621 CW |
247 | ], |
248 | 'title' => [ | |
e501603b TO |
249 | 'name' => 'title', |
250 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 251 | 'title' => ts('Group Title'), |
215b423e | 252 | 'description' => ts('Name of Group.'), |
e501603b TO |
253 | 'maxlength' => 64, |
254 | 'size' => CRM_Utils_Type::BIG, | |
a36434b9 | 255 | 'where' => 'civicrm_group.title', |
522a26c9 | 256 | 'table_name' => 'civicrm_group', |
257 | 'entity' => 'Group', | |
258 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 259 | 'localizable' => 1, |
7da21f11 | 260 | 'html' => [ |
261 | 'type' => 'Text', | |
262 | ], | |
a9d0587b | 263 | 'add' => '1.1', |
c3fc2621 CW |
264 | ], |
265 | 'description' => [ | |
e501603b TO |
266 | 'name' => 'description', |
267 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 268 | 'title' => ts('Group Description'), |
215b423e | 269 | 'description' => ts('Optional verbose description of the group.'), |
e501603b TO |
270 | 'rows' => 2, |
271 | 'cols' => 60, | |
a36434b9 | 272 | 'where' => 'civicrm_group.description', |
522a26c9 | 273 | 'table_name' => 'civicrm_group', |
274 | 'entity' => 'Group', | |
275 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 276 | 'localizable' => 0, |
c3fc2621 | 277 | 'html' => [ |
e501603b | 278 | 'type' => 'TextArea', |
c3fc2621 | 279 | ], |
a9d0587b | 280 | 'add' => '1.1', |
c3fc2621 CW |
281 | ], |
282 | 'source' => [ | |
e501603b TO |
283 | 'name' => 'source', |
284 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 285 | 'title' => ts('Group Source'), |
215b423e | 286 | 'description' => ts('Module or process which created this group.'), |
e501603b TO |
287 | 'maxlength' => 64, |
288 | 'size' => CRM_Utils_Type::BIG, | |
a36434b9 | 289 | 'where' => 'civicrm_group.source', |
522a26c9 | 290 | 'table_name' => 'civicrm_group', |
291 | 'entity' => 'Group', | |
292 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 293 | 'localizable' => 0, |
a9d0587b | 294 | 'add' => '1.1', |
c3fc2621 CW |
295 | ], |
296 | 'saved_search_id' => [ | |
e501603b TO |
297 | 'name' => 'saved_search_id', |
298 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 299 | 'title' => ts('Saved Search ID'), |
215b423e | 300 | 'description' => ts('FK to saved search table.'), |
a36434b9 | 301 | 'where' => 'civicrm_group.saved_search_id', |
522a26c9 | 302 | 'table_name' => 'civicrm_group', |
303 | 'entity' => 'Group', | |
304 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 305 | 'localizable' => 0, |
e501603b | 306 | 'FKClassName' => 'CRM_Contact_DAO_SavedSearch', |
a9d0587b | 307 | 'add' => '1.1', |
c3fc2621 CW |
308 | ], |
309 | 'is_active' => [ | |
e501603b TO |
310 | 'name' => 'is_active', |
311 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 312 | 'title' => ts('Group Enabled'), |
215b423e | 313 | 'description' => ts('Is this entry active?'), |
a36434b9 | 314 | 'where' => 'civicrm_group.is_active', |
522a26c9 | 315 | 'table_name' => 'civicrm_group', |
316 | 'entity' => 'Group', | |
317 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 318 | 'localizable' => 0, |
a9d0587b | 319 | 'add' => '1.1', |
c3fc2621 CW |
320 | ], |
321 | 'visibility' => [ | |
e501603b TO |
322 | 'name' => 'visibility', |
323 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 324 | 'title' => ts('Group Visibility Setting'), |
215b423e | 325 | 'description' => ts('In what context(s) is this field visible.'), |
e501603b TO |
326 | 'maxlength' => 24, |
327 | 'size' => CRM_Utils_Type::MEDIUM, | |
a36434b9 | 328 | 'where' => 'civicrm_group.visibility', |
e501603b | 329 | 'default' => 'User and User Admin Only', |
522a26c9 | 330 | 'table_name' => 'civicrm_group', |
331 | 'entity' => 'Group', | |
332 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 333 | 'localizable' => 0, |
c3fc2621 | 334 | 'html' => [ |
e501603b | 335 | 'type' => 'Select', |
c3fc2621 CW |
336 | ], |
337 | 'pseudoconstant' => [ | |
e501603b | 338 | 'callback' => 'CRM_Core_SelectValues::groupVisibility', |
e6ca0a57 | 339 | ], |
a9d0587b | 340 | 'add' => '1.2', |
c3fc2621 CW |
341 | ], |
342 | 'where_clause' => [ | |
e501603b TO |
343 | 'name' => 'where_clause', |
344 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 345 | 'title' => ts('Group Where Clause'), |
215b423e | 346 | 'description' => ts('the sql where clause if a saved search acl'), |
a36434b9 | 347 | 'where' => 'civicrm_group.where_clause', |
522a26c9 | 348 | 'table_name' => 'civicrm_group', |
349 | 'entity' => 'Group', | |
350 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 351 | 'localizable' => 0, |
a9d0587b | 352 | 'add' => '1.6', |
c3fc2621 CW |
353 | ], |
354 | 'select_tables' => [ | |
e501603b TO |
355 | 'name' => 'select_tables', |
356 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 357 | 'title' => ts('Tables For Select Clause'), |
215b423e | 358 | 'description' => ts('the tables to be included in a select data'), |
a36434b9 | 359 | 'where' => 'civicrm_group.select_tables', |
522a26c9 | 360 | 'table_name' => 'civicrm_group', |
361 | 'entity' => 'Group', | |
362 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 363 | 'localizable' => 0, |
2a5c9b4d | 364 | 'serialize' => self::SERIALIZE_PHP, |
a9d0587b | 365 | 'add' => '1.6', |
c3fc2621 CW |
366 | ], |
367 | 'where_tables' => [ | |
e501603b TO |
368 | 'name' => 'where_tables', |
369 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 370 | 'title' => ts('Tables For Where Clause'), |
215b423e | 371 | 'description' => ts('the tables to be included in the count statement'), |
a36434b9 | 372 | 'where' => 'civicrm_group.where_tables', |
522a26c9 | 373 | 'table_name' => 'civicrm_group', |
374 | 'entity' => 'Group', | |
375 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 376 | 'localizable' => 0, |
2a5c9b4d | 377 | 'serialize' => self::SERIALIZE_PHP, |
a9d0587b | 378 | 'add' => '1.6', |
c3fc2621 CW |
379 | ], |
380 | 'group_type' => [ | |
e501603b TO |
381 | 'name' => 'group_type', |
382 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 383 | 'title' => ts('Group Type'), |
215b423e | 384 | 'description' => ts('FK to group type'), |
e501603b TO |
385 | 'maxlength' => 128, |
386 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 387 | 'where' => 'civicrm_group.group_type', |
522a26c9 | 388 | 'table_name' => 'civicrm_group', |
389 | 'entity' => 'Group', | |
390 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 391 | 'localizable' => 0, |
2a5c9b4d | 392 | 'serialize' => self::SERIALIZE_SEPARATOR_BOOKEND, |
c3fc2621 | 393 | 'pseudoconstant' => [ |
e501603b TO |
394 | 'optionGroupName' => 'group_type', |
395 | 'optionEditPath' => 'civicrm/admin/options/group_type', | |
e6ca0a57 | 396 | ], |
a9d0587b | 397 | 'add' => '1.9', |
c3fc2621 CW |
398 | ], |
399 | 'cache_date' => [ | |
e501603b TO |
400 | 'name' => 'cache_date', |
401 | 'type' => CRM_Utils_Type::T_TIMESTAMP, | |
c3fc2621 | 402 | 'title' => ts('Group Cache Date'), |
215b423e | 403 | 'description' => ts('Date when we created the cache for a smart group'), |
c3fc2621 | 404 | 'required' => FALSE, |
a36434b9 | 405 | 'where' => 'civicrm_group.cache_date', |
522a26c9 | 406 | 'table_name' => 'civicrm_group', |
407 | 'entity' => 'Group', | |
408 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 409 | 'localizable' => 0, |
a9d0587b | 410 | 'add' => '2.1', |
c3fc2621 CW |
411 | ], |
412 | 'refresh_date' => [ | |
e501603b TO |
413 | 'name' => 'refresh_date', |
414 | 'type' => CRM_Utils_Type::T_TIMESTAMP, | |
c3fc2621 | 415 | 'title' => ts('Next Group Refresh Time'), |
215b423e | 416 | 'description' => ts('Date and time when we need to refresh the cache next.'), |
c3fc2621 | 417 | 'required' => FALSE, |
a36434b9 | 418 | 'where' => 'civicrm_group.refresh_date', |
522a26c9 | 419 | 'table_name' => 'civicrm_group', |
420 | 'entity' => 'Group', | |
421 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 422 | 'localizable' => 0, |
a9d0587b | 423 | 'add' => '4.3', |
c3fc2621 CW |
424 | ], |
425 | 'parents' => [ | |
e501603b TO |
426 | 'name' => 'parents', |
427 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 428 | 'title' => ts('Group Parents'), |
215b423e | 429 | 'description' => ts('IDs of the parent(s)'), |
a36434b9 | 430 | 'where' => 'civicrm_group.parents', |
522a26c9 | 431 | 'table_name' => 'civicrm_group', |
432 | 'entity' => 'Group', | |
433 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 434 | 'localizable' => 0, |
30208fab | 435 | 'serialize' => self::SERIALIZE_COMMA, |
1678a63b | 436 | 'pseudoconstant' => [ |
437 | 'callback' => 'CRM_Core_PseudoConstant::allGroup', | |
e6ca0a57 | 438 | ], |
a9d0587b | 439 | 'add' => '2.1', |
c3fc2621 CW |
440 | ], |
441 | 'children' => [ | |
e501603b TO |
442 | 'name' => 'children', |
443 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 444 | 'title' => ts('Group Children'), |
215b423e | 445 | 'description' => ts('IDs of the child(ren)'), |
a36434b9 | 446 | 'where' => 'civicrm_group.children', |
522a26c9 | 447 | 'table_name' => 'civicrm_group', |
448 | 'entity' => 'Group', | |
449 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 450 | 'localizable' => 0, |
a9d0587b | 451 | 'add' => '2.1', |
c3fc2621 CW |
452 | ], |
453 | 'is_hidden' => [ | |
e501603b TO |
454 | 'name' => 'is_hidden', |
455 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 456 | 'title' => ts('Group is Hidden'), |
215b423e | 457 | 'description' => ts('Is this group hidden?'), |
a36434b9 | 458 | 'where' => 'civicrm_group.is_hidden', |
45a83e42 | 459 | 'default' => '0', |
522a26c9 | 460 | 'table_name' => 'civicrm_group', |
461 | 'entity' => 'Group', | |
462 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 463 | 'localizable' => 0, |
a9d0587b | 464 | 'add' => '2.2', |
c3fc2621 CW |
465 | ], |
466 | 'is_reserved' => [ | |
e501603b TO |
467 | 'name' => 'is_reserved', |
468 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 469 | 'title' => ts('Group is Reserved'), |
a36434b9 | 470 | 'where' => 'civicrm_group.is_reserved', |
45a83e42 | 471 | 'default' => '0', |
522a26c9 | 472 | 'table_name' => 'civicrm_group', |
473 | 'entity' => 'Group', | |
474 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 475 | 'localizable' => 0, |
a9d0587b | 476 | 'add' => '4.2', |
c3fc2621 CW |
477 | ], |
478 | 'created_id' => [ | |
e501603b TO |
479 | 'name' => 'created_id', |
480 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 481 | 'title' => ts('Group Created By'), |
215b423e | 482 | 'description' => ts('FK to contact table.'), |
a36434b9 | 483 | 'where' => 'civicrm_group.created_id', |
522a26c9 | 484 | 'table_name' => 'civicrm_group', |
485 | 'entity' => 'Group', | |
486 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 487 | 'localizable' => 0, |
e501603b | 488 | 'FKClassName' => 'CRM_Contact_DAO_Contact', |
a9d0587b | 489 | 'add' => '4.3', |
c3fc2621 CW |
490 | ], |
491 | 'modified_id' => [ | |
e501603b TO |
492 | 'name' => 'modified_id', |
493 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 494 | 'title' => ts('Group Modified By'), |
215b423e | 495 | 'description' => ts('FK to contact table.'), |
a36434b9 | 496 | 'where' => 'civicrm_group.modified_id', |
522a26c9 | 497 | 'table_name' => 'civicrm_group', |
498 | 'entity' => 'Group', | |
499 | 'bao' => 'CRM_Contact_BAO_Group', | |
6a7e5e5d | 500 | 'localizable' => 0, |
e501603b | 501 | 'FKClassName' => 'CRM_Contact_DAO_Contact', |
a9d0587b | 502 | 'add' => '4.5', |
c3fc2621 CW |
503 | ], |
504 | ]; | |
346aaaba | 505 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 506 | } |
346aaaba | 507 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 508 | } |
c3fc2621 | 509 | |
e501603b | 510 | /** |
bd8e0b14 | 511 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
512 | * |
513 | * @return array | |
bd8e0b14 | 514 | * Array(string $name => string $uniqueName). |
e501603b | 515 | */ |
c3fc2621 | 516 | public static function &fieldKeys() { |
bd8e0b14 TO |
517 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
518 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 519 | } |
bd8e0b14 | 520 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 521 | } |
c3fc2621 | 522 | |
e501603b TO |
523 | /** |
524 | * Returns the names of this table | |
525 | * | |
526 | * @return string | |
527 | */ | |
c3fc2621 | 528 | public static function getTableName() { |
e501603b TO |
529 | return CRM_Core_DAO::getLocaleTableName(self::$_tableName); |
530 | } | |
c3fc2621 | 531 | |
e501603b TO |
532 | /** |
533 | * Returns if this table needs to be logged | |
534 | * | |
c3fc2621 | 535 | * @return bool |
e501603b | 536 | */ |
c3fc2621 | 537 | public function getLog() { |
e501603b TO |
538 | return self::$_log; |
539 | } | |
c3fc2621 | 540 | |
e501603b TO |
541 | /** |
542 | * Returns the list of fields that can be imported | |
543 | * | |
544 | * @param bool $prefix | |
545 | * | |
546 | * @return array | |
547 | */ | |
c3fc2621 CW |
548 | public static function &import($prefix = FALSE) { |
549 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'group', $prefix, []); | |
60808919 | 550 | return $r; |
e501603b | 551 | } |
c3fc2621 | 552 | |
e501603b TO |
553 | /** |
554 | * Returns the list of fields that can be exported | |
555 | * | |
556 | * @param bool $prefix | |
557 | * | |
558 | * @return array | |
559 | */ | |
c3fc2621 CW |
560 | public static function &export($prefix = FALSE) { |
561 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'group', $prefix, []); | |
60808919 | 562 | return $r; |
e501603b | 563 | } |
c3fc2621 | 564 | |
e7a6b91a AS |
565 | /** |
566 | * Returns the list of indices | |
c3fc2621 CW |
567 | * |
568 | * @param bool $localize | |
569 | * | |
570 | * @return array | |
e7a6b91a AS |
571 | */ |
572 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
573 | $indices = [ |
574 | 'index_group_type' => [ | |
e7a6b91a | 575 | 'name' => 'index_group_type', |
c3fc2621 | 576 | 'field' => [ |
e7a6b91a | 577 | 0 => 'group_type', |
c3fc2621 CW |
578 | ], |
579 | 'localizable' => FALSE, | |
e7a6b91a | 580 | 'sig' => 'civicrm_group::0::group_type', |
c3fc2621 CW |
581 | ], |
582 | 'UI_title' => [ | |
e7a6b91a | 583 | 'name' => 'UI_title', |
c3fc2621 | 584 | 'field' => [ |
e7a6b91a | 585 | 0 => 'title', |
c3fc2621 CW |
586 | ], |
587 | 'localizable' => TRUE, | |
588 | 'unique' => TRUE, | |
e7a6b91a | 589 | 'sig' => 'civicrm_group::1::title', |
c3fc2621 CW |
590 | ], |
591 | 'UI_name' => [ | |
e7a6b91a | 592 | 'name' => 'UI_name', |
c3fc2621 | 593 | 'field' => [ |
e7a6b91a | 594 | 0 => 'name', |
c3fc2621 CW |
595 | ], |
596 | 'localizable' => FALSE, | |
597 | 'unique' => TRUE, | |
e7a6b91a | 598 | 'sig' => 'civicrm_group::1::name', |
c3fc2621 CW |
599 | ], |
600 | ]; | |
e7a6b91a AS |
601 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
602 | } | |
c3fc2621 | 603 | |
e501603b | 604 | } |