SignaturePadWidget.php in SignatureField 1.x

Namespace

Drupal\signaturefield\Plugin\Field\FieldWidget

File

src/Plugin/Field/FieldWidget/SignaturePadWidget.php

<?php

namespace Drupal\signaturefield\Plugin\Field\FieldWidget;

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

/**
 * Provides the signature pad widget for the signature field.
 *
 * @FieldWidget(
 *   id = "signature_pad",
 *   label = @Translation("Signature pad"),
 *   field_types = {
 *     "signature",
 *   },
 *   multiple_values = FALSE,
 * )
 */
class SignaturePadWidget extends WidgetBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'width' => 400,
      'height' => 200,
      'pen_color' => 'black',
      'background_color' => 'rgba(0, 0, 0, 0)',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['width'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Width'),
      '#default_value' => $this
        ->getSetting('width'),
      '#min' => 200,
      '#step' => 10,
      '#required' => TRUE,
      '#field_suffix' => 'px',
    ];
    $form['height'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Height'),
      '#default_value' => $this
        ->getSetting('height'),
      '#min' => 150,
      '#step' => 10,
      '#required' => TRUE,
      '#field_suffix' => 'px',
    ];
    $form['pen_color'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Pen color'),
      '#description' => $this
        ->t('A color name, hex code or in rgb(a) format.'),
      '#default_value' => $this
        ->getSetting('pen_color'),
      '#required' => TRUE,
    ];
    $form['background_color'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Background color'),
      '#description' => $this
        ->t('A color name, hex code or in rgb(a) format.'),
      '#default_value' => $this
        ->getSetting('background_color'),
      '#required' => TRUE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $summary[] = $this
      ->t('Dimensions: @widthx@heightpx', [
      '@width' => $this
        ->getSetting('width'),
      '@height' => $this
        ->getSetting('height'),
    ]);
    $summary[] = $this
      ->t('Pen color: @pen, background color: @background', [
      '@pen' => $this
        ->getSetting('pen_color'),
      '@background' => $this
        ->getSetting('background_color'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element['value'] = $element + [
      '#type' => 'signature',
      '#default_value' => $items[$delta]->value ?? NULL,
      '#width' => $this
        ->getSetting('width'),
      '#height' => $this
        ->getSetting('height'),
      '#pen_color' => $this
        ->getSetting('pen_color'),
      '#background_color' => $this
        ->getSetting('background_color'),
    ];
    return $element;
  }

}

Classes

Name	Description
SignaturePadWidget	Provides the signature pad widget for the signature field.