Drupal\mongodb_watchdog\Controller\ControllerBase

Complexity

Total Complexity

8

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	getTop()	0	3	1
A	setupPager()	0	8	1
A	buildEmpty()	0	8	1
A	buildDefaults()	0	12	1
A	getPage()	0	13	3

<?php

declare(strict_types=1);

namespace Drupal\mongodb_watchdog\Controller;

use Drupal\Core\Config\ImmutableConfig;

The type Drupal\Core\Config\ImmutableConfig was not found. Maybe you did not declare it correctly or list all dependencies?

use Drupal\Core\Controller\ControllerBase as CoreControllerBase;

The type Drupal\Core\Controller\ControllerBase was not found. Maybe you did not declare it correctly or list all dependencies?

use Drupal\Core\Pager\PagerManagerInterface;

The type Drupal\Core\Pager\PagerManagerInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Drupal\Core\StringTranslation\TranslatableMarkup;

The type Drupal\Core\StringTranslation\TranslatableMarkup was not found. Maybe you did not declare it correctly or list all dependencies?

use Drupal\mongodb_watchdog\Logger;
use Psr\Log\LoggerAwareTrait;

The type Psr\Log\LoggerAwareTrait was not found. Maybe you did not declare it correctly or list all dependencies?

use Psr\Log\LoggerInterface;

The type Psr\Log\LoggerInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\HttpFoundation\Request;

The type Symfony\Component\HttpFoundation\Request was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * Base controller class for paged reports.
 */
abstract class ControllerBase extends CoreControllerBase {

  use LoggerAwareTrait;

  /**
   * The items_per_page configuration value.
   *
   * @var int
   */
  protected $itemsPerPage;

  /**
   * The pager.manager service.
   *
   * @var \Drupal\Core\Pager\PagerManagerInterface
   */
  protected $pagerManager;

  /**
   * The MongoDB logger, to load events.
   *
   * @var \Drupal\mongodb_watchdog\Logger
   */
  protected $watchdog;

  /**
   * ControllerBase constructor.
   *
   * @param \Psr\Log\LoggerInterface $logger
   *   The logger.channel.mongodb_watchdog service.
   * @param \Drupal\mongodb_watchdog\Logger $watchdog
   *   The mongodb.logger service, to load stored events.
   * @param \Drupal\Core\Pager\PagerManagerInterface $pagerManager
   *   The core pager.manager service.
   * @param \Drupal\Core\Config\ImmutableConfig $config
   *   The mongodb_watchdog configuration.
   */
  public function __construct(
    LoggerInterface $logger,
    Logger $watchdog,
    PagerManagerInterface $pagerManager,
    ImmutableConfig $config) {
    $this->setLogger($logger);

    $this->itemsPerPage = $config->get('items_per_page');
    $this->pagerManager = $pagerManager;
    $this->watchdog = $watchdog;
  }

  /**
   * The default build() implementation.
   *
   * Cannot be a build() method because each controller build() has a
   * different signature.
   *
   * @param array $main
   *   A render array for the main table.
   * @param array $top
   *   A render array for the top element present on some controllers results.
   *
   * @return array
   *   A render array for the whole controller.
   */
  protected function buildDefaults(array $main, array $top): array {
    $ret = ['top' => $top];

    $ret += [
      'main' => $main,
      'pager' => ['#type' => 'pager'],
      '#attached' => [
        'library' => ['mongodb_watchdog/styling'],
      ],
    ];

    return $ret;
  }

  /**
   * Build markup for a message about the lack of results.
   *
   * @param \Drupal\Core\StringTranslation\TranslatableMarkup $markup
   *   The message proper.
   *
   * @return array
   *   A render array for a message.
   */
  protected function buildEmpty(TranslatableMarkup $markup): array {
    $ret = [
      '#markup' => $markup,
      '#prefix' => '<div class="mongodb-watchdog__message">',
      '#suffix' => '</div>',
    ];

    return $ret;
  }

  /**
   * Return the top element: empty by default.
   *
   * @return array
   *   A render array for the top filter form.
   */
  protected function getTop(): array {
    $top = [];
    return $top;
  }

  /**
   * Set up the pager.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   * @param int $count
   *   The total number of possible rows.
   *
   * @return int
   *   The number of the page to display, starting at 0.
   */
  public function setupPager(Request $request, int $count): int {
    $height = $this->itemsPerPage;
    $this->pagerManager->createPager($count, $height);

    $requestedPage = intval($request->query->get('page', 0));
    $page = $this->getPage($count, $requestedPage, $height);

    return $page;
  }

  /**
   * Return a reliable page number based on available data.
   *
   * @param int $count
   *   The number of events templates in the collection.
   * @param int $requestedPage
   *   The page number requested by the user, starting at 0.
   * @param int $height
   *   The pager height.
   *
   * @return int
   *   The actual index of the page to display.
   */
  public static function getPage(int $count, int $requestedPage, int $height): int {
    if ($requestedPage <= 0) {
      return 0;
    }

    // There is always at least one page, even with $count === 0.
    $pageCount = max(1, intval(ceil($count / $height)));
    if ($requestedPage < $pageCount) {
      return $requestedPage;
    }

    $page = $pageCount - 1;
    return $page;
  }

}