CRM/Core/DAO/CustomField.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2019
   6  *
   7  * Generated from xml/schema/CRM/Core/CustomField.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:a1a27e2af4724a92f37a959ee359428b)
  10  */
  11
  12 /**
  13  * Database access object for the CustomField entity.
  14  */
  15 class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   public static $_tableName = 'civicrm_custom_field';
  23
  24   /**
  25    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  26    *
  27    * @var bool
  28    */
  29   public static $_log = TRUE;
  30
  31   /**
  32    * Unique Custom Field ID
  33    *
  34    * @var int unsigned
  35    */
  36   public $id;
  37
  38   /**
  39    * FK to civicrm_custom_group.
  40    *
  41    * @var int unsigned
  42    */
  43   public $custom_group_id;
  44
  45   /**
  46    * Variable name/programmatic handle for this group.
  47    *
  48    * @var string
  49    */
  50   public $name;
  51
  52   /**
  53    * Text for form field label (also friendly name for administering this custom property).
  54    *
  55    * @var string
  56    */
  57   public $label;
  58
  59   /**
  60    * Controls location of data storage in extended_data table.
  61    *
  62    * @var string
  63    */
  64   public $data_type;
  65
  66   /**
  67    * HTML types plus several built-in extended types.
  68    *
  69    * @var string
  70    */
  71   public $html_type;
  72
  73   /**
  74    * Use form_options.is_default for field_types which use options.
  75    *
  76    * @var string
  77    */
  78   public $default_value;
  79
  80   /**
  81    * Is a value required for this property.
  82    *
  83    * @var boolean
  84    */
  85   public $is_required;
  86
  87   /**
  88    * Is this property searchable.
  89    *
  90    * @var boolean
  91    */
  92   public $is_searchable;
  93
  94   /**
  95    * Is this property range searchable.
  96    *
  97    * @var boolean
  98    */
  99   public $is_search_range;
 100
 101   /**
 102    * Controls field display order within an extended property group.
 103    *
 104    * @var int
 105    */
 106   public $weight;
 107
 108   /**
 109    * Description and/or help text to display before this field.
 110    *
 111    * @var text
 112    */
 113   public $help_pre;
 114
 115   /**
 116    * Description and/or help text to display after this field.
 117    *
 118    * @var text
 119    */
 120   public $help_post;
 121
 122   /**
 123    * Optional format instructions for specific field types, like date types.
 124    *
 125    * @var string
 126    */
 127   public $mask;
 128
 129   /**
 130    * Store collection of type-appropriate attributes, e.g. textarea  needs rows/cols attributes
 131    *
 132    * @var string
 133    */
 134   public $attributes;
 135
 136   /**
 137    * Optional scripting attributes for field.
 138    *
 139    * @var string
 140    */
 141   public $javascript;
 142
 143   /**
 144    * Is this property active?
 145    *
 146    * @var boolean
 147    */
 148   public $is_active;
 149
 150   /**
 151    * Is this property set by PHP Code? A code field is viewable but not editable
 152    *
 153    * @var boolean
 154    */
 155   public $is_view;
 156
 157   /**
 158    * number of options per line for checkbox and radio
 159    *
 160    * @var int unsigned
 161    */
 162   public $options_per_line;
 163
 164   /**
 165    * field length if alphanumeric
 166    *
 167    * @var int unsigned
 168    */
 169   public $text_length;
 170
 171   /**
 172    * Date may be up to start_date_years years prior to the current date.
 173    *
 174    * @var int
 175    */
 176   public $start_date_years;
 177
 178   /**
 179    * Date may be up to end_date_years years after the current date.
 180    *
 181    * @var int
 182    */
 183   public $end_date_years;
 184
 185   /**
 186    * date format for custom date
 187    *
 188    * @var string
 189    */
 190   public $date_format;
 191
 192   /**
 193    * time format for custom date
 194    *
 195    * @var int unsigned
 196    */
 197   public $time_format;
 198
 199   /**
 200    *  Number of columns in Note Field
 201    *
 202    * @var int unsigned
 203    */
 204   public $note_columns;
 205
 206   /**
 207    *  Number of rows in Note Field
 208    *
 209    * @var int unsigned
 210    */
 211   public $note_rows;
 212
 213   /**
 214    * Name of the column that holds the values for this field.
 215    *
 216    * @var string
 217    */
 218   public $column_name;
 219
 220   /**
 221    * For elements with options, the option group id that is used
 222    *
 223    * @var int unsigned
 224    */
 225   public $option_group_id;
 226
 227   /**
 228    * Stores Contact Get API params contact reference custom fields. May be used for other filters in the future.
 229    *
 230    * @var string
 231    */
 232   public $filter;
 233
 234   /**
 235    * Should the multi-record custom field values be displayed in tab table listing
 236    *
 237    * @var boolean
 238    */
 239   public $in_selector;
 240
 241   /**
 242    * Class constructor.
 243    */
 244   public function __construct() {
 245     $this->__table = 'civicrm_custom_field';
 246     parent::__construct();
 247   }
 248
 249   /**
 250    * Returns foreign keys and entity references.
 251    *
 252    * @return array
 253    *   [CRM_Core_Reference_Interface]
 254    */
 255   public static function getReferenceColumns() {
 256     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 257       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 258       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'custom_group_id', 'civicrm_custom_group', 'id');
 259       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'option_group_id', 'civicrm_option_group', 'id');
 260       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 261     }
 262     return Civi::$statics[__CLASS__]['links'];
 263   }
 264
 265   /**
 266    * Returns all the column names of this table
 267    *
 268    * @return array
 269    */
 270   public static function &fields() {
 271     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 272       Civi::$statics[__CLASS__]['fields'] = [
 273         'id' => [
 274           'name' => 'id',
 275           'type' => CRM_Utils_Type::T_INT,
 276           'title' => ts('Custom Field ID'),
 277           'description' => ts('Unique Custom Field ID'),
 278           'required' => TRUE,
 279           'where' => 'civicrm_custom_field.id',
 280           'table_name' => 'civicrm_custom_field',
 281           'entity' => 'CustomField',
 282           'bao' => 'CRM_Core_BAO_CustomField',
 283           'localizable' => 0,
 284         ],
 285         'custom_group_id' => [
 286           'name' => 'custom_group_id',
 287           'type' => CRM_Utils_Type::T_INT,
 288           'title' => ts('Custom Group'),
 289           'description' => ts('FK to civicrm_custom_group.'),
 290           'required' => TRUE,
 291           'where' => 'civicrm_custom_field.custom_group_id',
 292           'table_name' => 'civicrm_custom_field',
 293           'entity' => 'CustomField',
 294           'bao' => 'CRM_Core_BAO_CustomField',
 295           'localizable' => 0,
 296           'FKClassName' => 'CRM_Core_DAO_CustomGroup',
 297           'html' => [
 298             'type' => 'Select',
 299           ],
 300           'pseudoconstant' => [
 301             'table' => 'civicrm_custom_group',
 302             'keyColumn' => 'id',
 303             'labelColumn' => 'title',
 304           ]
 305         ],
 306         'name' => [
 307           'name' => 'name',
 308           'type' => CRM_Utils_Type::T_STRING,
 309           'title' => ts('Custom Field Name'),
 310           'description' => ts('Variable name/programmatic handle for this group.'),
 311           'maxlength' => 64,
 312           'size' => CRM_Utils_Type::BIG,
 313           'where' => 'civicrm_custom_field.name',
 314           'table_name' => 'civicrm_custom_field',
 315           'entity' => 'CustomField',
 316           'bao' => 'CRM_Core_BAO_CustomField',
 317           'localizable' => 0,
 318         ],
 319         'label' => [
 320           'name' => 'label',
 321           'type' => CRM_Utils_Type::T_STRING,
 322           'title' => ts('Custom Field Label'),
 323           'description' => ts('Text for form field label (also friendly name for administering this custom property).'),
 324           'required' => TRUE,
 325           'maxlength' => 255,
 326           'size' => CRM_Utils_Type::HUGE,
 327           'where' => 'civicrm_custom_field.label',
 328           'table_name' => 'civicrm_custom_field',
 329           'entity' => 'CustomField',
 330           'bao' => 'CRM_Core_BAO_CustomField',
 331           'localizable' => 1,
 332         ],
 333         'data_type' => [
 334           'name' => 'data_type',
 335           'type' => CRM_Utils_Type::T_STRING,
 336           'title' => ts('Custom Field Data Type'),
 337           'description' => ts('Controls location of data storage in extended_data table.'),
 338           'required' => TRUE,
 339           'maxlength' => 16,
 340           'size' => CRM_Utils_Type::TWELVE,
 341           'where' => 'civicrm_custom_field.data_type',
 342           'table_name' => 'civicrm_custom_field',
 343           'entity' => 'CustomField',
 344           'bao' => 'CRM_Core_BAO_CustomField',
 345           'localizable' => 0,
 346           'html' => [
 347             'type' => 'Select',
 348           ],
 349           'pseudoconstant' => [
 350             'callback' => 'CRM_Core_BAO_CustomField::dataType',
 351           ]
 352         ],
 353         'html_type' => [
 354           'name' => 'html_type',
 355           'type' => CRM_Utils_Type::T_STRING,
 356           'title' => ts('Custom Field HTML Type'),
 357           'description' => ts('HTML types plus several built-in extended types.'),
 358           'required' => TRUE,
 359           'maxlength' => 32,
 360           'size' => CRM_Utils_Type::MEDIUM,
 361           'where' => 'civicrm_custom_field.html_type',
 362           'table_name' => 'civicrm_custom_field',
 363           'entity' => 'CustomField',
 364           'bao' => 'CRM_Core_BAO_CustomField',
 365           'localizable' => 0,
 366           'pseudoconstant' => [
 367             'callback' => 'CRM_Core_SelectValues::customHtmlType',
 368           ]
 369         ],
 370         'default_value' => [
 371           'name' => 'default_value',
 372           'type' => CRM_Utils_Type::T_STRING,
 373           'title' => ts('Custom Field Default'),
 374           'description' => ts('Use form_options.is_default for field_types which use options.'),
 375           'maxlength' => 255,
 376           'size' => CRM_Utils_Type::HUGE,
 377           'where' => 'civicrm_custom_field.default_value',
 378           'table_name' => 'civicrm_custom_field',
 379           'entity' => 'CustomField',
 380           'bao' => 'CRM_Core_BAO_CustomField',
 381           'localizable' => 0,
 382         ],
 383         'is_required' => [
 384           'name' => 'is_required',
 385           'type' => CRM_Utils_Type::T_BOOLEAN,
 386           'title' => ts('Custom Field Is Required?'),
 387           'description' => ts('Is a value required for this property.'),
 388           'where' => 'civicrm_custom_field.is_required',
 389           'default' => '0',
 390           'table_name' => 'civicrm_custom_field',
 391           'entity' => 'CustomField',
 392           'bao' => 'CRM_Core_BAO_CustomField',
 393           'localizable' => 0,
 394         ],
 395         'is_searchable' => [
 396           'name' => 'is_searchable',
 397           'type' => CRM_Utils_Type::T_BOOLEAN,
 398           'title' => ts('Allow Searching on Field?'),
 399           'description' => ts('Is this property searchable.'),
 400           'where' => 'civicrm_custom_field.is_searchable',
 401           'default' => '0',
 402           'table_name' => 'civicrm_custom_field',
 403           'entity' => 'CustomField',
 404           'bao' => 'CRM_Core_BAO_CustomField',
 405           'localizable' => 0,
 406         ],
 407         'is_search_range' => [
 408           'name' => 'is_search_range',
 409           'type' => CRM_Utils_Type::T_BOOLEAN,
 410           'title' => ts('Search as a Range'),
 411           'description' => ts('Is this property range searchable.'),
 412           'where' => 'civicrm_custom_field.is_search_range',
 413           'default' => '0',
 414           'table_name' => 'civicrm_custom_field',
 415           'entity' => 'CustomField',
 416           'bao' => 'CRM_Core_BAO_CustomField',
 417           'localizable' => 0,
 418         ],
 419         'weight' => [
 420           'name' => 'weight',
 421           'type' => CRM_Utils_Type::T_INT,
 422           'title' => ts('Order'),
 423           'description' => ts('Controls field display order within an extended property group.'),
 424           'required' => TRUE,
 425           'where' => 'civicrm_custom_field.weight',
 426           'default' => '1',
 427           'table_name' => 'civicrm_custom_field',
 428           'entity' => 'CustomField',
 429           'bao' => 'CRM_Core_BAO_CustomField',
 430           'localizable' => 0,
 431         ],
 432         'help_pre' => [
 433           'name' => 'help_pre',
 434           'type' => CRM_Utils_Type::T_TEXT,
 435           'title' => ts('Custom Field Pre Text'),
 436           'description' => ts('Description and/or help text to display before this field.'),
 437           'where' => 'civicrm_custom_field.help_pre',
 438           'table_name' => 'civicrm_custom_field',
 439           'entity' => 'CustomField',
 440           'bao' => 'CRM_Core_BAO_CustomField',
 441           'localizable' => 1,
 442         ],
 443         'help_post' => [
 444           'name' => 'help_post',
 445           'type' => CRM_Utils_Type::T_TEXT,
 446           'title' => ts('Custom Field Post Text'),
 447           'description' => ts('Description and/or help text to display after this field.'),
 448           'where' => 'civicrm_custom_field.help_post',
 449           'table_name' => 'civicrm_custom_field',
 450           'entity' => 'CustomField',
 451           'bao' => 'CRM_Core_BAO_CustomField',
 452           'localizable' => 1,
 453         ],
 454         'mask' => [
 455           'name' => 'mask',
 456           'type' => CRM_Utils_Type::T_STRING,
 457           'title' => ts('Custom Field Formatting'),
 458           'description' => ts('Optional format instructions for specific field types, like date types.'),
 459           'maxlength' => 64,
 460           'size' => CRM_Utils_Type::BIG,
 461           'where' => 'civicrm_custom_field.mask',
 462           'table_name' => 'civicrm_custom_field',
 463           'entity' => 'CustomField',
 464           'bao' => 'CRM_Core_BAO_CustomField',
 465           'localizable' => 0,
 466         ],
 467         'attributes' => [
 468           'name' => 'attributes',
 469           'type' => CRM_Utils_Type::T_STRING,
 470           'title' => ts('Custom Field Attributes'),
 471           'description' => ts('Store collection of type-appropriate attributes, e.g. textarea  needs rows/cols attributes'),
 472           'maxlength' => 255,
 473           'size' => CRM_Utils_Type::HUGE,
 474           'where' => 'civicrm_custom_field.attributes',
 475           'table_name' => 'civicrm_custom_field',
 476           'entity' => 'CustomField',
 477           'bao' => 'CRM_Core_BAO_CustomField',
 478           'localizable' => 0,
 479         ],
 480         'javascript' => [
 481           'name' => 'javascript',
 482           'type' => CRM_Utils_Type::T_STRING,
 483           'title' => ts('Custom Field Javascript'),
 484           'description' => ts('Optional scripting attributes for field.'),
 485           'maxlength' => 255,
 486           'size' => CRM_Utils_Type::HUGE,
 487           'where' => 'civicrm_custom_field.javascript',
 488           'table_name' => 'civicrm_custom_field',
 489           'entity' => 'CustomField',
 490           'bao' => 'CRM_Core_BAO_CustomField',
 491           'localizable' => 0,
 492         ],
 493         'is_active' => [
 494           'name' => 'is_active',
 495           'type' => CRM_Utils_Type::T_BOOLEAN,
 496           'title' => ts('Custom Field Is Active?'),
 497           'description' => ts('Is this property active?'),
 498           'where' => 'civicrm_custom_field.is_active',
 499           'default' => '1',
 500           'table_name' => 'civicrm_custom_field',
 501           'entity' => 'CustomField',
 502           'bao' => 'CRM_Core_BAO_CustomField',
 503           'localizable' => 0,
 504         ],
 505         'is_view' => [
 506           'name' => 'is_view',
 507           'type' => CRM_Utils_Type::T_BOOLEAN,
 508           'title' => ts('Field is Viewable'),
 509           'description' => ts('Is this property set by PHP Code? A code field is viewable but not editable'),
 510           'where' => 'civicrm_custom_field.is_view',
 511           'default' => '0',
 512           'table_name' => 'civicrm_custom_field',
 513           'entity' => 'CustomField',
 514           'bao' => 'CRM_Core_BAO_CustomField',
 515           'localizable' => 0,
 516         ],
 517         'options_per_line' => [
 518           'name' => 'options_per_line',
 519           'type' => CRM_Utils_Type::T_INT,
 520           'title' => ts('Field Options Per Line'),
 521           'description' => ts('number of options per line for checkbox and radio'),
 522           'where' => 'civicrm_custom_field.options_per_line',
 523           'table_name' => 'civicrm_custom_field',
 524           'entity' => 'CustomField',
 525           'bao' => 'CRM_Core_BAO_CustomField',
 526           'localizable' => 0,
 527         ],
 528         'text_length' => [
 529           'name' => 'text_length',
 530           'type' => CRM_Utils_Type::T_INT,
 531           'title' => ts('Field Length'),
 532           'description' => ts('field length if alphanumeric'),
 533           'where' => 'civicrm_custom_field.text_length',
 534           'table_name' => 'civicrm_custom_field',
 535           'entity' => 'CustomField',
 536           'bao' => 'CRM_Core_BAO_CustomField',
 537           'localizable' => 0,
 538         ],
 539         'start_date_years' => [
 540           'name' => 'start_date_years',
 541           'type' => CRM_Utils_Type::T_INT,
 542           'title' => ts('Field Start Date'),
 543           'description' => ts('Date may be up to start_date_years years prior to the current date.'),
 544           'where' => 'civicrm_custom_field.start_date_years',
 545           'table_name' => 'civicrm_custom_field',
 546           'entity' => 'CustomField',
 547           'bao' => 'CRM_Core_BAO_CustomField',
 548           'localizable' => 0,
 549         ],
 550         'end_date_years' => [
 551           'name' => 'end_date_years',
 552           'type' => CRM_Utils_Type::T_INT,
 553           'title' => ts('Field End Date'),
 554           'description' => ts('Date may be up to end_date_years years after the current date.'),
 555           'where' => 'civicrm_custom_field.end_date_years',
 556           'table_name' => 'civicrm_custom_field',
 557           'entity' => 'CustomField',
 558           'bao' => 'CRM_Core_BAO_CustomField',
 559           'localizable' => 0,
 560         ],
 561         'date_format' => [
 562           'name' => 'date_format',
 563           'type' => CRM_Utils_Type::T_STRING,
 564           'title' => ts('Field Data Format'),
 565           'description' => ts('date format for custom date'),
 566           'maxlength' => 64,
 567           'size' => CRM_Utils_Type::BIG,
 568           'where' => 'civicrm_custom_field.date_format',
 569           'table_name' => 'civicrm_custom_field',
 570           'entity' => 'CustomField',
 571           'bao' => 'CRM_Core_BAO_CustomField',
 572           'localizable' => 0,
 573         ],
 574         'time_format' => [
 575           'name' => 'time_format',
 576           'type' => CRM_Utils_Type::T_INT,
 577           'title' => ts('Field Time Format'),
 578           'description' => ts('time format for custom date'),
 579           'where' => 'civicrm_custom_field.time_format',
 580           'table_name' => 'civicrm_custom_field',
 581           'entity' => 'CustomField',
 582           'bao' => 'CRM_Core_BAO_CustomField',
 583           'localizable' => 0,
 584         ],
 585         'note_columns' => [
 586           'name' => 'note_columns',
 587           'type' => CRM_Utils_Type::T_INT,
 588           'title' => ts('Field Note Columns'),
 589           'description' => ts(' Number of columns in Note Field '),
 590           'where' => 'civicrm_custom_field.note_columns',
 591           'table_name' => 'civicrm_custom_field',
 592           'entity' => 'CustomField',
 593           'bao' => 'CRM_Core_BAO_CustomField',
 594           'localizable' => 0,
 595         ],
 596         'note_rows' => [
 597           'name' => 'note_rows',
 598           'type' => CRM_Utils_Type::T_INT,
 599           'title' => ts('Field Note Rows'),
 600           'description' => ts(' Number of rows in Note Field '),
 601           'where' => 'civicrm_custom_field.note_rows',
 602           'table_name' => 'civicrm_custom_field',
 603           'entity' => 'CustomField',
 604           'bao' => 'CRM_Core_BAO_CustomField',
 605           'localizable' => 0,
 606         ],
 607         'column_name' => [
 608           'name' => 'column_name',
 609           'type' => CRM_Utils_Type::T_STRING,
 610           'title' => ts('Field Column Name'),
 611           'description' => ts('Name of the column that holds the values for this field.'),
 612           'maxlength' => 255,
 613           'size' => CRM_Utils_Type::HUGE,
 614           'where' => 'civicrm_custom_field.column_name',
 615           'table_name' => 'civicrm_custom_field',
 616           'entity' => 'CustomField',
 617           'bao' => 'CRM_Core_BAO_CustomField',
 618           'localizable' => 0,
 619         ],
 620         'option_group_id' => [
 621           'name' => 'option_group_id',
 622           'type' => CRM_Utils_Type::T_INT,
 623           'title' => ts('Field Option Group'),
 624           'description' => ts('For elements with options, the option group id that is used'),
 625           'where' => 'civicrm_custom_field.option_group_id',
 626           'table_name' => 'civicrm_custom_field',
 627           'entity' => 'CustomField',
 628           'bao' => 'CRM_Core_BAO_CustomField',
 629           'localizable' => 0,
 630           'FKClassName' => 'CRM_Core_DAO_OptionGroup',
 631           'pseudoconstant' => [
 632             'table' => 'civicrm_option_group',
 633             'keyColumn' => 'id',
 634             'labelColumn' => 'title',
 635           ]
 636         ],
 637         'filter' => [
 638           'name' => 'filter',
 639           'type' => CRM_Utils_Type::T_STRING,
 640           'title' => ts('Field Filter'),
 641           'description' => ts('Stores Contact Get API params contact reference custom fields. May be used for other filters in the future.'),
 642           'maxlength' => 255,
 643           'size' => CRM_Utils_Type::HUGE,
 644           'where' => 'civicrm_custom_field.filter',
 645           'table_name' => 'civicrm_custom_field',
 646           'entity' => 'CustomField',
 647           'bao' => 'CRM_Core_BAO_CustomField',
 648           'localizable' => 0,
 649         ],
 650         'in_selector' => [
 651           'name' => 'in_selector',
 652           'type' => CRM_Utils_Type::T_BOOLEAN,
 653           'title' => ts('Field Display'),
 654           'description' => ts('Should the multi-record custom field values be displayed in tab table listing'),
 655           'where' => 'civicrm_custom_field.in_selector',
 656           'default' => '0',
 657           'table_name' => 'civicrm_custom_field',
 658           'entity' => 'CustomField',
 659           'bao' => 'CRM_Core_BAO_CustomField',
 660           'localizable' => 0,
 661         ],
 662       ];
 663       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 664     }
 665     return Civi::$statics[__CLASS__]['fields'];
 666   }
 667
 668   /**
 669    * Return a mapping from field-name to the corresponding key (as used in fields()).
 670    *
 671    * @return array
 672    *   Array(string $name => string $uniqueName).
 673    */
 674   public static function &fieldKeys() {
 675     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 676       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 677     }
 678     return Civi::$statics[__CLASS__]['fieldKeys'];
 679   }
 680
 681   /**
 682    * Returns the names of this table
 683    *
 684    * @return string
 685    */
 686   public static function getTableName() {
 687     return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
 688   }
 689
 690   /**
 691    * Returns if this table needs to be logged
 692    *
 693    * @return bool
 694    */
 695   public function getLog() {
 696     return self::$_log;
 697   }
 698
 699   /**
 700    * Returns the list of fields that can be imported
 701    *
 702    * @param bool $prefix
 703    *
 704    * @return array
 705    */
 706   public static function &import($prefix = FALSE) {
 707     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'custom_field', $prefix, []);
 708     return $r;
 709   }
 710
 711   /**
 712    * Returns the list of fields that can be exported
 713    *
 714    * @param bool $prefix
 715    *
 716    * @return array
 717    */
 718   public static function &export($prefix = FALSE) {
 719     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'custom_field', $prefix, []);
 720     return $r;
 721   }
 722
 723   /**
 724    * Returns the list of indices
 725    *
 726    * @param bool $localize
 727    *
 728    * @return array
 729    */
 730   public static function indices($localize = TRUE) {
 731     $indices = [
 732       'UI_label_custom_group_id' => [
 733         'name' => 'UI_label_custom_group_id',
 734         'field' => [
 735           0 => 'label',
 736           1 => 'custom_group_id',
 737         ],
 738         'localizable' => TRUE,
 739         'unique' => TRUE,
 740         'sig' => 'civicrm_custom_field::1::label::custom_group_id',
 741       ],
 742       'UI_name_custom_group_id' => [
 743         'name' => 'UI_name_custom_group_id',
 744         'field' => [
 745           0 => 'name',
 746           1 => 'custom_group_id',
 747         ],
 748         'localizable' => FALSE,
 749         'unique' => TRUE,
 750         'sig' => 'civicrm_custom_field::1::name::custom_group_id',
 751       ],
 752     ];
 753     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 754   }
 755
 756 }