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:65d78bdab80228a63775214faab08ee0)
  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
 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
 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
 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
 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
 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
 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           'required' => TRUE,
 416           'where' => 'civicrm_custom_group.collapse_display',
 417           'default' => '0',
 418           'table_name' => 'civicrm_custom_group',
 419           'entity' => 'CustomGroup',
 420           'bao' => 'CRM_Core_BAO_CustomGroup',
 421           'localizable' => 0,
 422           'add' => '1.1',
 423         ],
 424         'help_pre' => [
 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.'),
 429           'rows' => 4,
 430           'cols' => 80,
 431           'where' => 'civicrm_custom_group.help_pre',
 432           'table_name' => 'civicrm_custom_group',
 433           'entity' => 'CustomGroup',
 434           'bao' => 'CRM_Core_BAO_CustomGroup',
 435           'localizable' => 1,
 436           'html' => [
 437             'type' => 'TextArea',
 438           ],
 439           'add' => '1.1',
 440         ],
 441         'help_post' => [
 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.'),
 446           'rows' => 4,
 447           'cols' => 80,
 448           'where' => 'civicrm_custom_group.help_post',
 449           'table_name' => 'civicrm_custom_group',
 450           'entity' => 'CustomGroup',
 451           'bao' => 'CRM_Core_BAO_CustomGroup',
 452           'localizable' => 1,
 453           'html' => [
 454             'type' => 'TextArea',
 455           ],
 456           'add' => '1.1',
 457         ],
 458         'weight' => [
 459           'name' => 'weight',
 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.'),
 463           'required' => TRUE,
 464           'where' => 'civicrm_custom_group.weight',
 465           'default' => '1',
 466           'table_name' => 'civicrm_custom_group',
 467           'entity' => 'CustomGroup',
 468           'bao' => 'CRM_Core_BAO_CustomGroup',
 469           'localizable' => 0,
 470           'add' => '1.1',
 471         ],
 472         'is_active' => [
 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?'),
 477           'required' => TRUE,
 478           'where' => 'civicrm_custom_group.is_active',
 479           'default' => '1',
 480           'table_name' => 'civicrm_custom_group',
 481           'entity' => 'CustomGroup',
 482           'bao' => 'CRM_Core_BAO_CustomGroup',
 483           'localizable' => 0,
 484           'add' => '1.1',
 485         ],
 486         'table_name' => [
 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.'),
 491           'maxlength' => 255,
 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',
 497           'localizable' => 0,
 498           'html' => [
 499             'label' => ts("Table Name"),
 500           ],
 501           'readonly' => TRUE,
 502           'add' => '2.0',
 503         ],
 504         'is_multiple' => [
 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?'),
 509           'required' => TRUE,
 510           'where' => 'civicrm_custom_group.is_multiple',
 511           'default' => '0',
 512           'table_name' => 'civicrm_custom_group',
 513           'entity' => 'CustomGroup',
 514           'bao' => 'CRM_Core_BAO_CustomGroup',
 515           'localizable' => 0,
 516           'add' => '2.0',
 517         ],
 518         'min_multiple' => [
 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',
 527           'localizable' => 0,
 528           'add' => '2.2',
 529         ],
 530         'max_multiple' => [
 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',
 539           'localizable' => 0,
 540           'add' => '2.2',
 541         ],
 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 ?'),
 547           'required' => TRUE,
 548           'where' => 'civicrm_custom_group.collapse_adv_display',
 549           'default' => '0',
 550           'table_name' => 'civicrm_custom_group',
 551           'entity' => 'CustomGroup',
 552           'bao' => 'CRM_Core_BAO_CustomGroup',
 553           'localizable' => 0,
 554           'add' => '3.0',
 555         ],
 556         'created_id' => [
 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',
 565           'localizable' => 0,
 566           'FKClassName' => 'CRM_Contact_DAO_Contact',
 567           'html' => [
 568             'label' => ts("Created By"),
 569           ],
 570           'add' => '3.0',
 571         ],
 572         'created_date' => [
 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',
 581           'localizable' => 0,
 582           'add' => '3.0',
 583         ],
 584         'is_reserved' => [
 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?'),
 589           'required' => TRUE,
 590           'where' => 'civicrm_custom_group.is_reserved',
 591           'default' => '0',
 592           'table_name' => 'civicrm_custom_group',
 593           'entity' => 'CustomGroup',
 594           'bao' => 'CRM_Core_BAO_CustomGroup',
 595           'localizable' => 0,
 596           'add' => '4.4',
 597         ],
 598         'is_public' => [
 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?'),
 603           'required' => TRUE,
 604           'where' => 'civicrm_custom_group.is_public',
 605           'default' => '1',
 606           'table_name' => 'civicrm_custom_group',
 607           'entity' => 'CustomGroup',
 608           'bao' => 'CRM_Core_BAO_CustomGroup',
 609           'localizable' => 0,
 610           'add' => '4.7',
 611         ],
 612         'icon' => [
 613           'name' => 'icon',
 614           'type' => CRM_Utils_Type::T_STRING,
 615           'title' => ts('Icon'),
 616           'description' => ts('crm-i icon class'),
 617           'maxlength' => 255,
 618           'size' => CRM_Utils_Type::HUGE,
 619           'where' => 'civicrm_custom_group.icon',
 620           'default' => NULL,
 621           'table_name' => 'civicrm_custom_group',
 622           'entity' => 'CustomGroup',
 623           'bao' => 'CRM_Core_BAO_CustomGroup',
 624           'localizable' => 0,
 625           'add' => '5.28',
 626         ],
 627       ];
 628       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 629     }
 630     return Civi::$statics[__CLASS__]['fields'];
 631   }
 632
 633   /**
 634    * Return a mapping from field-name to the corresponding key (as used in fields()).
 635    *
 636    * @return array
 637    *   Array(string $name => string $uniqueName).
 638    */
 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()));
 642     }
 643     return Civi::$statics[__CLASS__]['fieldKeys'];
 644   }
 645
 646   /**
 647    * Returns the names of this table
 648    *
 649    * @return string
 650    */
 651   public static function getTableName() {
 652     return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
 653   }
 654
 655   /**
 656    * Returns if this table needs to be logged
 657    *
 658    * @return bool
 659    */
 660   public function getLog() {
 661     return self::$_log;
 662   }
 663
 664   /**
 665    * Returns the list of fields that can be imported
 666    *
 667    * @param bool $prefix
 668    *
 669    * @return array
 670    */
 671   public static function &import($prefix = FALSE) {
 672     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'custom_group', $prefix, []);
 673     return $r;
 674   }
 675
 676   /**
 677    * Returns the list of fields that can be exported
 678    *
 679    * @param bool $prefix
 680    *
 681    * @return array
 682    */
 683   public static function &export($prefix = FALSE) {
 684     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'custom_group', $prefix, []);
 685     return $r;
 686   }
 687
 688   /**
 689    * Returns the list of indices
 690    *
 691    * @param bool $localize
 692    *
 693    * @return array
 694    */
 695   public static function indices($localize = TRUE) {
 696     $indices = [
 697       'UI_title_extends' => [
 698         'name' => 'UI_title_extends',
 699         'field' => [
 700           0 => 'title',
 701           1 => 'extends',
 702         ],
 703         'localizable' => TRUE,
 704         'unique' => TRUE,
 705         'sig' => 'civicrm_custom_group::1::title::extends',
 706       ],
 707       'UI_name' => [
 708         'name' => 'UI_name',
 709         'field' => [
 710           0 => 'name',
 711         ],
 712         'localizable' => FALSE,
 713         'unique' => TRUE,
 714         'sig' => 'civicrm_custom_group::1::name',
 715       ],
 716     ];
 717     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 718   }
 719
 720 }