' . t('The possible values this field can contain. Enter one value per line, in the format key|label.');
+ $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.');
+ $description .= '
' . t('Allowed HTML tags in labels: @tags', array('@tags' => _field_filter_xss_display_allowed_tags())) . '
'; + return $description; + } + + /** + * {@inheritdoc} + */ + protected static function validateAllowedValue($option) { + if (!is_numeric($option)) { + return t('Allowed values list: each key must be a valid integer or decimal.'); + } + else { + return NULL; + } + } + + /** + * {@inheritdoc} + */ + protected static function validateOptionValue($value) { + return is_numeric($value); + } + + /** + * {@inheritdoc} + */ + protected static function allowedValueAlter($value) { + // Float keys are represented as strings and need to be disambiguated + // ('.5' is '0.5'). + if (is_numeric($value)) { + $value = (string) (float) $value; + } + return $value; + } + } diff --git a/core/modules/options/lib/Drupal/options/Plugin/Field/FieldType/ListIntegerItem.php b/core/modules/options/lib/Drupal/options/Plugin/Field/FieldType/ListIntegerItem.php index 9c6e7d7..c0be5c7 100644 --- a/core/modules/options/lib/Drupal/options/Plugin/Field/FieldType/ListIntegerItem.php +++ b/core/modules/options/lib/Drupal/options/Plugin/Field/FieldType/ListIntegerItem.php @@ -26,7 +26,7 @@ * } * ) */ -class ListIntegerItem extends ListItemBase { +class ListIntegerItem extends ListMultipleItemBase { /** * Definitions of the contained properties. @@ -39,13 +39,16 @@ class ListIntegerItem extends ListItemBase { * {@inheritdoc} */ public static function schema(FieldDefinitionInterface $field_definition) { - return parent::schema($field_definition) + array( - 'columns' => array( - 'value' => array( - 'type' => 'int', - 'not null' => FALSE, - ), - ), + return array( + 'columns' => array( + 'value' => array( + 'type' => 'int', + 'not null' => FALSE, + ), + ), + 'indexes' => array( + 'value' => array('value'), + ), ); } @@ -60,4 +63,37 @@ public function getPropertyDefinitions() { return static::$propertyDefinitions; } + /** + * {@inheritdoc} + */ + protected function settingsFormDescription() { + $description = '' . t('The possible values this field can contain. Enter one value per line, in the format key|label.');
+ $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.');
+ $description .= '
' . t('Allowed HTML tags in labels: @tags', array('@tags' => _field_filter_xss_display_allowed_tags())) . '
'; + return $description; + } + + /** + * {@inheritdoc} + */ + protected static function validateAllowedValue($option) { + if (!preg_match('/^-?\d+$/', $option)) { + return t('Allowed values list: keys must be integers.'); + } + else { + return NULL; + } + } + + /** + * {@inheritdoc} + */ + protected static function validateOptionValue($value) { + // Detecting true integer strings takes a little trick. + return is_numeric($value) && (float) $value == intval($value); + } + } diff --git a/core/modules/options/lib/Drupal/options/Plugin/Field/FieldType/ListItemBase.php b/core/modules/options/lib/Drupal/options/Plugin/Field/FieldType/ListItemBase.php index bd89bb6..eb024b1 100644 --- a/core/modules/options/lib/Drupal/options/Plugin/Field/FieldType/ListItemBase.php +++ b/core/modules/options/lib/Drupal/options/Plugin/Field/FieldType/ListItemBase.php @@ -7,7 +7,6 @@ namespace Drupal\options\Plugin\Field\FieldType; -use Drupal\Core\Field\FieldDefinitionInterface; use Drupal\Core\Field\ConfigFieldItemBase; use Drupal\Core\Session\AccountInterface; use Drupal\Core\TypedData\AllowedValuesInterface; @@ -55,255 +54,8 @@ public function getSettableOptions(AccountInterface $account = NULL) { /** * {@inheritdoc} */ - public static function schema(FieldDefinitionInterface $field_definition) { - return array( - 'indexes' => array( - 'value' => array('value'), - ), - ); - } - - /** - * {@inheritdoc} - */ - public function settingsForm(array $form, array &$form_state, $has_data) { - // @todo Move type-specific logic to the type-specific subclass: - // https://drupal.org/node/2169983. - $field_type = $this->getFieldDefinition()->getType(); - - $allowed_values = $this->getFieldSetting('allowed_values'); - $allowed_values_function = $this->getFieldSetting('allowed_values_function'); - - if (in_array($field_type, array('list_integer', 'list_float', 'list_text'))) { - $element['allowed_values'] = array( - '#type' => 'textarea', - '#title' => t('Allowed values list'), - '#default_value' => $this->allowedValuesString($allowed_values), - '#rows' => 10, - '#element_validate' => array(array($this, 'validateAllowedValues')), - '#field_has_data' => $has_data, - '#access' => empty($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("For a 'single on/off checkbox' widget, define the 'off' value first, then the 'on' value in the Allowed values section. Note that the checkbox will be labeled with the label of the 'on' value.") . '
'; - } - - $element['allowed_values']['#description'] .= '' . t('Allowed HTML tags in labels: @tags', array('@tags' => _field_filter_xss_display_allowed_tags())) . '
'; - - $element['allowed_values_function'] = array( - '#type' => 'item', - '#title' => t('Allowed values list'), - '#markup' => t('The value of this field is being determined by the %function function and may not be changed.', array('%function' => $allowed_values_function)), - '#access' => !empty($allowed_values_function), - '#value' => $allowed_values_function, - ); - - return $element; - } - - /** - * Generates a string representation of an array of 'allowed values'. - * - * This string format is suitable for edition in a textarea. - * - * @param array $values - * An array of values, where array keys are values and array values are - * labels. - * - * @return string - * The string representation of the $values array: - * - Values are separated by a carriage return. - * - Each value is in the format "value|label" or "value". - */ - protected function allowedValuesString($values) { - $lines = array(); - foreach ($values as $key => $value) { - $lines[] = "$key|$value"; - } - return implode("\n", $lines); - } - - /** - * Element validate callback; check that the entered values are valid. - */ - public function validateAllowedValues($element, &$form_state) { - // @todo Move type-specific logic to the type-specific subclass: - // https://drupal.org/node/2169983. - $field_type = $this->getFieldDefinition()->getType(); - - $has_data = $element['#field_has_data']; - $generate_keys = ($field_type == 'list_integer' || $field_type == 'list_float') && !$has_data; - - $values = $this->extractAllowedValues($element['#value'], $generate_keys); - - if (!is_array($values)) { - \Drupal::formBuilder()->setError($element, $form_state, 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)) { - \Drupal::formBuilder()->setError($element, $form_state, t('Allowed values list: keys must be integers.')); - break; - } - if ($field_type == 'list_float' && !is_numeric($key)) { - \Drupal::formBuilder()->setError($element, $form_state, t('Allowed values list: each key must be a valid integer or decimal.')); - break; - } - elseif ($field_type == 'list_text' && drupal_strlen($key) > 255) { - \Drupal::formBuilder()->setError($element, $form_state, t('Allowed values list: each key must be a string at most 255 characters long.')); - break; - } - } - - // Prevent removing values currently in use. - if ($has_data) { - $lost_keys = array_diff(array_keys($this->getFieldSetting('allowed_values')), array_keys($values)); - if (_options_values_in_use($this->getEntity()->getEntityTypeId(), $this->getFieldDefinition()->getName(), $lost_keys)) { - \Drupal::formBuilder()->setError($element, $form_state, t('Allowed values list: some values are being removed while currently in use.')); - } - } - - form_set_value($element, $values, $form_state); - } - } - - /** - * Parses a string of 'allowed values' into an array. - * - * @param string $string - * The list of allowed values in string format described in - * \Drupal\options\Plugin\Field\FieldType\ListItemBase::allowedValuesString(). - * @param bool $generate_keys - * Boolean value indicating whether to generate keys based on the position - * of 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 array - * The array of extracted key/value pairs, or NULL if the string is invalid. - * - * @see \Drupal\options\Plugin\Field\FieldType\ListItemBase::allowedValuesString() - */ - protected function extractAllowedValues($string, $generate_keys) { - // @todo Move type-specific logic to the type-specific subclass: - // https://drupal.org/node/2169983. - $field_type = $this->getFieldDefinition()->getType(); - - $values = array(); - - $list = explode("\n", $string); - $list = array_map('trim', $list); - $list = array_filter($list, 'strlen'); - - $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)) { - // Trim key and value to avoid unwanted spaces issues. - $key = trim($matches[1]); - $value = trim($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; - } - - // 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] = $value; - } - - // We generate keys only if the list contains no explicit key at all. - if ($explicit_keys && $generated_keys) { - return; - } - - return $values; - } - - /** - * {@inheritdoc} - */ public function isEmpty() { - $value = $this->get('value')->getValue(); - return empty($value) && (string) $value !== '0'; + return empty($this->value) && (string) $this->value !== '0'; } } diff --git a/core/modules/options/lib/Drupal/options/Plugin/Field/FieldType/ListMultipleItemBase.php b/core/modules/options/lib/Drupal/options/Plugin/Field/FieldType/ListMultipleItemBase.php new file mode 100644 index 0000000..4764089 --- /dev/null +++ b/core/modules/options/lib/Drupal/options/Plugin/Field/FieldType/ListMultipleItemBase.php @@ -0,0 +1,211 @@ +getFieldSetting('allowed_values'); + $allowed_values_function = $this->getFieldSetting('allowed_values_function'); + + $element['allowed_values'] = array( + '#type' => 'textarea', + '#title' => t('Allowed values list'), + '#default_value' => $this->allowedValuesString($allowed_values), + '#rows' => 10, + '#access' => empty($allowed_values_function), + '#element_validate' => array(array(get_class($this), 'validateAllowedValues')), + '#field_has_data' => $has_data, + '#field_name' => $this->getFieldDefinition()->getName(), + '#entity_type' => $this->getEntity()->getEntityTypeId(), + '#allowed_values' => $this->getFieldSetting('allowed_values'), + ); + + $element['allowed_values']['#description'] = $this->settingsFormDescription(); + + $element['allowed_values_function'] = array( + '#type' => 'item', + '#title' => t('Allowed values list'), + '#markup' => t('The value of this field is being determined by the %function function and may not be changed.', array('%function' => $allowed_values_function)), + '#access' => !empty($allowed_values_function), + '#value' => $allowed_values_function, + ); + + return $element; + } + + /** + * Provides the field type specific settings form element #description. + * + * @return string + * The field type settings form specific description. + */ + abstract protected function settingsFormDescription(); + + /** + * #element_validate callback for options field allowed values. + * + * @param $element + * An associative array containing the properties and children of the + * generic form element. + * @param $form_state + * The $form_state array for the form this element belongs to. + * + * @see form_process_pattern() + */ + public static function validateAllowedValues($element, &$form_state) { + $values = static::extractAllowedValues($element['#value'], $element['#field_has_data']); + + if (!is_array($values)) { + \Drupal::formBuilder()->setError($element, $form_state, t('Allowed values list: invalid input.')); + } + else { + // Check that keys are valid for the field type. + foreach ($values as $key => $value) { + if ($error = static::validateAllowedValue($key)) { + \Drupal::formBuilder()->setError($element, $form_state, $error); + break; + } + } + + // Prevent removing values currently in use. + if ($element['#field_has_data']) { + $lost_keys = array_diff(array_keys($element['#allowed_values']), array_keys($values)); + if (_options_values_in_use($element['#entity_type'], $element['#field_name'], $lost_keys)) { + \Drupal::formBuilder()->setError($element, $form_state, t('Allowed values list: some values are being removed while currently in use.')); + } + } + + \Drupal::formBuilder()->setValue($element, $values, $form_state); + } + } + + /** + * Extracts the allowed values array from the allowed_values element. + * + * @param string $string + * The raw string to extract values from. + * @param bool $has_data + * The current field already has data inserted or not. + * + * @return array + * The array of extracted key/value pairs, or NULL if the string is invalid. + * + * @see \Drupal\options\Plugin\Field\FieldType\ListTextItem::allowedValuesString() + */ + protected static function extractAllowedValues($string, $has_data) { + $values = array(); + + $list = explode("\n", $string); + $list = array_map('trim', $list); + $list = array_filter($list, 'strlen'); + + $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)) { + // Trim key and value to avoid unwanted spaces issues. + $key = trim($matches[1]); + $value = trim($matches[2]); + $explicit_keys = TRUE; + } + // Otherwise see if we can use the value as the key. + elseif (static::validateOptionValue($text)) { + $key = $value = $text; + $explicit_keys = TRUE; + } + // Otherwise see if we can generate a key from the position. + elseif (!$has_data) { + $key = (string) $position; + $value = $text; + $generated_keys = TRUE; + } + else { + return; + } + + $key = static::allowedValueAlter($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; + } + + /** + * Validates if the entry is a valid option. + * + * @param string $value + * The option entered by the user. + * @return bool + * TRUE if the entry is a valid option, FALSE otherwise. + */ + protected static function validateOptionValue($value) { + return TRUE; + } + + /** + * Processes the option value to store it properly. + * + * @param string $value + * The option value entered by the user. + * @return string + * The processed option value. + */ + protected static function allowedValueAlter($value) { + return $value; + } + + /** + * Checks whether a candidate allowed value is valid. + * + * @param string $option + * The option value entered by the user. + * + * @return string + * The error message if the specified value is invalid, NULL otherwise. + */ + protected static function validateAllowedValue($option) { } + + /** + * Generates a string representation of an array of 'allowed values'. + * + * This string format is suitable for edition in a textarea. + * + * @param array $values + * An array of values, where array keys are values and array values are + * labels. + * + * @return string + * The string representation of the $values array: + * - Values are separated by a carriage return. + * - Each value is in the format "value|label" or "value". + */ + protected function allowedValuesString($values) { + $lines = array(); + foreach ($values as $key => $value) { + $lines[] = "$key|$value"; + } + return implode("\n", $lines); + } + +} diff --git a/core/modules/options/lib/Drupal/options/Plugin/Field/FieldType/ListTextItem.php b/core/modules/options/lib/Drupal/options/Plugin/Field/FieldType/ListTextItem.php index 1e27eac..67cebd7 100644 --- a/core/modules/options/lib/Drupal/options/Plugin/Field/FieldType/ListTextItem.php +++ b/core/modules/options/lib/Drupal/options/Plugin/Field/FieldType/ListTextItem.php @@ -26,7 +26,7 @@ * } * ) */ -class ListTextItem extends ListItemBase { +class ListTextItem extends ListMultipleItemBase { /** * Definitions of the contained properties. @@ -39,14 +39,17 @@ class ListTextItem extends ListItemBase { * {@inheritdoc} */ public static function schema(FieldDefinitionInterface $field_definition) { - return parent::schema($field_definition) + array( - 'columns' => array( - 'value' => array( - 'type' => 'varchar', - 'length' => 255, - 'not null' => FALSE, - ), - ), + return array( + 'columns' => array( + 'value' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => FALSE, + ), + ), + 'indexes' => array( + 'value' => array('value'), + ), ); } @@ -59,7 +62,32 @@ public function getPropertyDefinitions() { static::$propertyDefinitions['value'] = DataDefinition::create('string') ->setLabel(t('Text value')) ->setConstraints($constraints); - } + } return static::$propertyDefinitions; } + + /** + * {@inheritdoc} + */ + protected function settingsFormDescription() { + $description = '' . t('The possible values this field can contain. Enter one value per line, in the format key|label.');
+ $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('Allowed HTML tags in labels: @tags', array('@tags' => _field_filter_xss_display_allowed_tags())) . '
'; + return $description; + } + + /** + * {@inheritdoc} + */ + protected static function validateAllowedValue($option) { + if (drupal_strlen($option) > 255) { + return t('Allowed values list: each key must be a string at most 255 characters long.'); + } + else { + return NULL; + } + } + } diff --git a/core/modules/options/options.module b/core/modules/options/options.module index 5ebcda2..7102ab7 100644 --- a/core/modules/options/options.module +++ b/core/modules/options/options.module @@ -5,7 +5,6 @@ * Defines selection, check box and radio button widgets for text and numeric fields. */ -use Drupal\Component\Utility\NestedArray; use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Field\FieldDefinitionInterface; use Drupal\field\FieldInterface; @@ -25,15 +24,6 @@ function options_help($path, $arg) { } /** -* Form element #value_callback: assembles the allowed values for 'boolean' fields. -*/ -function options_field_settings_form_value_boolean_allowed_values($element, $input, $form_state) { - $on = NestedArray::getValue($form_state['input'], $element['#on_parents']); - $off = NestedArray::getValue($form_state['input'], $element['#off_parents']); - return array($off, $on); -} - -/** * Implements hook_ENTITY_TYPE_update() for 'field_entity'. */ function options_field_entity_update(FieldInterface $field) {