5 * @copyright CiviCRM LLC (c) 2004-2018
7 * Generated from xml/schema/CRM/Core/CustomField.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:7f096c92af68ef9564675e3d708fbbe1)
13 * Database access object for the CustomField entity.
15 class CRM_Core_DAO_CustomField
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 static $_tableName = 'civicrm_custom_field';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
32 * Unique Custom Field ID
39 * FK to civicrm_custom_group.
43 public $custom_group_id;
46 * Variable name/programmatic handle for this group.
53 * Text for form field label (also friendly name for administering this custom property).
60 * Controls location of data storage in extended_data table.
67 * HTML types plus several built-in extended types.
74 * Use form_options.is_default for field_types which use options.
78 public $default_value;
81 * Is a value required for this property.
88 * Is this property searchable.
92 public $is_searchable;
95 * Is this property range searchable.
99 public $is_search_range;
102 * Controls field display order within an extended property group.
109 * Description and/or help text to display before this field.
116 * Description and/or help text to display after this field.
123 * Optional format instructions for specific field types, like date types.
130 * Store collection of type-appropriate attributes, e.g. textarea needs rows/cols attributes
137 * Optional scripting attributes for field.
144 * Is this property active?
151 * Is this property set by PHP Code? A code field is viewable but not editable
158 * number of options per line for checkbox and radio
162 public $options_per_line;
165 * field length if alphanumeric
172 * Date may be up to start_date_years years prior to the current date.
176 public $start_date_years;
179 * Date may be up to end_date_years years after the current date.
183 public $end_date_years;
186 * date format for custom date
193 * time format for custom date
200 * Number of columns in Note Field
204 public $note_columns;
207 * Number of rows in Note Field
214 * Name of the column that holds the values for this field.
221 * For elements with options, the option group id that is used
225 public $option_group_id;
228 * Stores Contact Get API params contact reference custom fields. May be used for other filters in the future.
235 * Should the multi-record custom field values be displayed in tab table listing
244 public function __construct() {
245 $this->__table
= 'civicrm_custom_field';
246 parent
::__construct();
250 * Returns foreign keys and entity references.
253 * [CRM_Core_Reference_Interface]
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 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
261 return Civi
::$statics[__CLASS__
]['links'];
265 * Returns all the column names of this table
269 public static function &fields() {
270 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
271 Civi
::$statics[__CLASS__
]['fields'] = [
274 'type' => CRM_Utils_Type
::T_INT
,
275 'title' => ts('Custom Field ID'),
276 'description' => 'Unique Custom Field ID',
278 'table_name' => 'civicrm_custom_field',
279 'entity' => 'CustomField',
280 'bao' => 'CRM_Core_BAO_CustomField',
283 'custom_group_id' => [
284 'name' => 'custom_group_id',
285 'type' => CRM_Utils_Type
::T_INT
,
286 'title' => ts('Custom Group'),
287 'description' => 'FK to civicrm_custom_group.',
289 'table_name' => 'civicrm_custom_field',
290 'entity' => 'CustomField',
291 'bao' => 'CRM_Core_BAO_CustomField',
293 'FKClassName' => 'CRM_Core_DAO_CustomGroup',
297 'pseudoconstant' => [
298 'table' => 'civicrm_custom_group',
300 'labelColumn' => 'title',
305 'type' => CRM_Utils_Type
::T_STRING
,
306 'title' => ts('Custom Field Name'),
307 'description' => 'Variable name/programmatic handle for this group.',
309 'size' => CRM_Utils_Type
::BIG
,
310 'table_name' => 'civicrm_custom_field',
311 'entity' => 'CustomField',
312 'bao' => 'CRM_Core_BAO_CustomField',
317 'type' => CRM_Utils_Type
::T_STRING
,
318 'title' => ts('Custom Field Label'),
319 'description' => 'Text for form field label (also friendly name for administering this custom property).',
322 'size' => CRM_Utils_Type
::HUGE
,
323 'table_name' => 'civicrm_custom_field',
324 'entity' => 'CustomField',
325 'bao' => 'CRM_Core_BAO_CustomField',
329 'name' => 'data_type',
330 'type' => CRM_Utils_Type
::T_STRING
,
331 'title' => ts('Custom Field Data Type'),
332 'description' => 'Controls location of data storage in extended_data table.',
335 'size' => CRM_Utils_Type
::TWELVE
,
336 'table_name' => 'civicrm_custom_field',
337 'entity' => 'CustomField',
338 'bao' => 'CRM_Core_BAO_CustomField',
343 'pseudoconstant' => [
344 'callback' => 'CRM_Core_BAO_CustomField::dataType',
348 'name' => 'html_type',
349 'type' => CRM_Utils_Type
::T_STRING
,
350 'title' => ts('Custom Field HTML Type'),
351 'description' => 'HTML types plus several built-in extended types.',
354 'size' => CRM_Utils_Type
::MEDIUM
,
355 'table_name' => 'civicrm_custom_field',
356 'entity' => 'CustomField',
357 'bao' => 'CRM_Core_BAO_CustomField',
359 'pseudoconstant' => [
360 'callback' => 'CRM_Core_SelectValues::customHtmlType',
364 'name' => 'default_value',
365 'type' => CRM_Utils_Type
::T_STRING
,
366 'title' => ts('Custom Field Default'),
367 'description' => 'Use form_options.is_default for field_types which use options.',
369 'size' => CRM_Utils_Type
::HUGE
,
370 'table_name' => 'civicrm_custom_field',
371 'entity' => 'CustomField',
372 'bao' => 'CRM_Core_BAO_CustomField',
376 'name' => 'is_required',
377 'type' => CRM_Utils_Type
::T_BOOLEAN
,
378 'title' => ts('Custom Field Is Required?'),
379 'description' => 'Is a value required for this property.',
381 'table_name' => 'civicrm_custom_field',
382 'entity' => 'CustomField',
383 'bao' => 'CRM_Core_BAO_CustomField',
387 'name' => 'is_searchable',
388 'type' => CRM_Utils_Type
::T_BOOLEAN
,
389 'title' => ts('Allow Searching on Field?'),
390 'description' => 'Is this property searchable.',
392 'table_name' => 'civicrm_custom_field',
393 'entity' => 'CustomField',
394 'bao' => 'CRM_Core_BAO_CustomField',
397 'is_search_range' => [
398 'name' => 'is_search_range',
399 'type' => CRM_Utils_Type
::T_BOOLEAN
,
400 'title' => ts('Search as a Range'),
401 'description' => 'Is this property range searchable.',
403 'table_name' => 'civicrm_custom_field',
404 'entity' => 'CustomField',
405 'bao' => 'CRM_Core_BAO_CustomField',
410 'type' => CRM_Utils_Type
::T_INT
,
411 'title' => ts('Order'),
412 'description' => 'Controls field display order within an extended property group.',
415 'table_name' => 'civicrm_custom_field',
416 'entity' => 'CustomField',
417 'bao' => 'CRM_Core_BAO_CustomField',
421 'name' => 'help_pre',
422 'type' => CRM_Utils_Type
::T_TEXT
,
423 'title' => ts('Custom Field Pre Text'),
424 'description' => 'Description and/or help text to display before this field.',
425 'table_name' => 'civicrm_custom_field',
426 'entity' => 'CustomField',
427 'bao' => 'CRM_Core_BAO_CustomField',
431 'name' => 'help_post',
432 'type' => CRM_Utils_Type
::T_TEXT
,
433 'title' => ts('Custom Field Post Text'),
434 'description' => 'Description and/or help text to display after this field.',
435 'table_name' => 'civicrm_custom_field',
436 'entity' => 'CustomField',
437 'bao' => 'CRM_Core_BAO_CustomField',
442 'type' => CRM_Utils_Type
::T_STRING
,
443 'title' => ts('Custom Field Formatting'),
444 'description' => 'Optional format instructions for specific field types, like date types.',
446 'size' => CRM_Utils_Type
::BIG
,
447 'table_name' => 'civicrm_custom_field',
448 'entity' => 'CustomField',
449 'bao' => 'CRM_Core_BAO_CustomField',
453 'name' => 'attributes',
454 'type' => CRM_Utils_Type
::T_STRING
,
455 'title' => ts('Custom Field Attributes'),
456 'description' => 'Store collection of type-appropriate attributes, e.g. textarea needs rows/cols attributes',
458 'size' => CRM_Utils_Type
::HUGE
,
459 'table_name' => 'civicrm_custom_field',
460 'entity' => 'CustomField',
461 'bao' => 'CRM_Core_BAO_CustomField',
465 'name' => 'javascript',
466 'type' => CRM_Utils_Type
::T_STRING
,
467 'title' => ts('Custom Field Javascript'),
468 'description' => 'Optional scripting attributes for field.',
470 'size' => CRM_Utils_Type
::HUGE
,
471 'table_name' => 'civicrm_custom_field',
472 'entity' => 'CustomField',
473 'bao' => 'CRM_Core_BAO_CustomField',
477 'name' => 'is_active',
478 'type' => CRM_Utils_Type
::T_BOOLEAN
,
479 'title' => ts('Custom Field Is Active?'),
480 'description' => 'Is this property active?',
482 'table_name' => 'civicrm_custom_field',
483 'entity' => 'CustomField',
484 'bao' => 'CRM_Core_BAO_CustomField',
489 'type' => CRM_Utils_Type
::T_BOOLEAN
,
490 'title' => ts('Field is Viewable'),
491 'description' => 'Is this property set by PHP Code? A code field is viewable but not editable',
493 'table_name' => 'civicrm_custom_field',
494 'entity' => 'CustomField',
495 'bao' => 'CRM_Core_BAO_CustomField',
498 'options_per_line' => [
499 'name' => 'options_per_line',
500 'type' => CRM_Utils_Type
::T_INT
,
501 'title' => ts('Field Options Per Line'),
502 'description' => 'number of options per line for checkbox and radio',
503 'table_name' => 'civicrm_custom_field',
504 'entity' => 'CustomField',
505 'bao' => 'CRM_Core_BAO_CustomField',
509 'name' => 'text_length',
510 'type' => CRM_Utils_Type
::T_INT
,
511 'title' => ts('Field Length'),
512 'description' => 'field length if alphanumeric',
513 'table_name' => 'civicrm_custom_field',
514 'entity' => 'CustomField',
515 'bao' => 'CRM_Core_BAO_CustomField',
518 'start_date_years' => [
519 'name' => 'start_date_years',
520 'type' => CRM_Utils_Type
::T_INT
,
521 'title' => ts('Field Start Date'),
522 'description' => 'Date may be up to start_date_years years prior to the current date.',
523 'table_name' => 'civicrm_custom_field',
524 'entity' => 'CustomField',
525 'bao' => 'CRM_Core_BAO_CustomField',
528 'end_date_years' => [
529 'name' => 'end_date_years',
530 'type' => CRM_Utils_Type
::T_INT
,
531 'title' => ts('Field End Date'),
532 'description' => 'Date may be up to end_date_years years after the current date.',
533 'table_name' => 'civicrm_custom_field',
534 'entity' => 'CustomField',
535 'bao' => 'CRM_Core_BAO_CustomField',
539 'name' => 'date_format',
540 'type' => CRM_Utils_Type
::T_STRING
,
541 'title' => ts('Field Data Format'),
542 'description' => 'date format for custom date',
544 'size' => CRM_Utils_Type
::BIG
,
545 'table_name' => 'civicrm_custom_field',
546 'entity' => 'CustomField',
547 'bao' => 'CRM_Core_BAO_CustomField',
551 'name' => 'time_format',
552 'type' => CRM_Utils_Type
::T_INT
,
553 'title' => ts('Field Time Format'),
554 'description' => 'time format for custom date',
555 'table_name' => 'civicrm_custom_field',
556 'entity' => 'CustomField',
557 'bao' => 'CRM_Core_BAO_CustomField',
561 'name' => 'note_columns',
562 'type' => CRM_Utils_Type
::T_INT
,
563 'title' => ts('Field Note Columns'),
564 'description' => ' Number of columns in Note Field ',
565 'table_name' => 'civicrm_custom_field',
566 'entity' => 'CustomField',
567 'bao' => 'CRM_Core_BAO_CustomField',
571 'name' => 'note_rows',
572 'type' => CRM_Utils_Type
::T_INT
,
573 'title' => ts('Field Note Rows'),
574 'description' => ' Number of rows in Note Field ',
575 'table_name' => 'civicrm_custom_field',
576 'entity' => 'CustomField',
577 'bao' => 'CRM_Core_BAO_CustomField',
581 'name' => 'column_name',
582 'type' => CRM_Utils_Type
::T_STRING
,
583 'title' => ts('Field Column Name'),
584 'description' => 'Name of the column that holds the values for this field.',
586 'size' => CRM_Utils_Type
::HUGE
,
587 'table_name' => 'civicrm_custom_field',
588 'entity' => 'CustomField',
589 'bao' => 'CRM_Core_BAO_CustomField',
592 'option_group_id' => [
593 'name' => 'option_group_id',
594 'type' => CRM_Utils_Type
::T_INT
,
595 'title' => ts('Field Option Group'),
596 'description' => 'For elements with options, the option group id that is used',
597 'table_name' => 'civicrm_custom_field',
598 'entity' => 'CustomField',
599 'bao' => 'CRM_Core_BAO_CustomField',
601 'pseudoconstant' => [
602 'table' => 'civicrm_option_group',
604 'labelColumn' => 'title',
609 'type' => CRM_Utils_Type
::T_STRING
,
610 'title' => ts('Field Filter'),
611 'description' => 'Stores Contact Get API params contact reference custom fields. May be used for other filters in the future.',
613 'size' => CRM_Utils_Type
::HUGE
,
614 'table_name' => 'civicrm_custom_field',
615 'entity' => 'CustomField',
616 'bao' => 'CRM_Core_BAO_CustomField',
620 'name' => 'in_selector',
621 'type' => CRM_Utils_Type
::T_BOOLEAN
,
622 'title' => ts('Field Display'),
623 'description' => 'Should the multi-record custom field values be displayed in tab table listing',
625 'table_name' => 'civicrm_custom_field',
626 'entity' => 'CustomField',
627 'bao' => 'CRM_Core_BAO_CustomField',
631 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
633 return Civi
::$statics[__CLASS__
]['fields'];
637 * Return a mapping from field-name to the corresponding key (as used in fields()).
640 * Array(string $name => string $uniqueName).
642 public static function &fieldKeys() {
643 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
644 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
646 return Civi
::$statics[__CLASS__
]['fieldKeys'];
650 * Returns the names of this table
654 public static function getTableName() {
655 return CRM_Core_DAO
::getLocaleTableName(self
::$_tableName);
659 * Returns if this table needs to be logged
663 public function getLog() {
668 * Returns the list of fields that can be imported
670 * @param bool $prefix
674 public static function &import($prefix = FALSE) {
675 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'custom_field', $prefix, []);
680 * Returns the list of fields that can be exported
682 * @param bool $prefix
686 public static function &export($prefix = FALSE) {
687 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'custom_field', $prefix, []);
692 * Returns the list of indices
694 * @param bool $localize
698 public static function indices($localize = TRUE) {
700 'UI_label_custom_group_id' => [
701 'name' => 'UI_label_custom_group_id',
704 1 => 'custom_group_id',
706 'localizable' => TRUE,
708 'sig' => 'civicrm_custom_field::1::label::custom_group_id',
710 'UI_name_custom_group_id' => [
711 'name' => 'UI_name_custom_group_id',
714 1 => 'custom_group_id',
716 'localizable' => FALSE,
718 'sig' => 'civicrm_custom_field::1::name::custom_group_id',
721 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;