Creazione di un widget per il campo

I widget dei campi vengono utilizzati per la visualizzazione del campo all’interno dei form. I widget dei campi sono definiti come plugin, quindi è consigliato leggere l’API dei plugin prima di iniziare a scrivere un nuovo tipo di campo.

Per creare un widget di campo in Drupal 8, serve una classe con l’annotazione FieldWidget.

Percorso della classe del widget di campo: /[MODULE_NAME]/src/Plugin/Field/FieldWidget. Per esempio: /foo/src/Plugin/Field/FieldWidget/BarWidget.php.

Namespace della classe: [MODULE_NAME]\Plugin\Field\FieldWidget. Per esempio: \Drupal\foo\Plugin\Field\FieldWidget.

L’annotazione sopra la classe deve includere un identificatore univoco, un’etichetta e un array di identificatori dei tipi di campo che questo widget può gestire.

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

La classe deve implementare l’interfaccia WidgetInterface. Può estendere WidgetBase per un’implementazione comune. L’unico metodo obbligatorio da implementare è ::formElement(), che deve restituire gli elementi del form che rappresentano il widget.

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 = [];
    // Costruisce l’array di render dell’elemento.
    return $element;
  }

}

Impostazioni del widget

Se al tuo widget servono impostazioni aggiuntive, occorre seguire tre passaggi:

• Sovrascrivere PluginSettingsBase::defaultSettings() per definire i valori predefiniti
• Creare lo schema di configurazione per le impostazioni definite
• Creare un form per permettere agli utenti di modificarle

Passo 1: Sovrascrivere PluginSettingsBase::defaultSettings() per definire valori predefiniti

/**
 * {@inheritdoc}
 */
 public static function defaultSettings() {
  return [
    // Crea l’impostazione personalizzata 'size'
    // e assegna il valore predefinito 60
    'size' => 60,
  ] + parent::defaultSettings();
}

Passo 2. Creare lo schema di configurazione

Lo schema si trova in:

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

In questo file descrivi il tipo di dato delle impostazioni create in defaultSettings():

Il passo 1 ha creato un parametro chiamato “size” che memorizza un intero. Lo schema sarà così:

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

Passo 3 - Creare il form per modificare le impostazioni

Il form che consente la modifica viene creato sovrascrivendo 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;
}

Puoi anche elencare le impostazioni selezionate nel riepilogo del widget, ad esempio:

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

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

  return $summary;
}

Puoi usare il metodo getSetting() per ottenere l’impostazione da usare nel widget:

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;
  }

}

Esempio di widget

TextWidget dal modulo field_example del modulo Examples:

namespace Drupal\field_example\Plugin\Field\FieldWidget;

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

/**
 * Implementazione del plugin '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];
  }

  /**
   * Valida il campo di testo del colore.
   */
  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("Il colore deve essere un valore esadecimale a 6 cifre, adatto al CSS."));
    }
  }

}