understand / understand-laravel5

src/Understand/UnderstandLaravel5/ExceptionEncoder.php

Doc Comments +2 added lines, -2 removed lines

@@ -157,7 +157,7 @@ 
     }
 
     /**
-     * @param $relativePath
+     * @param string|null $relativePath
      * @param $line
      * @param int $linesAround
      * @return array|void
@@ -217,7 +217,7 @@ 
      * Return stack trace file
      *
      * @param array $trace
-     * @return mixed
+     * @return string|null
      */
     protected function getStackTraceFile(array $trace)
     {

Spacing +16 added lines, -16 removed lines

@@ -42,7 +42,7 @@ 
      */
     public function exceptionToArray($exception)
     {
-        if ( ! ($exception instanceof Exception || $exception instanceof Throwable))
+        if (!($exception instanceof Exception || $exception instanceof Throwable))
         {
             throw new InvalidArgumentException('$exception must be instance of Exception or Throwable');
         }
@@ -71,7 +71,7 @@ 
         $stackTrace = $this->getCurrentStackTrace($level);
         $firstLineSet = false;
 
-        foreach($stackTrace as $trace)
+        foreach ($stackTrace as $trace)
         {
             if ($firstLineSet)
             {
@@ -98,7 +98,7 @@ 
         $stackTrace = debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT, $this->stackTraceLimit);
         $vendorExcluded = false;
 
-        foreach($stackTrace as $index => $trace)
+        foreach ($stackTrace as $index => $trace)
         {
             // exclude Understand service provider and helper classes
             if (isset($trace['class']) && strpos($trace['class'], 'Understand\UnderstandLaravel5\\') === 0)
@@ -106,7 +106,7 @@ 
                 unset($stackTrace[$index]);
             }
 
-            if ( ! isset($trace['file']))
+            if (!isset($trace['file']))
             {
                 $vendorExcluded = true;
             }
@@ -117,7 +117,7 @@ 
             }
 
             // exclude `vendor` folder until project path reached
-            if (strpos($trace['file'], $this->projectRoot . 'vendor' . DIRECTORY_SEPARATOR) === 0)
+            if (strpos($trace['file'], $this->projectRoot.'vendor'.DIRECTORY_SEPARATOR) === 0)
             {
                 unset($stackTrace[$index]);
             }
@@ -185,12 +185,12 @@ 
      */
     public function getCode($relativePath, $line, $linesAround = 6)
     {
-        if ( ! $relativePath || ! $line)
+        if (!$relativePath || !$line)
         {
             return;
         }
 
-        $filePath = $this->projectRoot . $relativePath;
+        $filePath = $this->projectRoot.$relativePath;
 
         try
         {
@@ -200,11 +200,11 @@ 
             $codeLines = [];
 
             $from = max(0, $line - $linesAround - 2);
-            $to = min($line + $linesAround -1, $file->key() + 1);
+            $to = min($line + $linesAround - 1, $file->key() + 1);
 
             $file->seek($from);
 
-            while ($file->key() < $to && ! $file->eof())
+            while ($file->key() < $to && !$file->eof())
             {
                 $file->next();
                 // `key()` returns 0 as the first line
@@ -256,7 +256,7 @@ 
      */
     protected function stackTraceCallToString(array $trace)
     {
-        if (! isset($trace['type']))
+        if (!isset($trace['type']))
         {
             return 'function';
         }
@@ -282,7 +282,7 @@ 
     {
         $params = [];
 
-        if (! isset($trace['args']))
+        if (!isset($trace['args']))
         {
             return $params;
         }
@@ -291,7 +291,7 @@ 
         {
             if (is_array($arg))
             {
-                $params[] = 'array(' . count($arg) . ')';
+                $params[] = 'array('.count($arg).')';
             }
             else if (is_object($arg))
             {
@@ -299,19 +299,19 @@ 
             }
             else if (is_string($arg))
             {
-                $params[] = 'string(' . $arg . ')';
+                $params[] = 'string('.$arg.')';
             }
             else if (is_int($arg))
             {
-                $params[] = 'int(' . $arg . ')';
+                $params[] = 'int('.$arg.')';
             }
             else if (is_float($arg))
             {
-                $params[] = 'float(' . $arg . ')';
+                $params[] = 'float('.$arg.')';
             }
             else if (is_bool($arg))
             {
-                $params[] = 'bool(' . ($arg ? 'true' : 'false') . ')';
+                $params[] = 'bool('.($arg ? 'true' : 'false').')';
             }
             else if ($arg instanceof \__PHP_Incomplete_Class)
             {

Braces +10 added lines, -20 removed lines

@@ -120,8 +120,7 @@ 
             if (strpos($trace['file'], $this->projectRoot . 'vendor' . DIRECTORY_SEPARATOR) === 0)
             {
                 unset($stackTrace[$index]);
-            }
-            else
+            } else
             {
                 $vendorExcluded = true;
             }
@@ -215,10 +214,8 @@ 
             }
 
             return $codeLines;
-        }
-        catch (\Throwable $e)
-        {}
-        catch (\Exception $e)
+        } catch (\Throwable $e)
+        {} catch (\Exception $e)
         {}
     }
 
@@ -294,32 +291,25 @@ 
             if (is_array($arg))
             {
                 $params[] = 'array(' . count($arg) . ')';
-            }
-            else if (is_object($arg))
+            } else if (is_object($arg))
             {
                 $params[] = get_class($arg);
-            }
-            else if (is_string($arg))
+            } else if (is_string($arg))
             {
                 $params[] = 'string(' . $arg . ')';
-            }
-            else if (is_int($arg))
+            } else if (is_int($arg))
             {
                 $params[] = 'int(' . $arg . ')';
-            }
-            else if (is_float($arg))
+            } else if (is_float($arg))
             {
                 $params[] = 'float(' . $arg . ')';
-            }
-            else if (is_bool($arg))
+            } else if (is_bool($arg))
             {
                 $params[] = 'bool(' . ($arg ? 'true' : 'false') . ')';
-            }
-            else if ($arg instanceof \__PHP_Incomplete_Class)
+            } else if ($arg instanceof \__PHP_Incomplete_Class)
             {
                 $params[] = 'object(__PHP_Incomplete_Class)'; 
-            }
-            else
+            } else
             {
                 $params[] = gettype($arg);
             }

src/Understand/UnderstandLaravel5/FieldProvider.php

Doc Comments +3 added lines, -4 removed lines

@@ -87,7 +87,7 @@ 
     protected $app;
 
     /**
-     * @return void
+     * @return Application
      */
     public function __construct()
     {
@@ -108,7 +108,7 @@ 
     /**
      * Set session store
      *
-     * @param type $service
+     * @param SessionStore $service
      */
     public function setSessionStore(SessionStore $service)
     {
@@ -157,7 +157,6 @@ 
      * Register a custom HTML macro.
      *
      * @param string $name
-     * @param  mixed  $macro
      * @return void
      */
     public function extend($name, $provider)
@@ -168,7 +167,7 @@ 
     /**
      * Set token provider
      *
-     * @param UniqueProcessIdentifier $tokenProvider
+     * @param TokenProvider $tokenProvider
      */
     public function setTokenProvider(TokenProvider $tokenProvider)
     {

Braces +10 added lines, -20 removed lines

@@ -299,12 +299,10 @@ 
             if ($value instanceof \DateTimeInterface)
             {
                 $binding = $value->format('Y-m-d H:i:s');
-            }
-            elseif (is_bool($value))
+            } elseif (is_bool($value))
             {
                 $binding = (int) $value;
-            }
-            else
+            } else
             {
                 $binding = $value;
             }
@@ -381,8 +379,7 @@ 
             try
             {
                 $queryString[$key] = $this->parseRequestFieldValue($key, $value);
-            }
-            catch (\Exception $e)
+            } catch (\Exception $e)
             {
                 $queryString[$key] = '[handler error]';
             }
@@ -415,8 +412,7 @@ 
             try
             {
                 $postData[$key] = $this->parseRequestFieldValue($key, $value);
-            }
-            catch (\Exception $e)
+            } catch (\Exception $e)
             {
                 $postData[$key] = '[handler error]';
             }
@@ -574,10 +570,8 @@ 
             {
                 return $userId;
             }
-        }
-        catch (\Throwable $e)
-        {}
-        catch (\Exception $e)
+        } catch (\Throwable $e)
+        {} catch (\Exception $e)
         {}
 
         try
@@ -586,10 +580,8 @@ 
             {
                 return $user->id;
             }
-        }
-        catch (\Throwable $e)
-        {}
-        catch (\Exception $e)
+        } catch (\Throwable $e)
+        {} catch (\Exception $e)
         {}
 
         try
@@ -598,10 +590,8 @@ 
             {
                 return $user->id;
             }
-        }
-        catch (\Throwable $e)
-        {}
-        catch (\Exception $e)
+        } catch (\Throwable $e)
+        {} catch (\Exception $e)
         {}
     }
 

Spacing +23 added lines, -23 removed lines

@@ -232,7 +232,7 @@ 
      */
     protected function getSessionId()
     {
-        if ( ! $this->session)
+        if (!$this->session)
         {
             return null;
         }
@@ -258,21 +258,21 @@ 
      */
     protected function getSqlQueries()
     {
-        if ( ! $this->dataCollector)
+        if (!$this->dataCollector)
         {
             return [];
         }
 
         $queries = $this->dataCollector->getByKey('sql_queries');
 
-        if ( ! $queries)
+        if (!$queries)
         {
             return null;
         }
 
         $bindingsEnabled = $this->app['config']->get('understand-laravel.sql_bindings');
 
-        foreach($queries as $key => $queryArray)
+        foreach ($queries as $key => $queryArray)
         {
             if ($bindingsEnabled)
             {
@@ -294,7 +294,7 @@ 
         $sqlQuery = $queryArray['query'];
         $placeholder = '?';
 
-        foreach($queryArray['bindings'] as $key => $value)
+        foreach ($queryArray['bindings'] as $key => $value)
         {
             if ($value instanceof \DateTimeInterface)
             {
@@ -327,7 +327,7 @@ 
      */
     protected function getRouteName()
     {
-        if ( ! $this->router)
+        if (!$this->router)
         {
             return null;
         }
@@ -342,16 +342,16 @@ 
      */
     protected function getUrl()
     {
-        if ( ! $this->request)
+        if (!$this->request)
         {
             return null;
         }
 
         $url = $this->request->path();
 
-        if ( ! starts_with($url, '/'))
+        if (!starts_with($url, '/'))
         {
-            $url = '/' . $url;
+            $url = '/'.$url;
         }
 
         return $url;
@@ -364,19 +364,19 @@ 
     {
         $enabled = $this->app['config']->get('understand-laravel.query_string_enabled');
 
-        if ( ! $enabled)
+        if (!$enabled)
         {
             return null;
         }
 
-        if ( ! $this->request->query instanceof \IteratorAggregate)
+        if (!$this->request->query instanceof \IteratorAggregate)
         {
             return null;
         }
 
         $queryString = [];
 
-        foreach($this->request->query as $key => $value)
+        foreach ($this->request->query as $key => $value)
         {
             try
             {
@@ -398,19 +398,19 @@ 
     {
         $enabled = $this->app['config']->get('understand-laravel.post_data_enabled');
 
-        if ( ! $enabled)
+        if (!$enabled)
         {
             return null;
         }
 
-        if ( ! $this->request->request instanceof \IteratorAggregate)
+        if (!$this->request->request instanceof \IteratorAggregate)
         {
             return null;
         }
 
         $postData = [];
 
-        foreach($this->request->request as $key => $value)
+        foreach ($this->request->request as $key => $value)
         {
             try
             {
@@ -454,7 +454,7 @@ 
             return get_class($value);
         }
 
-        return (string)$value;
+        return (string) $value;
     }
 
     /**
@@ -464,7 +464,7 @@ 
      */
     protected function getRequestMethod()
     {
-        if ( ! $this->request)
+        if (!$this->request)
         {
             return null;
         }
@@ -479,7 +479,7 @@ 
      */
     protected function getServerIp()
     {
-        if ( ! $this->request)
+        if (!$this->request)
         {
             return null;
         }
@@ -494,7 +494,7 @@ 
      */
     protected function getClientIp()
     {
-        if ( ! $this->request)
+        if (!$this->request)
         {
             return null;
         }
@@ -509,7 +509,7 @@ 
      */
     protected function getClientUserAgent()
     {
-        if ( ! $this->request)
+        if (!$this->request)
         {
             return null;
         }
@@ -535,7 +535,7 @@ 
      */
     protected function getFromSession($key)
     {
-        if ( ! $this->session)
+        if (!$this->session)
         {
             return null;
         }
@@ -553,7 +553,7 @@ 
     {
         $parts = [];
 
-        foreach(['class', 'file', 'line', 'code'] as $field)
+        foreach (['class', 'file', 'line', 'code'] as $field)
         {
             // only include `code` if it's not null value
             // the `code` attribute of the exception object is useful to differentiate SQL and other exceptions
@@ -566,7 +566,7 @@ 
                 continue;
             }
 
-            $parts[] = isset($log[$field]) ? (string)$log[$field] : null;
+            $parts[] = isset($log[$field]) ? (string) $log[$field] : null;
         }
 
         return sha1(implode('#', $parts));

src/Understand/UnderstandLaravel5/Logger.php

Doc Comments -2 removed lines

@@ -28,7 +28,6 @@ 
     /**
      * @param FieldProvider $fieldProvider
      * @param BaseHandler $handler
-     * @param bool $silent
      */
     public function __construct(FieldProvider $fieldProvider, BaseHandler $handler)
     {
@@ -144,7 +143,6 @@ 
     /**
      * Send data to storage
      *
-     * @param array $requestData
      * @return mixed
      */
     protected function send(array $event)

Spacing +2 added lines, -2 removed lines

@@ -107,9 +107,9 @@
      */
     protected function formatMessage($message)
     {
-        if ( ! is_bool($message))
+        if (!is_bool($message))
         {
-            return (string)$message;
+            return (string) $message;
         }
         
         // cast boolean values to "1" or "0" strings

Braces +2 added lines, -4 removed lines

@@ -152,12 +152,10 @@
         try
         {
             return $this->handler->handle($event);
-        }
-        catch (\Throwable $e)
+        } catch (\Throwable $e)
         {
             return false;
-        }
-        catch (\Exception $ex)
+        } catch (\Exception $ex)
         {
             return false;
         }

src/Understand/UnderstandLaravel5/ExceptionLogger.php

Spacing +5 added lines, -5 removed lines

@@ -55,7 +55,7 @@ 
      */
     public function log($error)
     {
-        if ( ! $this->canHandle($error))
+        if (!$this->canHandle($error))
         {
             return;
         }
@@ -73,7 +73,7 @@ 
      */
     public function logError($level, $message, $context)
     {
-        if ( ! $this->canHandle($message))
+        if (!$this->canHandle($message))
         {
             return;
         }
@@ -93,7 +93,7 @@ 
         }
         else
         {
-            $log = (array)$message;
+            $log = (array) $message;
             $log = $this->encoder->setCurrentStackTrace($log);
         }
 
@@ -101,7 +101,7 @@ 
 
         if ($context)
         {
-            $log['context'] = (array)$context;
+            $log['context'] = (array) $context;
         }
 
         return $this->dispatch($log);
@@ -150,6 +150,6 @@ 
      */
     protected function canHandle($error)
     {
-        return (bool)$this->config->get('understand-laravel.enabled');
+        return (bool) $this->config->get('understand-laravel.enabled');
     }
 }
\ No newline at end of file

Braces +1 added lines, -2 removed lines

@@ -90,8 +90,7 @@
             ];
 
             $log = $this->encoder->setCurrentStackTrace($log);
-        }
-        else
+        } else
         {
             $log = (array)$message;
             $log = $this->encoder->setCurrentStackTrace($log);

src/Understand/UnderstandLaravel5/EventLogger.php

Spacing +2 added lines, -2 removed lines

@@ -48,7 +48,7 @@ 
         }
         else
         {
-            $log = (array)$message;
+            $log = (array) $message;
         }
 
         $log['tags'] = ['laravel_log'];
@@ -56,7 +56,7 @@ 
 
         if ($context)
         {
-            $log['context'] = (array)$context;
+            $log['context'] = (array) $context;
         }
 
         $additionalFields = $this->getMetaFields();

Braces +1 added lines, -2 removed lines

@@ -45,8 +45,7 @@
             $log = [
                 'message' => $message
             ];
-        }
-        else
+        } else
         {
             $log = (array)$message;
         }

src/Understand/UnderstandLaravel5/UnderstandLaravel5ServiceProvider.php

Indentation +25 added lines, -25 removed lines

@@ -10,20 +10,20 @@ 
 class UnderstandLaravel5ServiceProvider extends ServiceProvider
 {
 
-	/**
-	 * Indicates if loading of the provider is deferred.
-	 *
-	 * @var bool
-	 */
-	protected $defer = false;
-
-	/**
-	 * Bootstrap the application events.
-	 *
-	 * @return void
-	 */
-	public function boot()
-	{
+    /**
+     * Indicates if loading of the provider is deferred.
+     *
+     * @var bool
+     */
+    protected $defer = false;
+
+    /**
+     * Bootstrap the application events.
+     *
+     * @return void
+     */
+    public function boot()
+    {
         $configPath = __DIR__ . '/../../config/understand-laravel.php';
         $this->publishes([$configPath => config_path('understand-laravel.php')], 'config');
         $enabled = $this->app['config']->get('understand-laravel.enabled');
@@ -37,23 +37,23 @@ 
         {
             $this->listenQueryEvents();
         }
-	}
-
-	/**
-	 * Register the service provider.
-	 *
-	 * @return void
-	 */
-	public function register()
-	{
-		$this->registerConfig();
+    }
+
+    /**
+     * Register the service provider.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->registerConfig();
         $this->registerFieldProvider();
         $this->registerDataCollector();
         $this->registerTokenProvider();
         $this->registerLogger();
         $this->registerExceptionEncoder();
         $this->registerEventLoggers();
-	}
+    }
 
     /**
      * Register config

Braces +3 added lines, -6 removed lines

@@ -237,8 +237,7 @@ 
             {
                 $this->handleEvent($level, $message, $context);
             });
-        }
-        else
+        } else
         {
             // starting from L5.4 MessageLogged event class was introduced
             // https://github.com/laravel/framework/commit/57c82d095c356a0fe0f9381536afec768cdcc072
@@ -268,8 +267,7 @@ 
                     'time' => $time,
                 ]);
             });
-        }
-        else
+        } else
         {
             // https://laravel.com/api/5.3/Illuminate/Database/Events/QueryExecuted.html
             $this->app['events']->listen('Illuminate\Database\Events\QueryExecuted', function($event)
@@ -304,8 +302,7 @@ 
             unset($context['exception']);
 
             $this->app['understand.exceptionLogger']->logError($level, $exception, $context);
-        }
-        else
+        } else
         {
             $this->app['understand.exceptionLogger']->logError($level, $message, $context);
         }

Doc Comments +4 added lines, -4 removed lines

@@ -215,8 +215,8 @@ 
     /**
      * Detect Laravel version
      * 
-     * @param array $versions
-     * @return type
+     * @param string[] $versions
+     * @return boolean
      */
     protected function detectLaravelVersion(array $versions)
     {
@@ -317,7 +317,7 @@ 
     }
 
     /**
-     * @param $level
+     * @param string $level
      * @param $message
      * @param $context
      * @return bool
@@ -337,7 +337,7 @@ 
     /**
      * Get the services provided by the provider.
      *
-     * @return array
+     * @return string[]
      */
     public function provides()
     {

Spacing +7 added lines, -7 removed lines

@@ -24,7 +24,7 @@ 
 	 */
 	public function boot()
 	{
-        $configPath = __DIR__ . '/../../config/understand-laravel.php';
+        $configPath = __DIR__.'/../../config/understand-laravel.php';
         $this->publishes([$configPath => config_path('understand-laravel.php')], 'config');
         $enabled = $this->app['config']->get('understand-laravel.enabled');
 
@@ -62,7 +62,7 @@ 
      */
     protected function registerConfig()
     {
-        $configPath = __DIR__ . '/../../config/understand-laravel.php';
+        $configPath = __DIR__.'/../../config/understand-laravel.php';
         $this->mergeConfigFrom($configPath, 'understand-laravel');
     }
 
@@ -209,7 +209,7 @@ 
             return new Handlers\SyncHandler($inputToken, $apiUrl, $sslBundlePath);
         }
 
-        throw new \ErrorException('understand-laravel handler misconfiguration:' . $handlerType);
+        throw new \ErrorException('understand-laravel handler misconfiguration:'.$handlerType);
     }
     
     /**
@@ -298,13 +298,13 @@ 
         }
 
         // `\Log::info`, `\Log::debug` and NOT `\Exception` or `\Throwable`
-        if (in_array($level, ['info', 'debug']) && ! ($message instanceof Exception || $message instanceof Throwable))
+        if (in_array($level, ['info', 'debug']) && !($message instanceof Exception || $message instanceof Throwable))
         {
             $this->app['understand.eventLogger']->logEvent($level, $message, $context);
         }
         // `\Log::notice`, `\Log::warning`, `\Log::error`, `\Log::critical`, `\Log::alert`, `\Log::emergency` and `\Exception`, `\Throwable`
         // '5.5', '5.6', '5.7', '5.8'
-        else if ( ! $this->detectLaravelVersion(['5.0', '5.1', '5.2', '5.3', '5.4']) && isset($context['exception']) && ($context['exception'] instanceof Exception || $context['exception'] instanceof Throwable))
+        else if (!$this->detectLaravelVersion(['5.0', '5.1', '5.2', '5.3', '5.4']) && isset($context['exception']) && ($context['exception'] instanceof Exception || $context['exception'] instanceof Throwable))
         {
             $exception = $context['exception'];
             unset($context['exception']);
@@ -325,9 +325,9 @@ 
      */
     protected function shouldIgnoreEvent($level, $message, $context)
     {
-        $ignoredEventTypes = (array)$this->app['config']->get('understand-laravel.ignored_logs');
+        $ignoredEventTypes = (array) $this->app['config']->get('understand-laravel.ignored_logs');
 
-        if ( ! $ignoredEventTypes)
+        if (!$ignoredEventTypes)
         {
             return false;
         }

src/config/understand-laravel.php

Spacing +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
     /**
      * Project root folder
      */
-    'project_root' => base_path() . DIRECTORY_SEPARATOR,
+    'project_root' => base_path().DIRECTORY_SEPARATOR,
 
     /**
      * Collect SQL queries