FormWidgetExampleForm.php in Typed Data API enhancements 8

Namespace

Drupal\typed_data_widget_test

File

tests/modules/typed_data_widget_test/src/FormWidgetExampleForm.php

<?php

namespace Drupal\typed_data_widget_test;

use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\typed_data\Form\SubformState;
use Drupal\Core\Plugin\Context\ContextDefinition;
use Drupal\Core\State\StateInterface;
use Drupal\Core\TypedData\TypedDataTrait;
use Drupal\typed_data\Widget\FormWidgetManagerTrait;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Class FormWidgetExampleForm.
 */
class FormWidgetExampleForm extends FormBase {
  use FormWidgetManagerTrait;
  use TypedDataTrait;

  /**
   * The state storage.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;

  /**
   * Form constructor.
   *
   * @param \Drupal\Core\State\StateInterface $state
   *   The state storage.
   */
  public function __construct(StateInterface $state) {
    $this->state = $state;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('state'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'typed_data_widget_test_form';
  }

  /**
   * Gets some example context definition.
   *
   * @param string $widget_id
   *   The widget id.
   *
   * @return \Drupal\Core\Plugin\Context\ContextDefinitionInterface
   *   The definition.
   */
  public function getExampleContextDefinition($widget_id) {
    switch ($widget_id) {
      default:
      case 'text_input':
        return ContextDefinition::create('string')
          ->setLabel('Example string')
          ->setDescription('Some example string with max. 8 characters.')
          ->setDefaultValue('default')
          ->addConstraint('Length', [
          'max' => 8,
        ]);
      case 'textarea':
        return ContextDefinition::create('text')
          ->setLabel('Example text area')
          ->setDefaultValue("default line one\nline two")
          ->setDescription('This is the long textarea example description.');
      case 'select':
        return ContextDefinition::create('filter_format')
          ->setLabel('Filter format')
          ->setDescription('Some example selection.');
      case 'datetime':
        return ContextDefinition::create('datetime_iso8601')
          ->setLabel('Example datetime')
          ->setDescription('Some example datetime.');
      case 'datetime_range':
        return ContextDefinition::create('any')
          ->setLabel('Example datetime range')
          ->setDescription('Some example datetime range.');
      case 'broken':
        return ContextDefinition::create('string')
          ->setLabel('Example string');
    }
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $widget_id = NULL) {
    $widget = $this
      ->getFormWidgetManager()
      ->createInstance($widget_id);

    // Read and write widget configuration from the state.
    // Allow tests to define a custom context definition.
    $context_definition = $this->state
      ->get('typed_data_widgets.definition');
    $context_definition = $context_definition ?: $this
      ->getExampleContextDefinition($widget_id);
    $form_state
      ->set('widget_id', $widget_id);
    $form_state
      ->set('context_definition', $context_definition);

    // Create a typed data object.
    $data = $this
      ->getTypedDataManager()
      ->create($context_definition
      ->getDataDefinition());
    $value = $this->state
      ->get('typed_data_widgets.' . $widget_id);
    $value = isset($value) ? $value : $context_definition
      ->getDefaultValue();
    $data
      ->setValue($value);
    $subform_state = SubformState::createWithParents([
      'data',
    ], $form, $form_state);
    $form['data'] = $widget
      ->form($data, $subform_state);
    $form['actions']['#type'] = 'actions';

    // 'Submit' will save the widget value.
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => 'Submit',
    ];

    // 'Reset' will erase the saved value and revert to default.
    $form['actions']['reset'] = [
      '#type' => 'submit',
      '#value' => 'Reset',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    $context_definition = $form_state
      ->get('context_definition');
    $widget_id = $form_state
      ->get('widget_id');
    $widget = $this
      ->getFormWidgetManager()
      ->createInstance($widget_id);
    $subform_state = SubformState::createWithParents([
      'data',
    ], $form, $form_state);
    $data = $this
      ->getTypedDataManager()
      ->create($context_definition
      ->getDataDefinition());
    $widget
      ->extractFormValues($data, $subform_state);

    // Validate the data and flag possible violations.
    $violations = $data
      ->validate();
    $widget
      ->flagViolations($data, $violations, $subform_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $context_definition = $form_state
      ->get('context_definition');
    $widget_id = $form_state
      ->get('widget_id');
    $widget = $this
      ->getFormWidgetManager()
      ->createInstance($widget_id);
    if (($triggering_element = $form_state
      ->getTriggeringElement()) && $triggering_element['#id'] == 'edit-reset') {

      // Erase the widget data.
      $this->state
        ->set('typed_data_widgets.' . $widget_id, NULL);
      $this
        ->messenger()
        ->addMessage($this
        ->t('Value reset to default'));
    }
    else {
      $subform_state = SubformState::createWithParents([
        'data',
      ], $form, $form_state);
      $data = $this
        ->getTypedDataManager()
        ->create($context_definition
        ->getDataDefinition());
      $widget
        ->extractFormValues($data, $subform_state);

      // Read and write widget configuration via the state.
      $this->state
        ->set('typed_data_widgets.' . $widget_id, $data
        ->getValue());

      // Display the value saved. Use print_r in case the value is an array.
      $this
        ->messenger()
        ->addMessage($this
        ->t('Value saved: %value', [
        '%value' => print_r($data
          ->getValue(), TRUE),
      ]));
    }
  }

}

Classes

Name	Description
FormWidgetExampleForm	Class FormWidgetExampleForm.