Coding

Drupal 9 confirmFormBase en un seul formulaire

Par Jean, 30 décembre, 2021

Drupal 9 vous propose la classe confirmFormBase(le lien est externe) qui étends FormBase(le lien est externe). Cela permet de rapidement rajouter une étape à un formulaire pour valider une action. L'utilisation courante est de confirmer la suppression de quelque chose, cela permet d'informer : "êtes-vous sûr de vouloir supprimer le noeud 23 ?"

L'utilisation standard est de créer une route avec un paramètre (par exemple un id) et donc d'avoir votre formulaire qui étends formBase et un second formulaire pour confirmer l'action qui étends confirmFormBase.

Un seul formulaire avec notre étape de confirmation

Mais dans notre cas nous voulons créer un seul formulaire et utiliser la confirmation au sein de ce formulaire. Cette solution existe déjà dans Drupal core et est utilisé pour l'import d'une configuration simple, la classe ConfigSingleImportForm.php(le lien est externe).

L'astuce est alors d'implémenter dans notre classe qui étends confirmFormBase les méthodes de formBase, soit depuis formInterface(le lien est externe) :

public function getFormId();
public function buildForm(array $form, FormStateInterface $form_state);
public function submitForm(array &$form, FormStateInterface $form_state);
// Si besoin d'une validation.
public function validateForm(array &$form, FormStateInterface $form_state);

Et depuis confirmFormInterface(le lien est externe)

public function getQuestion();
public function getCancelUrl();

Ensuite la première étape est d'ajouter une variable pour stocker la data de notre formulaire que l'on veut stocker. Cela peut être un ou un id pour une valeure simple ou un array pour une valeure plus complexe : 

protected $action = NULL;

Le plus important est alors d'ajouter une condition au submitForm() pour ne pas encore soumettre, reconstruire le formulaire et stocker notre action dans une variable de notre classe :

public function submitForm(array &$form, FormStateInterface $form_state): void {
  if (!$this->action) {
    $form_state->setRebuild();
    $this->action = $form_state->getValue('action');
    return;
  }
  // Notre code submit.
}

Il suffit ensuite simplement d'avoir une condition également au buildForm() pour ne pas utiliser notre formulaire mais renvoyer celui de confirmation présent dans confirmFormBase :

public function buildForm(array $form, FormStateInterface $form_state): array {
  if ($this->action) {
    return parent::buildForm($form, $form_state);
  }
  // Notre array $form avec les boutons d'action, au minimum "soumettre"
}

De même, si le formulaire contient une validation avec validateForm() il est nécessaire d'éviter la validation lors de l'étape de confirmation :

public function validateForm(array &$form, FormStateInterface $form_state): void {
  if ($this->action) {
    return;
  }
  // Notre code de validation.
}

Exemple complet de code

Voici un exemple complet d'implémentation pour n'avoir qu'un seul formulaire au lieu de deux et qui permet également de traiter des données plus complexes qu'un id.

demo_confirm_form.routing.yml

 demo_confirm_form.settings_form_minimal:
  path: '/admin/config/system/demo-form-minimal'
  defaults:
    _title: 'demo confirm form minimal'
    _form: 'Drupal\demo_confirm_form\Form\ExampleMinimalForm'
  requirements:
    _permission: 'administer demo_confirm_form_minimal configuration'

demo_confirm_form.settings_form:
  path: '/admin/config/system/demo-form'
  defaults:
    _title: 'demo confirm form'
    _form: 'Drupal\demo_confirm_form\Form\ExampleForm'
  requirements:
    _permission: 'administer demo_confirm_form configuration'

Voici un exemple minimum de formulaire web/modules/demo_confirm_form/src/Form/ExampleMinimalForm.php

 <?php

declare(strict_types=1);

namespace Drupal\demo_confirm_form\Form;

use Drupal\Core\Form\ConfirmFormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Messenger\MessengerInterface;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\Core\Url;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Example confirm form.
 */
class ExampleMinimalForm extends ConfirmFormBase {

  /**
   * The submitted action needing to be confirmed.
   *
   * @var string|null
   */
  protected $action = NULL;

  /**
   * JobOfferSettingsConfirmForm constructor.
   *
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The Messenger service.
   */
  public function __construct(MessengerInterface $messenger) {
    $this->setMessenger($messenger);
  }

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

  /**
   * {@inheritdoc}
   */
  public function getFormId(): string {
    return 'example_confirm_form';
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion(): TranslatableMarkup {
    return $this->t('Are you sure you want to %action?', ['%action' => $this->action]);
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl(): Url {
    return new Url('demo_confirm_form.settings_form');
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state): array {
    // When this is the confirmation step fall through to the confirmation form.
    if ($this->action) {
      return parent::buildForm($form, $form_state);
    }

    $form['action'] = [
      '#type' => 'radios',
      '#title' => $this->t('Choose action'),
      '#options' => [
        'delete' => $this->t('Delete'),
        'import' => $this->t('Import'),
      ],
      '#required' => TRUE,
    ];
    $form['actions'] = ['#type' => 'actions'];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this->t('Run selected action'),
      '#button_type' => 'primary',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state): void {
    // The confirmation step needs no additional validation.
    if ($this->action) {
      return;
    }

    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state): void {
    // If this form has not yet been confirmed, store the values and rebuild.
    if (!$this->action) {
      $form_state->setRebuild();
      $this->action = $form_state->getValue('action');
      return;
    }

    $method = $this->action . 'Data';
    $this->{$method}();
  }

  /**
   * Example action.
   */
  protected function deleteData(): void {
    $this->messenger->addMessage($this->t('Action %action done!', ['%action' => $this->action]));
  }

  /**
   * Example action.
   */
  protected function importData(): void {
    $this->messenger->addMessage($this->t('Action %action done!', ['%action' => $this->action]));
  }
}

Un exemple plus complet de formaulaire avec un texte et un array, web/modules/demo_confirm_form/src/Form/ExampleForm.php

 <?php

declare(strict_types=1);

namespace Drupal\demo_confirm_form\Form;

use Drupal\Core\Form\ConfirmFormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Messenger\MessengerInterface;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\Core\Url;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Example confirm form.
 *
 * https://git.drupalcode.org/project/drupal/-/blob/9.3.x/core/modules/config/src/Form/ConfigSingleImportForm.php
 */
class ExampleForm extends ConfirmFormBase {

  /**
   * The submitted action needing to be confirmed.
   *
   * @var string|null
   */
  protected $action = NULL;

  /**
   * The submitted data needing to be confirmed.
   *
   * @var array
   */
  protected $data = [];

  /**
   * JobOfferSettingsConfirmForm constructor.
   *
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The Messenger service.
   */
  public function __construct(MessengerInterface $messenger) {
    $this->setMessenger($messenger);
  }

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

  /**
   * {@inheritdoc}
   */
  public function getFormId(): string {
    return 'example_confirm_form';
  }

  /**
   * {@inheritdoc}
   */
  public function getFormName(): string {
    return 'example_confirm';
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription(): TranslatableMarkup {
    $args = [
      '%data' => $this->data,
      '%action' => $this->action,
    ];
    return $this->t('This action of %action on %data is definitive.', $args);
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText(): TranslatableMarkup {
    $args = [
      '%data' => $this->data,
      '%action' => $this->action,
    ];
    return $this->t('Run %action on %data', $args);
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion(): TranslatableMarkup {
    $args = [
      '%data' => $this->data,
      '%action' => $this->action,
    ];
    return $this->t('Are you sure you want to %action on %data?', $args);
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl(): Url {
    return new Url('demo_confirm_form.settings_form');
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state): array {
    // When this is the confirmation step fall through to the confirmation form.
    if ($this->action) {
      return parent::buildForm($form, $form_state);
    }

    $form['data'] = [
      '#type' => 'textfield',
      '#title' => $this->t('Data to process'),
      '#required' => TRUE,
    ];
    $form['action'] = [
      '#type' => 'radios',
      '#title' => $this->t('Choose action'),
      '#options' => [
        'delete' => $this->t('Delete'),
        'import' => $this->t('Import'),
        'invalid' => $this->t('Invalid action'),
      ],
      '#required' => TRUE,
    ];
    $form['actions'] = ['#type' => 'actions'];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this->t('Run selected action'),
      '#button_type' => 'primary',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state): void {
    // The confirmation step needs no additional validation.
    if ($this->action) {
      return;
    }

    if ($form_state->getValue('data') === 'invalid') {
      $form_state->setErrorByName('data', $this->t('The value is not correct.'));
    }

    $action = $form_state->getValue('action');
    $method = $action . 'Data';
    if (!method_exists($this, $method)) {
      $form_state->setErrorByName('action', $this->t('Action %action not yet implemented!', ['%action' => $action]), 'error');
      return;
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state): void {
    // If this form has not yet been confirmed, store the values and rebuild.
    if (!$this->action) {
      $form_state->setRebuild();
      $this->action = $form_state->getValue('action');
      $this->data = $form_state->getValue('data');
      return;
    }

    $method = $this->action . 'Data';
    if (!method_exists($this, $method)) {
      $this->messenger->addMessage($this->t('Action %action not yet implemented!', ['%action' => $this->action]), 'error');
      return;
    }
    $this->{$method}();
  }

  /**
   * Example action.
   */
  protected function deleteData(): void {
    $this->messenger->addMessage($this->t('Deleted %data!', ['%data' => $this->data]));
  }

  /**
   * Example action.
   */
  protected function importData(): void {
    $this->messenger->addMessage($this->t('Imported %data!', ['%data' => $this->data]));
  }
}

Tags

Resources
https://www.drupal.org/docs/drupal-apis/form-api/confirmformbase-to-confirm-an-…(le lien est externe)
https://github.com/mogtofu33/demo-drupal-confirm-base(le lien est externe)