You are here

Home » API reference » Purge 8.3 » QueueBrowserForm.php

class QueueBrowserForm in Purge 8.3

The queue data browser.

Hierarchy

Expanded class hierarchy of QueueBrowserForm

1 file declares its use of QueueBrowserForm
QueueBrowserFormTest.php in modules/purge_ui/tests/src/Functional/Form/QueueBrowserFormTest.php
1 string reference to 'QueueBrowserForm'
purge_ui.routing.yml in modules/purge_ui/purge_ui.routing.yml
modules/purge_ui/purge_ui.routing.yml

File

modules/purge_ui/src/Form/QueueBrowserForm.php, line 15

Namespace

Drupal\purge_ui\Form
View source 
class QueueBrowserForm extends FormBase {
  use CloseDialogTrait;

  /**
   * The 'purge.queue' service.
   *
   * @var \Drupal\purge\Plugin\Purge\Queue\QueueServiceInterface
   */
  protected $purgeQueue;

  /**
   * The number of items to show in the data table.
   *
   * @var int
   */
  protected $numberOfItems = 15;

  /**
   * Construct a QueueBrowserForm object.
   *
   * @param \Drupal\purge\Plugin\Purge\Queue\QueueServiceInterface $purge_queue
   *   The purge queue service.
   */
  public final function __construct(QueueServiceInterface $purge_queue) {
    $this->purgeQueue = $purge_queue;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['#prefix'] = '<div id="browserwrapper">';
    $form['#suffix'] = '</div>';

    // This is rendered as a modal dialog, so we need to set some extras.
    $form['#attached']['library'][] = 'core/drupal.dialog.ajax';

    // Store paging information in form state so we can easily update it.
    if (is_null($form_state
      ->get('pages'))) {
      $form_state
        ->set('pages', $this->purgeQueue
        ->selectPageMax());
      $form_state
        ->set('page', 1);
    }
    $pages = $form_state
      ->get('pages');
    $page = $form_state
      ->get('page');

    // Define a anonymous function with which we can easily add buttons.
    $button = function ($overrides = []) {
      return $overrides + [
        '#type' => 'submit',
        '#name' => 'page',
        '#submit' => [
          [
            $this,
            'submitForm',
          ],
        ],
        '#ajax' => [
          'callback' => '::submitForm',
          'wrapper' => 'browserwrapper',
        ],
      ];
    };

    // Generate the table filled with the paged data.
    $header = [
      [
        'data' => $this
          ->t('Type'),
      ],
      [
        'data' => $this
          ->t('State'),
      ],
      [
        'data' => $this
          ->t('Expression'),
      ],
    ];
    $form['wrapper']['table'] = [
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => [],
    ];
    $this->purgeQueue
      ->selectPageLimit($this->numberOfItems);
    foreach ($this->purgeQueue
      ->selectPage($page) as $immutable) {
      $form['wrapper']['table']['#rows'][] = [
        'data' => [
          $immutable
            ->getPluginDefinition()['label'],
          $immutable
            ->getStateStringTranslated(),
          $immutable
            ->getExpression(),
        ],
      ];
    }
    if (empty($form['wrapper']['table']['#rows'])) {
      $form['wrapper']['table'] = [
        '#markup' => $this
          ->t("Your queue is empty."),
      ];
    }

    // Build a pager, as '#theme' => 'pager' doesn't work in AJAX modals.
    $form['pager'] = [];
    $form['pager']['page']['first'] = $button([
      '#value' => '<<',
      '#access' => $page > 4,
    ]);
    $links = 2;
    $start = $page - $links > 0 ? $page - $links : 1;
    $end = $page + $links < $pages ? $page + $links : $pages;
    for ($i = $start; $i <= $end; $i++) {
      $form['pager']['page'][$i] = $button([
        '#value' => $i,
        '#button_type' => $page == $i ? 'primary' : '',
      ]);
    }
    $form['pager']['page']['last'] = $button([
      '#value' => ">> {$pages}",
      '#access' => $page < $pages - 4,
    ]);
    if (count($form['pager']['page']) === 3) {
      unset($form['pager']);
    }

    // Define the close button and return the form definition.
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['close'] = [
      '#ajax' => [
        'callback' => '::closeDialog',
      ],
      '#value' => $this
        ->t('Close'),
      '#button_type' => 'primary',
      '#type' => 'submit',
      '#weight' => -10,
    ];
    $form['actions']['refresh'] = $button([
      '#value' => $this
        ->t("Refresh"),
    ]);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $op = (string) $form_state
      ->getValue('page');
    $page = $form_state
      ->get('page');
    $pages = $form_state
      ->get('pages');
    if (is_numeric($op)) {
      $page = (int) $op;
    }
    elseif ($op == '<<') {
      $page = 1;
    }
    elseif ($op == ">> {$pages}") {
      $page = $pages;
    }
    $form_state
      ->set('page', $page);
    $form_state
      ->setRebuild();
    $response = new AjaxResponse();
    $response
      ->addCommand(new HtmlCommand('#browserwrapper', $form));
    return $form;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CloseDialogTrait::closeDialog public function Respond a CloseModalDialogCommand to close the modal dialog.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
QueueBrowserForm::$numberOfItems protected property The number of items to show in the data table.
QueueBrowserForm::$purgeQueue protected property The 'purge.queue' service.
QueueBrowserForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
QueueBrowserForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
QueueBrowserForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
QueueBrowserForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
QueueBrowserForm::__construct final public function Construct a QueueBrowserForm object.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.