Создание виджета для поля

Виджеты полей используются для визуализации поля внутри форм. Виджеты полей определяются как плагины, поэтому рекомендуется ознакомиться с API плагинов перед тем, как приступить к написанию нового типа поля.

Чтобы создать виджет поля в Drupal 8, вам нужен класс с аннотацией FieldWidget.

Расположение класса виджета поля должно быть /[MODULE_NAME]/src/Plugin/Field/FieldWidget. For example, /foo/src/Plugin/Field/FieldWidget/BarWidget.php.

Пространство имен этого класса должно быть [MODULE_NAME]\Plugin\Field\FieldWidget. For example, \Drupal\foo\Plugin\Field\FieldWidget.

Аннотация над классом должна включать уникальный идентификатор, метку и массив идентификаторов типов полей, которые может обрабатывать этот виджет.

/**
 * A widget bar.
 *
 * @FieldWidget(
 *   id = "bar",
 *   label = @Translation("Bar widget"),
 *   field_types = {
 *     "baz",
 *     "string"
 *   }
 * )
 */

Класс должен реализовывать интерфейс WidgetInterface. И может расширить класс WidgetBase для общей реализации интерфейса. Единственный необходимый для реализации метод - это ::formElement(), который должен возвращать фактические элементы формы, которые представляют ваш виджет.

use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\WidgetBase;
use Drupal\Core\Form\FormStateInterface;

//...
class BarWidget extends WidgetBase {

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element = [];
    // Build the element render array.
    return $element;
  }

}

Настройки виджета

Если вашему виджету нужны дополнительные настройки, для этого необходимо выполнить три шага:

• Переопределите PluginSettingsBase::defaultSettings(), чтобы установить значения по умолчанию
• Создайте схему конфигурации для созданных вами настроек
• Создайте форму, чтобы позволить пользователям изменять настройки

Шаг 1: Переопределите PluginSettingsBase::defaultSettings(), чтобы установить значения по умолчанию

/**
 * {@inheritdoc}
 */
 public static function defaultSettings() {
  return [
    // Create the custom setting 'size', and
    // assign a default value of 60
    'size' => 60,
  ] + parent::defaultSettings();
}

Шаг 2. Создайте схему конфигурации для созданных вами настроек

Схема конфигурации идет в следующем файле:

/[MODULE_NAME]/config/schema/[MODULE_NAME].schema.yml

В этом файле вы опишите тип (ы) данных настроек, которые вы ввели в defaultSettings():

Шаг 1 создал параметр с именем «size», в котором хранится целочисленное значение. Схема для этого будет выглядеть следующим образом:

field.widget.settings.[WIDGET ID]:
  type: mapping
  label: 'WIDGET NAME widget settings'
  mapping:
    size:
      type: integer
      label: 'Size'

Шаг 3 - Создайте форму, чтобы позволить пользователям изменять настройки

Форма, позволяющая пользователям изменять значения параметров, создается путем переопределения WidgetBase::settingsForm().

/**
 * {@inheritdoc}
 */
public function settingsForm(array $form, FormStateInterface $form_state) {
  $element['size'] = [
    '#type' => 'number',
    '#title' => $this->t('Size of textfield'),
    '#default_value' => $this->getSetting('size'),
    '#required' => TRUE,
    '#min' => 1,
  ];

  return $element;
}

Вы также можете перечислить выбранные настройки в сводке для виджета следующим образом:

/**
 * {@inheritdoc}
 */
public function settingsSummary() {
  $summary = [];

  $summary[] = $this->t('Textfield size: @size', array('@size' => $this->getSetting('size')));

  return $summary;
}

Вы можете использовать метод getSetting() класса, чтобы получить настройку для использования в виджете:

class BarWidget extends WidgetBase implements WidgetInterface {

class BarWidget extends WidgetBase implements WidgetInterface {

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

    return $element;
  }

}

Пример виджета

TextWidget из модуля field_example из модуля Examples:

namespace Drupal\field_example\Plugin\Field\FieldWidget;

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' => [
        [static::class, 'validate'],
      ],
    ];
    return ['value' => $element];
  }

  /**
   * Validate the color text field.
   */
  public static function validate($element, FormStateInterface $form_state) {
    $value = $element['#value'];
    if (strlen($value) == 0) {
      $form_state->setValueForElement($element, '');
      return;
    }
    if (!preg_match('/^#([a-f0-9]{6})$/iD', strtolower($value))) {
      $form_state->setError($element, t("Color must be a 6-digit hexadecimal value, suitable for CSS."));
    }
  }

}