' . t('The possible values this field can contain. Enter one value per line, in the format key|label. The key is the value that will be stored in the database, and must be a %type value. The label is optional, and the key will be used as the label if no label is specified.', array('%type' => $field['type'] == 'list_text' ? t('text') : t('numeric'))) . '
', - '#element_validate' => array('list_allowed_values_setting_validate'), - '#list_field_type' => $field['type'], - '#access' => empty($settings['allowed_values_function']), - ); + switch ($field['type']) { + case 'list_integer': + case 'list_float': + case 'list_text': + $form['allowed_values'] = array( + '#type' => 'textarea', + '#title' => t('Allowed values list'), + '#default_value' => list_allowed_values_string($settings['allowed_values']), + '#rows' => 10, + '#element_validate' => array('list_allowed_values_setting_validate'), + '#field_has_data' => $has_data, + '#field' => $field, + '#field_type' => $field['type'], + '#access' => empty($settings['allowed_values_function']), + ); + + $description = '' . t('The possible values this field can contain. Enter one value per line, in the format key|label.');
+ if ($field['type'] == 'list_integer' || $field['type'] == 'list_float') {
+ $description .= '
' . t('The key is the stored value, and must be numeric. The label will be used in displayed values and edit forms.');
+ $description .= '
' . t('The label is optional: if a line contains a single number, it will be used as key and label.');
+ $description .= '
' . t('Lists of labels are also accepted (one label per line), only if the field does not hold any values yet. Numeric keys will be automatically generated from the positions in the list.');
+ }
+ else {
+ $description .= '
' . t('The key is the stored value. The label will be used in displayed values and edit forms.');
+ $description .= '
' . t('The label is optional: if a line contains a single string, it will be used as key and label.');
+ }
+ $description .= '
' . t("The 'checkboxes/radio buttons' widget will display checkboxes if the Number of values option is greater than 1 for this field, otherwise radios will be displayed.") . '
'; } - $form['allowed_values']['#description'] .= t('Allowed HTML tags in labels: @tags', array('@tags' => _field_filter_xss_display_allowed_tags())); + $form['allowed_values']['#description'] .= '' . t('Allowed HTML tags in labels: @tags', array('@tags' => _field_filter_xss_display_allowed_tags())) . '
'; $form['allowed_values_function'] = array( '#type' => 'value', @@ -142,23 +159,42 @@ function list_field_settings_form($field, $instance, $has_data) { * Element validate callback; check that the entered values are valid. */ function list_allowed_values_setting_validate($element, &$form_state) { - $values = list_extract_allowed_values($element['#value'], $element['#list_field_type'] == 'list'); - $field_type = $element['#list_field_type']; + $field = $element['#field']; + $has_data = $element['#field_has_data']; + $field_type = $field['type']; + $generate_keys = ($field_type == 'list_integer' || $field_type == 'list_float') && !$has_data; - // Check that keys are valid for the field type. - foreach ($values as $key => $value) { - if ($field_type == 'list_number' && !is_numeric($key)) { - form_error($element, t('Allowed values list: each key must be a valid integer or decimal.')); - break; - } - elseif ($field_type == 'list_text' && drupal_strlen($key) > 255) { - form_error($element, t('Allowed values list: each key must be a string at most 255 characters long.')); - break; + $values = list_extract_allowed_values($element['#value'], $field['type'], $generate_keys); + + if (!is_array($values)) { + form_error($element, t('Invalid input for the allowed values list.')); + } + else { + // Check that keys are valid for the field type. + foreach ($values as $key => $value) { + if ($field_type == 'list_integer' && !preg_match('/^-?\d+$/', $key)) { + form_error($element, t('Allowed values list: keys must be integers.')); + break; + } + if ($field_type == 'list_float' && !is_numeric($key)) { + form_error($element, t('Allowed values list: each key must be a valid integer or decimal.')); + break; + } + elseif ($field_type == 'list_text' && drupal_strlen($key) > 255) { + form_error($element, t('Allowed values list: each key must be a string at most 255 characters long.')); + break; + } } - elseif ($field_type == 'list' && !preg_match('/^-?\d+$/', $key)) { - form_error($element, t('Allowed values list: keys must be integers.')); - break; + + // Prevent removing values currently in use. + if ($has_data) { + $lost_keys = array_diff(array_keys($field['settings']['allowed_values']), array_keys($values)); + if (_list_values_in_use($field, $lost_keys)) { + form_error($element, t('Some allowed values are being removed while currently in use.')); + } } + + form_set_value($element, $values, $form_state); } } @@ -168,7 +204,7 @@ function list_allowed_values_setting_validate($element, &$form_state) { function list_boolean_allowed_values_callback($element, $input, $form_state) { $on = drupal_array_get_nested_value($form_state['input'], $element['#on_parents']); $off = drupal_array_get_nested_value($form_state['input'], $element['#off_parents']); - return "0|$off\n1|$on"; + return array($off, $on); } /** @@ -179,7 +215,7 @@ function list_field_update_field($field, $prior_field, $has_data) { } /** - * Returns the set of allowed values for a list field. + * Returns the array of allowed values for a list field. * * The strings are not safe for output. Keys and values of the array should be * sanitized through field_filter_xss() before being displayed. @@ -189,21 +225,18 @@ function list_field_update_field($field, $prior_field, $has_data) { * * @return * The array of allowed values. Keys of the array are the raw stored values - * (integer or text), values of the array are the display aliases. + * (number or text), values of the array are the display labels. */ function list_allowed_values($field) { $allowed_values = &drupal_static(__FUNCTION__, array()); if (!isset($allowed_values[$field['id']])) { - $values = array(); - $function = $field['settings']['allowed_values_function']; if (!empty($function) && function_exists($function)) { $values = $function($field); } - elseif (!empty($field['settings']['allowed_values'])) { - $position_keys = $field['type'] == 'list'; - $values = list_extract_allowed_values($field['settings']['allowed_values'], $position_keys); + else { + $values = $field['settings']['allowed_values']; } $allowed_values[$field['id']] = $values; @@ -213,44 +246,138 @@ function list_allowed_values($field) { } /** - * Generates an array of values from a string. + * Parses a string of 'allowed values' into an array. * - * Explode a string with keys and labels separated with '|' and with each new - * value on its own line. - * - * @param $string_values - * The list of choices as a string, in the format expected by the - * 'allowed_values' setting: - * - Values are separated by a carriage return. - * - Each value is in the format "value|label" or "value". + * @param $string + * The list of allowed values in string format descibed in + * list_allowed_values_string(). + * @param $field_type + * The field type. Either 'list_number' or 'list_text'. * @param $position_keys * Boolean value indicating whether to generate keys based on the position of - * the value if a key is not manually specified, effectively generating - * integer-based keys. This should only be TRUE for fields that have a type of - * "list". Otherwise the value will be used as the key if not specified. + * the value if a key is not manually specified, and if the value cannot be + * used as a key. This should only be TRUE for fields of type 'list_number'. + * + * @return + * The array of extracted key/value pairs, or NULL if the string is invalid. + * + * @see list_allowed_values_string() */ -function list_extract_allowed_values($string_values, $position_keys = FALSE) { +function list_extract_allowed_values($string, $field_type, $position_keys) { $values = array(); - $list = explode("\n", $string_values); + $list = explode("\n", $string); $list = array_map('trim', $list); $list = array_filter($list, 'strlen'); - foreach ($list as $key => $value) { - // Check for a manually specified key. - if (strpos($value, '|') !== FALSE) { - list($key, $value) = explode('|', $value); + + $generated_keys = $explicit_keys = FALSE; + foreach ($list as $position => $text) { + $value = $key = FALSE; + + // Check for an explicit key. + $matches = array(); + if (preg_match('/(.*)\|(.*)/', $text, $matches)) { + $key = $matches[1]; + $value = $matches[2]; + $explicit_keys = TRUE; + } + // Otherwise see if we can use the value as the key. + elseif ($field_type == 'list_text' + || ($field_type == 'list_float' && is_numeric($text)) + || ($field_type == 'list_integer' && is_numeric($text) && (float) $text == intval($text))) { + $key = $value = $text; + $explicit_keys = TRUE; + } + // Otherwise see if we can generate a key from the position. + elseif ($position_keys) { + $key = $position; + $value = $text; + $generated_keys = TRUE; } - // Otherwise see if we need to use the value as the key. The "list" type - // will automatically convert non-keyed lines to integers. - elseif (!$position_keys) { - $key = $value; + else { + return; + } + + // Float keys are represented as strings and need to be disambiguated + // ('.5' is '0.5'). + if ($field_type == 'list_float') { + $key = (string) (float) $key; } - $values[$key] = (isset($value) && $value !== '') ? $value : $key; + + $values[$key] = $value; + } + + // We generate keys only if the list contains no explicit key at all. + if ($explicit_keys && $generated_keys) { + return; } return $values; } +//function foo($a) {return ((float) $a) == intval($a); } +//$a = 'aa'; +//dsm(foo($a), $a); +//$a = '1.5'; +//dsm(foo($a), $a); +//$a = '1.0'; +//dsm(foo($a), $a); +//$a = '1'; +//dsm(foo($a), $a); +//$a = '0'; +//dsm(foo($a)); + +/** + * Generates a string representation of an array of 'allowed values'. + * + * This string format is suitable for edition in a textarea. + * + * @param $values + * An array of values, where array keys are values and array values are + * labels. + * + * @return + * The string representation of the $values array: + * - Values are separated by a carriage return. + * - Each value is in the format "value|label" or "value". + */ +function list_allowed_values_string($values) { + $lines = array(); + foreach ($values as $key => $value) { + $lines[] = "$key|$value"; + } + return implode("\n", $lines); +} + +/** + * Implements hook_field_update_forbid(). + */ +function list_field_update_forbid($field, $prior_field, $has_data) { + if ($field['module'] == 'list' && $has_data) { + // Forbid any update that removes allowed values with actual data. + $lost_keys = array_diff(array_keys($field['settings']['allowed_values']), array_keys($prior_field['settings']['allowed_values'])); + if (_list_values_in_use($field, $lost_keys)) { + throw new FieldUpdateForbiddenException(t('Cannot update a list field to not include keys with existing data.')); + } + } +} + +/** + * Checks if a list of values are being used in actual field values. + */ +function _list_values_in_use($field, $values) { + if ($values) { + $query = new EntityFieldQuery(); + $found = $query + ->fieldCondition($field['field_name'], 'value', $values) + ->range(0, 1) + ->execute(); + return !empty($found); + } + + return FALSE; +} + /** * Implements hook_field_validate(). * @@ -291,8 +418,8 @@ function list_field_is_empty($item, $field) { */ function list_field_widget_info_alter(&$info) { $widgets = array( - 'options_select' => array('list', 'list_text', 'list_number'), - 'options_buttons' => array('list', 'list_text', 'list_number', 'list_boolean'), + 'options_select' => array('list_text', 'list_number'), + 'options_buttons' => array('list_text', 'list_number', 'list_boolean'), 'options_onoff' => array('list_boolean'), ); @@ -315,11 +442,11 @@ function list_field_formatter_info() { return array( 'list_default' => array( 'label' => t('Default'), - 'field types' => array('list', 'list_boolean', 'list_text', 'list_number'), + 'field types' => array('list_boolean', 'list_text', 'list_number'), ), 'list_key' => array( 'label' => t('Key'), - 'field types' => array('list', 'list_boolean', 'list_text', 'list_number'), + 'field types' => array('list_boolean', 'list_text', 'list_number'), ), ); } diff --git modules/field/modules/list/tests/list.test modules/field/modules/list/tests/list.test index da0ea82..55f5a35 100644 --- modules/field/modules/list/tests/list.test +++ modules/field/modules/list/tests/list.test @@ -24,10 +24,10 @@ class ListFieldTestCase extends FieldTestCase { $this->field_name = 'test_list'; $this->field = array( 'field_name' => $this->field_name, - 'type' => 'list', + 'type' => 'list_integer', 'cardinality' => 1, 'settings' => array( - 'allowed_values' => "1|One\n2|Two\n3|Three\n", + 'allowed_values' => array(1 => 'One', 2 => 'Two', 3 => 'Three'), ), ); $this->field = field_create_field($this->field); @@ -57,7 +57,7 @@ class ListFieldTestCase extends FieldTestCase { $this->assertTrue(!empty($form[$this->field_name][$langcode][3]), t('Option 3 exists')); // Removed options do not appear. - $this->field['settings']['allowed_values'] = "2|Two"; + $this->field['settings']['allowed_values'] = array(2 => 'Two'); field_update_field($this->field); $entity = field_test_create_stub_entity(); $form = drupal_get_form('field_test_entity_form', $entity); @@ -66,7 +66,7 @@ class ListFieldTestCase extends FieldTestCase { $this->assertTrue(empty($form[$this->field_name][$langcode][3]), t('Option 3 does not exist')); // Completely new options appear. - $this->field['settings']['allowed_values'] = "10|Update\n20|Twenty"; + $this->field['settings']['allowed_values'] = array(10 => 'Update', 20 => 'Twenty'); field_update_field($this->field); $form = drupal_get_form('field_test_entity_form', $entity); $this->assertTrue(empty($form[$this->field_name][$langcode][1]), t('Option 1 does not exist')); @@ -78,7 +78,7 @@ class ListFieldTestCase extends FieldTestCase { // Options are reset when a new field with the same name is created. field_delete_field($this->field_name); unset($this->field['id']); - $this->field['settings']['allowed_values'] = "1|One\n2|Two\n3|Three\n"; + $this->field['settings']['allowed_values'] = array(1 => 'One', 2 => 'Two', 3 => 'Three'); $this->field = field_create_field($this->field); $this->instance = array( 'field_name' => $this->field_name, @@ -134,15 +134,15 @@ class ListFieldUITestCase extends FieldTestCase { function testAllowedValues() { $element_name = "field[settings][allowed_values]"; - // Test 'List' field type. - $admin_path = $this->createListFieldAndEdit('list'); + // Test 'List (integer)' field type. + $admin_path = $this->createListFieldAndEdit('list_integer'); // Check that non-integer keys are rejected. $edit = array($element_name => "1.1|one\n"); $this->drupalPost($admin_path, $edit, t('Save settings')); $this->assertText("keys must be integers", t('Form validation failed.')); - // Test 'List (number)' field type. - $admin_path = $this->createListFieldAndEdit('list_number'); + // Test 'List (float)' field type. + $admin_path = $this->createListFieldAndEdit('list_float'); // Check that non-numeric keys are rejected. $edit = array($element_name => "1|one\nB|two"); $this->drupalPost($admin_path, $edit, t('Save settings')); @@ -160,6 +160,7 @@ class ListFieldUITestCase extends FieldTestCase { // Check that the seperate 'On' and 'Off' form fields work. $on = $this->randomName(); $off = $this->randomName(); + $allowed_values = array(1 => $on, 0 => $off); $edit = array( 'on' => $on, 'off' => $off, @@ -171,7 +172,7 @@ class ListFieldUITestCase extends FieldTestCase { $this->assertFieldByName('on', $on, t("The 'On' value is stored correctly.")); $this->assertFieldByName('off', $off, t("The 'Off' value is stored correctly.")); $field = field_info_field($this->field['field_name']); - $this->assertEqual($field['settings']['allowed_values'], "0|$off\n1|$on", t('The allowed value is correct')); + $this->assertEqual($field['settings']['allowed_values'], $allowed_values, t('The allowed value is correct')); $this->assertFalse(isset($field['settings']['on']), t('The on value is not saved into settings')); $this->assertFalse(isset($field['settings']['off']), t('The off value is not saved into settings')); } @@ -180,7 +181,7 @@ class ListFieldUITestCase extends FieldTestCase { * Helper function to create list field of a given type and get the edit page. * * @param string $type - * 'list', 'list_boolean', 'list_number', or 'list_text' + * 'list_integer', 'list_float', 'list_text' or 'list_boolean' */ protected function createListFieldAndEdit($type) { // Create a test field and instance. diff --git modules/field/modules/options/options.test modules/field/modules/options/options.test index 78a3bd7..9aa4b20 100644 --- modules/field/modules/options/options.test +++ modules/field/modules/options/options.test @@ -16,11 +16,11 @@ class OptionsWidgetsTestCase extends FieldTestCase { // Field with cardinality 1. $this->card_1 = array( 'field_name' => 'card_1', - 'type' => 'list', + 'type' => 'list_integer', 'cardinality' => 1, 'settings' => array( // Make sure that 0 works as an option. - 'allowed_values' => "0|Zero\n1|One\n2|Some & unescaped markup\n", + 'allowed_values' => array(0 => 'Zero', 1 => 'One', 2 => 'Some & unescaped markup'), ), ); $this->card_1 = field_create_field($this->card_1); @@ -28,11 +28,11 @@ class OptionsWidgetsTestCase extends FieldTestCase { // Field with cardinality 2. $this->card_2 = array( 'field_name' => 'card_2', - 'type' => 'list', + 'type' => 'list_integer', 'cardinality' => 2, 'settings' => array( // Make sure that 0 works as an option. - 'allowed_values' => "0|Zero\n1|One\n2|Some & unescaped markup\n", + 'allowed_values' => array(0 => 'Zero', 1 => 'One', 2 => 'Some & unescaped markup'), ), ); $this->card_2 = field_create_field($this->card_2); @@ -44,7 +44,7 @@ class OptionsWidgetsTestCase extends FieldTestCase { 'cardinality' => 1, 'settings' => array( // Make sure that 0 works as a 'on' value'. - 'allowed_values' => "1|No\n0|Some & unescaped markup\n", + 'allowed_values' => array(1 => 'Zero', 0 => 'Some & unescaped markup'), ), ); $this->bool = field_create_field($this->bool); @@ -100,7 +100,7 @@ class OptionsWidgetsTestCase extends FieldTestCase { $this->assertFieldValues($entity_init, 'card_1', $langcode, array()); // Check that required radios with one option is auto-selected. - $this->card_1['settings']['allowed_values'] = '99|Only allowed value'; + $this->card_1['settings']['allowed_values'] = array(99 => 'Only allowed value'); field_update_field($this->card_1); $instance['required'] = TRUE; field_update_instance($instance); @@ -187,7 +187,7 @@ class OptionsWidgetsTestCase extends FieldTestCase { $this->assertFieldValues($entity_init, 'card_2', $langcode, array()); // Required checkbox with one option is auto-selected. - $this->card_2['settings']['allowed_values'] = '99|Only allowed value'; + $this->card_2['settings']['allowed_values'] = array(99 => 'Only allowed value'); field_update_field($this->card_2); $instance['required'] = TRUE; field_update_instance($instance); @@ -263,7 +263,7 @@ class OptionsWidgetsTestCase extends FieldTestCase { // Test optgroups. - $this->card_1['settings']['allowed_values'] = NULL; + $this->card_1['settings']['allowed_values'] = array(); $this->card_1['settings']['allowed_values_function'] = 'list_test_allowed_values_callback'; field_update_field($this->card_1); @@ -378,7 +378,7 @@ class OptionsWidgetsTestCase extends FieldTestCase { // Test optgroups. // Use a callback function defining optgroups. - $this->card_2['settings']['allowed_values'] = NULL; + $this->card_2['settings']['allowed_values'] = array(); $this->card_2['settings']['allowed_values_function'] = 'list_test_allowed_values_callback'; field_update_field($this->card_2); $instance['required'] = FALSE; @@ -460,7 +460,7 @@ class OptionsWidgetsTestCase extends FieldTestCase { // Create a test field instance. $fieldUpdate = $this->bool; - $fieldUpdate['settings']['allowed_values'] = "0|0\n1|MyOnValue"; + $fieldUpdate['settings']['allowed_values'] = array(0 => 0, 1 => 'MyOnValue'); field_update_field($fieldUpdate); $instance = array( 'field_name' => $this->bool['field_name'],