Modernize code

jsor · Apr 15, 2020 · d47543c · d47543c
1 parent 05585b8
commit d47543c
Show file tree

Hide file tree

Showing 34 changed files with 382 additions and 317 deletions.
diff --git a/src/EventListener/ExceptionConversionListener.php b/src/EventListener/ExceptionConversionListener.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Jsor\Stack\Hal\EventListener;
 
 use Jsor\Stack\Hal\ExceptionConverter;
@@ -9,7 +11,7 @@
 use Symfony\Component\HttpKernel\Event\ExceptionEvent;
 use Symfony\Component\HttpKernel\KernelEvents;
 
-class ExceptionConversionListener implements EventSubscriberInterface
+final class ExceptionConversionListener implements EventSubscriberInterface
 {
     private $logger;
     private $prettyPrint;
@@ -18,17 +20,17 @@ class ExceptionConversionListener implements EventSubscriberInterface
 
     public function __construct(
         LoggerInterface $logger = null,
-        $prettyPrint = true,
-        $debug = false,
+        bool $prettyPrint = true,
+        bool $debug = false,
         array $formats = null
     ) {
         $this->logger = $logger;
-        $this->prettyPrint = (bool) $prettyPrint;
-        $this->debug = (bool) $debug;
+        $this->prettyPrint = $prettyPrint;
+        $this->debug = $debug;
         $this->formats = $formats;
     }
 
-    public function onKernelException(ExceptionEvent $event)
+    public function onKernelException(ExceptionEvent $event): void
     {
         $response = ExceptionConverter::handleThrowable(
             $event->getThrowable(),
@@ -44,7 +46,7 @@ public function onKernelException(ExceptionEvent $event)
         }
     }
 
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             KernelEvents::EXCEPTION => 'onKernelException',

diff --git a/src/EventListener/RequestFormatNegotiationListener.php b/src/EventListener/RequestFormatNegotiationListener.php
@@ -1,13 +1,15 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Jsor\Stack\Hal\EventListener;
 
 use Jsor\Stack\Hal\RequestFormatNegotiator;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Symfony\Component\HttpKernel\KernelEvents;
 
-class RequestFormatNegotiationListener implements EventSubscriberInterface
+final class RequestFormatNegotiationListener implements EventSubscriberInterface
 {
     private $formats;
     private $priorities;
@@ -20,7 +22,7 @@ public function __construct(
         $this->priorities = $priorities;
     }
 
-    public function onKernelRequest(RequestEvent $event)
+    public function onKernelRequest(RequestEvent $event): void
     {
         RequestFormatNegotiator::negotiate(
             $event->getRequest(),
@@ -29,7 +31,7 @@ public function onKernelRequest(RequestEvent $event)
         );
     }
 
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             KernelEvents::REQUEST => 'onKernelRequest',

diff --git a/src/EventListener/RequestFormatValidationListener.php b/src/EventListener/RequestFormatValidationListener.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Jsor\Stack\Hal\EventListener;
 
 use Jsor\Stack\Hal\RequestFormatValidator;
@@ -8,7 +10,7 @@
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Symfony\Component\HttpKernel\KernelEvents;
 
-class RequestFormatValidationListener implements EventSubscriberInterface
+final class RequestFormatValidationListener implements EventSubscriberInterface
 {
     private $acceptableFormats;
     private $exclude;
@@ -21,7 +23,7 @@ public function __construct(
         $this->exclude = $exclude;
     }
 
-    public function onKernelRequest(RequestEvent $event)
+    public function onKernelRequest(RequestEvent $event): void
     {
         $response = RequestFormatValidator::intercept(
             $event->getRequest(),
@@ -34,7 +36,7 @@ public function onKernelRequest(RequestEvent $event)
         }
     }
 
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             KernelEvents::REQUEST => 'onKernelRequest',

diff --git a/src/EventListener/ResponseConversionListener.php b/src/EventListener/ResponseConversionListener.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Jsor\Stack\Hal\EventListener;
 
 use Jsor\Stack\Hal\Response\HalResponse;
@@ -8,7 +10,7 @@
 use Symfony\Component\HttpKernel\Event\ViewEvent;
 use Symfony\Component\HttpKernel\KernelEvents;
 
-class ResponseConversionListener implements EventSubscriberInterface
+final class ResponseConversionListener implements EventSubscriberInterface
 {
     private $prettyPrint;
 
@@ -17,7 +19,7 @@ public function __construct($prettyPrint = true)
         $this->prettyPrint = (bool) $prettyPrint;
     }
 
-    public function onKernelView(ViewEvent $event)
+    public function onKernelView(ViewEvent $event): void
     {
         $hal = $event->getControllerResult();
 
@@ -28,7 +30,7 @@ public function onKernelView(ViewEvent $event)
         }
     }
 
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             KernelEvents::VIEW => 'onKernelView',

diff --git a/src/Exception/ErrorException.php b/src/Exception/ErrorException.php
@@ -1,11 +1,13 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Jsor\Stack\Hal\Exception;
 
 use Nocarrier\Hal;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 
-class ErrorException extends BadRequestHttpException implements HalException
+final class ErrorException extends BadRequestHttpException implements HalException
 {
     private $errors;
     private $logref;
@@ -23,7 +25,7 @@ public function __construct(
         $this->logref = $logref;
     }
 
-    public function getHal()
+    public function getHal(): Hal
     {
         $data = [
             'message' => $this->getMessage(),
@@ -40,7 +42,7 @@ public function getHal()
         return $hal;
     }
 
-    private function appendErrors(Hal $hal, array $errors)
+    private function appendErrors(Hal $hal, array $errors): void
     {
         foreach ($errors as $error) {
             if (!\is_array($error)) {

diff --git a/src/Exception/FormErrorException.php b/src/Exception/FormErrorException.php
@@ -1,13 +1,15 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Jsor\Stack\Hal\Exception;
 
 use Nocarrier\Hal;
 use Symfony\Component\Form\FormError;
 use Symfony\Component\Form\FormInterface;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 
-class FormErrorException extends BadRequestHttpException implements HalException
+final class FormErrorException extends BadRequestHttpException implements HalException
 {
     private $form;
     private $logref;
@@ -25,7 +27,7 @@ public function __construct(
         $this->logref = $logref;
     }
 
-    public function getHal()
+    public function getHal(): Hal
     {
         $data = [
             'message' => $this->getMessage(),
@@ -42,7 +44,7 @@ public function getHal()
         return $hal;
     }
 
-    private function appendErrors(Hal $hal, FormInterface $form)
+    private function appendErrors(Hal $hal, FormInterface $form): void
     {
         $formPath = null;
 
@@ -54,7 +56,7 @@ private function appendErrors(Hal $hal, FormInterface $form)
 
             $origin = $error->getOrigin();
 
-            if ($origin) {
+            if ($origin !== null) {
                 $currPath = $this->getPath($origin);
             } else {
                 if (null === $formPath) {
@@ -76,7 +78,7 @@ private function appendErrors(Hal $hal, FormInterface $form)
         }
     }
 
-    private function getPath(FormInterface $form)
+    private function getPath(FormInterface $form): string
     {
         $path = [];
 

diff --git a/src/Exception/HalException.php b/src/Exception/HalException.php
@@ -1,13 +1,12 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Jsor\Stack\Hal\Exception;
 
 use Nocarrier\Hal;
 
 interface HalException
 {
-    /**
-     * @return Hal
-     */
-    public function getHal();
+    public function getHal(): Hal;
 }
diff --git a/src/Exception/ValidationErrorException.php b/src/Exception/ValidationErrorException.php
@@ -1,12 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Jsor\Stack\Hal\Exception;
 
 use Nocarrier\Hal;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 use Symfony\Component\Validator\ConstraintViolationListInterface;
 
-class ValidationErrorException extends BadRequestHttpException implements HalException
+final class ValidationErrorException extends BadRequestHttpException implements HalException
 {
     private $violationList;
     private $logref;
@@ -24,7 +26,7 @@ public function __construct(
         $this->logref = $logref;
     }
 
-    public function getHal()
+    public function getHal(): Hal
     {
         $data = [
             'message' => $this->getMessage(),

diff --git a/src/ExceptionConverter.php b/src/ExceptionConverter.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Jsor\Stack\Hal;
 
 use Jsor\Stack\Hal\Response\VndErrorResponse;
@@ -14,7 +16,7 @@
  *
  * @see https://github.com/blongden/vnd.error
  */
-class ExceptionConverter implements HttpKernelInterface
+final class ExceptionConverter implements HttpKernelInterface
 {
     private $app;
     private $logger;
@@ -26,16 +28,16 @@ class ExceptionConverter implements HttpKernelInterface
     public function __construct(
         HttpKernelInterface $app,
         LoggerInterface $logger = null,
-        $prettyPrint = true,
-        $debug = false,
-        $passThroughCatch = false,
+        bool $prettyPrint = true,
+        bool $debug = false,
+        bool $passThroughCatch = false,
         array $formats = null
     ) {
         $this->app = $app;
         $this->logger = $logger;
-        $this->prettyPrint = (bool) $prettyPrint;
-        $this->debug = (bool) $debug;
-        $this->passThroughCatch = (bool) $passThroughCatch;
+        $this->prettyPrint = $prettyPrint;
+        $this->debug = $debug;
+        $this->passThroughCatch = $passThroughCatch;
         $this->formats = $formats;
     }
 
@@ -76,10 +78,10 @@ public static function handleThrowable(
         \Throwable $throwable,
         Request $request,
         LoggerInterface $logger = null,
-        $prettyPrint = true,
-        $debug = false,
+        bool $prettyPrint = true,
+        bool $debug = false,
         array $formats = null
-    ) {
+    ): ?VndErrorResponse {
         if (null !== $logger) {
             self::logThrowable($logger, $throwable);
         }
@@ -89,7 +91,7 @@ public static function handleThrowable(
         $format = $request->getRequestFormat(null);
 
         if (!$format || !\in_array($format, $formats, true)) {
-            return;
+            return null;
         }
 
         return VndErrorResponse::fromThrowable(
@@ -102,7 +104,7 @@ public static function handleThrowable(
     public static function logThrowable(
         LoggerInterface $logger,
         \Throwable $throwable
-    ) {
+    ): void {
         $message = \sprintf(
             'Uncaught PHP Exception %s: "%s" at %s line %s',
             \get_class($throwable),