Style fixes and comments

Author: Nyholm

Collector/DebugPlugin.php

@@ -12,7 +12,7 @@
  *
  * @author Tobias Nyholm <[email protected]>
  */
-class DebugPlugin implements Plugin
+final class DebugPlugin implements Plugin
 {
     /**
      * @var DebugPluginCollector

Collector/DebugPluginCollector.php

@@ -15,7 +15,7 @@
  *
  * @author Tobias Nyholm <[email protected]>
  */
-class DebugPluginCollector extends DataCollector
+final class DebugPluginCollector extends DataCollector
 {
     /**
      * @var Formatter
@@ -29,6 +29,7 @@ class DebugPluginCollector extends DataCollector
 
     /**
      * @param Formatter $formatter
+     * @param PluginJournal $journal
      */
     public function __construct(Formatter $formatter, PluginJournal $journal)
     {
@@ -38,6 +39,8 @@ public function __construct(Formatter $formatter, PluginJournal $journal)
 
     /**
      * @param RequestInterface $request
+     * @param string $clientName
+     * @param int $depth
      */
     public function addRequest(RequestInterface $request, $clientName, $depth)
     {
@@ -46,6 +49,8 @@ public function addRequest(RequestInterface $request, $clientName, $depth)
 
     /**
      * @param ResponseInterface $response
+     * @param string $clientName
+     * @param int $depth
      */
     public function addResponse(ResponseInterface $response, $clientName, $depth)
     {
@@ -55,6 +60,8 @@ public function addResponse(ResponseInterface $response, $clientName, $depth)
 
     /**
      * @param Exception $exception
+     * @param string $clientName
+     * @param int $depth
      */
     public function addFailure(Exception $exception, $clientName, $depth)
     {
@@ -79,6 +86,7 @@ public function getSucessfulRequests()
     {
         $count = 0;
         foreach ($this->data as $client) {
+
             if (isset($client['failure'])) {
                 foreach ($client['failure'][0] as $failure) {
                     if (!$failure) {
@@ -100,6 +108,7 @@ public function getFailedRequests()
     {
         $count = 0;
         foreach ($this->data as $client) {
+
             if (isset($client['failure'])) {
                 foreach ($client['failure'][0] as $failure) {
                     if ($failure) {
@@ -156,11 +165,17 @@ public function getName()
         return 'httplug';
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function serialize()
     {
         return serialize([$this->data, $this->journal]);
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function unserialize($data)
     {
         list($this->data, $this->journal) = unserialize($data);

Collector/PluginJournal.php

@@ -7,14 +7,16 @@
  *
  * @author Tobias Nyholm <[email protected]>
  */
-class PluginJournal
+final class PluginJournal
 {
     /**
      * @var array ['clientName'=>['index' => 'PluginName']
      */
     private $data;
 
     /**
+     * @param string $clientName
+     *
      * @return array
      */
     public function getPlugins($clientName)
@@ -23,6 +25,9 @@ public function getPlugins($clientName)
     }
 
     /**
+     * @param string $clientName
+     * @param int $idx
+     *
      * @return string|null
      */
     public function getPluginName($clientName, $idx)
@@ -37,13 +42,9 @@ public function getPluginName($clientName, $idx)
     /**
      * @param string $clientName
      * @param array  $plugins
-     *
-     * @return $this
      */
     public function setPlugins($clientName, array $plugins)
     {
         $this->data[$clientName] = $plugins;
-
-        return $this;
     }
 }

Collector/RequestStackProvider.php

@@ -10,14 +10,14 @@
  *
  * @author Tobias Nyholm <[email protected]>
  */
-class RequestStackProvider
+final class RequestStackProvider
 {
     /**
      * Array that tell if a request errored or not. true = success, false = failure.
      *
      * @var array
      */
-    private $failure;
+    private $failures;
 
     /**
      * A multidimensional array with requests.
@@ -38,13 +38,13 @@ class RequestStackProvider
     private $responses;
 
     /**
-     * @param array $failure   if the response was successful or not
+     * @param array $failures   if the response was successful or not
      * @param array $requests
      * @param array $responses
      */
-    public function __construct(array $failure, array $requests, array $responses)
+    public function __construct(array $failures, array $requests, array $responses)
     {
-        $this->failure = $failure;
+        $this->failures = $failures;
         $this->requests = $requests;
         $this->responses = $responses;
     }
@@ -112,7 +112,7 @@ public function getStackIndexKeys()
     /**
      * @param int $idx
      *
-     * @return array responses
+     * @return array
      */
     public function getRequstStack($idx)
     {
@@ -122,7 +122,7 @@ public function getRequstStack($idx)
     /**
      * @param int $idx
      *
-     * @return array responses
+     * @return array
      */
     public function getResponseStack($idx)
     {
@@ -132,10 +132,10 @@ public function getResponseStack($idx)
     /**
      * @param int $idx
      *
-     * @return array failures
+     * @return array
      */
     public function getFailureStack($idx)
     {
-        return $this->failure[$idx];
+        return $this->failures[$idx];
     }
 }

Resources/public/script/httplug.js

@@ -1,5 +1,3 @@
-
-
 /**
  * Toggle hide/show on the message body
  */

Resources/public/style/httplug.css

@@ -21,4 +21,4 @@
 }
 .httplug-error {
     color: red;
-}
+}

Resources/views/webprofiler.html.twig

@@ -66,7 +66,7 @@
                 {% for stackIndex in client.stackIndexKeys %}
                     {% set failureStack = client.failureStack(stackIndex) %}
                     <h3>
-                        Request {{ stackIndex }}
+                        Request #{{ stackIndex }}
                         {% if failureStack[0] %}
                             - <span class="httplug-error">Errored</span>
                         {% endif %}

composer.json

@@ -28,7 +28,7 @@
         "symfony/framework-bundle": "^2.7 || ^3.0",
         "php-http/message": "^1.3",
         "php-http/discovery": "^0.9",
-        "twig/twig": "^1.18|^2.0"
+        "twig/twig": "^1.18||^2.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^4.5",