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:22712766c53c71ece90631f131f338a4)
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_BAO_CustomGroup::getCustomGroupExtendsOptions',
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',
367 'type' => 'ChainSelect',
368 'controlField' => 'extends',
370 'pseudoconstant' => [
371 'optionGroupName' => 'custom_data_type',
372 'optionEditPath' => 'civicrm/admin/options/custom_data_type',
376 'extends_entity_column_value' => [
377 'name' => 'extends_entity_column_value',
378 'type' => CRM_Utils_Type
::T_STRING
,
379 'title' => ts('Custom Group Subtype'),
380 'description' => ts('linking custom group for dynamic object'),
382 'size' => CRM_Utils_Type
::HUGE
,
383 'where' => 'civicrm_custom_group.extends_entity_column_value',
384 'table_name' => 'civicrm_custom_group',
385 'entity' => 'CustomGroup',
386 'bao' => 'CRM_Core_BAO_CustomGroup',
388 'serialize' => self
::SERIALIZE_SEPARATOR_BOOKEND
,
390 'type' => 'ChainSelect',
391 'controlField' => 'extends_entity_column_id',
393 'pseudoconstant' => [
394 'callback' => 'CRM_Core_BAO_CustomGroup::getExtendsEntityColumnValueOptions',
400 'type' => CRM_Utils_Type
::T_STRING
,
401 'title' => ts('Custom Group Style'),
402 'description' => ts('Visual relationship between this form and its parent.'),
404 'size' => CRM_Utils_Type
::TWELVE
,
405 'where' => 'civicrm_custom_group.style',
406 'table_name' => 'civicrm_custom_group',
407 'entity' => 'CustomGroup',
408 'bao' => 'CRM_Core_BAO_CustomGroup',
413 'pseudoconstant' => [
414 'callback' => 'CRM_Core_SelectValues::customGroupStyle',
418 'collapse_display' => [
419 'name' => 'collapse_display',
420 'type' => CRM_Utils_Type
::T_BOOLEAN
,
421 'title' => ts('Collapse Custom Group?'),
422 'description' => ts('Will this group be in collapsed or expanded mode on initial display ?'),
424 'where' => 'civicrm_custom_group.collapse_display',
426 'table_name' => 'civicrm_custom_group',
427 'entity' => 'CustomGroup',
428 'bao' => 'CRM_Core_BAO_CustomGroup',
433 'name' => 'help_pre',
434 'type' => CRM_Utils_Type
::T_TEXT
,
435 'title' => ts('Custom Group Pre Text'),
436 'description' => ts('Description and/or help text to display before fields in form.'),
439 'where' => 'civicrm_custom_group.help_pre',
440 'table_name' => 'civicrm_custom_group',
441 'entity' => 'CustomGroup',
442 'bao' => 'CRM_Core_BAO_CustomGroup',
445 'type' => 'TextArea',
450 'name' => 'help_post',
451 'type' => CRM_Utils_Type
::T_TEXT
,
452 'title' => ts('Custom Group Post Text'),
453 'description' => ts('Description and/or help text to display after fields in form.'),
456 'where' => 'civicrm_custom_group.help_post',
457 'table_name' => 'civicrm_custom_group',
458 'entity' => 'CustomGroup',
459 'bao' => 'CRM_Core_BAO_CustomGroup',
462 'type' => 'TextArea',
468 'type' => CRM_Utils_Type
::T_INT
,
469 'title' => ts('Order'),
470 'description' => ts('Controls display order when multiple extended property groups are setup for the same class.'),
472 'where' => 'civicrm_custom_group.weight',
474 'table_name' => 'civicrm_custom_group',
475 'entity' => 'CustomGroup',
476 'bao' => 'CRM_Core_BAO_CustomGroup',
481 'name' => 'is_active',
482 'type' => CRM_Utils_Type
::T_BOOLEAN
,
483 'title' => ts('Custom Group Is Active?'),
484 'description' => ts('Is this property active?'),
486 'where' => 'civicrm_custom_group.is_active',
488 'table_name' => 'civicrm_custom_group',
489 'entity' => 'CustomGroup',
490 'bao' => 'CRM_Core_BAO_CustomGroup',
495 'name' => 'table_name',
496 'type' => CRM_Utils_Type
::T_STRING
,
497 'title' => ts('Table Name'),
498 'description' => ts('Name of the table that holds the values for this group.'),
500 'size' => CRM_Utils_Type
::HUGE
,
501 'where' => 'civicrm_custom_group.table_name',
502 'table_name' => 'civicrm_custom_group',
503 'entity' => 'CustomGroup',
504 'bao' => 'CRM_Core_BAO_CustomGroup',
507 'label' => ts("Table Name"),
513 'name' => 'is_multiple',
514 'type' => CRM_Utils_Type
::T_BOOLEAN
,
515 'title' => ts('Supports Multiple Records'),
516 'description' => ts('Does this group hold multiple values?'),
518 'where' => 'civicrm_custom_group.is_multiple',
520 'table_name' => 'civicrm_custom_group',
521 'entity' => 'CustomGroup',
522 'bao' => 'CRM_Core_BAO_CustomGroup',
527 'name' => 'min_multiple',
528 'type' => CRM_Utils_Type
::T_INT
,
529 'title' => ts('Minimum Multiple Records'),
530 'description' => ts('minimum number of multiple records (typically 0?)'),
531 'where' => 'civicrm_custom_group.min_multiple',
532 'table_name' => 'civicrm_custom_group',
533 'entity' => 'CustomGroup',
534 'bao' => 'CRM_Core_BAO_CustomGroup',
539 'name' => 'max_multiple',
540 'type' => CRM_Utils_Type
::T_INT
,
541 'title' => ts('Maximum Multiple Records'),
542 'description' => ts('maximum number of multiple records, if 0 - no max'),
543 'where' => 'civicrm_custom_group.max_multiple',
544 'table_name' => 'civicrm_custom_group',
545 'entity' => 'CustomGroup',
546 'bao' => 'CRM_Core_BAO_CustomGroup',
550 'collapse_adv_display' => [
551 'name' => 'collapse_adv_display',
552 'type' => CRM_Utils_Type
::T_BOOLEAN
,
553 'title' => ts('Collapse Group Display'),
554 'description' => ts('Will this group be in collapsed or expanded mode on advanced search display ?'),
556 'where' => 'civicrm_custom_group.collapse_adv_display',
558 'table_name' => 'civicrm_custom_group',
559 'entity' => 'CustomGroup',
560 'bao' => 'CRM_Core_BAO_CustomGroup',
565 'name' => 'created_id',
566 'type' => CRM_Utils_Type
::T_INT
,
567 'title' => ts('Created By Contact ID'),
568 'description' => ts('FK to civicrm_contact, who created this custom group'),
569 'where' => 'civicrm_custom_group.created_id',
570 'table_name' => 'civicrm_custom_group',
571 'entity' => 'CustomGroup',
572 'bao' => 'CRM_Core_BAO_CustomGroup',
574 'FKClassName' => 'CRM_Contact_DAO_Contact',
576 'label' => ts("Created By"),
581 'name' => 'created_date',
582 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
583 'title' => ts('Custom Group Created Date'),
584 'description' => ts('Date and time this custom group was created.'),
585 'where' => 'civicrm_custom_group.created_date',
586 'table_name' => 'civicrm_custom_group',
587 'entity' => 'CustomGroup',
588 'bao' => 'CRM_Core_BAO_CustomGroup',
593 'name' => 'is_reserved',
594 'type' => CRM_Utils_Type
::T_BOOLEAN
,
595 'title' => ts('Reserved Group?'),
596 'description' => ts('Is this a reserved Custom Group?'),
598 'where' => 'civicrm_custom_group.is_reserved',
600 'table_name' => 'civicrm_custom_group',
601 'entity' => 'CustomGroup',
602 'bao' => 'CRM_Core_BAO_CustomGroup',
607 'name' => 'is_public',
608 'type' => CRM_Utils_Type
::T_BOOLEAN
,
609 'title' => ts('Custom Group Is Public?'),
610 'description' => ts('Is this property public?'),
612 'where' => 'civicrm_custom_group.is_public',
614 'table_name' => 'civicrm_custom_group',
615 'entity' => 'CustomGroup',
616 'bao' => 'CRM_Core_BAO_CustomGroup',
622 'type' => CRM_Utils_Type
::T_STRING
,
623 'title' => ts('Icon'),
624 'description' => ts('crm-i icon class'),
626 'size' => CRM_Utils_Type
::HUGE
,
627 'where' => 'civicrm_custom_group.icon',
629 'table_name' => 'civicrm_custom_group',
630 'entity' => 'CustomGroup',
631 'bao' => 'CRM_Core_BAO_CustomGroup',
636 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
638 return Civi
::$statics[__CLASS__
]['fields'];
642 * Return a mapping from field-name to the corresponding key (as used in fields()).
645 * Array(string $name => string $uniqueName).
647 public static function &fieldKeys() {
648 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
649 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
651 return Civi
::$statics[__CLASS__
]['fieldKeys'];
655 * Returns the names of this table
659 public static function getTableName() {
660 return CRM_Core_DAO
::getLocaleTableName(self
::$_tableName);
664 * Returns if this table needs to be logged
668 public function getLog() {
673 * Returns the list of fields that can be imported
675 * @param bool $prefix
679 public static function &import($prefix = FALSE) {
680 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'custom_group', $prefix, []);
685 * Returns the list of fields that can be exported
687 * @param bool $prefix
691 public static function &export($prefix = FALSE) {
692 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'custom_group', $prefix, []);
697 * Returns the list of indices
699 * @param bool $localize
703 public static function indices($localize = TRUE) {
705 'UI_title_extends' => [
706 'name' => 'UI_title_extends',
711 'localizable' => TRUE,
713 'sig' => 'civicrm_custom_group::1::title::extends',
720 'localizable' => FALSE,
722 'sig' => 'civicrm_custom_group::1::name',
725 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;