Drupal\mongodb_watchdog\EventController

Complexity

Total Complexity

8

Size/Duplication

Total Lines	137
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	4

Importance

Changes	2
Bugs	0	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
B	asTableRow()	0	22	5
A	find()	0	16	1
A	count()	0	5	1

<?php

namespace Drupal\mongodb_watchdog;

use Drupal\Component\Utility\Unicode;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Datetime\DateFormatterInterface;
use Drupal\Core\Link;
use Drupal\Core\Url;
use Drupal\user\Entity\User;

/**
 * Class EventController provides query and render logic for Event occurrences.
 */
class EventController {

  /**
   * The length of the absolute home URL.
   *
   * @var int
   */
  protected $baseLength;

  /**
   * The date.formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * The absolute path to the site home.
   *
   * @var string
   */
  protected $front;

  /**
   * An instance cache for user accounts, which are used in a loop.
   *
   * @var array
   */
  protected $userCache = [];

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

  /**
   * EventController constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config
   *   The config.factory service.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The core data.formatter service.
   * @param \Drupal\mongodb_watchdog\Logger $watchdog
   *   The MongoDB logger service, to load events.
   */
  public function __construct(ConfigFactoryInterface $config,
    DateFormatterInterface $date_formatter,
    Logger $watchdog) {
    $this->anonymous = $config->get('user.settings')->get('anonymous');

The property anonymous does not exist. Did you maybe forget to declare it?

    $this->front = Url::fromRoute('<front>', [], ['absolute' => TRUE])->toString();
    $this->baseLength = Unicode::strlen($this->front) - 1;

It seems like \Drupal\Component\Utility\Unicode::strlen($this->front) - 1 can also be of type double. However, the property $baseLength is declared as type integer. Maybe add an additional type check?

    $this->dateFormatter = $date_formatter;
    $this->watchdog = $watchdog;
  }

  /**
   * Provide a table rows representation of an event occurrence.
   *
   * @param \Drupal\mongodb_watchdog\EventTemplate $template
   *   The template for which the occurrence exists.
   * @param \Drupal\mongodb_watchdog\Event $event
   *   The event occurrence to represent.
   *
   * @return array
   *   A render array.
   */
  public function asTableRow(EventTemplate $template, Event $event) {
    $uid = intval($event->uid);
    if (!isset($this->userCache[$uid])) {
      $this->userCache[$uid] = $uid ? User::load($uid)->toLink() : $this->anonymous;
    }

    $ret = [
      $this->dateFormatter->format($event->timestamp),
      $this->userCache[$uid],
      // Locations generated from Drush/Console will not necessarily match the
      // site home URL, and will not therefore not necessarily be reachable, so
      // we only generate a link if the location is "within" the site.
      (Unicode::strpos($event->location, $this->front) === 0)
        ? Link::fromTextAndUrl(Unicode::substr($event->location, $this->baseLength), Url::fromUri($event->location))
        : $event->location,
      empty($event->referrer) ? '' : Link::fromTextAndUrl($event->referrer, Url::fromUri($event->referrer)),
      $event->hostname,
      $template->asString($event->variables),
      [],
    ];
    return $ret;
  }

  /**
   * Load MongoDB watchdog events for a given event template.
   *
   * @param \Drupal\mongodb_watchdog\EventTemplate $template
   *   The template for which to find events.
   * @param string $first_id
   *   The string representation of the first event to match.
   * @param int $limit
   *   The limit on the number of objects to return.
   *
   * @return \MongoDB\Driver\Cursor
   *   A cursor to the event occurrences.
   */
  public function find(EventTemplate $template, $first_id, $limit) {

The parameter $first_id is not used and could be removed.

    $collection = $this->watchdog->eventCollection($template->_id);
    $selector = [];
    $options = [
      'limit' => $limit,
      'sort' => ['timestamp' => -1],
      'typeMap' => [
        'array' => 'array',
        'document' => 'array',
        'root' => 'Drupal\mongodb_watchdog\Event',
      ],
    ];

    $result = $collection->find($selector, $options);
    return $result;
  }

  /**
   * Return the number of event occurrences for a given template.
   *
   * @param \Drupal\mongodb_watchdog\EventTemplate $template
   *   The template for which to count events.
   *
   * @return int
   *   The number of occurrences.
   */
  public function count(EventTemplate $template) {
    $collection = $this->watchdog->eventCollection($template->_id);
    $ret = $collection->count();
    return $ret;
  }

}

As per coding style, files should not end with a newline character.