Merge branch '3373694-fix-the-issues' into '2.0.x'

Fix the issues reported by phpcs.

See merge request !5

devel_debug_log.install

@@ -5,47 +5,50 @@
  * Devel debug log module install/schema hooks.
  */
 
+/**
+ * {@inheritdoc}
+ */
 function devel_debug_log_schema() {
-  $schema = array();
+  $schema = [];
 
-  $schema['devel_debug_log'] = array(
+  $schema['devel_debug_log'] = [
     'description' => 'Table for storing debug messages.',
-    'fields' => array(
-      'id' => array(
+    'fields' => [
+      'id' => [
         'description' => 'The message identifier.',
         'type' => 'serial',
         'unsigned' => TRUE,
         'not null' => TRUE,
-      ),
-      'timestamp' => array(
+      ],
+      'timestamp' => [
         'description' => 'The Unix timestamp when the message was saved.',
         'type' => 'int',
         'not null' => TRUE,
         'default' => 0,
-      ),
-      'title' => array(
+      ],
+      'title' => [
         'description' => 'The title of the debug message.',
         'type' => 'varchar',
         'length' => '255',
         'not null' => TRUE,
         'default' => '',
-      ),
-      'message' => array(
+      ],
+      'message' => [
         'description' => 'The debug message.',
         'type' => 'text',
         'size' => 'big',
         'not null' => TRUE,
-      ),
-      'serialized' => array(
+      ],
+      'serialized' => [
         'description' => 'Indicates whether the message is serialized.',
         'type' => 'int',
         'size' => 'small',
         'not null' => TRUE,
         'default' => 0,
-      ),
-    ),
-    'primary key' => array('id'),
-  );
+      ],
+    ],
+    'primary key' => ['id'],
+  ];
 
   return $schema;
 }

devel_debug_log.links.menu.yml

@@ -2,4 +2,4 @@ devel_debug_log.list:
   title: Debug messages
   description: 'List debug messages.'
   route_name: devel_debug_log.list
-  parent: system.admin_reports
+  parent: system.admin_reports
\ No newline at end of file

devel_debug_log.module

@@ -12,54 +12,56 @@ use Kint\Renderer\RichRenderer;
  * Saves a debug message.
  *
  * @param mixed $message
- *  A debug message to save, which can be:
+ *   A debug message to save, which can be:
  *    - string: saved as it is;
  *    - object/array: serialized before saving;
  *
- *  Currently, there's development going on regarding the serialization part,
- * since most of the data in D8 contains references to injected services and
- * maybe even plugins.
- *  A discussion about this topic can be found here:
- *  @see https://www.drupal.org/node/2705731
- *
+ *   Currently, there's development going on regarding the serialization part,
+ *   since most of the data in D8 contains references to injected services and
+ *   maybe even plugins.
+ *   A discussion about this topic can be found here:.
  * @param string $title
- *  Title of the debug message.
+ *   Title of the debug message.
+ *
+ * @see https://www.drupal.org/node/2705731
  *
  * @return void
+ *   Return void.
+ *
  * @throws \Exception
  */
-function ddl(mixed $message, string $title = ''): void {
+function devel_debug_log_ddl(mixed $message, string $title = ''): void {
   $serialized = FALSE;
   $message = devel_debug_log_ob_kint($message);
-  // TODO Find a way to store the initial message, instead of storing the entire
+  // @todo Find a way to store the initial message, instead of storing the entire
   // debug markup returned by kint().
-
   $connection = \Drupal::database();
   $query = $connection->insert('devel_debug_log')
-    ->fields(array(
+    ->fields([
       'timestamp' => \Drupal::time()->getRequestTime(),
       'title' => $title,
       'message' => $message,
       'serialized' => $serialized ? 1 : 0,
-    ));
+    ]);
   $query->execute();
 }
 
 /**
- * Checks if the message has already been saved during the current page request,
- * and saves the message only if it is not a repetition of a previous one.
+ * Checks if the message has already been saved during the current page request.
  *
  * @param mixed $message
  *   A debug message to save, which can be:
  *   - string: saved as is.
  *   - object or array: saved serialized.
  * @param string $title
- *  Title for the debug message.
+ *   Title for the debug message.
  *
  * @return void
+ *   Returns void.
+ *
  * @throws \Exception
  */
-function ddl_once(mixed $message, string $title = ''): void {
+function devel_debug_log_once(mixed $message, string $title = ''): void {
   $message_history = &drupal_static(__FUNCTION__);
 
   if (!is_resource($message)) {
@@ -72,7 +74,7 @@ function ddl_once(mixed $message, string $title = ''): void {
 
     $message_history[] = $hash;
   }
-  ddl($message, $title);
+  devel_debug_log_ddl($message, $title);
 }
 
 /**
@@ -85,21 +87,21 @@ function devel_debug_log_theme(array &$cache, $type, $theme, $path): array {
         'content' => NULL,
         'delete_form' => NULL,
       ],
-    ]
+    ],
   ];
 }
 
 /**
  * Provides debug output for later printing.
  *
- * kint() outputs the debug information at the top of the page. This function
+ * Kint() outputs the debug information at the top of the page. This function
  * allows you to get the output and use it for later printing.
  *
  * @param mixed $message
- *  The data that's displayed for debugging.
+ *   The data that's displayed for debugging.
  *
  * @return string
- *  The debug information.
+ *   The debug information.
  */
 function devel_debug_log_ob_kint(mixed $message): string {
   ob_start();
@@ -107,7 +109,8 @@ function devel_debug_log_ob_kint(mixed $message): string {
     Kint::$enabled_mode = Kint::MODE_RICH;
     RichRenderer::$folder = FALSE;
     Kint::dump($message);
-  } else {
+  }
+  else {
     \Drupal::service('devel.dumper')->dump($message);
   }
   $output = ob_get_contents();

src/Controller/DevelDebugLogController.php

@@ -6,13 +6,16 @@ use Drupal\Core\Controller\ControllerBase;
 use Drupal\Core\Database\Connection;
 use Drupal\Core\Datetime\DateFormatter;
 use Drupal\Core\Form\FormBuilderInterface;
-use Symfony\Component\Serializer\Serializer;
 use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\Serializer\Serializer;
 
+/**
+ * The main controller for the module.
+ */
 class DevelDebugLogController extends ControllerBase {
 
   /**
-   * The Database Connection
+   * The Database Connection.
    *
    * @var \Drupal\Core\Database\Connection
    */
@@ -21,7 +24,7 @@ class DevelDebugLogController extends ControllerBase {
   /**
    * The Serializer service.
    *
-   * @var Symfony\Component\Serializer\Serializer;
+   * @var Symfony\Component\Serializer\Serializer
    */
   protected $serializer;
 
@@ -35,7 +38,7 @@ class DevelDebugLogController extends ControllerBase {
   /**
    * The FormBuilder object.
    *
-   * @var Drupal\Core\Form\FormBuilderInterface;
+   * @var Drupal\Core\Form\FormBuilderInterface
    */
   protected $formBuilder;
 
@@ -54,10 +57,14 @@ class DevelDebugLogController extends ControllerBase {
   /**
    * DevelDebugLogController constructor.
    *
-   * @param Connection $database
-   * @param DateFormatter $dateFormatter
-   * @param Serializer $serializer
-   * @param FormBuilderInterface $formBuilder
+   * @param \Drupal\Core\Database\Connection $database
+   *   The database object.
+   * @param \Drupal\Core\Datetime\DateFormatter $dateFormatter
+   *   The dateFormatter object.
+   * @param \Symfony\Component\Serializer\Serializer $serializer
+   *   The serializer object.
+   * @param \Drupal\Core\Form\FormBuilderInterface $formBuilder
+   *   The formBuilder object.
    */
   public function __construct(Connection $database, DateFormatter $dateFormatter, Serializer $serializer, FormBuilderInterface $formBuilder) {
     $this->database = $database;
@@ -70,7 +77,7 @@ class DevelDebugLogController extends ControllerBase {
    * Lists debug information.
    *
    * @return array
-   *  Renderable array that contains a list of debug data.
+   *   Renderable array that contains a list of debug data.
    */
   public function listLogs() {
     $query = $this->database->select('devel_debug_log', 'm')
@@ -81,31 +88,32 @@ class DevelDebugLogController extends ControllerBase {
 
     $rows = [];
     foreach ($results as $result) {
-      $rows[] = array(
+      $rows[] = [
         'title' => $result->title,
         'time' => $this->dateFormatter
-            ->format($result->timestamp, 'short'),
+          ->format($result->timestamp, 'short'),
         'message' => $result->message,
-      );
+      ];
     }
 
     if (empty($rows)) {
-      return array(
+      return [
         '#markup' => $this->t('No debug messages.'),
-      );
+      ];
     }
 
-    $build = array(
-      'messages' => array(
+    $build = [
+      'messages' => [
         '#theme' => 'devel_debug_log_list',
         '#content' => $rows,
         '#delete_form' => $this->formBuilder->getForm('Drupal\devel_debug_log\Form\DevelDebugLogDeleteForm'),
-      ),
-      'pager' => array(
-        '#type' => 'pager'
-    ),
-  );
+      ],
+      'pager' => [
+        '#type' => 'pager',
+      ],
+    ];
 
     return $build;
   }
+
 }

src/Form/DevelDebugLogDeleteForm.php

@@ -8,9 +8,14 @@ use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Messenger\MessengerInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
+/**
+ * The delete form.
+ */
 class DevelDebugLogDeleteForm extends FormBase {
 
   /**
+   * The messenger interface.
+   *
    * @var \Drupal\Core\Messenger\MessengerInterface
    */
   protected $messenger;
@@ -34,39 +39,39 @@ class DevelDebugLogDeleteForm extends FormBase {
     $this->messenger = $messenger;
   }
 
-
   /**
-   * @inheritdoc
+   * {@inheritdoc}
    */
   public function getFormId() {
     return 'ddl_delete_form';
   }
 
   /**
-   * @inheritdoc
+   * {@inheritdoc}
    */
   public function buildForm(array $form, FormStateInterface $form_state) {
-    $form['ddl_clear'] = array(
+    $form['ddl_clear'] = [
       '#type' => 'fieldset',
       '#title' => $this->t('Clear debug log messages'),
       '#description' => $this->t('This will permanently remove the log messages from the database.'),
       '#collapsible' => TRUE,
       '#collapsed' => TRUE,
-    );
-    $form['ddl_clear']['clear'] = array(
+    ];
+    $form['ddl_clear']['clear'] = [
       '#type' => 'submit',
       '#value' => $this->t('Clear log messages'),
-    );
+    ];
 
     return $form;
   }
 
   /**
-   * @inheritdoc
+   * {@inheritdoc}
    */
   public function submitForm(array &$form, FormStateInterface $form_state) {
     Database::getConnection()->delete('devel_debug_log')
       ->execute();
     $this->messenger->addMessage($this->t('All debug messages have been cleared.'));
   }
+
 }

src/Twig/DevelDebugLogExtension.php

@@ -24,12 +24,12 @@ class DevelDebugLogExtension extends AbstractExtension {
    * {@inheritdoc}
    */
   public function getFunctions() {
-    return array(
-      new TwigFunction('ddl', array($this, 'ddl'), array(
+    return [
+      new TwigFunction('ddl', [$this, 'ddl'], [
         'needs_environment' => TRUE,
         'needs_context' => TRUE,
-      )),
-    );
+      ]),
+    ];
   }
 
   /**
@@ -41,14 +41,14 @@ class DevelDebugLogExtension extends AbstractExtension {
    *   An array of parameters passed to the template.
    */
   public function ddl(\Twig_Environment $env, array $context) {
-    // Don't do anything unless twig_debug is enabled. This reads from the Twig
+    // Don't do anything unless twig_debug is enabled. This reads from the Twig.
     if (!$env->isDebug()) {
       return;
     }
 
     if (func_num_args() === 2) {
       // No arguments passed, display full Twig context.
-      $ddl_variables = array();
+      $ddl_variables = [];
       foreach ($context as $key => $value) {
         if (!$value instanceof \Twig_Template) {
           $ddl_variables[$key] = $value;

templates/devel-debug-log-list.html.twig

@@ -5,4 +5,4 @@
     {% endif %}
     {{ value.time }}
     {{ value.message|raw }}
-{% endfor %}
+{% endfor %}
\ No newline at end of file