AdminController::overview() - Code Metrics - Inspection of "Form, tabs and style, as close as possible to dblo..." - FGM/mongodb - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 8.x-2.x (#5)

by Frédéric G.

created 2016-07-02 07:56 UTC

AdminController::overview() B

↳ Parent: Project

Complexity

Conditions	7
Paths	33

Size

Total Lines	65
Code Lines	34

Duplication

Lines	0
Ratio	0 %

Importance

Changes	7
Bugs	0	Features	1

Metric	Value
cc	7
eloc	34
c	7
b	0
f	1
nc	33
nop	0
dl	0
loc	65
rs	7.1439

How to fix Long Method

<?php

/**
 * @file
 * Contains AdminController.
 */

namespace Drupal\mongodb_watchdog\Controller;

use Drupal\Component\Utility\Unicode;
use Drupal\Core\Controller\ControllerBase;
use Drupal\Core\Logger\RfcLogLevel;
use Drupal\Core\Url;
use Drupal\mongodb_watchdog\Logger;
use MongoDB\Database;
use Psr\Log\LogLevel;
use Psr\Log\LoggerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Form\FormBuilderInterface;


/**
 * Class AdminController.
 *
 * @package Drupal\mongodb_watchdog
 */
class AdminController extends ControllerBase {

  /**
   * The MongoDB database for the logger alias.
   *
   * @var \MongoDB
   */
  protected $database;

  /**
   * The core logger channel, to log intervening events.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

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

   * The module handler service.

   *

   * @var \Drupal\Core\Extension\ModuleHandlerInterface

   */

  protected $moduleHandler;

  /**
   * The form builder service.
   *
   * @var \Drupal\Core\Form\FormBuilderInterface
   */
  protected $formBuilder;

  /**
   * Constructor.
   *
   * @param \MongoDB $database
   *   The watchdog database.
   * @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\Extension\ModuleHandlerInterface $module_handler
   *   A module handler.
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The form builder service.
   */
  public function __construct(Database $database, LoggerInterface $logger, Logger $watchdog, ModuleHandlerInterface $module_handler, FormBuilderInterface $form_builder) {

    $this->database = $database;
    $this->logger = $logger;
    $this->moduleHandler = $module_handler;
    $this->formBuilder = $form_builder;
    $this->watchdog = $watchdog;
  }

  /**
   * Controller for mongodb_watchdog.overview.
   *
   * @return array
   *   A render array.
   */
  public function overview() {
    $icons = array(
      RfcLogLevel::DEBUG     => '',
      RfcLogLevel::INFO      => '',
      RfcLogLevel::NOTICE    => '',
      RfcLogLevel::WARNING   => ['#theme' => 'image', 'path' => 'misc/watchdog-warning.png', 'alt' => t('warning'), 'title' => t('warning')],
      RfcLogLevel::ERROR     => ['#theme' => 'image', 'path' => 'misc/watchdog-error.png', 'alt' => t('error'), 'title' => t('error')],
      RfcLogLevel::CRITICAL  => ['#theme' => 'image', 'path' => 'misc/watchdog-error.png', 'alt' => t('critical'), 'title' => t('critical')],
      RfcLogLevel::ALERT     => ['#theme' => 'image', 'path' => 'misc/watchdog-error.png', 'alt' => t('alert'), 'title' => t('alert')],
      RfcLogLevel::EMERGENCY => ['#theme' => 'image', 'path' => 'misc/watchdog-error.png', 'alt' => t('emergency'), 'title' => t('emergency')],
    );

    $collection = $this->watchdog->templateCollection();
    $templates = $collection->find([], TopController::LEGACY_TYPE_MAP)->toArray();
ksm($templates);

    $this->moduleHandler->loadInclude('mongodb_watchdog', 'admin.inc');

    $build['dblog_filter_form'] = $this->formBuilder->getForm('Drupal\mongodb_watchdog\Form\MongodbWatchdogFilterForm');

    $header = array(
      // Icon column.
      '',
      t('#'),
      array('data' => t('Type')),
      array('data' => t('Date')),
      t('Source'),
      t('Message'),
    );

    $rows = array();
    foreach ($templates as $id => $value) {
      if ($id < 5) {
//        if ($value['type'] == 'php' && $value['message'] == '%type: %message in %function (line %line of %file).') {

//          $collection = $this->logger->eventCollection($value['_id']);

//          $result = $collection->find()

//            ->sort(['$natural' => -1])

//            ->limit(1)

//            ->getNext();

//          if ($value) {

//            $value['file'] = basename($result['variables']['%file']);

//            $value['line'] = $result['variables']['%line'];

//            $value['message'] = '%type in %function';

//            $value['variables'] = $result['variables'];

//          }

//        }

        $message = Unicode::truncate(strip_tags(SafeMarkup::format($value['message'], [])), 56, TRUE, TRUE);
        $value['count'] = $this->watchdog->eventCollection($value['_id'])->count();
        $rows[$id] = [
          $icons[$value['severity']],
          isset($value['count']) && $value['count'] > 1 ? intval($value['count']) : 0,
          t($value['type']),

          empty($value['timestamp']) ? '' : format_date($value['timestamp'], 'short'),
          empty($value['file']) ? '' : Unicode::truncate(basename($value['file']), 30) . (empty($value['line']) ? '' : ('+' . $value['line'])),
          \Drupal::l($message, Url::fromRoute('mongodb_watchdog.reports.detail', ['id' => $id])),
        ];
      }

    }
kint($rows);

    $build['mongodb_watchdog_table'] = array(
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => $rows,
      '#attributes' => ['id' => 'admin-mongodb_watchdog'],
      '#attached' => array(
        'library' => array('mongodb_watchdog/drupal.mongodb_watchdog'),
      ),
    );

    $build['mongodb_watchdog_pager'] = array('#type' => 'pager');

    return $build;
  }

  /**
   * The controller factory.
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   *   The DIC.
   *
   * @return static
   *   The database instance.
   */
  public static function create(ContainerInterface $container) {
    /** @var \MongoDB $database */
    $database = $container->get('mongodb.watchdog_storage');

    $form_builder = $container->get('form_builder');

    $module_handler = $container->get('module_handler');

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

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

    return new static($database, $logger, $watchdog, $module_handler, $form_builder);
  }
}



1			<?php
2
3			/**
4			* @file
5			* Contains AdminController.
6			*/
7
8			namespace Drupal\mongodb_watchdog\Controller;
9
10			use Drupal\Component\Utility\Unicode;
11			use Drupal\Core\Controller\ControllerBase;
12			use Drupal\Core\Logger\RfcLogLevel;
13			use Drupal\Core\Url;
14			use Drupal\mongodb_watchdog\Logger;
15			use MongoDB\Database;
16			use Psr\Log\LogLevel;
17			use Psr\Log\LoggerInterface;
18			use Symfony\Component\DependencyInjection\ContainerInterface;
19			use Drupal\Core\Extension\ModuleHandlerInterface;
20			use Drupal\Core\Form\FormBuilderInterface;
21
22
23			/**
24			* Class AdminController.
25			*
26			* @package Drupal\mongodb_watchdog
27			*/
28			class AdminController extends ControllerBase {
29
30			/**
31			* The MongoDB database for the logger alias.
32			*
33			* @var \MongoDB
34			*/
35			protected $database;
36
37			/**
38			* The core logger channel, to log intervening events.
39			*
40			* @var \Psr\Log\LoggerInterface
41			*/
42			protected $logger;
43
44			/**
45			* The MongoDB logger, to load events.
46			*
47			* @var \Drupal\mongodb_watchdog\Logger
48			*/
49			protected $watchdog;
50
51			* The module handler service.
			0 ignored issues – show Bug introduced 2016-07-02 07:59 UTC by Report Bug Copy Issue Report This code did not parse for me. Apparently, there is an error somewhere around this line: Syntax error, unexpected '', expecting T_FUNCTION Loading history... Coding Style introduced 2016-07-02 07:59 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 2 spaces, found 3 Loading history... introduced 2016-07-02 07:59 UTC by Report Bug Copy Issue Report Expected 1 space before ""; newline found Loading history... introduced 2016-07-02 07:59 UTC by Report Bug Copy Issue Report Concat operator must be surrounded by spaces Loading history...
52			*
			0 ignored issues – show introduced 2016-07-02 07:59 UTC by Report Bug Copy Issue Report Expected 1 space before "*"; newline found Loading history...
53			* @var \Drupal\Core\Extension\ModuleHandlerInterface
			0 ignored issues – show introduced 2016-07-02 07:59 UTC by Report Bug Copy Issue Report Expected 1 space before "*"; newline found Loading history...
54			*/
			0 ignored issues – show introduced 2016-07-02 07:59 UTC by Report Bug Copy Issue Report Expected 1 space before ""; newline found Loading history... introduced 2016-07-02 07:59 UTC by Report Bug Copy Issue Report Expected 1 space after ""; 0 found Loading history... introduced 2016-07-02 07:59 UTC by Report Bug Copy Issue Report Expected 1 space before "/"; 0 found Loading history...
55			protected $moduleHandler;
56
57			/**
58			* The form builder service.
59			*
60			* @var \Drupal\Core\Form\FormBuilderInterface
61			*/
62			protected $formBuilder;
63
64			/**
65			* Constructor.
66			*
67			* @param \MongoDB $database
68			* The watchdog database.
69			* @param \Psr\Log\LoggerInterface $logger
70			* The logger service, to log intervening events.
71			* @param \Drupal\mongodb_watchdog\Logger $watchdog
72			* The MongoDB logger, to load stored events.
73			* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
74			* A module handler.
75			* @param \Drupal\Core\Form\FormBuilderInterface $form_builder
76			* The form builder service.
77			*/
78			public function __construct(Database $database, LoggerInterface $logger, Logger $watchdog, ModuleHandlerInterface $module_handler, FormBuilderInterface $form_builder) {
			0 ignored issues – show introduced 2016-07-02 07:59 UTC by Report Bug Copy Issue Report Expected type hint "MongoDB"; found "Database" for $database Loading history...
79			$this->database = $database;
80			$this->logger = $logger;
81			$this->moduleHandler = $module_handler;
82			$this->formBuilder = $form_builder;
83			$this->watchdog = $watchdog;
84			}
85
86			/**
87			* Controller for mongodb_watchdog.overview.
88			*
89			* @return array
90			* A render array.
91			*/
92			public function overview() {
93			$icons = array(
94			RfcLogLevel::DEBUG => '',
95			RfcLogLevel::INFO => '',
96			RfcLogLevel::NOTICE => '',
97			RfcLogLevel::WARNING => ['#theme' => 'image', 'path' => 'misc/watchdog-warning.png', 'alt' => t('warning'), 'title' => t('warning')],
98			RfcLogLevel::ERROR => ['#theme' => 'image', 'path' => 'misc/watchdog-error.png', 'alt' => t('error'), 'title' => t('error')],
99			RfcLogLevel::CRITICAL => ['#theme' => 'image', 'path' => 'misc/watchdog-error.png', 'alt' => t('critical'), 'title' => t('critical')],
100			RfcLogLevel::ALERT => ['#theme' => 'image', 'path' => 'misc/watchdog-error.png', 'alt' => t('alert'), 'title' => t('alert')],
101			RfcLogLevel::EMERGENCY => ['#theme' => 'image', 'path' => 'misc/watchdog-error.png', 'alt' => t('emergency'), 'title' => t('emergency')],
102			);
103
104			$collection = $this->watchdog->templateCollection();
105			$templates = $collection->find([], TopController::LEGACY_TYPE_MAP)->toArray();
106			ksm($templates);
			0 ignored issues – show Coding Style introduced 2016-06-26 12:01 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 4 spaces, found 0 Loading history...
107			$this->moduleHandler->loadInclude('mongodb_watchdog', 'admin.inc');
108
109			$build['dblog_filter_form'] = $this->formBuilder->getForm('Drupal\mongodb_watchdog\Form\MongodbWatchdogFilterForm');
110
111			$header = array(
112			// Icon column.
113			'',
114			t('#'),
115			array('data' => t('Type')),
116			array('data' => t('Date')),
117			t('Source'),
118			t('Message'),
119			);
120
121			$rows = array();
122			foreach ($templates as $id => $value) {
123			if ($id < 5) {
124			// if ($value['type'] == 'php' && $value['message'] == '%type: %message in %function (line %line of %file).') {
			0 ignored issues – show introduced 2016-06-25 15:29 UTC by Report Bug Copy Issue Report Line exceeds 80 characters; contains 118 characters Loading history... Unused Code Comprehensibility introduced 2016-06-24 11:00 UTC by Report Bug Copy Issue Report `60%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history... Coding Style introduced 2016-06-25 15:29 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 0 Loading history... introduced 2016-06-25 15:29 UTC by Report Bug Copy Issue Report 8 spaces found before inline comment; expected "// if ($value['type'] == 'php' && $value['message'] == 'type: message in function (line line of file).') {" but found "// if ($value['type'] == 'php' && $value['message'] == 'type: message in function (line line of file).') {" Loading history... introduced 2016-06-24 11:00 UTC by Report Bug Copy Issue Report Inline comments must start with a capital letter Loading history...
125			// $collection = $this->logger->eventCollection($value['_id']);
			0 ignored issues – show Coding Style introduced 2016-06-25 15:29 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 0 Loading history... introduced 2016-06-25 15:29 UTC by Report Bug Copy Issue Report Comment indentation error, expected only 8 spaces Loading history...
126			// $result = $collection->find()
			0 ignored issues – show Coding Style introduced 2016-06-25 15:29 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 0 Loading history...
127			// ->sort(['$natural' => -1])
			0 ignored issues – show Coding Style introduced 2016-06-25 15:29 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 0 Loading history... introduced 2016-06-25 15:29 UTC by Report Bug Copy Issue Report Comment indentation error, expected only 10 spaces Loading history...
128			// ->limit(1)
			0 ignored issues – show Coding Style introduced 2016-06-25 15:29 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 0 Loading history...
129			// ->getNext();
			0 ignored issues – show Coding Style introduced 2016-06-25 15:29 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 0 Loading history...
130			// if ($value) {
			0 ignored issues – show Coding Style introduced 2016-06-25 15:29 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 0 Loading history...
131			// $value['file'] = basename($result['variables']['%file']);
			0 ignored issues – show Coding Style introduced 2016-06-25 15:29 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 0 Loading history... introduced 2016-06-25 15:29 UTC by Report Bug Copy Issue Report Comment indentation error, expected only 10 spaces Loading history...
132			// $value['line'] = $result['variables']['%line'];
			0 ignored issues – show Coding Style introduced 2016-06-25 15:29 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 0 Loading history...
133			// $value['message'] = '%type in %function';
			0 ignored issues – show Coding Style introduced 2016-06-25 15:29 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 0 Loading history...
134			// $value['variables'] = $result['variables'];
			0 ignored issues – show Coding Style introduced 2016-06-25 15:29 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 0 Loading history...
135			// }
			0 ignored issues – show Coding Style introduced 2016-06-25 15:29 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 0 Loading history...
136			// }
			0 ignored issues – show Coding Style introduced 2016-06-26 12:01 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 0 Loading history...
137			$message = Unicode::truncate(strip_tags(SafeMarkup::format($value['message'], [])), 56, TRUE, TRUE);
138			$value['count'] = $this->watchdog->eventCollection($value['_id'])->count();
139			$rows[$id] = [
140			$icons[$value['severity']],
141			isset($value['count']) && $value['count'] > 1 ? intval($value['count']) : 0,
142			t($value['type']),
			0 ignored issues – show introduced 2016-06-24 11:00 UTC by Report Bug Copy Issue Report Only string literals should be passed to t() where possible Loading history...
143			empty($value['timestamp']) ? '' : format_date($value['timestamp'], 'short'),
144			empty($value['file']) ? '' : Unicode::truncate(basename($value['file']), 30) . (empty($value['line']) ? '' : ('+' . $value['line'])),
145			\Drupal::l($message, Url::fromRoute('mongodb_watchdog.reports.detail', ['id' => $id])),
146			];
147			}
148
149			}
150			kint($rows);
			0 ignored issues – show Coding Style introduced 2016-06-25 15:29 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 4 spaces, found 0 Loading history...
151			$build['mongodb_watchdog_table'] = array(
152			'#theme' => 'table',
153			'#header' => $header,
154			'#rows' => $rows,
155			'#attributes' => ['id' => 'admin-mongodb_watchdog'],
156			'#attached' => array(
157			'library' => array('mongodb_watchdog/drupal.mongodb_watchdog'),
158			),
159			);
160
161			$build['mongodb_watchdog_pager'] = array('#type' => 'pager');
162
163			return $build;
164			}
165
166			/**
167			* The controller factory.
168			*
169			* @param \Symfony\Component\DependencyInjection\ContainerInterface $container
170			* The DIC.
171			*
172			* @return static
173			* The database instance.
174			*/
175			public static function create(ContainerInterface $container) {
176			/** @var \MongoDB $database */
177			$database = $container->get('mongodb.watchdog_storage');
178
179			$form_builder = $container->get('form_builder');
180
181			$module_handler = $container->get('module_handler');
182
183			/** @var \Psr\Log\LoggerInterface $logger */
184			$logger = $container->get('logger.channel.mongodb_watchdog');
185
186			/** @var \Drupal\mongodb_watchdog\Logger $logger */
187			$watchdog = $container->get('mongodb.logger');
188
189			return new static($database, $logger, $watchdog, $module_handler, $form_builder);
190			}
191			}
			0 ignored issues – show Coding Style introduced 2016-06-24 11:00 UTC by Report Bug Copy Issue Report As per coding style, files should not end with a newline character. This check marks files that end in a newline character, i.e. an empy line. Loading history...
192

FGM / mongodb

Pull Request — 8.x-2.x (#5)

AdminController::overview() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like