PurgerAddForm.php in Purge 8.3

Namespace

Drupal\purge_ui\Form

File

modules/purge_ui/src/Form/PurgerAddForm.php

<?php

namespace Drupal\purge_ui\Form;

use Drupal\Core\Ajax\AjaxResponse;
use Drupal\Core\Ajax\CloseModalDialogCommand;
use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\purge\Plugin\Purge\Purger\PurgersServiceInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Add a new instance of a purger plugin to purge.
 */
class PurgerAddForm extends ConfigFormBase {
  use CloseDialogTrait;

  /**
   * The purge executive service, which wipes content from external caches.
   *
   * @var \Drupal\purge\Plugin\Purge\Purger\PurgersServiceInterface
   */
  protected $purgePurgers;

  /**
   * Construct a AddPurgerForm object.
   *
   * @param \Drupal\purge\Plugin\Purge\Purger\PurgersServiceInterface $purge_purgers
   *   The purgers service.
   */
  public final function __construct(PurgersServiceInterface $purge_purgers) {
    $this->purgePurgers = $purge_purgers;
  }

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'purge_ui.purger_add_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $form['#attached']['library'][] = 'core/drupal.dialog.ajax';

    // Provide all plugins that can be added.
    $available = $this->purgePurgers
      ->getPluginsAvailable();
    $plugins = $this->purgePurgers
      ->getPlugins();
    foreach ($plugins as $plugin_id => $definition) {
      if (!in_array($plugin_id, $available)) {
        unset($plugins[$plugin_id]);
      }
      else {
        $plugins[$plugin_id] = $this
          ->t('<b>@label</b><br />@description', [
          '@label' => $definition['label'],
          '@description' => $definition['description'],
        ]);
      }
    }
    $form['plugin_id'] = [
      '#default_value' => count($plugins) ? key($plugins) : NULL,
      '#type' => 'radios',
      '#options' => $plugins,
    ];

    // Update the buttons and bind callbacks.
    $form['actions']['submit'] = [
      '#access' => (bool) count($plugins),
      '#type' => 'submit',
      '#button_type' => 'primary',
      '#value' => $this
        ->t("Add"),
      '#ajax' => [
        'callback' => '::addPurger',
      ],
    ];
    $form['actions']['cancel'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Cancel'),
      '#weight' => -10,
      '#ajax' => [
        'callback' => '::closeDialog',
      ],
    ];
    return $form;
  }

  /**
   * Add the purger.
   *
   * @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 addPurger(array &$form, FormStateInterface $form_state) {
    $response = new AjaxResponse();
    $enabled = $this->purgePurgers
      ->getPluginsEnabled();
    $plugin_id = $form_state
      ->getValue('plugin_id');
    $response
      ->addCommand(new CloseModalDialogCommand());
    if (in_array($plugin_id, $this->purgePurgers
      ->getPluginsAvailable())) {
      $enabled[$this->purgePurgers
        ->createId()] = $plugin_id;
      $this->purgePurgers
        ->setPluginsEnabled($enabled);
      $response
        ->addCommand(new ReloadConfigFormCommand('edit-purgers'));
    }
    return $response;
  }

}

Classes

Name	Description
PurgerAddForm	Add a new instance of a purger plugin to purge.