5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Core/CustomGroup.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:65d78bdab80228a63775214faab08ee0)
13 * Database access object for the CustomGroup entity.
15 class CRM_Core_DAO_CustomGroup
extends CRM_Core_DAO
{
16 const EXT
= 'civicrm';
17 const TABLE_ADDED
= '1.1';
20 * Static instance to hold the table name.
24 public static $_tableName = 'civicrm_custom_group';
27 * Field to show when displaying a record.
31 public static $_labelField = 'title';
34 * Should CiviCRM log any modifications to this table in the civicrm_log table.
38 public static $_log = TRUE;
41 * Paths for accessing this entity in the UI.
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]',
53 * Unique Custom Group ID
55 * @var int|string|null
56 * (SQL type: int unsigned)
57 * Note that values will be retrieved from the database as a string.
62 * Variable name/programmatic handle for this group.
65 * (SQL type: varchar(64))
66 * Note that values will be retrieved from the database as a string.
74 * (SQL type: varchar(64))
75 * Note that values will be retrieved from the database as a string.
80 * Type of object this group extends (can add other options later e.g. contact_address, etc.).
83 * (SQL type: varchar(255))
84 * Note that values will be retrieved from the database as a string.
89 * FK to civicrm_option_value.id (for option group custom_data_type.)
91 * @var int|string|null
92 * (SQL type: int unsigned)
93 * Note that values will be retrieved from the database as a string.
95 public $extends_entity_column_id;
98 * linking custom group for dynamic object
101 * (SQL type: varchar(255))
102 * Note that values will be retrieved from the database as a string.
104 public $extends_entity_column_value;
107 * Visual relationship between this form and its parent.
110 * (SQL type: varchar(15))
111 * Note that values will be retrieved from the database as a string.
116 * Will this group be in collapsed or expanded mode on initial display ?
119 * (SQL type: tinyint)
120 * Note that values will be retrieved from the database as a string.
122 public $collapse_display;
125 * Description and/or help text to display before fields in form.
129 * Note that values will be retrieved from the database as a string.
134 * Description and/or help text to display after fields in form.
138 * Note that values will be retrieved from the database as a string.
143 * Controls display order when multiple extended property groups are setup for the same class.
147 * Note that values will be retrieved from the database as a string.
152 * Is this property active?
155 * (SQL type: tinyint)
156 * Note that values will be retrieved from the database as a string.
161 * Name of the table that holds the values for this group.
164 * (SQL type: varchar(255))
165 * Note that values will be retrieved from the database as a string.
170 * Does this group hold multiple values?
173 * (SQL type: tinyint)
174 * Note that values will be retrieved from the database as a string.
179 * minimum number of multiple records (typically 0?)
181 * @var int|string|null
182 * (SQL type: int unsigned)
183 * Note that values will be retrieved from the database as a string.
185 public $min_multiple;
188 * maximum number of multiple records, if 0 - no max
190 * @var int|string|null
191 * (SQL type: int unsigned)
192 * Note that values will be retrieved from the database as a string.
194 public $max_multiple;
197 * Will this group be in collapsed or expanded mode on advanced search display ?
200 * (SQL type: tinyint)
201 * Note that values will be retrieved from the database as a string.
203 public $collapse_adv_display;
206 * FK to civicrm_contact, who created this custom group
208 * @var int|string|null
209 * (SQL type: int unsigned)
210 * Note that values will be retrieved from the database as a string.
215 * Date and time this custom group was created.
218 * (SQL type: datetime)
219 * Note that values will be retrieved from the database as a string.
221 public $created_date;
224 * Is this a reserved Custom Group?
227 * (SQL type: tinyint)
228 * Note that values will be retrieved from the database as a string.
233 * Is this property public?
236 * (SQL type: tinyint)
237 * Note that values will be retrieved from the database as a string.
245 * (SQL type: varchar(255))
246 * Note that values will be retrieved from the database as a string.
253 public function __construct() {
254 $this->__table
= 'civicrm_custom_group';
255 parent
::__construct();
259 * Returns localized title of this entity.
261 * @param bool $plural
262 * Whether to return the plural version of the title.
264 public static function getEntityTitle($plural = FALSE) {
265 return $plural ?
ts('Custom Field Groups') : ts('Custom Field Group');
269 * Returns foreign keys and entity references.
272 * [CRM_Core_Reference_Interface]
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']);
280 return Civi
::$statics[__CLASS__
]['links'];
284 * Returns all the column names of this table
288 public static function &fields() {
289 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
290 Civi
::$statics[__CLASS__
]['fields'] = [
293 'type' => CRM_Utils_Type
::T_INT
,
294 'title' => ts('Custom Group ID'),
295 'description' => ts('Unique Custom Group ID'),
297 'where' => 'civicrm_custom_group.id',
298 'table_name' => 'civicrm_custom_group',
299 'entity' => 'CustomGroup',
300 'bao' => 'CRM_Core_BAO_CustomGroup',
310 'type' => CRM_Utils_Type
::T_STRING
,
311 'title' => ts('Custom Group Name'),
312 'description' => ts('Variable name/programmatic handle for this group.'),
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',
324 'type' => CRM_Utils_Type
::T_STRING
,
325 'title' => ts('Custom Group Title'),
326 'description' => ts('Friendly Name.'),
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',
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.).'),
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',
350 'pseudoconstant' => [
351 'callback' => 'CRM_Core_SelectValues::customGroupExtends',
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',
362 'table_name' => 'civicrm_custom_group',
363 'entity' => 'CustomGroup',
364 'bao' => 'CRM_Core_BAO_CustomGroup',
369 'pseudoconstant' => [
370 'optionGroupName' => 'custom_data_type',
371 'optionEditPath' => 'civicrm/admin/options/custom_data_type',
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'),
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',
387 'serialize' => self
::SERIALIZE_SEPARATOR_BOOKEND
,
392 'type' => CRM_Utils_Type
::T_STRING
,
393 'title' => ts('Custom Group Style'),
394 'description' => ts('Visual relationship between this form and its parent.'),
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',
405 'pseudoconstant' => [
406 'callback' => 'CRM_Core_SelectValues::customGroupStyle',
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 ?'),
416 'where' => 'civicrm_custom_group.collapse_display',
418 'table_name' => 'civicrm_custom_group',
419 'entity' => 'CustomGroup',
420 'bao' => 'CRM_Core_BAO_CustomGroup',
425 'name' => 'help_pre',
426 'type' => CRM_Utils_Type
::T_TEXT
,
427 'title' => ts('Custom Group Pre Text'),
428 'description' => ts('Description and/or help text to display before fields in form.'),
431 'where' => 'civicrm_custom_group.help_pre',
432 'table_name' => 'civicrm_custom_group',
433 'entity' => 'CustomGroup',
434 'bao' => 'CRM_Core_BAO_CustomGroup',
437 'type' => 'TextArea',
442 'name' => 'help_post',
443 'type' => CRM_Utils_Type
::T_TEXT
,
444 'title' => ts('Custom Group Post Text'),
445 'description' => ts('Description and/or help text to display after fields in form.'),
448 'where' => 'civicrm_custom_group.help_post',
449 'table_name' => 'civicrm_custom_group',
450 'entity' => 'CustomGroup',
451 'bao' => 'CRM_Core_BAO_CustomGroup',
454 'type' => 'TextArea',
460 'type' => CRM_Utils_Type
::T_INT
,
461 'title' => ts('Order'),
462 'description' => ts('Controls display order when multiple extended property groups are setup for the same class.'),
464 'where' => 'civicrm_custom_group.weight',
466 'table_name' => 'civicrm_custom_group',
467 'entity' => 'CustomGroup',
468 'bao' => 'CRM_Core_BAO_CustomGroup',
473 'name' => 'is_active',
474 'type' => CRM_Utils_Type
::T_BOOLEAN
,
475 'title' => ts('Custom Group Is Active?'),
476 'description' => ts('Is this property active?'),
478 'where' => 'civicrm_custom_group.is_active',
480 'table_name' => 'civicrm_custom_group',
481 'entity' => 'CustomGroup',
482 'bao' => 'CRM_Core_BAO_CustomGroup',
487 'name' => 'table_name',
488 'type' => CRM_Utils_Type
::T_STRING
,
489 'title' => ts('Table Name'),
490 'description' => ts('Name of the table that holds the values for this group.'),
492 'size' => CRM_Utils_Type
::HUGE
,
493 'where' => 'civicrm_custom_group.table_name',
494 'table_name' => 'civicrm_custom_group',
495 'entity' => 'CustomGroup',
496 'bao' => 'CRM_Core_BAO_CustomGroup',
499 'label' => ts("Table Name"),
505 'name' => 'is_multiple',
506 'type' => CRM_Utils_Type
::T_BOOLEAN
,
507 'title' => ts('Supports Multiple Records'),
508 'description' => ts('Does this group hold multiple values?'),
510 'where' => 'civicrm_custom_group.is_multiple',
512 'table_name' => 'civicrm_custom_group',
513 'entity' => 'CustomGroup',
514 'bao' => 'CRM_Core_BAO_CustomGroup',
519 'name' => 'min_multiple',
520 'type' => CRM_Utils_Type
::T_INT
,
521 'title' => ts('Minimum Multiple Records'),
522 'description' => ts('minimum number of multiple records (typically 0?)'),
523 'where' => 'civicrm_custom_group.min_multiple',
524 'table_name' => 'civicrm_custom_group',
525 'entity' => 'CustomGroup',
526 'bao' => 'CRM_Core_BAO_CustomGroup',
531 'name' => 'max_multiple',
532 'type' => CRM_Utils_Type
::T_INT
,
533 'title' => ts('Maximum Multiple Records'),
534 'description' => ts('maximum number of multiple records, if 0 - no max'),
535 'where' => 'civicrm_custom_group.max_multiple',
536 'table_name' => 'civicrm_custom_group',
537 'entity' => 'CustomGroup',
538 'bao' => 'CRM_Core_BAO_CustomGroup',
542 'collapse_adv_display' => [
543 'name' => 'collapse_adv_display',
544 'type' => CRM_Utils_Type
::T_BOOLEAN
,
545 'title' => ts('Collapse Group Display'),
546 'description' => ts('Will this group be in collapsed or expanded mode on advanced search display ?'),
548 'where' => 'civicrm_custom_group.collapse_adv_display',
550 'table_name' => 'civicrm_custom_group',
551 'entity' => 'CustomGroup',
552 'bao' => 'CRM_Core_BAO_CustomGroup',
557 'name' => 'created_id',
558 'type' => CRM_Utils_Type
::T_INT
,
559 'title' => ts('Created By Contact ID'),
560 'description' => ts('FK to civicrm_contact, who created this custom group'),
561 'where' => 'civicrm_custom_group.created_id',
562 'table_name' => 'civicrm_custom_group',
563 'entity' => 'CustomGroup',
564 'bao' => 'CRM_Core_BAO_CustomGroup',
566 'FKClassName' => 'CRM_Contact_DAO_Contact',
568 'label' => ts("Created By"),
573 'name' => 'created_date',
574 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
575 'title' => ts('Custom Group Created Date'),
576 'description' => ts('Date and time this custom group was created.'),
577 'where' => 'civicrm_custom_group.created_date',
578 'table_name' => 'civicrm_custom_group',
579 'entity' => 'CustomGroup',
580 'bao' => 'CRM_Core_BAO_CustomGroup',
585 'name' => 'is_reserved',
586 'type' => CRM_Utils_Type
::T_BOOLEAN
,
587 'title' => ts('Reserved Group?'),
588 'description' => ts('Is this a reserved Custom Group?'),
590 'where' => 'civicrm_custom_group.is_reserved',
592 'table_name' => 'civicrm_custom_group',
593 'entity' => 'CustomGroup',
594 'bao' => 'CRM_Core_BAO_CustomGroup',
599 'name' => 'is_public',
600 'type' => CRM_Utils_Type
::T_BOOLEAN
,
601 'title' => ts('Custom Group Is Public?'),
602 'description' => ts('Is this property public?'),
604 'where' => 'civicrm_custom_group.is_public',
606 'table_name' => 'civicrm_custom_group',
607 'entity' => 'CustomGroup',
608 'bao' => 'CRM_Core_BAO_CustomGroup',
614 'type' => CRM_Utils_Type
::T_STRING
,
615 'title' => ts('Icon'),
616 'description' => ts('crm-i icon class'),
618 'size' => CRM_Utils_Type
::HUGE
,
619 'where' => 'civicrm_custom_group.icon',
621 'table_name' => 'civicrm_custom_group',
622 'entity' => 'CustomGroup',
623 'bao' => 'CRM_Core_BAO_CustomGroup',
628 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
630 return Civi
::$statics[__CLASS__
]['fields'];
634 * Return a mapping from field-name to the corresponding key (as used in fields()).
637 * Array(string $name => string $uniqueName).
639 public static function &fieldKeys() {
640 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
641 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
643 return Civi
::$statics[__CLASS__
]['fieldKeys'];
647 * Returns the names of this table
651 public static function getTableName() {
652 return CRM_Core_DAO
::getLocaleTableName(self
::$_tableName);
656 * Returns if this table needs to be logged
660 public function getLog() {
665 * Returns the list of fields that can be imported
667 * @param bool $prefix
671 public static function &import($prefix = FALSE) {
672 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'custom_group', $prefix, []);
677 * Returns the list of fields that can be exported
679 * @param bool $prefix
683 public static function &export($prefix = FALSE) {
684 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'custom_group', $prefix, []);
689 * Returns the list of indices
691 * @param bool $localize
695 public static function indices($localize = TRUE) {
697 'UI_title_extends' => [
698 'name' => 'UI_title_extends',
703 'localizable' => TRUE,
705 'sig' => 'civicrm_custom_group::1::title::extends',
712 'localizable' => FALSE,
714 'sig' => 'civicrm_custom_group::1::name',
717 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;