class Text3Widget

Same name in other branches
  1. 3.x modules/field_example/src/Plugin/Field/FieldWidget/Text3Widget.php \Drupal\field_example\Plugin\Field\FieldWidget\Text3Widget

Plugin implementation of the 'field_example_3text' widget.

Plugin annotation


@FieldWidget(
  id = "field_example_3text",
  module = "field_example",
  label = @Translation("RGB text field"),
  field_types = {
    "field_example_rgb"
  }
)

Hierarchy

Expanded class hierarchy of Text3Widget

File

modules/field_example/src/Plugin/Field/FieldWidget/Text3Widget.php, line 21

Namespace

Drupal\field_example\Plugin\Field\FieldWidget
View source
class Text3Widget extends WidgetBase {
    
    /**
     * {@inheritdoc}
     */
    public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
        $value = $items[$delta]->value ?? '';
        // Parse the single hex string into RBG values.
        if (!empty($value)) {
            preg_match_all('@..@', substr($value, 1), $match);
        }
        else {
            $match = [
                [],
            ];
        }
        // Set up the form element for this widget.
        $element += [
            '#type' => 'details',
            '#element_validate' => [
                [
                    $this,
                    'validate',
                ],
            ],
        ];
        // Add in the RGB textfield elements.
        foreach ([
            'r' => $this->t('Red'),
            'g' => $this->t('Green'),
            'b' => $this->t('Blue'),
        ] as $key => $title) {
            $element[$key] = [
                '#type' => 'textfield',
                '#title' => $title,
                '#size' => 2,
                '#default_value' => array_shift($match[0]),
                '#attributes' => [
                    'class' => [
                        'rgb-entry',
                    ],
                ],
                '#description' => $this->t('The 2-digit hexadecimal representation of @color saturation, like "a1" or "ff"', [
                    '@color' => $title,
                ]),
            ];
            // Since Form API doesn't allow a fieldset to be required, we
            // have to require each field element individually.
            if ($element['#required']) {
                $element[$key]['#required'] = TRUE;
            }
        }
        return [
            'value' => $element,
        ];
    }
    
    /**
     * Validate the fields and convert them into a single value as text.
     */
    public function validate($element, FormStateInterface $form_state) {
        // Validate each of the textfield entries.
        $values = [];
        foreach ([
            'r',
            'g',
            'b',
        ] as $colorfield) {
            $values[$colorfield] = $element[$colorfield]['#value'];
            // If they left any empty, we'll set the value empty and quit.
            if (strlen($values[$colorfield]) == 0) {
                $form_state->setValueForElement($element, '');
                return;
            }
            // If they gave us anything that's not hex, reject it.
            if (strlen($values[$colorfield]) != 2 || !ctype_xdigit($values[$colorfield])) {
                $form_state->setError($element[$colorfield], $form_state, $this->t("Saturation value must be a 2-digit hexadecimal value between 00 and ff."));
            }
        }
        // Set the value of the entire form element.
        $value = strtolower(sprintf('#%02s%02s%02s', $values['r'], $values['g'], $values['b']));
        $form_state->setValueForElement($element, $value);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
Text3Widget::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
Text3Widget::validate public function Validate the fields and convert them into a single value as text.
WidgetBase::$fieldDefinition protected property The field definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax public static function Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit public static function Submission handler for the "Add another item" button.
WidgetBase::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 5
WidgetBase::deleteAjax public static function Ajax refresh callback for the "Remove" button.
WidgetBase::deleteSubmit public static function Ajax submit callback for the "Remove" button.
WidgetBase::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues 3
WidgetBase::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors 2
WidgetBase::form public function Creates a form element for a field. Overrides WidgetBaseInterface::form 3
WidgetBase::formMultipleElements protected function Special handling to create form elements for multiple values. 1
WidgetBase::formSingleElement protected function Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting protected function Returns the value of a field setting.
WidgetBase::getFieldSettings protected function Returns the array of field settings.
WidgetBase::getFilteredDescription protected function Returns the filtered field description.
WidgetBase::getWidgetState public static function Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents protected static function Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues protected function Returns whether the widget handles multiple values.
WidgetBase::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable 4
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues 7
WidgetBase::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetInterface::settingsForm 16
WidgetBase::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetInterface::settingsSummary 15
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState
WidgetBase::__construct public function Constructs a WidgetBase object. 5