TextWidget.php in Examples for Developers 8

Namespace

Drupal\field_example\Plugin\Field\FieldWidget

File

field_example/src/Plugin/Field/FieldWidget/TextWidget.php

<?php

namespace Drupal\field_example\Plugin\Field\FieldWidget;

use Drupal\Component\Utility\Color;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\WidgetBase;
use Drupal\Core\Form\FormStateInterface;

/**
 * Plugin implementation of the 'field_example_text' widget.
 *
 * @FieldWidget(
 *   id = "field_example_text",
 *   module = "field_example",
 *   label = @Translation("RGB value as #ffffff"),
 *   field_types = {
 *     "field_example_rgb"
 *   }
 * )
 */
class TextWidget extends WidgetBase {

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $value = isset($items[$delta]->value) ? $items[$delta]->value : '';
    $element += [
      '#type' => 'textfield',
      '#default_value' => $value,
      '#size' => 7,
      '#maxlength' => 7,
      '#element_validate' => [
        [
          $this,
          'validate',
        ],
      ],
    ];
    return [
      'value' => $element,
    ];
  }

  /**
   * Validate the color text field.
   */
  public function validate($element, FormStateInterface $form_state) {
    $value = $element['#value'];
    if (strlen($value) === 0) {
      $form_state
        ->setValueForElement($element, '');
      return;
    }
    if (!Color::validateHex($value)) {
      $form_state
        ->setError($element, $this
        ->t('Color must be a 3- or 6-digit hexadecimal value, suitable for CSS.'));
    }
  }

}

Classes

Name	Description
TextWidget	Plugin implementation of the 'field_example_text' widget.