Drupal\mongodb_watchdog\Controller\DetailController

Complexity

Total Complexity

13

Size/Duplication

Total Lines	212
Duplicated Lines	7.08 %

Coupling/Cohesion

Components	2
Dependencies	4

Importance

Changes	6
Bugs	0	Features	2

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	build()	0	15	2
A	buildMainTable()	0	11	1
A	buildMainTableHeader()	0	13	1
A	buildMainTableRows()	0	10	2
A	buildTitle()	0	3	1
A	create()	15	15	1
A	getRowData()	0	12	1
A	getTop()	0	21	3

<?php

namespace Drupal\mongodb_watchdog\Controller;

use Drupal\Core\Config\ImmutableConfig;
use Drupal\Core\Template\Attribute;
use Drupal\mongodb_watchdog\EventController;
use Drupal\mongodb_watchdog\EventTemplate;
use Drupal\mongodb_watchdog\Logger;
use Psr\Log\LoggerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;

/**
 * The controller for the event detail page.
 */
class DetailController extends ControllerBase {

  /**
   * The mongodb.watchdog_event_controller service.
   *
   * @var \Drupal\mongodb_watchdog\EventController
   */
  protected $eventController;

  /**
   * Controller constructor.
   *
   * @param \Psr\Log\LoggerInterface $logger
   *   The logger service, to log intervening events.
   * @param \Drupal\mongodb_watchdog\Logger $watchdog
   *   The MongoDB logger, to load stored events.
   * @param \Drupal\Core\Config\ImmutableConfig $config
   *   The module configuration.
   * @param \Drupal\mongodb_watchdog\EventController $eventController
   *   The event controller service.
   */
  public function __construct(
    LoggerInterface $logger,
    Logger $watchdog,
    ImmutableConfig $config,
    EventController $eventController) {
    parent::__construct($logger, $watchdog, $config);

    $this->eventController = $eventController;
  }

  /**
   * Controller.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   * @param \Drupal\mongodb_watchdog\EventTemplate $eventTemplate
   *   The event template.
   *
   * @return array<string,array>

Should the return type not be array<string,string|array>?

   *   A render array.
   */
  public function build(Request $request, EventTemplate $eventTemplate) {
    $top = $this->getTop($eventTemplate);

    $rows = $this->getRowData($request, $eventTemplate);
    $main = empty($rows)
      ? [
        '#markup' => t('No occurrence of this event found in logger.'),
        '#prefix' => '<div class="mongodb_watchdog__message">',
        '#suffix' => '</div>',
      ]
      : $this->buildMainTable($rows, $eventTemplate);

    $ret = $this->buildDefaults($main, $top);
    return $ret;
  }

  /**
   * Build the main table.
   *
   * @param \Drupal\mongodb_watchdog\Event[] $events
   *   The event data.
   * @param \Drupal\mongodb_watchdog\EventTemplate $eventTemplate
   *   The template for which to built the detail lines.
   *
   * @return array<string,string|array>
   *   A render array for the main table.
   */
  protected function buildMainTable(array $events, EventTemplate $eventTemplate) {
    $ret = [
      '#attributes' => new Attribute(['class' => 'mongodb_watchdog__detail']),
      '#caption' => t('Event occurrences'),
      '#header' => $this->buildMainTableHeader(),
      '#rows' => $this->buildMainTableRows($events, $eventTemplate),
      '#type' => 'table',
    ];

    return $ret;
  }

  /**
   * Build the main table header.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup[]
   *   A table header array.
   */
  protected function buildMainTableHeader() {
    $header = [
      t('Date'),
      t('User'),
      t('Message'),
      t('Location'),
      t('Referrer'),
      t('Hostname'),
      t('Operations'),
    ];

    return $header;
  }

  /**
   * Build the main table rows.
   *
   * @param \Drupal\mongodb_watchdog\Event[] $events
   *   The event row data.
   * @param \Drupal\mongodb_watchdog\EventTemplate $eventTemplate
   *   The template for these events.
   *
   * @return array<string,array|string>
   *   A render array for a table.
   */
  protected function buildMainTableRows(array $events, EventTemplate $eventTemplate) {
    $rows = [];

    foreach ($events as $event) {
      // TODO bring this back from "model": it is a display method.
      $rows[] = $this->eventController->asTableRow($eventTemplate, $event);
    }

    return $rows;
  }

  /**
   * Title callback for mongodb_watchdog.detail.
   *
   * @param \Drupal\mongodb_watchdog\EventTemplate $eventTemplate
   *   The event template for which the title is built.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The page title.
   */
  public function buildTitle(EventTemplate $eventTemplate) {
    return t('MongoDB events: "@template"', ['@template' => $eventTemplate->message]);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

This method seems to be duplicated in your project.

    /** @var \Psr\Log\LoggerInterface $logger */
    $logger = $container->get('logger.channel.mongodb_watchdog');

    /** @var \Drupal\mongodb_watchdog\Logger $watchdog */
    $watchdog = $container->get('mongodb.logger');

    /** @var \Drupal\Core\Config\ImmutableConfig $config */
    $config = $container->get('config.factory')->get('mongodb_watchdog.settings');

    /** @var \Drupal\mongodb_watchdog\EventController $eventController */
    $eventController = $container->get('mongodb.watchdog_event_controller');

    return new static($logger, $watchdog, $config, $eventController);
  }

  /**
   * Obtain the data from the logger.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request. Needed for paging.
   * @param \Drupal\mongodb_watchdog\EventTemplate $eventTemplate
   *   The template for which to build the detail page.
   *
   * @return \Drupal\mongodb_watchdog\Event[]
   *   The data array.
   */
  protected function getRowData(Request $request, EventTemplate $eventTemplate) {
    $count = $this->watchdog->eventCount($eventTemplate);
    $page = $this->setupPager($request, $count);
    $skip = $page * $this->itemsPerPage;
    $limit = $this->itemsPerPage;

    $rows = $this->eventController
      ->find($eventTemplate, $skip, $limit)
      ->toArray();

    return $rows;
  }

  /**
   * Build the heading rows on the event occurrences page.
   *
   * @param \Drupal\mongodb_watchdog\EventTemplate|null $eventTemplate
   *   The template for which to provide details. Not actually expected to be
   *   NULL, but this is needed to remain compatible with parent class.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup[]
   *   A render array for a table.
   */
  protected function getTop(EventTemplate $eventTemplate = NULL) {
    $rows = [];
    foreach ($eventTemplate->keys() as $key => $info) {

It seems like $eventTemplate is not always an object, but can also be of type null. Maybe add an additional type check?

      $value = $eventTemplate->{$key};
      $row = [];
      $row[] = [
        'header' => TRUE,
        'data' => $info['label'],
      ];
      $row[] = isset($info['display_callback']) ? $info['display_callback']($value) : $value;
      $rows[] = $row;
    }

    $ret = [
      '#caption' => t('Event template'),
      '#rows' => $rows,
      '#type' => 'table',
    ];

    return $ret;
  }

}