CloseDialogTrait.php in Purge 8.3

Namespace

Drupal\purge_ui\Form

File

modules/purge_ui/src/Form/CloseDialogTrait.php

<?php

namespace Drupal\purge_ui\Form;

use Drupal\Core\Ajax\AjaxResponse;
use Drupal\Core\Ajax\CloseModalDialogCommand;
use Drupal\Core\Form\FormStateInterface;

/**
 * Shares the closeDialog AJAX form callback.
 *
 * @see \Drupal\purge_ui\Form\PurgerAddForm
 * @see \Drupal\purge_ui\Form\DeletePurgerForm
 * @see \Drupal\purge_ui\Form\PurgerConfigFormBase
 */
trait CloseDialogTrait {

  /**
   * Respond a CloseModalDialogCommand to close the modal dialog.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   The AJAX response object.
   */
  public function closeDialog(array &$form, FormStateInterface $form_state) {
    $response = new AjaxResponse();
    $response
      ->addCommand(new CloseModalDialogCommand());
    return $response;
  }

}

Traits

Name	Description
CloseDialogTrait	Shares the closeDialog AJAX form callback.