level up phpstan (#25)

* Update phpstan.neon.dist

* return types

* types

* Update SystemMonitor.php

* Update SystemMonitor.php

* Update phpstan.neon.dist

* Update SerializableException.php

Co-authored-by: Markus Staab <m.staab@complex-it.de>

Author: staabm

phpstan.neon.dist

@@ -1,5 +1,5 @@
 parameters:
-    level: 5
+    level: 7
     paths:
         - src/
     ignoreErrors:

src/sysmonitor/SerializableException.php

@@ -39,37 +39,64 @@ class SerializableException
      */
     private $previous;
 
+    /**
+     * @return string
+     */
     public function getMessage()
     {
         return $this->message;
     }
+
+    /**
+     * @return string
+     */
     public function getCode()
     {
         return $this->code;
     }
+
+    /**
+     * @return string
+     */
     public function getFile()
     {
         return $this->file;
     }
+
+    /**
+     * @return int
+     */
     public function getLine()
     {
         return $this->line;
     }
+
+    /**
+     * @return string
+     */
     public function getTraceAsString()
     {
         return $this->trace;
     }
+
+    /**
+     * @return SerializableException
+     */
     public function getPrevious()
     {
         return $this->previous;
     }
+
+    /**
+     * @return string
+     */
     public function getOriginClass()
     {
         return $this->originClass;
     }
 
     /**
-     * @param \Exception|\Throwable $e
+     * @param \Exception|\Throwable|self $e
      * @return self
      */
     public static function fromException($e)

src/sysmonitor/SeverityNotifier.php

@@ -16,6 +16,9 @@ class SeverityNotifier implements Notifier
      */
     private $wrapped;
 
+    /**
+     * @param int $minSeverity
+     */
     public function __construct(Notifier $wrappedNotifier, $minSeverity)
     {
         $this->minSeverity = $minSeverity;

src/sysmonitor/SystemEventStats.php

@@ -15,17 +15,26 @@ class SystemEventStats
      */
     private $count;
 
+    /**
+     * @param int $count
+     */
     public function __construct(SystemEvent $sysEvt, $count)
     {
         $this->count = $count;
         $this->sysEvt = $sysEvt;
     }
 
+    /**
+     * @return SystemEvent
+     */
     public function getEvent()
     {
         return $this->sysEvt;
     }
 
+    /**
+     * @return int
+     */
     public function getCount()
     {
         return $this->count;

src/sysmonitor/SystemMonitor.php

@@ -46,6 +46,9 @@ public function __construct(SystemEventStorage $storage, RequestEnvironment $env
         }
     }
 
+    /**
+     * @return void
+     */
     public function collectStats(RequestStatsEvent $evt)
     {
         // we won't even collect data for requests which don't hit either of these min-values, to prevent unnecessary garbage.
@@ -65,6 +68,9 @@ public function collectStats(RequestStatsEvent $evt)
         }
     }
 
+    /**
+     * @return void
+     */
     public function collectException(RequestExceptionEvent $evt)
     {
         $sysEvt = $this->createSystemEvent($evt);
@@ -86,6 +92,9 @@ protected function notifyException(RequestExceptionEvent $evt)
         return !($evt->exception instanceof UnreportedException);
     }
 
+    /**
+     * @return void
+     */
     private function rateAndStore(SystemEvent $sysEvt)
     {
         $evt = $sysEvt->origin;
@@ -156,6 +165,10 @@ private function rateAndStore(SystemEvent $sysEvt)
         $this->storage->store($sysEvt);
     }
 
+    /**
+     * @param RequestStatsEvent|RequestExceptionEvent $evt
+     * @return SystemEvent
+     */
     private function createSystemEvent($evt)
     {
         if ($evt instanceof RequestStatsEvent) {
@@ -166,6 +179,7 @@ private function createSystemEvent($evt)
             $title = sprintf('Exception: "%s" in %s:%s', $exc->getMessage(), $exc->getFile(), $exc->getLine());
             $hash = md5($title);
         } else {
+            // @phpstan-ignore-next-line
             throw new \Exception(sprintf('Unsupported event type "%s"', is_object($evt) ? get_class($evt) : gettype($evt)));
         }
 
@@ -178,13 +192,20 @@ private function createSystemEvent($evt)
         return $sysEvt;
     }
 
+    /**
+     * @return bool
+     */
     private function expectsSoap()
     {
         // depending on the used framework, there are different was to check for soap requests
         return !empty($_SERVER['HTTP_SOAPACTION']) ||
                !empty($_SERVER['HTTP_ACCEPT']) && stripos($_SERVER['HTTP_ACCEPT'], 'application/soap+xml') !== false;
     }
 
+    /**
+     * @param int $errno
+     * @return bool
+     */
     private function isFatalError($errno)
     {
         return in_array(