feat(*): Prepare release 0.31.0

Author: julienloizelet

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.31.0](https://github.com/crowdsecurity/php-cs-bouncer/releases/tag/v0.31.0) - 2022-09-23
+[_Compare with previous release_](https://github.com/crowdsecurity/php-cs-bouncer/compare/v0.30.0...v0.31.0)
+
+### Changed
+- Use Twig as template engine for ban and captcha walls
+
+---
 
 ## [0.30.0](https://github.com/crowdsecurity/php-cs-bouncer/releases/tag/v0.30.0) - 2022-09-22
 [_Compare with previous release_](https://github.com/crowdsecurity/php-cs-bouncer/compare/v0.29.0...v0.30.0)

src/Bouncer.php

@@ -151,7 +151,7 @@ public function getRemediationForIp(string $ip): string
     }
 
     /**
-     * Returns a default "CrowdSec 403" HTML template to display to a web browser using a banned IP.
+     * Returns a default "CrowdSec 403" HTML template.
      * The input $config should match the TemplateConfiguration input format.
      *
      * @param array $config An array of template configuration parameters
@@ -170,8 +170,14 @@ public static function getAccessForbiddenHtmlTemplate(array $config): string
     }
 
     /**
-     * Returns a default "CrowdSec Captcha" HTML template to display to a web browser using a captchable IP.
+     * Returns a default "CrowdSec Captcha (401)" HTML template.
      * The input $config should match the TemplateConfiguration input format.
+     *
+     * @param bool $error
+     * @param string $captchaImageSrc
+     * @param string $captchaResolutionFormUrl
+     * @param array $config
+     * @return string
      */
     public static function getCaptchaHtmlTemplate(
         bool $error,

src/Constants.php

@@ -20,7 +20,7 @@ class Constants
     public const DEFAULT_LAPI_URL = 'http://localhost:8080';
 
     /** @var string The last version of this library */
-    public const VERSION = 'v0.30.0';
+    public const VERSION = 'v0.31.0';
 
     /** @var string The user agent used to send request to LAPI */
     public const BASE_USER_AGENT = 'PHP CrowdSec Bouncer/' . self::VERSION;

src/Template.php

@@ -2,6 +2,9 @@
 
 namespace CrowdSecBouncer;
 
+use Twig\Error\LoaderError;
+use Twig\Error\RuntimeError;
+use Twig\Error\SyntaxError;
 use Twig\Loader\FilesystemLoader;
 use Twig\Environment;
 use Twig\TemplateWrapper;
@@ -21,6 +24,14 @@ class Template
     /** @var TemplateWrapper */
     private $template;
 
+    /**
+     * @param string $path
+     * @param string $templatesDir
+     * @param array $options
+     * @throws LoaderError
+     * @throws RuntimeError
+     * @throws SyntaxError
+     */
     public function __construct(string $path, string $templatesDir = Constants::TEMPLATES_DIR, array $options = [])
     {
         $loader = new FilesystemLoader($templatesDir);