RequestController::buildMainTableHeader() - Code Metrics - Inspection of "Issue #2763495: Reduce duplication in controllers..." - FGM/mongodb - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 8.x-2.x ( 74e505...ec080d )

by Frédéric G.

created 2016-07-10 17:34 UTC

RequestController::buildMainTableHeader() A

↳ Parent: RequestController

Complexity

Conditions	1
Paths	1

Size

Total Lines	12
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	9
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	12
rs	9.4285

<?php

namespace Drupal\mongodb_watchdog\Controller;

use Drupal\Component\Utility\Unicode;
use Drupal\Core\Config\ImmutableConfig;
use Drupal\Core\Datetime\DateFormatterInterface;
use Drupal\Core\Link;
use Drupal\Core\Logger\RfcLogLevel;
use Drupal\mongodb_watchdog\Event;
use Drupal\mongodb_watchdog\Logger;
use Psr\Log\LoggerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

/**
 * The controller for the request events page.
 */
class RequestController extends ControllerBase {

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

  /**
   * A RfcLogLevel instance, to avoid static access.
   *
   * @var \Drupal\Core\Logger\RfcLogLevel
   */
  protected $rfcLogLevel;

  /**
   * The length of the absolute path to the site root, in runes.
   *
   * @var int
   */
  protected $rootLength;

  /**
   * A Unicode instance, to avoid static access.
   *
   * @var \Drupal\Component\Utility\Unicode
   */
  protected $unicode;

  /**
   * 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\Core\Datetime\DateFormatterInterface $dateFormatter
   *   The core date.formatter service.
   * @param \Drupal\Component\Utility\Unicode $unicode
   *   A Unicode instance, to avoid static access.
   * @param \Drupal\Core\Logger\RfcLogLevel $rfcLogLevel
   *   A RfcLogLevel instance, to avoid static access.
   */
  public function __construct(

    LoggerInterface $logger,
    Logger $watchdog,
    ImmutableConfig $config,
    DateFormatterInterface $dateFormatter,
    Unicode $unicode,
    RfcLogLevel $rfcLogLevel) {
    parent::__construct($logger, $watchdog, $config);

    $this->dateFormatter = $dateFormatter;
    $this->rfcLogLevel = $rfcLogLevel;
    $this->unicode = $unicode;

    // Add terminal "/".
    $this->rootLength = $this->unicode->strlen(DRUPAL_ROOT) + 1;
  }

  /**
   * Controller.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   * @param string $uniqueId
   *   The unique request id from mod_unique_id. Unsafe.
   *
   * @return array<string,string|array>
   *   A render array.
   */
  public function build(Request $request, $uniqueId) {
    if (!preg_match('/^[\w-@]+$/', $uniqueId)) {
      throw new NotFoundHttpException(t('Request ID is not well-formed.'));
    }

    $events = $this->getRowData($request, $uniqueId);

    if (empty($events)) {
      $top = NULL;
      $main = $this->buildEmpty(t('No events found for this request.'));
    }
    else {
      list(, $first) = reset($events);
      $top = $this->getTop($uniqueId, $first);
      $main = $this->buildMainTable($events);
    }

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

  /**
   * Build the main table.
   *
   * @param array $rows
   *   The event data.
   *
   * @return array<string,string|array>

   *   A render array for the main table.
   */
  protected function buildMainTable(array $rows) {

    $ret = [
      '#header' => $this->buildMainTableHeader(),
      '#rows' => $this->buildMainTableRows($rows),
      '#type' => 'table',
    ];
    return $ret;
  }

  /**
   * Build the main table header.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup[]
   *   A table header array.
   */
  protected function buildMainTableHeader() {
    $header = [
      t('Sequence'),
      t('Type'),
      t('Severity'),
      t('Event'),
      t('File'),
      t('Line'),
    ];

    return $header;
  }

  /**
   * Build the main table rows.
   *
   * @param array<\Drupal\mongodb_watchdog\EventTemplate\Drupal\mongodb_watchdog\Event[]> $events
   *   A fully loaded array of events and their templates.
   *
   * @return array<string,array|string>
   *   A render array for a table.
   */
  protected function buildMainTableRows(array $events) {
    $rows = [];
    $levels = $this->rfcLogLevel->getLevels();

    /** @var \Drupal\mongodb_watchdog\EventTemplate $template */
    /** @var \Drupal\mongodb_watchdog\Event $event */
    foreach ($events as list($template, $event)) {

      $row = [];
      $row[] = ['data' => $event->requestTracking_sequence];

      $row[] = $template->type;

      $row[] = [
        'data' => $levels[$template->severity],

        'class' => OverviewController::SEVERITY_CLASSES[$template->severity],

      ];
      $row[] = [
        'data' => Link::createFromRoute($template->asString($event->variables), 'mongodb_watchdog.reports.detail', [

          'eventTemplate' => $template->_id,

        ]),
      ];
      $row[] = $this->simplifyPath($event->variables['%file']);

      $row[] = $event->variables['%line'];

      $rows[] = $row;
    }

    return $rows;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    /** @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\Core\Datetime\DateFormatterInterface $dateFormatter */
    $dateFormatter = $container->get('date.formatter');

    $rfcLogLevel = new RfcLogLevel();
    $unicode = new Unicode();

    return new static($logger, $watchdog, $config, $dateFormatter, $unicode, $rfcLogLevel);
  }

  /**
   * Obtain the data from the logger.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request. Needed for paging.
   * @param string $uniqueId
   *   The request for which to build the detail page.
   *
   * @return \Drupal\mongodb_watchdog\Event[]

   *   The data array.
   */
  protected function getRowData(Request $request, $uniqueId) {

    $count = $this->watchdog->requestEventsCount($uniqueId);
    $page = $this->setupPager($request, $count);
    $skip = $page * $this->itemsPerPage;
    $height = $this->itemsPerPage;

    $events = $this->watchdog->requestEvents($uniqueId, $skip, $height);
    return $events;
  }

  /**
   * Build the heading rows on the per-request event occurrences page.
   *
   * @param string $uniqueId

   *   The unique request id.
   * @param \Drupal\mongodb_watchdog\Event $first

   *   A fully loaded array of events and their templates.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup[]
   *   A render array for a table.
   */
  protected function getTop($uniqueId = NULL, Event $first = NULL) {
    $location = $first->location;
    $timestamp = isset($first->timestamp)
      ? $this->dateFormatter->format($first->timestamp, 'long')
      : t('No information');

    $rows = [
      [t('Request ID'), $uniqueId],
      [t('Location'), $location],
      [t('Date/time'), $timestamp],
    ];

    foreach ($rows as &$row) {
      $row[0] = [
        'data' => $row[0],
        'header' => TRUE,
      ];
    }

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

    return $ret;
  }

  /**
   * Convert an absolute path to a relative one if below the site root.
   *
   * @param string $path
   *   An absolute path on the filesystem.
   *
   * @return string
   *   A relative path if possible, otherwise the input path.
   */
  public function simplifyPath($path) {
    $ret = ($this->unicode->strpos($path, DRUPAL_ROOT) === 0)
      ? $this->unicode->substr($path, $this->rootLength)
      : $path;

    return $ret;
  }

}


1		<?php
2
3		namespace Drupal\mongodb_watchdog\Controller;
4
5		use Drupal\Component\Utility\Unicode;
6		use Drupal\Core\Config\ImmutableConfig;
7		use Drupal\Core\Datetime\DateFormatterInterface;
8		use Drupal\Core\Link;
9		use Drupal\Core\Logger\RfcLogLevel;
10		use Drupal\mongodb_watchdog\Event;
11		use Drupal\mongodb_watchdog\Logger;
12		use Psr\Log\LoggerInterface;
13		use Symfony\Component\DependencyInjection\ContainerInterface;
14		use Symfony\Component\HttpFoundation\Request;
15		use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
16
17		/**
18		* The controller for the request events page.
19		*/
20		class RequestController extends ControllerBase {
21
22		/**
23		* The core date.formatter service.
24		*
25		* @var \Drupal\Core\Datetime\DateFormatterInterface
26		*/
27		protected $dateFormatter;
28
29		/**
30		* A RfcLogLevel instance, to avoid static access.
31		*
32		* @var \Drupal\Core\Logger\RfcLogLevel
33		*/
34		protected $rfcLogLevel;
35
36		/**
37		* The length of the absolute path to the site root, in runes.
38		*
39		* @var int
40		*/
41		protected $rootLength;
42
43		/**
44		* A Unicode instance, to avoid static access.
45		*
46		* @var \Drupal\Component\Utility\Unicode
47		*/
48		protected $unicode;
49
50		/**
51		* Controller constructor.
52		*
53		* @param \Psr\Log\LoggerInterface $logger
54		* The logger service, to log intervening events.
55		* @param \Drupal\mongodb_watchdog\Logger $watchdog
56		* The MongoDB logger, to load stored events.
57		* @param \Drupal\Core\Config\ImmutableConfig $config
58		* The module configuration.
59		* @param \Drupal\Core\Datetime\DateFormatterInterface $dateFormatter
60		* The core date.formatter service.
61		* @param \Drupal\Component\Utility\Unicode $unicode
62		* A Unicode instance, to avoid static access.
63		* @param \Drupal\Core\Logger\RfcLogLevel $rfcLogLevel
64		* A RfcLogLevel instance, to avoid static access.
65		*/
66	View Code Duplication	public function __construct(
		0 ignored issues – show Duplication introduced 2016-07-10 17:31 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
67		LoggerInterface $logger,
68		Logger $watchdog,
69		ImmutableConfig $config,
70		DateFormatterInterface $dateFormatter,
71		Unicode $unicode,
72		RfcLogLevel $rfcLogLevel) {
73		parent::__construct($logger, $watchdog, $config);
74
75		$this->dateFormatter = $dateFormatter;
76		$this->rfcLogLevel = $rfcLogLevel;
77		$this->unicode = $unicode;
78
79		// Add terminal "/".
80		$this->rootLength = $this->unicode->strlen(DRUPAL_ROOT) + 1;
81		}
82
83		/**
84		* Controller.
85		*
86		* @param \Symfony\Component\HttpFoundation\Request $request
87		* The current request.
88		* @param string $uniqueId
89		* The unique request id from mod_unique_id. Unsafe.
90		*
91		* @return array<string,string\|array>
92		* A render array.
93		*/
94		public function build(Request $request, $uniqueId) {
95		if (!preg_match('/^[\w-@]+$/', $uniqueId)) {
96		throw new NotFoundHttpException(t('Request ID is not well-formed.'));
97		}
98
99		$events = $this->getRowData($request, $uniqueId);
100
101		if (empty($events)) {
102		$top = NULL;
103		$main = $this->buildEmpty(t('No events found for this request.'));
104		}
105		else {
106		list(, $first) = reset($events);
107		$top = $this->getTop($uniqueId, $first);
108		$main = $this->buildMainTable($events);
109		}
110
111		$ret = $this->buildDefaults($main, $top);
112		return $ret;
113		}
114
115		/**
116		* Build the main table.
117		*
118		* @param array $rows
119		* The event data.
120		*
121		* @return array<string,string\|array>
		0 ignored issues – show Documentation introduced 2016-07-10 17:19 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `array<string,\Drupal\Cor...g,array\|string>\|string>`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
122		* A render array for the main table.
123		*/
124	View Code Duplication	protected function buildMainTable(array $rows) {
		0 ignored issues – show Duplication introduced 2016-07-10 17:19 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
125		$ret = [
126		'#header' => $this->buildMainTableHeader(),
127		'#rows' => $this->buildMainTableRows($rows),
128		'#type' => 'table',
129		];
130		return $ret;
131		}
132
133		/**
134		* Build the main table header.
135		*
136		* @return \Drupal\Core\StringTranslation\TranslatableMarkup[]
137		* A table header array.
138		*/
139		protected function buildMainTableHeader() {
140		$header = [
141		t('Sequence'),
142		t('Type'),
143		t('Severity'),
144		t('Event'),
145		t('File'),
146		t('Line'),
147		];
148
149		return $header;
150		}
151
152		/**
153		* Build the main table rows.
154		*
155		* @param array<\Drupal\mongodb_watchdog\EventTemplate\Drupal\mongodb_watchdog\Event[]> $events
156		* A fully loaded array of events and their templates.
157		*
158		* @return array<string,array\|string>
159		* A render array for a table.
160		*/
161		protected function buildMainTableRows(array $events) {
162		$rows = [];
163		$levels = $this->rfcLogLevel->getLevels();
164
165		/** @var \Drupal\mongodb_watchdog\EventTemplate $template */
166		/** @var \Drupal\mongodb_watchdog\Event $event */
167		foreach ($events as list($template, $event)) {
		0 ignored issues – show introduced 2016-07-01 20:41 UTC by Report Bug Copy Issue Report Variable $template is undefined. Loading history... introduced 2016-07-01 20:41 UTC by Report Bug Copy Issue Report Variable $event is undefined. Loading history...
168		$row = [];
169		$row[] = ['data' => $event->requestTracking_sequence];
		0 ignored issues – show introduced 2016-07-01 20:41 UTC by Report Bug Copy Issue Report Variable $event is undefined. Loading history...
170		$row[] = $template->type;
		0 ignored issues – show introduced 2016-07-10 17:19 UTC by Report Bug Copy Issue Report Variable $template is undefined. Loading history...
171		$row[] = [
172		'data' => $levels[$template->severity],
		0 ignored issues – show introduced 2016-07-01 20:41 UTC by Report Bug Copy Issue Report Variable $template is undefined. Loading history...
173		'class' => OverviewController::SEVERITY_CLASSES[$template->severity],
		0 ignored issues – show introduced 2016-07-01 20:41 UTC by Report Bug Copy Issue Report Variable $template is undefined. Loading history...
174		];
175		$row[] = [
176		'data' => Link::createFromRoute($template->asString($event->variables), 'mongodb_watchdog.reports.detail', [
		0 ignored issues – show introduced 2016-07-03 09:19 UTC by Report Bug Copy Issue Report Variable $template is undefined. Loading history... introduced 2016-07-03 09:19 UTC by Report Bug Copy Issue Report Variable $event is undefined. Loading history...
177		'eventTemplate' => $template->_id,
		0 ignored issues – show introduced 2016-07-03 09:19 UTC by Report Bug Copy Issue Report Variable $template is undefined. Loading history...
178		]),
179		];
180		$row[] = $this->simplifyPath($event->variables['%file']);
		0 ignored issues – show introduced 2016-07-01 20:41 UTC by Report Bug Copy Issue Report Variable $event is undefined. Loading history...
181		$row[] = $event->variables['%line'];
		0 ignored issues – show introduced 2016-07-10 17:19 UTC by Report Bug Copy Issue Report Variable $event is undefined. Loading history...
182		$rows[] = $row;
183		}
184
185		return $rows;
186		}
187
188		/**
189		* {@inheritdoc}
190		*/
191		public static function create(ContainerInterface $container) {
192		/** @var \Psr\Log\LoggerInterface $logger */
193		$logger = $container->get('logger.channel.mongodb_watchdog');
194
195		/** @var \Drupal\mongodb_watchdog\Logger $watchdog */
196		$watchdog = $container->get('mongodb.logger');
197
198		/** @var \Drupal\Core\Config\ImmutableConfig $config */
199		$config = $container->get('config.factory')->get('mongodb_watchdog.settings');
200
201		/** @var \Drupal\Core\Datetime\DateFormatterInterface $dateFormatter */
202		$dateFormatter = $container->get('date.formatter');
203
204		$rfcLogLevel = new RfcLogLevel();
205		$unicode = new Unicode();
206
207		return new static($logger, $watchdog, $config, $dateFormatter, $unicode, $rfcLogLevel);
208		}
209
210		/**
211		* Obtain the data from the logger.
212		*
213		* @param \Symfony\Component\HttpFoundation\Request $request
214		* The current request. Needed for paging.
215		* @param string $uniqueId
216		* The request for which to build the detail page.
217		*
218		* @return \Drupal\mongodb_watchdog\Event[]
		0 ignored issues – show Documentation introduced 2016-07-10 17:19 UTC by Report Bug Copy Issue Report Should the return type not be `\Drupal\mongodb_watchdog...godb_watchdog\Event[][]`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
219		* The data array.
220		*/
221	View Code Duplication	protected function getRowData(Request $request, $uniqueId) {
		0 ignored issues – show Duplication introduced 2016-07-10 17:19 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
222		$count = $this->watchdog->requestEventsCount($uniqueId);
223		$page = $this->setupPager($request, $count);
224		$skip = $page * $this->itemsPerPage;
225		$height = $this->itemsPerPage;
226
227		$events = $this->watchdog->requestEvents($uniqueId, $skip, $height);
228		return $events;
229		}
230
231		/**
232		* Build the heading rows on the per-request event occurrences page.
233		*
234		* @param string $uniqueId
		0 ignored issues – show Documentation introduced 2016-07-10 17:19 UTC by Report Bug Copy Issue Report Should the type for parameter `$uniqueId` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
235		* The unique request id.
236		* @param \Drupal\mongodb_watchdog\Event $first
		0 ignored issues – show Documentation introduced 2016-07-10 17:19 UTC by Report Bug Copy Issue Report Should the type for parameter `$first` not be `null\|Event`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
237		* A fully loaded array of events and their templates.
238		*
239		* @return \Drupal\Core\StringTranslation\TranslatableMarkup[]
240		* A render array for a table.
241		*/
242		protected function getTop($uniqueId = NULL, Event $first = NULL) {
243		$location = $first->location;
244		$timestamp = isset($first->timestamp)
245		? $this->dateFormatter->format($first->timestamp, 'long')
246		: t('No information');
247
248		$rows = [
249		[t('Request ID'), $uniqueId],
250		[t('Location'), $location],
251		[t('Date/time'), $timestamp],
252		];
253
254		foreach ($rows as &$row) {
255		$row[0] = [
256		'data' => $row[0],
257		'header' => TRUE,
258		];
259		}
260
261		$ret = [
262		'#caption' => t('Request'),
263		'#rows' => $rows,
264		'#type' => 'table',
265		];
266
267		return $ret;
268		}
269
270		/**
271		* Convert an absolute path to a relative one if below the site root.
272		*
273		* @param string $path
274		* An absolute path on the filesystem.
275		*
276		* @return string
277		* A relative path if possible, otherwise the input path.
278		*/
279		public function simplifyPath($path) {
280		$ret = ($this->unicode->strpos($path, DRUPAL_ROOT) === 0)
281		? $this->unicode->substr($path, $this->rootLength)
282		: $path;
283
284		return $ret;
285		}
286
287		}
288

FGM / mongodb

Push — 8.x-2.x ( 74e505...ec080d )

RequestController::buildMainTableHeader() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like