X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FDAO%2FCustomField.php;h=42f04e959fca5255f939669c642320d8a6b0cc9f;hb=bfd5da64bde46b359a0d9195c0a30364ff277f58;hp=e679adf27437df1463523a41bc8a2849414bacd4;hpb=13d421f615c01ef29ec1d5fc01805abcec00d25d;p=civicrm-core.git diff --git a/CRM/Core/DAO/CustomField.php b/CRM/Core/DAO/CustomField.php index e679adf274..42f04e959f 100644 --- a/CRM/Core/DAO/CustomField.php +++ b/CRM/Core/DAO/CustomField.php @@ -1,614 +1,658 @@ __table = 'civicrm_custom_field'; parent::__construct(); } + /** * Returns foreign keys and entity references. * * @return array * [CRM_Core_Reference_Interface] */ - static function getReferenceColumns() { + public static function getReferenceColumns() { 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(), 'custom_group_id', 'civicrm_custom_group', 'id'); CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); } return Civi::$statics[__CLASS__]['links']; } + /** * Returns all the column names of this table * * @return array */ - static function &fields() { + public static function &fields() { if (!isset(Civi::$statics[__CLASS__]['fields'])) { - Civi::$statics[__CLASS__]['fields'] = array( - 'id' => array( + Civi::$statics[__CLASS__]['fields'] = [ + 'id' => [ 'name' => 'id', 'type' => CRM_Utils_Type::T_INT, - 'title' => ts('Custom Field ID') , + 'title' => ts('Custom Field ID'), 'description' => 'Unique Custom Field ID', - 'required' => true, + 'required' => TRUE, 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'custom_group_id' => array( + 'localizable' => 0, + ], + 'custom_group_id' => [ 'name' => 'custom_group_id', 'type' => CRM_Utils_Type::T_INT, - 'title' => ts('Custom Group') , + 'title' => ts('Custom Group'), 'description' => 'FK to civicrm_custom_group.', - 'required' => true, + 'required' => TRUE, 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', + 'localizable' => 0, 'FKClassName' => 'CRM_Core_DAO_CustomGroup', - 'html' => array( + 'html' => [ 'type' => 'Select', - ) , - 'pseudoconstant' => array( + ], + 'pseudoconstant' => [ 'table' => 'civicrm_custom_group', 'keyColumn' => 'id', 'labelColumn' => 'title', - ) - ) , - 'name' => array( + ] + ], + 'name' => [ 'name' => 'name', 'type' => CRM_Utils_Type::T_STRING, - 'title' => ts('Custom Field Name') , + 'title' => ts('Custom Field Name'), 'description' => 'Variable name/programmatic handle for this group.', 'maxlength' => 64, 'size' => CRM_Utils_Type::BIG, 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'label' => array( + 'localizable' => 0, + ], + 'label' => [ 'name' => 'label', 'type' => CRM_Utils_Type::T_STRING, - 'title' => ts('Custom Field Label') , + 'title' => ts('Custom Field Label'), 'description' => 'Text for form field label (also friendly name for administering this custom property).', - 'required' => true, + 'required' => TRUE, 'maxlength' => 255, 'size' => CRM_Utils_Type::HUGE, 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'data_type' => array( + 'localizable' => 1, + ], + 'data_type' => [ 'name' => 'data_type', 'type' => CRM_Utils_Type::T_STRING, - 'title' => ts('Custom Field Data Type') , + 'title' => ts('Custom Field Data Type'), 'description' => 'Controls location of data storage in extended_data table.', - 'required' => true, + 'required' => TRUE, 'maxlength' => 16, 'size' => CRM_Utils_Type::TWELVE, 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - 'html' => array( + 'localizable' => 0, + 'html' => [ 'type' => 'Select', - ) , - 'pseudoconstant' => array( + ], + 'pseudoconstant' => [ 'callback' => 'CRM_Core_BAO_CustomField::dataType', - ) - ) , - 'html_type' => array( + ] + ], + 'html_type' => [ 'name' => 'html_type', 'type' => CRM_Utils_Type::T_STRING, - 'title' => ts('Custom Field HTML Type') , + 'title' => ts('Custom Field HTML Type'), 'description' => 'HTML types plus several built-in extended types.', - 'required' => true, + 'required' => TRUE, 'maxlength' => 32, 'size' => CRM_Utils_Type::MEDIUM, 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - 'pseudoconstant' => array( + 'localizable' => 0, + 'pseudoconstant' => [ 'callback' => 'CRM_Core_SelectValues::customHtmlType', - ) - ) , - 'default_value' => array( + ] + ], + 'default_value' => [ 'name' => 'default_value', 'type' => CRM_Utils_Type::T_STRING, - 'title' => ts('Custom Field Default') , + 'title' => ts('Custom Field Default'), 'description' => 'Use form_options.is_default for field_types which use options.', 'maxlength' => 255, 'size' => CRM_Utils_Type::HUGE, 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'is_required' => array( + 'localizable' => 0, + ], + 'is_required' => [ 'name' => 'is_required', 'type' => CRM_Utils_Type::T_BOOLEAN, - 'title' => ts('Custom Field Is Required?') , + 'title' => ts('Custom Field Is Required?'), 'description' => 'Is a value required for this property.', 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'is_searchable' => array( + 'localizable' => 0, + ], + 'is_searchable' => [ 'name' => 'is_searchable', 'type' => CRM_Utils_Type::T_BOOLEAN, - 'title' => ts('Allow Searching on Field?') , + 'title' => ts('Allow Searching on Field?'), 'description' => 'Is this property searchable.', 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'is_search_range' => array( + 'localizable' => 0, + ], + 'is_search_range' => [ 'name' => 'is_search_range', 'type' => CRM_Utils_Type::T_BOOLEAN, - 'title' => ts('Search as a Range') , + 'title' => ts('Search as a Range'), 'description' => 'Is this property range searchable.', 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'weight' => array( + 'localizable' => 0, + ], + 'weight' => [ 'name' => 'weight', 'type' => CRM_Utils_Type::T_INT, - 'title' => ts('Order') , + 'title' => ts('Order'), 'description' => 'Controls field display order within an extended property group.', - 'required' => true, + 'required' => TRUE, 'default' => '1', 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'help_pre' => array( + 'localizable' => 0, + ], + 'help_pre' => [ 'name' => 'help_pre', 'type' => CRM_Utils_Type::T_TEXT, - 'title' => ts('Custom Field Pre Text') , + 'title' => ts('Custom Field Pre Text'), 'description' => 'Description and/or help text to display before this field.', 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'help_post' => array( + 'localizable' => 1, + ], + 'help_post' => [ 'name' => 'help_post', 'type' => CRM_Utils_Type::T_TEXT, - 'title' => ts('Custom Field Post Text') , + 'title' => ts('Custom Field Post Text'), 'description' => 'Description and/or help text to display after this field.', 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'mask' => array( + 'localizable' => 1, + ], + 'mask' => [ 'name' => 'mask', 'type' => CRM_Utils_Type::T_STRING, - 'title' => ts('Custom Field Formatting') , + 'title' => ts('Custom Field Formatting'), 'description' => 'Optional format instructions for specific field types, like date types.', 'maxlength' => 64, 'size' => CRM_Utils_Type::BIG, 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'attributes' => array( + 'localizable' => 0, + ], + 'attributes' => [ 'name' => 'attributes', 'type' => CRM_Utils_Type::T_STRING, - 'title' => ts('Custom Field Attributes') , + 'title' => ts('Custom Field Attributes'), 'description' => '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', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'javascript' => array( + 'localizable' => 0, + ], + 'javascript' => [ 'name' => 'javascript', 'type' => CRM_Utils_Type::T_STRING, - 'title' => ts('Custom Field Javascript') , + 'title' => ts('Custom Field Javascript'), 'description' => 'Optional scripting attributes for field.', 'maxlength' => 255, 'size' => CRM_Utils_Type::HUGE, 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'is_active' => array( + 'localizable' => 0, + ], + 'is_active' => [ 'name' => 'is_active', 'type' => CRM_Utils_Type::T_BOOLEAN, - 'title' => ts('Custom Field Is Active?') , + 'title' => ts('Custom Field Is Active?'), 'description' => 'Is this property active?', 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'is_view' => array( + 'localizable' => 0, + ], + 'is_view' => [ 'name' => 'is_view', 'type' => CRM_Utils_Type::T_BOOLEAN, - 'title' => ts('Field is Viewable') , + 'title' => ts('Field is Viewable'), 'description' => 'Is this property set by PHP Code? A code field is viewable but not editable', 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'options_per_line' => array( + 'localizable' => 0, + ], + 'options_per_line' => [ 'name' => 'options_per_line', 'type' => CRM_Utils_Type::T_INT, - 'title' => ts('Field Options Per Line') , + 'title' => ts('Field Options Per Line'), 'description' => 'number of options per line for checkbox and radio', 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'text_length' => array( + 'localizable' => 0, + ], + 'text_length' => [ 'name' => 'text_length', 'type' => CRM_Utils_Type::T_INT, - 'title' => ts('Field Length') , + 'title' => ts('Field Length'), 'description' => 'field length if alphanumeric', 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'start_date_years' => array( + 'localizable' => 0, + ], + 'start_date_years' => [ 'name' => 'start_date_years', 'type' => CRM_Utils_Type::T_INT, - 'title' => ts('Field Start Date') , + 'title' => ts('Field Start Date'), 'description' => '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', - ) , - 'end_date_years' => array( + 'localizable' => 0, + ], + 'end_date_years' => [ 'name' => 'end_date_years', 'type' => CRM_Utils_Type::T_INT, - 'title' => ts('Field End Date') , + 'title' => ts('Field End Date'), 'description' => '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', - ) , - 'date_format' => array( + 'localizable' => 0, + ], + 'date_format' => [ 'name' => 'date_format', 'type' => CRM_Utils_Type::T_STRING, - 'title' => ts('Field Data Format') , + 'title' => ts('Field Data Format'), 'description' => 'date format for custom date', 'maxlength' => 64, 'size' => CRM_Utils_Type::BIG, 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'time_format' => array( + 'localizable' => 0, + ], + 'time_format' => [ 'name' => 'time_format', 'type' => CRM_Utils_Type::T_INT, - 'title' => ts('Field Time Format') , + 'title' => ts('Field Time Format'), 'description' => 'time format for custom date', 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'note_columns' => array( + 'localizable' => 0, + ], + 'note_columns' => [ 'name' => 'note_columns', 'type' => CRM_Utils_Type::T_INT, - 'title' => ts('Field Note Columns') , + 'title' => ts('Field Note Columns'), 'description' => ' Number of columns in Note Field ', 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'note_rows' => array( + 'localizable' => 0, + ], + 'note_rows' => [ 'name' => 'note_rows', 'type' => CRM_Utils_Type::T_INT, - 'title' => ts('Field Note Rows') , + 'title' => ts('Field Note Rows'), 'description' => ' Number of rows in Note Field ', 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'column_name' => array( + 'localizable' => 0, + ], + 'column_name' => [ 'name' => 'column_name', 'type' => CRM_Utils_Type::T_STRING, - 'title' => ts('Field Column Name') , + 'title' => ts('Field Column Name'), 'description' => 'Name of the column that holds the values for this field.', 'maxlength' => 255, 'size' => CRM_Utils_Type::HUGE, 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'option_group_id' => array( + 'localizable' => 0, + ], + 'option_group_id' => [ 'name' => 'option_group_id', 'type' => CRM_Utils_Type::T_INT, - 'title' => ts('Field Option Group') , + 'title' => ts('Field Option Group'), 'description' => 'For elements with options, the option group id that is used', 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'filter' => array( + 'localizable' => 0, + ], + 'filter' => [ 'name' => 'filter', 'type' => CRM_Utils_Type::T_STRING, - 'title' => ts('Field Filter') , + 'title' => ts('Field Filter'), 'description' => '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', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - 'in_selector' => array( + 'localizable' => 0, + ], + 'in_selector' => [ 'name' => 'in_selector', 'type' => CRM_Utils_Type::T_BOOLEAN, - 'title' => ts('Field Display') , + 'title' => ts('Field Display'), 'description' => 'Should the multi-record custom field values be displayed in tab table listing', 'table_name' => 'civicrm_custom_field', 'entity' => 'CustomField', 'bao' => 'CRM_Core_BAO_CustomField', - ) , - ); + 'localizable' => 0, + ], + ]; CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); } return Civi::$statics[__CLASS__]['fields']; } + /** * Return a mapping from field-name to the corresponding key (as used in fields()). * * @return array * Array(string $name => string $uniqueName). */ - static function &fieldKeys() { + public static function &fieldKeys() { if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); } return Civi::$statics[__CLASS__]['fieldKeys']; } + /** * Returns the names of this table * * @return string */ - static function getTableName() { + public static function getTableName() { return CRM_Core_DAO::getLocaleTableName(self::$_tableName); } + /** * Returns if this table needs to be logged * - * @return boolean + * @return bool */ - function getLog() { + public function getLog() { return self::$_log; } + /** * Returns the list of fields that can be imported * @@ -616,10 +660,11 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO { * * @return array */ - static function &import($prefix = false) { - $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'custom_field', $prefix, array()); + public static function &import($prefix = FALSE) { + $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'custom_field', $prefix, []); return $r; } + /** * Returns the list of fields that can be exported * @@ -627,8 +672,42 @@ class CRM_Core_DAO_CustomField extends CRM_Core_DAO { * * @return array */ - static function &export($prefix = false) { - $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'custom_field', $prefix, array()); + public static function &export($prefix = FALSE) { + $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'custom_field', $prefix, []); return $r; } + + /** + * Returns the list of indices + * + * @param bool $localize + * + * @return array + */ + public static function indices($localize = TRUE) { + $indices = [ + 'UI_label_custom_group_id' => [ + 'name' => 'UI_label_custom_group_id', + 'field' => [ + 0 => 'label', + 1 => 'custom_group_id', + ], + 'localizable' => TRUE, + 'unique' => TRUE, + 'sig' => 'civicrm_custom_field::1::label::custom_group_id', + ], + 'UI_name_custom_group_id' => [ + 'name' => 'UI_name_custom_group_id', + 'field' => [ + 0 => 'name', + 1 => 'custom_group_id', + ], + 'localizable' => FALSE, + 'unique' => TRUE, + 'sig' => 'civicrm_custom_field::1::name::custom_group_id', + ], + ]; + return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; + } + }