public function QueueBrowserForm::buildForm in Purge 8.3

Form constructor.

Parameters

array $form: An associative array containing the structure of the form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form structure.

Overrides FormInterface::buildForm

File

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

Class

QueueBrowserForm

The queue data browser.

Namespace

Drupal\purge_ui\Form

Code

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;
}