diff --git modules/field/modules/list/list.install modules/field/modules/list/list.install index 9ef563e..05518f3 100644 --- modules/field/modules/list/list.install +++ modules/field/modules/list/list.install @@ -20,7 +20,7 @@ function list_field_schema($field) { ), ); break; - case 'list_number': + case 'list_float': $columns = array( 'value' => array( 'type' => 'float', @@ -28,7 +28,8 @@ function list_field_schema($field) { ), ); break; - default: + case 'list_integer': + case 'list_boolean': $columns = array( 'value' => array( 'type' => 'int', @@ -43,4 +44,75 @@ function list_field_schema($field) { 'value' => array('value'), ), ); -} \ No newline at end of file +} + +/** + * Rename the list field types and change 'allowed_values' format. + */ +function list_update_7001() { + $fields = _update_7000_field_read_fields(array('module' => 'list')); + foreach ($fields as $field_name => $field) { + $update = array(); + + // Translate the old string format into the new array format. + $allowed_values = $field['settings']['allowed_values']; + if (is_string($allowed_values)) { + $position_keys = ($field['type'] == 'list'); + $allowed_values = _list_update_7001_extract_allowed_values($allowed_values, $position_keys); + + // Additionally, float keys need to be disambiguated ('.5' is '0.5'). + if ($field['type'] == 'list_number') { + $keys = array_map(create_function('$a', 'return (string) (float) $a;'), array_keys($allowed_values)); + $allowed_values = array_combine($keys, array_values($allowed_values)); + } + + // Place the new setting in the existing serialized 'data' column. + $data = db_query("SELECT data FROM {field_config} WHERE id = :id", array(':id' => $field['id']))->fetchField(); + $data = unserialize($data); + $data['settings']['allowed_values'] = $allowed_values; + $update['data'] = serialize($data); + } + + // Rename field types. + $types = array('list' => 'list_integer', 'list_number' => 'list_float'); + if (isset($types[$field['type']])) { + $update['type'] = $types[$field['type']]; + } + + // Save the new data. + if ($update) { + $query = db_update('field_config') + ->condition('id', $field['id']) + ->fields($update) + ->execute(); + } + } +} + +/** + * Helper function for list_update_7001: extract allowed values from a string. + * + * This reproduces the parsing logic in use before D7 RC2. + */ +function _list_update_7001_extract_allowed_values($string, $position_keys) { + $values = array(); + + $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); + } + // 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; + } + $values[$key] = (isset($value) && $value !== '') ? $value : $key; + } + + return $values; +} diff --git modules/field/modules/list/list.module modules/field/modules/list/list.module index cdfefab..25f9bad 100644 --- modules/field/modules/list/list.module +++ modules/field/modules/list/list.module @@ -24,95 +24,112 @@ function list_help($path, $arg) { */ function list_field_info() { return array( - 'list' => array( - 'label' => t('List'), - 'description' => t('This field stores numeric keys from key/value lists of allowed values where the key is a simple alias for the position of the value, i.e. 0|First option, 1|Second option, 2|Third option.'), - 'settings' => array('allowed_values' => '', 'allowed_values_function' => ''), + 'list_integer' => array( + 'label' => t('List (integer)'), + 'description' => t("This field stores integer values from a list of allowed 'value => label' pairs, i.e. 'Lifetime in days': 1 => 1 day, 7 => 1 week, 31 => 1 month."), + 'settings' => array('allowed_values' => array(), 'allowed_values_function' => ''), 'default_widget' => 'options_select', 'default_formatter' => 'list_default', ), - 'list_boolean' => array( - 'label' => t('Boolean'), - 'description' => t('This field stores simple on/off or yes/no options.'), - 'settings' => array('allowed_values' => '', 'allowed_values_function' => ''), - 'default_widget' => 'options_buttons', - 'default_formatter' => 'list_default', - ), - 'list_number' => array( - 'label' => t('List (numeric)'), - 'description' => t('This field stores keys from key/value lists of allowed numbers where the stored numeric key has significance and must be preserved, i.e. \'Lifetime in days\': 1|1 day, 7|1 week, 31|1 month.'), - 'settings' => array('allowed_values' => '', 'allowed_values_function' => ''), + 'list_float' => array( + 'label' => t('List (float)'), + 'description' => t("This field stores float values from a list of allowed 'value => label' pairs, i.e. 'Fraction': 0 => 0, .25 => 1/4, .75 => 3/4, 1 => 1."), + 'settings' => array('allowed_values' => array(), 'allowed_values_function' => ''), 'default_widget' => 'options_select', 'default_formatter' => 'list_default', ), 'list_text' => array( 'label' => t('List (text)'), - 'description' => t('This field stores keys from key/value lists of allowed values where the stored key has significance and must be a varchar, i.e. \'US States\': IL|Illinois, IA|Iowa, IN|Indiana'), - 'settings' => array('allowed_values' => '', 'allowed_values_function' => ''), + 'description' => t("This field stores text values from a list of allowed 'value => label' pairs, i.e. 'US States': IL => Illinois, IA => Iowa, IN => Indiana."), + 'settings' => array('allowed_values' => array(), 'allowed_values_function' => ''), 'default_widget' => 'options_select', 'default_formatter' => 'list_default', ), + 'list_boolean' => array( + 'label' => t('Boolean'), + 'description' => t('This field stores simple on/off or yes/no options.'), + 'settings' => array('allowed_values' => array(), 'allowed_values_function' => ''), + 'default_widget' => 'options_buttons', + 'default_formatter' => 'list_default', + ), ); } /** * Implements hook_field_settings_form(). - * - * @todo: If $has_data, add a form validate function to verify that the - * new allowed values do not exclude any keys for which data already - * exists in the field storage (use EntityFieldQuery to find out). - * Implement the validate function via hook_field_update_forbid() so - * list.module does not depend on form submission. */ function list_field_settings_form($field, $instance, $has_data) { $settings = $field['settings']; - $form['allowed_values'] = array( - '#type' => 'textarea', - '#title' => t('Allowed values list'), - '#default_value' => $settings['allowed_values'], - '#required' => FALSE, - '#rows' => 10, - '#description' => '

' . 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 .= '

'; + $form['allowed_values']['#description'] = $description; + + break; - if ($field['type'] == 'list_boolean') { - $values = list_extract_allowed_values($settings['allowed_values']); - $off_value = array_shift($values); - $on_value = array_shift($values); - $form['allowed_values'] = array( - '#type' => 'value', - '#description' => '', - '#value_callback' => 'list_boolean_allowed_values_callback', - '#access' => empty($settings['allowed_values_function']), - ); - $form['allowed_values']['on'] = array( - '#type' => 'textfield', - '#title' => t('On value'), - '#default_value' => $on_value, - '#required' => FALSE, - '#description' => t('If left empty, "1" will be used.'), - // Change #parents to make sure the element is not saved into field - // settings. - '#parents' => array('on'), - ); - $form['allowed_values']['off'] = array( - '#type' => 'textfield', - '#title' => t('Off value'), - '#default_value' => $off_value, - '#required' => FALSE, - '#description' => t('If left empty, "0" will be used.'), - // Change #parents to make sure the element is not saved into field - // settings. - '#parents' => array('off'), - ); - // Link the allowed value to the on / off elements to prepare for the rare - // case of an alter changing #parents. - $form['allowed_values']['#on_parents'] = &$form['allowed_values']['on']['#parents']; - $form['allowed_values']['#off_parents'] = &$form['allowed_values']['off']['#parents']; + case 'list_boolean': + $values = $settings['allowed_values']; + $off_value = array_shift($values); + $on_value = array_shift($values); + + $form['allowed_values'] = array( + '#type' => 'value', + '#description' => '', + '#value_callback' => 'list_boolean_allowed_values_callback', + '#access' => empty($settings['allowed_values_function']), + ); + $form['allowed_values']['on'] = array( + '#type' => 'textfield', + '#title' => t('On value'), + '#default_value' => $on_value, + '#required' => FALSE, + '#description' => t('If left empty, "1" will be used.'), + // Change #parents to make sure the element is not saved into field + // settings. + '#parents' => array('on'), + ); + $form['allowed_values']['off'] = array( + '#type' => 'textfield', + '#title' => t('Off value'), + '#default_value' => $off_value, + '#required' => FALSE, + '#description' => t('If left empty, "0" will be used.'), + // Change #parents to make sure the element is not saved into field + // settings. + '#parents' => array('off'), + ); + + // Link the allowed value to the on / off elements to prepare for the rare + // case of an alter changing #parents. + $form['allowed_values']['#on_parents'] = &$form['allowed_values']['on']['#parents']; + $form['allowed_values']['#off_parents'] = &$form['allowed_values']['off']['#parents']; + + break; } // Alter the description for allowed values depending on the widget type. @@ -122,7 +139,7 @@ function list_field_settings_form($field, $instance, $has_data) { elseif ($instance['widget']['type'] == 'options_buttons') { $form['allowed_values']['#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('Allowed values list: invalid input.')); + } + 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('Allowed values list: some 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,45 +246,128 @@ function list_allowed_values($field) { } /** - * Generates an array of values from a string. - * - * Explode a string with keys and labels separated with '|' and with each new - * value on its own line. + * Parses a string of 'allowed values' into an array. * - * @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 $position_keys + * @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 $generate_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, $generate_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. Detecting true integer + // strings takes a little trick. + 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 ($generate_keys) { + $key = (string) $position; + $value = $text; + $generated_keys = TRUE; + } + else { + return; } - // 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; + + // Float keys are represented as strings and need to be disambiguated + // ('.5' is '0.5'). + if ($field_type == 'list_float' && is_numeric($key)) { + $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; } /** + * 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(). * * Possible error codes: @@ -291,8 +407,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_integer', 'list_float', 'list_text'), + 'options_buttons' => array('list_integer', 'list_float', 'list_text', 'list_boolean'), 'options_onoff' => array('list_boolean'), ); @@ -315,11 +431,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_integer', 'list_float', 'list_text', 'list_boolean'), ), 'list_key' => array( 'label' => t('Key'), - 'field types' => array('list', 'list_boolean', 'list_text', 'list_number'), + 'field types' => array('list_integer', 'list_float', 'list_text', 'list_boolean'), ), ); } diff --git modules/field/modules/list/tests/list.test modules/field/modules/list/tests/list.test index da0ea82..92c2394 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, @@ -122,84 +122,237 @@ class ListFieldUITestCase extends FieldTestCase { $this->type = $type->type; // Store a valid URL name, with hyphens instead of underscores. $this->hyphen_type = str_replace('_', '-', $this->type); + } + + /** + * List (integer) : test 'allowed values' input. + */ + function testListAllowedValuesInteger() { + $this->field_name = 'field_list_integer'; + $this->createListField('list_integer'); + + // Flat list of textual values. + $string = "Zero\nOne"; + $array = array('0' => 'Zero', '1' => 'One'); + $this->assertAllowedValuesInput($string, $array, t('Unkeyed lists are accepted.')); + // Explicit integer keys. + $string = "0|Zero\n2|Two"; + $array = array('0' => 'Zero', '2' => 'Two'); + $this->assertAllowedValuesInput($string, $array, t('Integer keys are accepted.')); + // Check that values can be added and removed. + $string = "0|Zero\n1|One"; + $array = array('0' => 'Zero', '1' => 'One'); + $this->assertAllowedValuesInput($string, $array, t('Values can be added and removed.')); + // Non-integer keys. + $this->assertAllowedValuesInput("1.1|One", 'keys must be integers', t('Non integer keys are rejected.')); + $this->assertAllowedValuesInput("abc|abc", 'keys must be integers', t('Non integer keys are rejected.')); + // Mixed list of keyed and unkeyed values. + $this->assertAllowedValuesInput("Zero\n1|One", 'invalid input', t('Mixed lists are rejected.')); + + // Create a node with actual data for the field. + $settings = array( + 'type' => $this->type, + $this->field_name => array(LANGUAGE_NONE => array(array('value' => 1))), + ); + $node = $this->drupalCreateNode($settings); + + // Check that a flat list of values is rejected once the field has data. + $this->assertAllowedValuesInput( "Zero\nOne", 'invalid input', t('Unkeyed lists are rejected once the field has data.')); + + // Check that values can be added but values in use cannot be removed. + $string = "0|Zero\n1|One\n2|Two"; + $array = array('0' => 'Zero', '1' => 'One', '2' => 'Two'); + $this->assertAllowedValuesInput($string, $array, t('Values can be added.')); + $string = "0|Zero\n1|One"; + $array = array('0' => 'Zero', '1' => 'One'); + $this->assertAllowedValuesInput($string, $array, t('Values not in use can be removed.')); + $this->assertAllowedValuesInput("0|Zero", 'some values are being removed while currently in use', t('Values in use cannot be removed.')); + + // Delete the node, remove the value. + node_delete($node->nid); + $string = "0|Zero"; + $array = array('0' => 'Zero'); + $this->assertAllowedValuesInput($string, $array, t('Values not in use can be removed.')); + } + + /** + * List (float) : test 'allowed values' input. + */ + function testListAllowedValuesFloat() { + $this->field_name = 'field_list_float'; + $this->createListField('list_float'); + + // Flat list of textual values. + $string = "Zero\nOne"; + $array = array('0' => 'Zero', '1' => 'One'); + $this->assertAllowedValuesInput($string, $array, t('Unkeyed lists are accepted.')); + // Explicit numeric keys. + $string = "0|Zero\n.5|Point five"; + $array = array('0' => 'Zero', '0.5' => 'Point five'); + $this->assertAllowedValuesInput($string, $array, t('Integer keys are accepted.')); + // Check that values can be added and removed. + $string = "0|Zero\n.5|Point five\n1.0|One"; + $array = array('0' => 'Zero', '0.5' => 'Point five', '1' => 'One'); + $this->assertAllowedValuesInput($string, $array, t('Values can be added and removed.')); + // Non-numeric keys. + $this->assertAllowedValuesInput("abc|abc\n", 'each key must be a valid integer or decimal', t('Non numeric keys are rejected.')); + // Mixed list of keyed and unkeyed values. + $this->assertAllowedValuesInput("Zero\n1|One\n", 'invalid input', t('Mixed lists are rejected.')); + + // Create a node with actual data for the field. + $settings = array( + 'type' => $this->type, + $this->field_name => array(LANGUAGE_NONE => array(array('value' => .5))), + ); + $node = $this->drupalCreateNode($settings); + + // Check that a flat list of values is rejected once the field has data. + $this->assertAllowedValuesInput("Zero\nOne", 'invalid input', t('Unkeyed lists are rejected once the field has data.')); + + // Check that values can be added but values in use cannot be removed. + $string = "0|Zero\n.5|Point five\n2|Two"; + $array = array('0' => 'Zero', '0.5' => 'Point five', '2' => 'Two'); + $this->assertAllowedValuesInput($string, $array, t('Values can be added.')); + $string = "0|Zero\n.5|Point five"; + $array = array('0' => 'Zero', '0.5' => 'Point five'); + $this->assertAllowedValuesInput($string, $array, t('Values not in use can be removed.')); + $this->assertAllowedValuesInput("0|Zero", 'some values are being removed while currently in use', t('Values in use cannot be removed.')); - // Create random field name. - $this->field_label = $this->randomString(); - $this->field_name = strtolower($this->randomName()); + // Delete the node, remove the value. + node_delete($node->nid); + $string = "0|Zero"; + $array = array('0' => 'Zero'); + $this->assertAllowedValuesInput($string, $array, t('Values not in use can be removed.')); } /** - * Tests that allowed values are properly validated in the UI. + * List (text) : test 'allowed values' input. */ - function testAllowedValues() { - $element_name = "field[settings][allowed_values]"; - - // Test 'List' field type. - $admin_path = $this->createListFieldAndEdit('list'); - // 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'); - // Check that non-numeric keys are rejected. - $edit = array($element_name => "1|one\nB|two"); - $this->drupalPost($admin_path, $edit, t('Save settings')); - $this->assertText("each key must be a valid integer or decimal", t('Form validation failed.')); - - // Test 'List (text)' field type. - $admin_path = $this->createListFieldAndEdit('list_text'); - // Check that overly long keys are rejected. - $edit = array($element_name => "1|one\n" . $this->randomName(256) . "|two"); - $this->drupalPost($admin_path, $edit, t('Save settings')); - $this->assertText("each key must be a string at most 255 characters long", t('Form validation failed.')); - - // Test 'Boolean' field type. - $admin_path = $this->createListFieldAndEdit('list_boolean'); + function testListAllowedValuesText() { + $this->field_name = 'field_list_text'; + $this->createListField('list_text'); + + // Flat list of textual values. + $string = "Zero\nOne"; + $array = array('Zero' => 'Zero', 'One' => 'One'); + $this->assertAllowedValuesInput($string, $array, t('Unkeyed lists are accepted.')); + // Explicit keys. + $string = "zero|Zero\none|One"; + $array = array('zero' => 'Zero', 'one' => 'One'); + $this->assertAllowedValuesInput($string, $array, t('Explicit keys are accepted.')); + // Check that values can be added and removed. + $string = "zero|Zero\ntwo|Two"; + $array = array('zero' => 'Zero', 'two' => 'Two'); + $this->assertAllowedValuesInput($string, $array, t('Values can be added and removed.')); + // Mixed list of keyed and unkeyed values. + $string = "zero|Zero\nOne\n"; + $array = array('zero' => 'Zero', 'One' => 'One'); + $this->assertAllowedValuesInput($string, $array, t('Mixed lists are accepted.')); + // Overly long keys. + $this->assertAllowedValuesInput("zero|Zero\n" . $this->randomName(256) . "|One", 'each key must be a string at most 255 characters long', t('Overly long keys are rejected.')); + + // Create a node with actual data for the field. + $settings = array( + 'type' => $this->type, + $this->field_name => array(LANGUAGE_NONE => array(array('value' => 'One'))), + ); + $node = $this->drupalCreateNode($settings); + + // Check that flat lists of values are still accepted once the field has + // data. + $string = "Zero\nOne"; + $array = array('Zero' => 'Zero', 'One' => 'One'); + $this->assertAllowedValuesInput($string, $array, t('Unkeyed lists are still accepted once the field has data.')); + + // Check that values can be added but values in use cannot be removed. + $string = "Zero\nOne\nTwo"; + $array = array('Zero' => 'Zero', 'One' => 'One', 'Two' => 'Two'); + $this->assertAllowedValuesInput($string, $array, t('Values can be added.')); + $string = "Zero\nOne"; + $array = array('Zero' => 'Zero', 'One' => 'One'); + $this->assertAllowedValuesInput($string, $array, t('Values not in use can be removed.')); + $this->assertAllowedValuesInput("Zero", 'some values are being removed while currently in use', t('Values in use cannot be removed.')); + + // Delete the node, remove the value. + node_delete($node->nid); + $string = "Zero"; + $array = array('Zero' => 'Zero'); + $this->assertAllowedValuesInput($string, $array, t('Values not in use can be removed.')); + } + + /** + * List (boolen) : test 'On/Off' values input. + */ + function testListAllowedValuesBoolean() { + $this->field_name = 'field_list_boolean'; + $this->createListField('list_boolean'); + // 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, ); - $this->drupalPost($admin_path, $edit, t('Save settings')); - $this->assertText("Saved test_list_boolean configuration.", t("The 'On' and 'Off' form fields work for boolean fields.")); + $this->drupalPost($this->admin_path, $edit, t('Save settings')); + $this->assertText("Saved field_list_boolean configuration.", t("The 'On' and 'Off' form fields work for boolean fields.")); // Test the allowed_values on the field settings form. - $this->drupalGet($admin_path); + $this->drupalGet($this->admin_path); $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')); + $field = field_info_field($this->field_name); + $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')); } /** - * Helper function to create list field of a given type and get the edit page. + * Helper function to create list field of a given type. * * @param string $type - * 'list', 'list_boolean', 'list_number', or 'list_text' + * 'list_integer', 'list_float', 'list_text' or 'list_boolean' */ - protected function createListFieldAndEdit($type) { + protected function createListField($type) { // Create a test field and instance. - $field_name = 'test_' . $type; $field = array( - 'field_name' => $field_name, + 'field_name' => $this->field_name, 'type' => $type, ); field_create_field($field); - $this->field = $field; $instance = array( - 'field_name' => $field_name, + 'field_name' => $this->field_name, 'entity_type' => 'node', 'bundle' => $this->type, ); field_create_instance($instance); - $admin_path = 'admin/structure/types/manage/' . $this->hyphen_type . '/fields/' . $field_name; - return $admin_path; + $this->admin_path = 'admin/structure/types/manage/' . $this->hyphen_type . '/fields/' . $this->field_name; } + /** + * Tests a string input for the 'allowed values' form element. + * + * @param $input_string + * The input string, in the pipe-linefeed format expected by the form + * element. + * @param $result + * Either an expected resulting array in + * $field['settings']['allowed_values'], or an expected error message. + * @param $message + * Message to display. + */ + function assertAllowedValuesInput($input_string, $result, $message) { + $edit = array('field[settings][allowed_values]' => $input_string); + $this->drupalPost($this->admin_path, $edit, t('Save settings')); + + if (is_string($result)) { + $this->assertText($result, $message); + } + else { + field_info_cache_clear(); + $field = field_info_field($this->field_name); + $this->assertIdentical($field['settings']['allowed_values'], $result, $message); + } + } } diff --git modules/field/modules/options/options.test modules/field/modules/options/options.test index ab345f7..4696106 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'],