Merge pull request #22631 from braders/calculateBaseScheduleDate-docblock
[civicrm-core.git] / CRM / Core / DAO / CustomGroup.php
1 <?php
2
3 /**
4 * @package CRM
5 * @copyright CiviCRM LLC https://civicrm.org/licensing
6 *
7 * Generated from xml/schema/CRM/Core/CustomGroup.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:0c41f19103b41d2f82bcd3b60aaf2165)
10 */
11
12 /**
13 * Database access object for the CustomGroup entity.
14 */
15 class CRM_Core_DAO_CustomGroup extends CRM_Core_DAO {
16 const EXT = 'civicrm';
17 const TABLE_ADDED = '1.1';
18
19 /**
20 * Static instance to hold the table name.
21 *
22 * @var string
23 */
24 public static $_tableName = 'civicrm_custom_group';
25
26 /**
27 * Field to show when displaying a record.
28 *
29 * @var string
30 */
31 public static $_labelField = 'title';
32
33 /**
34 * Should CiviCRM log any modifications to this table in the civicrm_log table.
35 *
36 * @var bool
37 */
38 public static $_log = TRUE;
39
40 /**
41 * Paths for accessing this entity in the UI.
42 *
43 * @var string[]
44 */
45 protected static $_paths = [
46 'add' => 'civicrm/admin/custom/group/edit?action=add&reset=1',
47 'update' => 'civicrm/admin/custom/group/edit?action=update&reset=1&id=[id]',
48 'preview' => 'civicrm/admin/custom/group/preview?reset=1&gid=[id]',
49 'delete' => 'civicrm/admin/custom/group/delete?reset=1&id=[id]',
50 ];
51
52 /**
53 * Unique Custom Group ID
54 *
55 * @var int|string|null
56 * (SQL type: int unsigned)
57 * Note that values will be retrieved from the database as a string.
58 */
59 public $id;
60
61 /**
62 * Variable name/programmatic handle for this group.
63 *
64 * @var string|null
65 * (SQL type: varchar(64))
66 * Note that values will be retrieved from the database as a string.
67 */
68 public $name;
69
70 /**
71 * Friendly Name.
72 *
73 * @var string
74 * (SQL type: varchar(64))
75 * Note that values will be retrieved from the database as a string.
76 */
77 public $title;
78
79 /**
80 * Type of object this group extends (can add other options later e.g. contact_address, etc.).
81 *
82 * @var string|null
83 * (SQL type: varchar(255))
84 * Note that values will be retrieved from the database as a string.
85 */
86 public $extends;
87
88 /**
89 * FK to civicrm_option_value.id (for option group custom_data_type.)
90 *
91 * @var int|string|null
92 * (SQL type: int unsigned)
93 * Note that values will be retrieved from the database as a string.
94 */
95 public $extends_entity_column_id;
96
97 /**
98 * linking custom group for dynamic object
99 *
100 * @var string|null
101 * (SQL type: varchar(255))
102 * Note that values will be retrieved from the database as a string.
103 */
104 public $extends_entity_column_value;
105
106 /**
107 * Visual relationship between this form and its parent.
108 *
109 * @var string|null
110 * (SQL type: varchar(15))
111 * Note that values will be retrieved from the database as a string.
112 */
113 public $style;
114
115 /**
116 * Will this group be in collapsed or expanded mode on initial display ?
117 *
118 * @var bool|string|null
119 * (SQL type: tinyint)
120 * Note that values will be retrieved from the database as a string.
121 */
122 public $collapse_display;
123
124 /**
125 * Description and/or help text to display before fields in form.
126 *
127 * @var string|null
128 * (SQL type: text)
129 * Note that values will be retrieved from the database as a string.
130 */
131 public $help_pre;
132
133 /**
134 * Description and/or help text to display after fields in form.
135 *
136 * @var string|null
137 * (SQL type: text)
138 * Note that values will be retrieved from the database as a string.
139 */
140 public $help_post;
141
142 /**
143 * Controls display order when multiple extended property groups are setup for the same class.
144 *
145 * @var int|string
146 * (SQL type: int)
147 * Note that values will be retrieved from the database as a string.
148 */
149 public $weight;
150
151 /**
152 * Is this property active?
153 *
154 * @var bool|string|null
155 * (SQL type: tinyint)
156 * Note that values will be retrieved from the database as a string.
157 */
158 public $is_active;
159
160 /**
161 * Name of the table that holds the values for this group.
162 *
163 * @var string|null
164 * (SQL type: varchar(255))
165 * Note that values will be retrieved from the database as a string.
166 */
167 public $table_name;
168
169 /**
170 * Does this group hold multiple values?
171 *
172 * @var bool|string|null
173 * (SQL type: tinyint)
174 * Note that values will be retrieved from the database as a string.
175 */
176 public $is_multiple;
177
178 /**
179 * minimum number of multiple records (typically 0?)
180 *
181 * @var int|string|null
182 * (SQL type: int unsigned)
183 * Note that values will be retrieved from the database as a string.
184 */
185 public $min_multiple;
186
187 /**
188 * maximum number of multiple records, if 0 - no max
189 *
190 * @var int|string|null
191 * (SQL type: int unsigned)
192 * Note that values will be retrieved from the database as a string.
193 */
194 public $max_multiple;
195
196 /**
197 * Will this group be in collapsed or expanded mode on advanced search display ?
198 *
199 * @var bool|string|null
200 * (SQL type: tinyint)
201 * Note that values will be retrieved from the database as a string.
202 */
203 public $collapse_adv_display;
204
205 /**
206 * FK to civicrm_contact, who created this custom group
207 *
208 * @var int|string|null
209 * (SQL type: int unsigned)
210 * Note that values will be retrieved from the database as a string.
211 */
212 public $created_id;
213
214 /**
215 * Date and time this custom group was created.
216 *
217 * @var string|null
218 * (SQL type: datetime)
219 * Note that values will be retrieved from the database as a string.
220 */
221 public $created_date;
222
223 /**
224 * Is this a reserved Custom Group?
225 *
226 * @var bool|string|null
227 * (SQL type: tinyint)
228 * Note that values will be retrieved from the database as a string.
229 */
230 public $is_reserved;
231
232 /**
233 * Is this property public?
234 *
235 * @var bool|string|null
236 * (SQL type: tinyint)
237 * Note that values will be retrieved from the database as a string.
238 */
239 public $is_public;
240
241 /**
242 * crm-i icon class
243 *
244 * @var string|null
245 * (SQL type: varchar(255))
246 * Note that values will be retrieved from the database as a string.
247 */
248 public $icon;
249
250 /**
251 * Class constructor.
252 */
253 public function __construct() {
254 $this->__table = 'civicrm_custom_group';
255 parent::__construct();
256 }
257
258 /**
259 * Returns localized title of this entity.
260 *
261 * @param bool $plural
262 * Whether to return the plural version of the title.
263 */
264 public static function getEntityTitle($plural = FALSE) {
265 return $plural ? ts('Custom Field Groups') : ts('Custom Field Group');
266 }
267
268 /**
269 * Returns foreign keys and entity references.
270 *
271 * @return array
272 * [CRM_Core_Reference_Interface]
273 */
274 public static function getReferenceColumns() {
275 if (!isset(Civi::$statics[__CLASS__]['links'])) {
276 Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
277 Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'created_id', 'civicrm_contact', 'id');
278 CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
279 }
280 return Civi::$statics[__CLASS__]['links'];
281 }
282
283 /**
284 * Returns all the column names of this table
285 *
286 * @return array
287 */
288 public static function &fields() {
289 if (!isset(Civi::$statics[__CLASS__]['fields'])) {
290 Civi::$statics[__CLASS__]['fields'] = [
291 'id' => [
292 'name' => 'id',
293 'type' => CRM_Utils_Type::T_INT,
294 'title' => ts('Custom Group ID'),
295 'description' => ts('Unique Custom Group ID'),
296 'required' => TRUE,
297 'where' => 'civicrm_custom_group.id',
298 'table_name' => 'civicrm_custom_group',
299 'entity' => 'CustomGroup',
300 'bao' => 'CRM_Core_BAO_CustomGroup',
301 'localizable' => 0,
302 'html' => [
303 'type' => 'Number',
304 ],
305 'readonly' => TRUE,
306 'add' => '1.1',
307 ],
308 'name' => [
309 'name' => 'name',
310 'type' => CRM_Utils_Type::T_STRING,
311 'title' => ts('Custom Group Name'),
312 'description' => ts('Variable name/programmatic handle for this group.'),
313 'maxlength' => 64,
314 'size' => CRM_Utils_Type::BIG,
315 'where' => 'civicrm_custom_group.name',
316 'table_name' => 'civicrm_custom_group',
317 'entity' => 'CustomGroup',
318 'bao' => 'CRM_Core_BAO_CustomGroup',
319 'localizable' => 0,
320 'add' => '1.1',
321 ],
322 'title' => [
323 'name' => 'title',
324 'type' => CRM_Utils_Type::T_STRING,
325 'title' => ts('Custom Group Title'),
326 'description' => ts('Friendly Name.'),
327 'required' => TRUE,
328 'maxlength' => 64,
329 'size' => CRM_Utils_Type::BIG,
330 'where' => 'civicrm_custom_group.title',
331 'table_name' => 'civicrm_custom_group',
332 'entity' => 'CustomGroup',
333 'bao' => 'CRM_Core_BAO_CustomGroup',
334 'localizable' => 1,
335 'add' => '1.1',
336 ],
337 'extends' => [
338 'name' => 'extends',
339 'type' => CRM_Utils_Type::T_STRING,
340 'title' => ts('Custom Group Extends'),
341 'description' => ts('Type of object this group extends (can add other options later e.g. contact_address, etc.).'),
342 'maxlength' => 255,
343 'size' => CRM_Utils_Type::HUGE,
344 'where' => 'civicrm_custom_group.extends',
345 'default' => 'Contact',
346 'table_name' => 'civicrm_custom_group',
347 'entity' => 'CustomGroup',
348 'bao' => 'CRM_Core_BAO_CustomGroup',
349 'localizable' => 0,
350 'pseudoconstant' => [
351 'callback' => 'CRM_Core_SelectValues::customGroupExtends',
352 ],
353 'add' => '1.1',
354 ],
355 'extends_entity_column_id' => [
356 'name' => 'extends_entity_column_id',
357 'type' => CRM_Utils_Type::T_INT,
358 'title' => ts('Custom Group Subtype List'),
359 'description' => ts('FK to civicrm_option_value.id (for option group custom_data_type.)'),
360 'where' => 'civicrm_custom_group.extends_entity_column_id',
361 'default' => NULL,
362 'table_name' => 'civicrm_custom_group',
363 'entity' => 'CustomGroup',
364 'bao' => 'CRM_Core_BAO_CustomGroup',
365 'localizable' => 0,
366 'html' => [
367 'type' => 'Select',
368 ],
369 'pseudoconstant' => [
370 'optionGroupName' => 'custom_data_type',
371 'optionEditPath' => 'civicrm/admin/options/custom_data_type',
372 ],
373 'add' => '2.2',
374 ],
375 'extends_entity_column_value' => [
376 'name' => 'extends_entity_column_value',
377 'type' => CRM_Utils_Type::T_STRING,
378 'title' => ts('Custom Group Subtype'),
379 'description' => ts('linking custom group for dynamic object'),
380 'maxlength' => 255,
381 'size' => CRM_Utils_Type::HUGE,
382 'where' => 'civicrm_custom_group.extends_entity_column_value',
383 'table_name' => 'civicrm_custom_group',
384 'entity' => 'CustomGroup',
385 'bao' => 'CRM_Core_BAO_CustomGroup',
386 'localizable' => 0,
387 'serialize' => self::SERIALIZE_SEPARATOR_BOOKEND,
388 'add' => '1.6',
389 ],
390 'style' => [
391 'name' => 'style',
392 'type' => CRM_Utils_Type::T_STRING,
393 'title' => ts('Custom Group Style'),
394 'description' => ts('Visual relationship between this form and its parent.'),
395 'maxlength' => 15,
396 'size' => CRM_Utils_Type::TWELVE,
397 'where' => 'civicrm_custom_group.style',
398 'table_name' => 'civicrm_custom_group',
399 'entity' => 'CustomGroup',
400 'bao' => 'CRM_Core_BAO_CustomGroup',
401 'localizable' => 0,
402 'html' => [
403 'type' => 'Select',
404 ],
405 'pseudoconstant' => [
406 'callback' => 'CRM_Core_SelectValues::customGroupStyle',
407 ],
408 'add' => '1.1',
409 ],
410 'collapse_display' => [
411 'name' => 'collapse_display',
412 'type' => CRM_Utils_Type::T_BOOLEAN,
413 'title' => ts('Collapse Custom Group?'),
414 'description' => ts('Will this group be in collapsed or expanded mode on initial display ?'),
415 'where' => 'civicrm_custom_group.collapse_display',
416 'default' => '0',
417 'table_name' => 'civicrm_custom_group',
418 'entity' => 'CustomGroup',
419 'bao' => 'CRM_Core_BAO_CustomGroup',
420 'localizable' => 0,
421 'add' => '1.1',
422 ],
423 'help_pre' => [
424 'name' => 'help_pre',
425 'type' => CRM_Utils_Type::T_TEXT,
426 'title' => ts('Custom Group Pre Text'),
427 'description' => ts('Description and/or help text to display before fields in form.'),
428 'rows' => 4,
429 'cols' => 80,
430 'where' => 'civicrm_custom_group.help_pre',
431 'table_name' => 'civicrm_custom_group',
432 'entity' => 'CustomGroup',
433 'bao' => 'CRM_Core_BAO_CustomGroup',
434 'localizable' => 1,
435 'html' => [
436 'type' => 'TextArea',
437 ],
438 'add' => '1.1',
439 ],
440 'help_post' => [
441 'name' => 'help_post',
442 'type' => CRM_Utils_Type::T_TEXT,
443 'title' => ts('Custom Group Post Text'),
444 'description' => ts('Description and/or help text to display after fields in form.'),
445 'rows' => 4,
446 'cols' => 80,
447 'where' => 'civicrm_custom_group.help_post',
448 'table_name' => 'civicrm_custom_group',
449 'entity' => 'CustomGroup',
450 'bao' => 'CRM_Core_BAO_CustomGroup',
451 'localizable' => 1,
452 'html' => [
453 'type' => 'TextArea',
454 ],
455 'add' => '1.1',
456 ],
457 'weight' => [
458 'name' => 'weight',
459 'type' => CRM_Utils_Type::T_INT,
460 'title' => ts('Order'),
461 'description' => ts('Controls display order when multiple extended property groups are setup for the same class.'),
462 'required' => TRUE,
463 'where' => 'civicrm_custom_group.weight',
464 'default' => '1',
465 'table_name' => 'civicrm_custom_group',
466 'entity' => 'CustomGroup',
467 'bao' => 'CRM_Core_BAO_CustomGroup',
468 'localizable' => 0,
469 'add' => '1.1',
470 ],
471 'is_active' => [
472 'name' => 'is_active',
473 'type' => CRM_Utils_Type::T_BOOLEAN,
474 'title' => ts('Custom Group Is Active?'),
475 'description' => ts('Is this property active?'),
476 'where' => 'civicrm_custom_group.is_active',
477 'default' => '1',
478 'table_name' => 'civicrm_custom_group',
479 'entity' => 'CustomGroup',
480 'bao' => 'CRM_Core_BAO_CustomGroup',
481 'localizable' => 0,
482 'add' => '1.1',
483 ],
484 'table_name' => [
485 'name' => 'table_name',
486 'type' => CRM_Utils_Type::T_STRING,
487 'title' => ts('Table Name'),
488 'description' => ts('Name of the table that holds the values for this group.'),
489 'maxlength' => 255,
490 'size' => CRM_Utils_Type::HUGE,
491 'where' => 'civicrm_custom_group.table_name',
492 'table_name' => 'civicrm_custom_group',
493 'entity' => 'CustomGroup',
494 'bao' => 'CRM_Core_BAO_CustomGroup',
495 'localizable' => 0,
496 'html' => [
497 'label' => ts("Table Name"),
498 ],
499 'readonly' => TRUE,
500 'add' => '2.0',
501 ],
502 'is_multiple' => [
503 'name' => 'is_multiple',
504 'type' => CRM_Utils_Type::T_BOOLEAN,
505 'title' => ts('Supports Multiple Records'),
506 'description' => ts('Does this group hold multiple values?'),
507 'where' => 'civicrm_custom_group.is_multiple',
508 'default' => '0',
509 'table_name' => 'civicrm_custom_group',
510 'entity' => 'CustomGroup',
511 'bao' => 'CRM_Core_BAO_CustomGroup',
512 'localizable' => 0,
513 'add' => '2.0',
514 ],
515 'min_multiple' => [
516 'name' => 'min_multiple',
517 'type' => CRM_Utils_Type::T_INT,
518 'title' => ts('Minimum Multiple Records'),
519 'description' => ts('minimum number of multiple records (typically 0?)'),
520 'where' => 'civicrm_custom_group.min_multiple',
521 'table_name' => 'civicrm_custom_group',
522 'entity' => 'CustomGroup',
523 'bao' => 'CRM_Core_BAO_CustomGroup',
524 'localizable' => 0,
525 'add' => '2.2',
526 ],
527 'max_multiple' => [
528 'name' => 'max_multiple',
529 'type' => CRM_Utils_Type::T_INT,
530 'title' => ts('Maximum Multiple Records'),
531 'description' => ts('maximum number of multiple records, if 0 - no max'),
532 'where' => 'civicrm_custom_group.max_multiple',
533 'table_name' => 'civicrm_custom_group',
534 'entity' => 'CustomGroup',
535 'bao' => 'CRM_Core_BAO_CustomGroup',
536 'localizable' => 0,
537 'add' => '2.2',
538 ],
539 'collapse_adv_display' => [
540 'name' => 'collapse_adv_display',
541 'type' => CRM_Utils_Type::T_BOOLEAN,
542 'title' => ts('Collapse Group Display'),
543 'description' => ts('Will this group be in collapsed or expanded mode on advanced search display ?'),
544 'where' => 'civicrm_custom_group.collapse_adv_display',
545 'default' => '0',
546 'table_name' => 'civicrm_custom_group',
547 'entity' => 'CustomGroup',
548 'bao' => 'CRM_Core_BAO_CustomGroup',
549 'localizable' => 0,
550 'add' => '3.0',
551 ],
552 'created_id' => [
553 'name' => 'created_id',
554 'type' => CRM_Utils_Type::T_INT,
555 'title' => ts('Created By Contact ID'),
556 'description' => ts('FK to civicrm_contact, who created this custom group'),
557 'where' => 'civicrm_custom_group.created_id',
558 'table_name' => 'civicrm_custom_group',
559 'entity' => 'CustomGroup',
560 'bao' => 'CRM_Core_BAO_CustomGroup',
561 'localizable' => 0,
562 'FKClassName' => 'CRM_Contact_DAO_Contact',
563 'html' => [
564 'label' => ts("Created By"),
565 ],
566 'add' => '3.0',
567 ],
568 'created_date' => [
569 'name' => 'created_date',
570 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
571 'title' => ts('Custom Group Created Date'),
572 'description' => ts('Date and time this custom group was created.'),
573 'where' => 'civicrm_custom_group.created_date',
574 'table_name' => 'civicrm_custom_group',
575 'entity' => 'CustomGroup',
576 'bao' => 'CRM_Core_BAO_CustomGroup',
577 'localizable' => 0,
578 'add' => '3.0',
579 ],
580 'is_reserved' => [
581 'name' => 'is_reserved',
582 'type' => CRM_Utils_Type::T_BOOLEAN,
583 'title' => ts('Reserved Group?'),
584 'description' => ts('Is this a reserved Custom Group?'),
585 'where' => 'civicrm_custom_group.is_reserved',
586 'default' => '0',
587 'table_name' => 'civicrm_custom_group',
588 'entity' => 'CustomGroup',
589 'bao' => 'CRM_Core_BAO_CustomGroup',
590 'localizable' => 0,
591 'add' => '4.4',
592 ],
593 'is_public' => [
594 'name' => 'is_public',
595 'type' => CRM_Utils_Type::T_BOOLEAN,
596 'title' => ts('Custom Group Is Public?'),
597 'description' => ts('Is this property public?'),
598 'where' => 'civicrm_custom_group.is_public',
599 'default' => '1',
600 'table_name' => 'civicrm_custom_group',
601 'entity' => 'CustomGroup',
602 'bao' => 'CRM_Core_BAO_CustomGroup',
603 'localizable' => 0,
604 'add' => '4.7',
605 ],
606 'icon' => [
607 'name' => 'icon',
608 'type' => CRM_Utils_Type::T_STRING,
609 'title' => ts('Icon'),
610 'description' => ts('crm-i icon class'),
611 'maxlength' => 255,
612 'size' => CRM_Utils_Type::HUGE,
613 'where' => 'civicrm_custom_group.icon',
614 'default' => NULL,
615 'table_name' => 'civicrm_custom_group',
616 'entity' => 'CustomGroup',
617 'bao' => 'CRM_Core_BAO_CustomGroup',
618 'localizable' => 0,
619 'add' => '5.28',
620 ],
621 ];
622 CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
623 }
624 return Civi::$statics[__CLASS__]['fields'];
625 }
626
627 /**
628 * Return a mapping from field-name to the corresponding key (as used in fields()).
629 *
630 * @return array
631 * Array(string $name => string $uniqueName).
632 */
633 public static function &fieldKeys() {
634 if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
635 Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
636 }
637 return Civi::$statics[__CLASS__]['fieldKeys'];
638 }
639
640 /**
641 * Returns the names of this table
642 *
643 * @return string
644 */
645 public static function getTableName() {
646 return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
647 }
648
649 /**
650 * Returns if this table needs to be logged
651 *
652 * @return bool
653 */
654 public function getLog() {
655 return self::$_log;
656 }
657
658 /**
659 * Returns the list of fields that can be imported
660 *
661 * @param bool $prefix
662 *
663 * @return array
664 */
665 public static function &import($prefix = FALSE) {
666 $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'custom_group', $prefix, []);
667 return $r;
668 }
669
670 /**
671 * Returns the list of fields that can be exported
672 *
673 * @param bool $prefix
674 *
675 * @return array
676 */
677 public static function &export($prefix = FALSE) {
678 $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'custom_group', $prefix, []);
679 return $r;
680 }
681
682 /**
683 * Returns the list of indices
684 *
685 * @param bool $localize
686 *
687 * @return array
688 */
689 public static function indices($localize = TRUE) {
690 $indices = [
691 'UI_title_extends' => [
692 'name' => 'UI_title_extends',
693 'field' => [
694 0 => 'title',
695 1 => 'extends',
696 ],
697 'localizable' => TRUE,
698 'unique' => TRUE,
699 'sig' => 'civicrm_custom_group::1::title::extends',
700 ],
701 'UI_name_extends' => [
702 'name' => 'UI_name_extends',
703 'field' => [
704 0 => 'name',
705 1 => 'extends',
706 ],
707 'localizable' => FALSE,
708 'unique' => TRUE,
709 'sig' => 'civicrm_custom_group::1::name::extends',
710 ],
711 ];
712 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
713 }
714
715 }