Merge pull request #8 from Kick-In/fix-deprecation

Fix some deprecations and remove superfluous PHPDoc

Author: bobvandevijver

Backtrace/BacktraceLogFile.php

@@ -37,24 +37,18 @@ class BacktraceLogFile
   private $folder;
 
   /**
-   * Constructor -> generate an unique name
-   *
-   * @param string $folder
-   *
    * @throws Exception
    */
-  public function __construct($folder)
+  public function __construct(string $folder)
   {
     $this->folder = $folder;
     $this->generateNewName();
   }
 
   /**
    * Returns the name of the file that will be uploaded
-   *
-   * @return string
    */
-  public function getName()
+  public function getName(): string
   {
     return $this->name;
   }
@@ -64,19 +58,15 @@ public function getName()
    *
    * @throws Exception
    */
-  public function generateNewName()
+  public function generateNewName(): void
   {
     $this->name = $this->folder . "/" . bin2hex(random_bytes(20)) . ".btl";
   }
 
   /**
    * Sets the content for the file to be uploaded
-   *
-   * @param $code
-   *
-   * @return $this
    */
-  public function setFileContent($code)
+  public function setFileContent(string $code): self
   {
     $this->fileContent = $code;
 
@@ -85,21 +75,18 @@ public function setFileContent($code)
 
   /**
    * Returns the content of the backtrace file that will be uploaded
-   *
-   * @return string
    */
-  public function getFileContent()
+  public function getFileContent(): string
   {
     return $this->fileContent;
   }
 
   /**
-   * Upload the file. Returns the true if it the upload was succesful, else returns false
+   * Upload the file. Returns true if the upload was successful, else throws
    *
-   * @return bool
    * @throws UploadFailedException|FileAlreadyExistsException
    */
-  public function uploadFile()
+  public function uploadFile(): bool
   {
     $fs = new Filesystem();
 

Configuration/ConfigurationInterface.php

@@ -5,8 +5,6 @@
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 
 /**
- * Interface ConfigurationInterface
- *
  * @internal
  */
 interface ConfigurationInterface

Configuration/SwiftMailerConfigurationInterface.php

@@ -2,21 +2,14 @@
 
 namespace Kickin\ExceptionHandlerBundle\Configuration;
 
-/**
- * Interface SwiftMailerConfigurationInterface
- */
 interface SwiftMailerConfigurationInterface extends ConfigurationInterface
 {
   /**
-   * @inheritDoc
-   *
    * @return string|array
    */
   public function getSender();
 
   /**
-   * @inheritDoc
-   *
    * @return mixed
    */
   public function getReceiver();

Configuration/SymfonyMailerConfigurationInterface.php

@@ -4,21 +4,14 @@
 
 use Symfony\Component\Mime\Address;
 
-/**
- * Interface SymfonyMailerConfigurationInterface
- */
 interface SymfonyMailerConfigurationInterface extends ConfigurationInterface
 {
   /**
-   * @inheritDoc
-   *
    * @return Address|string
    */
   public function getSender();
 
   /**
-   * @inheritDoc
-   *
    * @return Address|string
    */
   public function getReceiver();

DependencyInjection/Configuration.php

@@ -5,26 +5,13 @@
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
-/**
- * This is the class that validates and merges configuration from your app/config files
- *
- * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html#cookbook-bundles-extension-config-class}
- */
 class Configuration implements ConfigurationInterface
 {
-  /**
-   * {@inheritDoc}
-   */
   public function getConfigTreeBuilder(): TreeBuilder
   {
     $treeBuilder = new TreeBuilder('kickin_exception_handler');
 
-    if (method_exists($treeBuilder, 'getRootNode')) {
-      $rootNode = $treeBuilder->getRootNode();
-    } else {
-      // for symfony/config 4.1 and older
-      $rootNode = $treeBuilder->root('kickin_exception_handler');
-    }
+    $rootNode = $treeBuilder->getRootNode();
 
     // Here you should define the parameters that are allowed to
     // configure your bundle. See the documentation linked above for

DependencyInjection/KickinExceptionHandlerExtension.php

@@ -11,18 +11,9 @@
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
-/**
- * This is the class that loads and manages your bundle configuration
- *
- * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html}
- */
 class KickinExceptionHandlerExtension extends Extension
 {
-  /**
-   * {@inheritDoc}
-   * @throws Exception
-   */
-  public function load(array $configs, ContainerBuilder $container)
+  public function load(array $configs, ContainerBuilder $container): void
   {
     // Parse configuration
     $configuration = new Configuration();
@@ -38,10 +29,8 @@ public function load(array $configs, ContainerBuilder $container)
 
   /**
    * Configures the Swift Mailer handler
-   *
-   * @param ContainerBuilder $container
    */
-  private function configureSwiftMailer(ContainerBuilder $container)
+  private function configureSwiftMailer(ContainerBuilder $container): void
   {
     if (!class_exists('Swift_Mailer')) {
       throw new InvalidConfigurationException('You selected SwiftMailer as mail backend, but it is not installed. Try running `composer req symfony/swiftmailer-bundle` or switch to the Symfony mailer in the configuration.');
@@ -57,10 +46,8 @@ private function configureSwiftMailer(ContainerBuilder $container)
 
   /**
    * Configures the Symfony Mailer handler
-   *
-   * @param ContainerBuilder $container
    */
-  private function configureSymfonyMailer(ContainerBuilder $container)
+  private function configureSymfonyMailer(ContainerBuilder $container): void
   {
     if (!class_exists('Symfony\Component\Mailer\Mailer')) {
       throw new InvalidConfigurationException('You selected the Symfony mailer as mail backend, but it is not installed. Try running `composer req symfony/mailer` or switch to SwiftMailer in the configuration.');
@@ -71,11 +58,6 @@ private function configureSymfonyMailer(ContainerBuilder $container)
 
   /**
    * Configure the shared defaults for both handlers
-   *
-   * @param ContainerBuilder $container
-   * @param string           $handlerClass
-   *
-   * @return Definition
    */
   private function configureMailer(ContainerBuilder $container, string $handlerClass): Definition
   {

Handler/AbstractExceptionHandler.php

@@ -20,11 +20,12 @@
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\HttpKernel\KernelEvents;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
+use Throwable;
 use Traversable;
 
 /**
  * This Service triggers on the kernel.exception and catches any HTTP 500 error. When an HTTP 500 error is detected,
- * an e-mail is send to maintainers.
+ * an e-mail is sent to maintainers.
  *
  * Pick one of the available implementations, based on your mailer configuration.
  *
@@ -77,24 +78,22 @@ public function __construct(TokenStorageInterface $tokenStorage, ConfigurationIn
    * while the KernelResponse event is used to determine if the 500 error message is actually displayed to the user.
    * This ensures that NotAuthorizedExceptions are not mailed as a 500 error (as a 403 error is presented).
    */
-  static protected function getSubscribedEvents()
+  static protected function getSubscribedEvents(): array
   {
-    return array(
-        KernelEvents::EXCEPTION => array(array('onKernelException', 0)),
-        KernelEvents::RESPONSE  => array(array('onKernelResponse', 0)),
-    );
+    return [
+        KernelEvents::EXCEPTION => [['onKernelException', 0]],
+        KernelEvents::RESPONSE  => [['onKernelResponse', 0]],
+    ];
   }
 
   /**
-   * This function will create create the backtrace and save it with an random
+   * This function will create the backtrace and save it with a random
    * name in /web/uploads/exceptionBacktrace/ and save the name in the session so
    * in the html status exception handler load the backtrace and send it in an email.
    *
-   * @param ExceptionEvent $event
-   *
    * @throws Exception
    */
-  public function onKernelException(ExceptionEvent $event)
+  public function onKernelException(ExceptionEvent $event): void
   {
     // Skip some exception types directly
     $exception = $event->getThrowable();
@@ -172,12 +171,8 @@ public function onKernelException(ExceptionEvent $event)
 
   /**
    * This function builds a backtrace
-   *
-   * @param ExceptionEvent $event
-   *
-   * @return string
    */
-  protected function buildBacktrace(ExceptionEvent $event)
+  protected function buildBacktrace(ExceptionEvent $event): string
   {
     $user = $this->configuration->getUserInformation($this->tokenStorage->getToken());
 
@@ -196,11 +191,9 @@ protected function buildBacktrace(ExceptionEvent $event)
    * This function handles the Kernel exception response. When the response contains an http 500 error, it is tried to
    * get the backtrace from the server (via the file name stored in the session) and mail this to the maintainers
    *
-   * @param ResponseEvent $responseObject
-   *
    * @throws Exception
    */
-  public function onKernelResponse(ResponseEvent $responseObject)
+  public function onKernelResponse(ResponseEvent $responseObject): void
   {
     $response   = $responseObject->getResponse();
     $request    = $responseObject->getRequest();
@@ -318,25 +311,15 @@ public function onKernelResponse(ResponseEvent $responseObject)
     }
   }
 
-  /**
-   * @param $url
-   * @param $exceptionMessage
-   *
-   * @return string
-   */
-  protected function generateHash($url, $exceptionMessage)
+  protected function generateHash(string $url, string $exceptionMessage): string
   {
     return md5($url . $exceptionMessage);
   }
 
   /**
    * Removes a variable from the request
-   *
-   * @param Request $request
-   * @param string  $parameterBin
-   * @param string  $variable
    */
-  protected function removeVar(Request $request, $parameterBin, $variable)
+  protected function removeVar(Request $request, string $parameterBin, string $variable): void
   {
     if ($request->$parameterBin->has($variable)) {
       $request->$parameterBin->set($variable, '**REMOVED**');
@@ -345,12 +328,8 @@ protected function removeVar(Request $request, $parameterBin, $variable)
 
   /**
    * Removes a variables from the request
-   *
-   * @param Request $request
-   * @param string  $parameterBin
-   * @param array   $variables
    */
-  protected function removeVars(Request $request, $parameterBin, array $variables)
+  protected function removeVars(Request $request, string $parameterBin, array $variables): void
   {
     foreach ($variables as $variable) {
       $this->removeVar($request, $parameterBin, $variable);
@@ -363,12 +342,8 @@ protected function removeVars(Request $request, $parameterBin, array $variables)
 
   /**
    * Returns the request as a string.
-   *
-   * @param Request $request
-   *
-   * @return string The request
    */
-  protected function getRequestString(Request $request)
+  protected function getRequestString(Request $request): string
   {
     $string =
         sprintf('%s %s %s', $request->getMethod(), $request->getRequestUri(), $request->server->get('SERVER_PROTOCOL')) . "\r\n\r\nRequest headers:\r\n" .
@@ -389,14 +364,8 @@ protected function getRequestString(Request $request)
 
   /**
    * Convert an array to string
-   *
-   * @param     $array
-   * @param int $currentDepth
-   * @param int $maxDepth
-   *
-   * @return string
    */
-  protected function arrayToString($array, $currentDepth = 0, $maxDepth = 3)
+  protected function arrayToString(array $array, int $currentDepth = 0, int $maxDepth = 3): string
   {
     if ($currentDepth >= $maxDepth) {
       return '**Maximum recursion level reached**';
@@ -418,25 +387,11 @@ protected function arrayToString($array, $currentDepth = 0, $maxDepth = 3)
   }
 
   /**
-   * @param                  $uploadException
-   * @param BacktraceLogFile $backtrace
-   *
    * @throws Exception
    */
-  abstract protected function sendExceptionHandledFailedMessage($uploadException, BacktraceLogFile $backtrace): void;
+  abstract protected function sendExceptionHandledFailedMessage(Throwable $uploadException, BacktraceLogFile $backtrace): void;
 
   /**
-   * @param SessionInterface|null $session
-   * @param string                $requestUri
-   * @param string                $baseUrl
-   * @param string                $method
-   * @param string                $requestString
-   * @param array                 $responseString
-   * @param string                $backtrace
-   * @param string                $serverVariablesString
-   * @param string                $globalVariablesString
-   * @param string                $extension
-   *
    * @throws Exception
    */
   abstract protected function sendExceptionMessage(