You are here

Home » API reference » MongoDB 8.2 » DetailController.php

class DetailController in MongoDB 8.2

The controller for the event detail page.

Hierarchy

Expanded class hierarchy of DetailController

File

modules/mongodb_watchdog/src/Controller/DetailController.php, line 21

Namespace

Drupal\mongodb_watchdog\Controller
View source 
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.
   * @param \Drupal\Core\Pager\PagerManagerInterface $pagerManager
   *   The core pager.manager service.
   */
  public function __construct(LoggerInterface $logger, Logger $watchdog, ImmutableConfig $config, EventController $eventController, PagerManagerInterface $pagerManager) {
    parent::__construct($logger, $watchdog, $pagerManager, $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
   *   A render array.
   */
  public function build(Request $request, EventTemplate $eventTemplate) : array {
    $top = $this
      ->getTop($eventTemplate);
    $rows = $this
      ->getRowData($request, $eventTemplate);
    $main = empty($rows) ? $this
      ->buildEmpty($this
      ->t('No occurrence of this event found in logger.')) : $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
   *   A render array for the main table.
   */
  protected function buildMainTable(array $events, EventTemplate $eventTemplate) : array {
    $ret = [
      '#attributes' => new Attribute([
        'class' => 'mongodb_watchdog__detail',
      ]),
      '#caption' => $this
        ->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() : array {
    $header = [
      $this
        ->t('Date'),
      $this
        ->t('User'),
      $this
        ->t('Message'),
      $this
        ->t('Location'),
      $this
        ->t('Referrer'),
      $this
        ->t('Hostname'),
      $this
        ->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 string[array|string]
   *   A render array for a table.
   *
   * @throws \Drupal\Core\Entity\EntityMalformedException
   */
  protected function buildMainTableRows(array $events, EventTemplate $eventTemplate) : array {
    $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\Component\Render\MarkupInterface
   *   The page title.
   */
  public function buildTitle(EventTemplate $eventTemplate) : MarkupInterface {
    return $this
      ->t('MongoDB events: "@template"', [
      '@template' => $eventTemplate->message,
    ]);
  }

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

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

    /** @var \Drupal\mongodb_watchdog\Logger $watchdog */
    $watchdog = $container
      ->get(Logger::SERVICE_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');

    /** @var \Drupal\Core\Pager\PagerManagerInterface $pagerManager */
    $pagerManager = $container
      ->get('pager.manager');
    return new static($logger, $watchdog, $config, $eventController, $pagerManager);
  }

  /**
   * 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) : array {
    $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 per-template 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) : array {
    $rows = [];
    foreach ($eventTemplate
      ->keys() as $key => $info) {
      $value = $eventTemplate->{$key};
      $row = [];
      $row[] = [
        'header' => TRUE,
        'data' => $info['label'],
      ];
      $row[] = isset($info['display_callback']) ? $info['display_callback']($value) : $value;
      $rows[] = $row;
    }
    $ret = [
      '#caption' => $this
        ->t('Event template'),
      '#rows' => $rows,
      '#type' => 'table',
    ];
    return $ret;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$itemsPerPage protected property The items_per_page configuration value.
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$pagerManager protected property The pager.manager service.
ControllerBase::$stateService protected property The state service.
ControllerBase::$watchdog protected property The MongoDB logger, to load events.
ControllerBase::buildDefaults protected function The default build() implementation.
ControllerBase::buildEmpty protected function Build markup for a message about the lack of results.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::getPage public static function Return a reliable page number based on available data.
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::setupPager public function Set up the pager.
ControllerBase::state protected function Returns the state storage service.
DetailController::$eventController protected property The mongodb.watchdog_event_controller service.
DetailController::build public function Controller.
DetailController::buildMainTable protected function Build the main table.
DetailController::buildMainTableHeader protected function Build the main table header.
DetailController::buildMainTableRows protected function Build the main table rows.
DetailController::buildTitle public function Title callback for mongodb_watchdog.detail.
DetailController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
DetailController::getRowData protected function Obtain the data from the logger.
DetailController::getTop protected function Build the heading rows on the per-template event occurrences page. Overrides ControllerBase::getTop
DetailController::__construct public function Controller constructor. Overrides ControllerBase::__construct
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.
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.