style(*): Update PHPdoc and comments

Author: julienloizelet

src/AbstractBounce.php

@@ -11,6 +11,7 @@
 use Monolog\Formatter\LineFormatter;
 use Monolog\Handler\RotatingFileHandler;
 use Monolog\Logger;
+use Psr\Cache\InvalidArgumentException;
 use Psr\Log\LoggerInterface;
 
 /**
@@ -53,7 +54,7 @@ protected function getArraySettings(string $name): array
     /**
      * Run a bounce.
      *
-     * @throws Exception
+     * @throws Exception|InvalidArgumentException
      */
     public function run(
     ): void {
@@ -97,7 +98,7 @@ protected function initLoggerHelper($logDirectoryPath, $loggerName): void
     }
 
     /**
-     * @throws Exception
+     * @throws Exception|InvalidArgumentException
      */
     protected function bounceCurrentIp()
     {

src/ApiClient.php

@@ -19,12 +19,12 @@
 class ApiClient
 {
     /** @var LoggerInterface */
-    private $logger = null;
+    private $logger;
 
     /**
      * @var RestClient
      */
-    private $restClient = null;
+    private $restClient;
 
     public function __construct(LoggerInterface $logger)
     {

src/Bouncer.php

@@ -11,6 +11,7 @@
 use IPLib\ParseStringFlag;
 use Monolog\Handler\NullHandler;
 use Monolog\Logger;
+use Psr\Cache\InvalidArgumentException;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Cache\Adapter\AbstractAdapter;
 use Symfony\Component\Config\Definition\Processor;
@@ -54,7 +55,7 @@ public function __construct(AbstractAdapter $cacheAdapter = null, LoggerInterfac
      *
      * @param array $config An array with all configuration parameters
      *
-     * @throws \Psr\Cache\InvalidArgumentException
+     * @throws InvalidArgumentException
      */
     public function configure(array $config): void
     {
@@ -110,7 +111,7 @@ private function capRemediationLevel(string $remediation): string
      *
      * @return string the remediation to apply (ex: 'ban', 'captcha', 'bypass')
      *
-     * @throws \Psr\Cache\InvalidArgumentException
+     * @throws InvalidArgumentException
      */
     public function getRemediationForIp(string $ip): string
     {
@@ -172,7 +173,7 @@ public static function getCaptchaHtmlTemplate(bool $error, string $captchaImageS
      *
      * @return array "count": number of decisions added, "errors": decisions not added
      *
-     * @throws \Psr\Cache\InvalidArgumentException
+     * @throws InvalidArgumentException
      */
     public function warmBlocklistCacheUp(): array
     {
@@ -185,7 +186,7 @@ public function warmBlocklistCacheUp(): array
      *
      * @return array Number of deleted and new decisions, and errors when processing decisions
      *
-     * @throws \Psr\Cache\InvalidArgumentException
+     * @throws InvalidArgumentException
      */
     public function refreshBlocklistCache(): array
     {
@@ -197,7 +198,7 @@ public function refreshBlocklistCache(): array
      *
      * @return bool If the cache has been successfully cleared or not
      *
-     * @throws \Psr\Cache\InvalidArgumentException
+     * @throws InvalidArgumentException
      */
     public function clearCache(): bool
     {
@@ -266,7 +267,7 @@ public function checkCaptcha(string $expected, string $try, string $ip): bool
      *
      * @return void If the connection was successful or not
      *
-     * @throws BouncerException|\Psr\Cache\InvalidArgumentException if the connection was not successful
+     * @throws BouncerException|InvalidArgumentException if the connection was not successful
      * */
     public function testConnection()
     {

src/BouncerException.php

@@ -2,6 +2,8 @@
 
 namespace CrowdSecBouncer;
 
+use RuntimeException;
+
 /**
  * Exception interface for all exceptions thrown by CrowdSec Bouncer.
  *
@@ -12,6 +14,6 @@
  * @copyright Copyright (c) 2020+ CrowdSec
  * @license   MIT License
  */
-class BouncerException extends \RuntimeException
+class BouncerException extends RuntimeException
 {
 }

src/IBounce.php

@@ -2,8 +2,6 @@
 
 namespace CrowdSecBouncer;
 
-use Monolog\Logger;
-
 /**
  * The interface to implement when bouncing.
  *
@@ -52,7 +50,7 @@ public function getCaptchaWallOptions(): array;
     public function getBanWallOptions(): array;
 
     /**
-     * @return [[string, string], ...] Returns IP ranges to trust as proxies as an array of comparables ip bounds
+     * @return array [[string, string], ...] Returns IP ranges to trust as proxies as an array of comparables ip bounds
      */
     public function getTrustForwardedIpBoundsList(): array;
 
@@ -67,7 +65,7 @@ public function getSessionVariable(string $name);
     public function setSessionVariable(string $name, $value): void;
 
     /**
-     * Unset a session variable, throw an error if this does not exists.
+     * Unset a session variable, throw an error if this does not exist.
      *
      * @return void;
      */

src/RestClient.php

@@ -28,7 +28,7 @@ class RestClient
     private $baseUri = null;
 
     /** @var LoggerInterface */
-    private $logger = null;
+    private $logger;
 
     public function __construct(LoggerInterface $logger)
     {
@@ -52,7 +52,7 @@ public function configure(string $baseUri, array $headers, int $timeout): void
     }
 
     /**
-     * Convert an key-value array of headers to the official HTTP header string.
+     * Convert a key-value array of headers to the official HTTP header string.
      */
     private function convertHeadersToString(array $headers): string
     {
@@ -67,7 +67,7 @@ private function convertHeadersToString(array $headers): string
     /**
      * Send an HTTP request using the file_get_contents and parse its JSON result if any.
      *
-     * @throws BouncerException when the reponse status is not 2xx
+     * @throws BouncerException when the response status is not 2xx
      */
     public function request(
         string $endpoint,
@@ -115,8 +115,7 @@ public function request(
         if ($status < 200 || $status >= 300) {
             throw new BouncerException("unexpected response status from $this->baseUri$endpoint: $status\n".$response);
         }
-        $data = json_decode($response, true);
 
-        return $data;
+        return json_decode($response, true);
     }
 }

src/Session.php

@@ -37,7 +37,7 @@ public static function setSessionVariable(string $name, $value): void
     }
 
     /**
-     * Unset a session variable, throw an error if this does not exists.
+     * Unset a session variable, throw an error if this does not exist.
      *
      * @return void;
      */

src/StandAloneBounce.php

@@ -2,10 +2,13 @@
 
 namespace CrowdSecBouncer;
 
+use ErrorException;
+use Exception;
 use Symfony\Component\Cache\Adapter\AbstractAdapter;
 use Symfony\Component\Cache\Adapter\MemcachedAdapter;
 use Symfony\Component\Cache\Adapter\PhpFilesAdapter;
 use Symfony\Component\Cache\Adapter\RedisAdapter;
+use Symfony\Component\Cache\Exception\CacheException;
 use Symfony\Component\Cache\Exception\InvalidArgumentException;
 
 /**
@@ -23,6 +26,11 @@ class StandAloneBounce extends AbstractBounce implements IBounce
     /** @var AbstractAdapter */
     protected $cacheAdapter;
 
+    /**
+     * @var string
+     */
+    protected $session_name;
+
     public function init(array $crowdSecStandaloneBouncerConfig)
     {
         if (\PHP_SESSION_NONE === session_status()) {
@@ -33,6 +41,10 @@ public function init(array $crowdSecStandaloneBouncerConfig)
         $this->initLogger();
     }
 
+    /**
+     * @throws CacheException
+     * @throws ErrorException
+     */
     private function getCacheAdapterInstance(): AbstractAdapter
     {
         // Singleton for this function
@@ -69,14 +81,18 @@ private function getCacheAdapterInstance(): AbstractAdapter
 
                 break;
             default:
-                throw new BouncerException('Unknow selected cache technology.');
+                throw new BouncerException('Unknown selected cache technology.');
         }
 
         return $this->cacheAdapter;
     }
 
     /**
      * @return Bouncer get the bouncer instance
+     *
+     * @throws CacheException
+     * @throws ErrorException
+     * @throws \Psr\Cache\InvalidArgumentException
      */
     public function getBouncerInstance(): Bouncer
     {
@@ -271,7 +287,7 @@ public function setSessionVariable(string $name, $value): void
     }
 
     /**
-     * Unset a session variable, throw an error if this does not exists.
+     * Unset a session variable, throw an error if this does not exist.
      *
      * @return void;
      */
@@ -294,6 +310,9 @@ public function getPostedVariable(string $name): ?string
 
     /**
      * If the current IP should be bounced or not, matching custom business rules.
+     *
+     * @throws CacheException
+     * @throws ErrorException
      */
     public function shouldBounceCurrentIp(): bool
     {
@@ -340,6 +359,10 @@ public function sendResponse(?string $body, int $statusCode = 200): void
         exit();
     }
 
+    /**
+     * @throws \Psr\Cache\InvalidArgumentException
+     * @throws Exception
+     */
     public function safelyBounce(): void
     {
         // If there is any technical problem while bouncing, don't block the user. Bypass bouncing and log the error.
@@ -349,7 +372,7 @@ public function safelyBounce(): void
             });
             $this->run();
             restore_error_handler();
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
             $this->logger->error('', [
                 'type' => 'EXCEPTION_WHILE_BOUNCING',
                 'message' => $e->getMessage(),
@@ -368,6 +391,10 @@ public function safelyBounce(): void
         }
     }
 
+    /**
+     * @throws ErrorException
+     * @throws CacheException
+     */
     public function isConfigValid(): bool
     {
         $issues = ['errors' => [], 'warnings' => []];