Merge pull request #12987 from eileenmcnaughton/strtolower_sort
[civicrm-core.git] / CRM / Core / DAO / CustomField.php
index 1f48b8858fb3a3370804f161dc5dc76ef471e021..98c1ae64d4cb3c0d7c760117227fe0205ddffe0a 100644 (file)
@@ -6,7 +6,7 @@
  *
  * Generated from xml/schema/CRM/Core/CustomField.xml
  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:dcb494bf3990ce63b66ef13ee47a2d15)
+ * (GenCodeChecksum:73d7ccebba6055cae4fa0c9d797025c4)
  */
 
 /**
@@ -256,6 +256,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
     if (!isset(Civi::$statics[__CLASS__]['links'])) {
       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'custom_group_id', 'civicrm_custom_group', 'id');
+      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'option_group_id', 'civicrm_option_group', 'id');
       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
     }
     return Civi::$statics[__CLASS__]['links'];
@@ -273,7 +274,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'id',
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Custom Field ID'),
-          'description' => 'Unique Custom Field ID',
+          'description' => ts('Unique Custom Field ID'),
           'required' => TRUE,
           'table_name' => 'civicrm_custom_field',
           'entity' => 'CustomField',
@@ -284,7 +285,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'custom_group_id',
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Custom Group'),
-          'description' => 'FK to civicrm_custom_group.',
+          'description' => ts('FK to civicrm_custom_group.'),
           'required' => TRUE,
           'table_name' => 'civicrm_custom_field',
           'entity' => 'CustomField',
@@ -304,7 +305,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'name',
           'type' => CRM_Utils_Type::T_STRING,
           'title' => ts('Custom Field Name'),
-          'description' => 'Variable name/programmatic handle for this group.',
+          'description' => ts('Variable name/programmatic handle for this group.'),
           'maxlength' => 64,
           'size' => CRM_Utils_Type::BIG,
           'table_name' => 'civicrm_custom_field',
@@ -316,7 +317,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'label',
           'type' => CRM_Utils_Type::T_STRING,
           'title' => ts('Custom Field Label'),
-          'description' => 'Text for form field label (also friendly name for administering this custom property).',
+          'description' => ts('Text for form field label (also friendly name for administering this custom property).'),
           'required' => TRUE,
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
@@ -329,7 +330,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'data_type',
           'type' => CRM_Utils_Type::T_STRING,
           'title' => ts('Custom Field Data Type'),
-          'description' => 'Controls location of data storage in extended_data table.',
+          'description' => ts('Controls location of data storage in extended_data table.'),
           'required' => TRUE,
           'maxlength' => 16,
           'size' => CRM_Utils_Type::TWELVE,
@@ -348,7 +349,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'html_type',
           'type' => CRM_Utils_Type::T_STRING,
           'title' => ts('Custom Field HTML Type'),
-          'description' => 'HTML types plus several built-in extended types.',
+          'description' => ts('HTML types plus several built-in extended types.'),
           'required' => TRUE,
           'maxlength' => 32,
           'size' => CRM_Utils_Type::MEDIUM,
@@ -364,7 +365,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'default_value',
           'type' => CRM_Utils_Type::T_STRING,
           'title' => ts('Custom Field Default'),
-          'description' => 'Use form_options.is_default for field_types which use options.',
+          'description' => ts('Use form_options.is_default for field_types which use options.'),
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
           'table_name' => 'civicrm_custom_field',
@@ -376,7 +377,8 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'is_required',
           'type' => CRM_Utils_Type::T_BOOLEAN,
           'title' => ts('Custom Field Is Required?'),
-          'description' => 'Is a value required for this property.',
+          'description' => ts('Is a value required for this property.'),
+          'default' => '0',
           'table_name' => 'civicrm_custom_field',
           'entity' => 'CustomField',
           'bao' => 'CRM_Core_BAO_CustomField',
@@ -386,7 +388,8 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'is_searchable',
           'type' => CRM_Utils_Type::T_BOOLEAN,
           'title' => ts('Allow Searching on Field?'),
-          'description' => 'Is this property searchable.',
+          'description' => ts('Is this property searchable.'),
+          'default' => '0',
           'table_name' => 'civicrm_custom_field',
           'entity' => 'CustomField',
           'bao' => 'CRM_Core_BAO_CustomField',
@@ -396,7 +399,8 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'is_search_range',
           'type' => CRM_Utils_Type::T_BOOLEAN,
           'title' => ts('Search as a Range'),
-          'description' => 'Is this property range searchable.',
+          'description' => ts('Is this property range searchable.'),
+          'default' => '0',
           'table_name' => 'civicrm_custom_field',
           'entity' => 'CustomField',
           'bao' => 'CRM_Core_BAO_CustomField',
@@ -406,7 +410,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'weight',
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Order'),
-          'description' => 'Controls field display order within an extended property group.',
+          'description' => ts('Controls field display order within an extended property group.'),
           'required' => TRUE,
           'default' => '1',
           'table_name' => 'civicrm_custom_field',
@@ -418,7 +422,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'help_pre',
           'type' => CRM_Utils_Type::T_TEXT,
           'title' => ts('Custom Field Pre Text'),
-          'description' => 'Description and/or help text to display before this field.',
+          'description' => ts('Description and/or help text to display before this field.'),
           'table_name' => 'civicrm_custom_field',
           'entity' => 'CustomField',
           'bao' => 'CRM_Core_BAO_CustomField',
@@ -428,7 +432,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'help_post',
           'type' => CRM_Utils_Type::T_TEXT,
           'title' => ts('Custom Field Post Text'),
-          'description' => 'Description and/or help text to display after this field.',
+          'description' => ts('Description and/or help text to display after this field.'),
           'table_name' => 'civicrm_custom_field',
           'entity' => 'CustomField',
           'bao' => 'CRM_Core_BAO_CustomField',
@@ -438,7 +442,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'mask',
           'type' => CRM_Utils_Type::T_STRING,
           'title' => ts('Custom Field Formatting'),
-          'description' => 'Optional format instructions for specific field types, like date types.',
+          'description' => ts('Optional format instructions for specific field types, like date types.'),
           'maxlength' => 64,
           'size' => CRM_Utils_Type::BIG,
           'table_name' => 'civicrm_custom_field',
@@ -450,7 +454,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'attributes',
           'type' => CRM_Utils_Type::T_STRING,
           'title' => ts('Custom Field Attributes'),
-          'description' => 'Store collection of type-appropriate attributes, e.g. textarea  needs rows/cols attributes',
+          'description' => ts('Store collection of type-appropriate attributes, e.g. textarea  needs rows/cols attributes'),
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
           'table_name' => 'civicrm_custom_field',
@@ -462,7 +466,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'javascript',
           'type' => CRM_Utils_Type::T_STRING,
           'title' => ts('Custom Field Javascript'),
-          'description' => 'Optional scripting attributes for field.',
+          'description' => ts('Optional scripting attributes for field.'),
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
           'table_name' => 'civicrm_custom_field',
@@ -474,7 +478,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'is_active',
           'type' => CRM_Utils_Type::T_BOOLEAN,
           'title' => ts('Custom Field Is Active?'),
-          'description' => 'Is this property active?',
+          'description' => ts('Is this property active?'),
           'default' => '1',
           'table_name' => 'civicrm_custom_field',
           'entity' => 'CustomField',
@@ -485,7 +489,8 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'is_view',
           'type' => CRM_Utils_Type::T_BOOLEAN,
           'title' => ts('Field is Viewable'),
-          'description' => 'Is this property set by PHP Code? A code field is viewable but not editable',
+          'description' => ts('Is this property set by PHP Code? A code field is viewable but not editable'),
+          'default' => '0',
           'table_name' => 'civicrm_custom_field',
           'entity' => 'CustomField',
           'bao' => 'CRM_Core_BAO_CustomField',
@@ -495,7 +500,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'options_per_line',
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Field Options Per Line'),
-          'description' => 'number of options per line for checkbox and radio',
+          'description' => ts('number of options per line for checkbox and radio'),
           'table_name' => 'civicrm_custom_field',
           'entity' => 'CustomField',
           'bao' => 'CRM_Core_BAO_CustomField',
@@ -505,7 +510,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'text_length',
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Field Length'),
-          'description' => 'field length if alphanumeric',
+          'description' => ts('field length if alphanumeric'),
           'table_name' => 'civicrm_custom_field',
           'entity' => 'CustomField',
           'bao' => 'CRM_Core_BAO_CustomField',
@@ -515,7 +520,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'start_date_years',
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Field Start Date'),
-          'description' => 'Date may be up to start_date_years years prior to the current date.',
+          'description' => ts('Date may be up to start_date_years years prior to the current date.'),
           'table_name' => 'civicrm_custom_field',
           'entity' => 'CustomField',
           'bao' => 'CRM_Core_BAO_CustomField',
@@ -525,7 +530,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'end_date_years',
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Field End Date'),
-          'description' => 'Date may be up to end_date_years years after the current date.',
+          'description' => ts('Date may be up to end_date_years years after the current date.'),
           'table_name' => 'civicrm_custom_field',
           'entity' => 'CustomField',
           'bao' => 'CRM_Core_BAO_CustomField',
@@ -535,7 +540,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'date_format',
           'type' => CRM_Utils_Type::T_STRING,
           'title' => ts('Field Data Format'),
-          'description' => 'date format for custom date',
+          'description' => ts('date format for custom date'),
           'maxlength' => 64,
           'size' => CRM_Utils_Type::BIG,
           'table_name' => 'civicrm_custom_field',
@@ -547,7 +552,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'time_format',
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Field Time Format'),
-          'description' => 'time format for custom date',
+          'description' => ts('time format for custom date'),
           'table_name' => 'civicrm_custom_field',
           'entity' => 'CustomField',
           'bao' => 'CRM_Core_BAO_CustomField',
@@ -557,7 +562,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'note_columns',
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Field Note Columns'),
-          'description' => ' Number of columns in Note Field ',
+          'description' => ts(' Number of columns in Note Field '),
           'table_name' => 'civicrm_custom_field',
           'entity' => 'CustomField',
           'bao' => 'CRM_Core_BAO_CustomField',
@@ -567,7 +572,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'note_rows',
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Field Note Rows'),
-          'description' => ' Number of rows in Note Field ',
+          'description' => ts(' Number of rows in Note Field '),
           'table_name' => 'civicrm_custom_field',
           'entity' => 'CustomField',
           'bao' => 'CRM_Core_BAO_CustomField',
@@ -577,7 +582,7 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'column_name',
           'type' => CRM_Utils_Type::T_STRING,
           'title' => ts('Field Column Name'),
-          'description' => 'Name of the column that holds the values for this field.',
+          'description' => ts('Name of the column that holds the values for this field.'),
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
           'table_name' => 'civicrm_custom_field',
@@ -589,17 +594,23 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'option_group_id',
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Field Option Group'),
-          'description' => 'For elements with options, the option group id that is used',
+          'description' => ts('For elements with options, the option group id that is used'),
           'table_name' => 'civicrm_custom_field',
           'entity' => 'CustomField',
           'bao' => 'CRM_Core_BAO_CustomField',
           'localizable' => 0,
+          'FKClassName' => 'CRM_Core_DAO_OptionGroup',
+          'pseudoconstant' => [
+            'table' => 'civicrm_option_group',
+            'keyColumn' => 'id',
+            'labelColumn' => 'title',
+          ]
         ],
         'filter' => [
           'name' => 'filter',
           'type' => CRM_Utils_Type::T_STRING,
           'title' => ts('Field Filter'),
-          'description' => 'Stores Contact Get API params contact reference custom fields. May be used for other filters in the future.',
+          'description' => ts('Stores Contact Get API params contact reference custom fields. May be used for other filters in the future.'),
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
           'table_name' => 'civicrm_custom_field',
@@ -611,7 +622,8 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO {
           'name' => 'in_selector',
           'type' => CRM_Utils_Type::T_BOOLEAN,
           'title' => ts('Field Display'),
-          'description' => 'Should the multi-record custom field values be displayed in tab table listing',
+          'description' => ts('Should the multi-record custom field values be displayed in tab table listing'),
+          'default' => '0',
           'table_name' => 'civicrm_custom_field',
           'entity' => 'CustomField',
           'bao' => 'CRM_Core_BAO_CustomField',