Cakephp 5

.github/workflows/php.yml

@@ -16,16 +16,16 @@ jobs:
   cs:
     uses: bedita/github-workflows/.github/workflows/php-cs.yml@v2
     with:
-      php_versions: '["8.3"]'
+      php_versions: '["8.4"]'
 
   stan:
     uses: bedita/github-workflows/.github/workflows/php-stan.yml@v2
     with:
-      php_versions: '["8.3"]'
+      php_versions: '["8.4"]'
 
   unit-5:
     uses: bedita/github-workflows/.github/workflows/php-unit.yml@v2
     with:
-      php_versions: '["8.3"]'
+      php_versions: '["8.3","8.4"]'
       bedita_version: '5'
       coverage_min_percentage: 99

composer.json

@@ -22,24 +22,21 @@
     "require": {
         "php": ">=8.3",
         "bedita/php-sdk": "^4.1.0",
-        "cakephp/cakephp": "^4.5",
+        "cakephp/cakephp": "^5.0",
         "firebase/php-jwt": "^6.9",
-        "cakephp/twig-view": "^1.3.0"
+        "cakephp/twig-view": "^2"
     },
     "require-dev": {
-        "cakephp/authentication": "^2.9",
-        "cakephp/authorization": "^2.2",
-        "cakephp/cakephp-codesniffer": "^4.7",
+        "cakephp/authentication": "^3.0.3",
+        "cakephp/authorization": "^3.1.2",
+        "cakephp/cakephp-codesniffer": "^5.0",
         "league/oauth2-client": "^2.6",
         "josegonzalez/dotenv": "^3.2",
-        "phpstan/phpstan": "^1.10",
-        "phpstan/extension-installer": "^1.2",
+        "phpstan/extension-installer": "^1.4",
+        "phpstan/phpstan": "^1.12",
+        "phpstan/phpstan-phpunit": "^1.4",
         "phpstan/phpstan-deprecation-rules": "^1.2",
-        "phpunit/phpunit": "^9.6"
-    },
-    "suggest": {
-        "cakephp/authentication": "^2.9 To use \"ApiIdentifier\", \"Identity\", \"IdentityHelper\" and other authentication features",
-        "cakephp/authorization": "^2.2 To use \"RequestPolicy\" and other authorization features"
+        "phpunit/phpunit": "^11.1.3"
     },
     "autoload": {
         "psr-4": {
@@ -67,8 +64,8 @@
     "config": {
         "allow-plugins": {
             "dealerdirect/phpcodesniffer-composer-installer": true,
-            "phpstan/extension-installer": true,
-            "cakephp/plugin-installer": true
+            "cakephp/plugin-installer": true,
+            "phpstan/extension-installer": true
         }
     }
 }

config/bootstrap.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * BEdita, API-first content management framework
  * Copyright 2018 ChannelWeb Srl, Chialab Srl
@@ -11,8 +12,29 @@
  * See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
  */
 
+/*
+ * Configure paths required to find CakePHP + general filepath constants
+ */
+require __DIR__ . DIRECTORY_SEPARATOR . 'paths.php';
+
+/*
+ * Bootstrap CakePHP.
+ *
+ * Does the various bits of setup that CakePHP needs to do.
+ * This includes:
+ *
+ * - Registering the CakePHP autoloader.
+ * - Setting the default application paths.
+ */
+require CORE_PATH . 'config' . DS . 'bootstrap.php';
+
 use Cake\Core\Configure;
 
+/**
+ * Load global functions.
+ */
+require CAKE . 'functions.php';
+
 /**
  * Setup API config if missing
  */

config/paths.php

@@ -0,0 +1,66 @@
+<?php
+/**
+ * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ * @link          https://cakephp.org CakePHP(tm) Project
+ * @since         3.0.0
+ * @license       MIT License (https://opensource.org/licenses/mit-license.php)
+ */
+
+/*
+ * Use the DS to separate the directories in other defines
+ */
+if (!defined('DS')) {
+    define('DS', DIRECTORY_SEPARATOR);
+}
+
+/*
+ * These defines should only be edited if you have cake installed in
+ * a directory layout other than the way it is distributed.
+ * When using custom settings be sure to use the DS and do not add a trailing DS.
+ */
+
+/*
+ * The full path to the directory which holds "src", WITHOUT a trailing DS.
+ */
+if (!defined('ROOT')) {
+    define('ROOT', dirname(__DIR__));
+}
+
+/*
+ * Path to the temporary files directory.
+ */
+if (!defined('TMP')) {
+    define('TMP', ROOT . DS . 'tmp' . DS);
+}
+
+/*
+ * Path to the cache files directory. It can be shared between hosts in a multi-server setup.
+ */
+if (!defined('CACHE')) {
+    define('CACHE', TMP . 'cache' . DS);
+}
+
+/*
+ * The absolute path to the "cake" directory, WITHOUT a trailing DS.
+ *
+ * CakePHP should always be installed with composer, so look there.
+ */
+if (!defined('CAKE_CORE_INCLUDE_PATH')) {
+    define('CAKE_CORE_INCLUDE_PATH', ROOT . DS . 'vendor' . DS . 'cakephp' . DS . 'cakephp');
+}
+
+/*
+ * Path to the cake directory.
+ */
+if (!defined('CORE_PATH')) {
+    define('CORE_PATH', CAKE_CORE_INCLUDE_PATH . DS);
+}
+if (!defined('CAKE')) {
+    define('CAKE', CORE_PATH . 'src' . DS);
+}

phpunit.xml.dist

@@ -1,10 +1,17 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" processIsolation="false" stopOnFailure="false" bootstrap="./tests/bootstrap.php" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
-  <coverage>
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    colors="true"
+    processIsolation="false"
+    stopOnFailure="false"
+    bootstrap="./tests/bootstrap.php"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+>
+  <source>
     <include>
       <directory suffix=".php">./src/</directory>
     </include>
-  </coverage>
+  </source>
   <php>
     <ini name="memory_limit" value="-1"/>
     <ini name="apc.enable_cli" value="1"/>
@@ -16,6 +23,6 @@
     </testsuite>
   </testsuites>
   <extensions>
-    <extension class="\Cake\TestSuite\Fixture\PHPUnitExtension"/>
+    <bootstrap class="\Cake\TestSuite\Fixture\Extension\PHPUnitExtension"/>
   </extensions>
 </phpunit>

src/ApiClientProvider.php

@@ -27,9 +27,9 @@ class ApiClientProvider
     /**
      * BEdita API client
      *
-     * @var \BEdita\SDK\BEditaClient
+     * @var \BEdita\SDK\BEditaClient|null
      */
-    private $apiClient = null;
+    private ?BEditaClient $apiClient = null;
 
     /**
      * Read singleton API client data.

src/Authenticator/OAuth2Authenticator.php

@@ -23,6 +23,7 @@
 use Cake\Routing\Router;
 use Cake\Utility\Hash;
 use Firebase\JWT\JWT;
+use League\OAuth2\Client\Provider\AbstractProvider;
 use Psr\Http\Message\ServerRequestInterface;
 
 /**
@@ -37,9 +38,9 @@ class OAuth2Authenticator extends AbstractAuthenticator
     /**
      * External Auth provider
      *
-     * @var \League\OAuth2\Client\Provider\AbstractProvider
+     * @var \League\OAuth2\Client\Provider\AbstractProvider|null
      */
-    protected $provider = null;
+    protected ?AbstractProvider $provider = null;
 
     /**
      * Authentication URL key
@@ -59,7 +60,7 @@ class OAuth2Authenticator extends AbstractAuthenticator
      *
      * @var array
      */
-    protected $_defaultConfig = [
+    protected array $_defaultConfig = [
         'sessionKey' => 'oauth2state',
         'redirect' => ['_name' => 'login'],
         'providers' => [],

src/Command/CacheClearallCommand.php

@@ -17,7 +17,6 @@
 use Cake\Command\CacheClearallCommand as BaseCommand;
 use Cake\Console\Arguments;
 use Cake\Console\ConsoleIo;
-use Cake\Filesystem\Folder;
 
 /**
  * Extend `CacheClearallCommand` to remove Twig compiled files.
@@ -37,8 +36,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
 
             return parent::execute($args, $io);
         }
-        $folder = new Folder($path); /* @phpstan-ignore-line */
-        $folder->delete();
+        unlink($path);
         $io->out('<success>Cleared twig cache</success>');
 
         return parent::execute($args, $io);

src/Controller/ApiProxyTrait.php

@@ -14,13 +14,17 @@
  */
 namespace BEdita\WebTools\Controller;
 
+use BEdita\SDK\BEditaClient;
 use BEdita\SDK\BEditaClientException;
 use BEdita\WebTools\ApiClientProvider;
 use Cake\Http\Exception\BadRequestException;
 use Cake\Http\Exception\MethodNotAllowedException;
+use Cake\Http\Response;
+use Cake\Http\ServerRequest;
 use Cake\Routing\Router;
 use Cake\Utility\Hash;
 use Cake\View\ViewVarsTrait;
+use Throwable;
 
 /**
  * Use this Trait in a controller to directly proxy requests to BE4 API.
@@ -45,28 +49,28 @@ trait ApiProxyTrait
      *
      * @var \Cake\Http\ServerRequest
      */
-    protected $request;
+    protected ServerRequest $request;
 
     /**
      * An instance of a Response object that contains information about the impending response.
      *
      * @var \Cake\Http\Response
      */
-    protected $response;
+    protected Response $response;
 
     /**
      * BEdita API client
      *
-     * @var \BEdita\SDK\BEditaClient
+     * @var \BEdita\SDK\BEditaClient|null
      */
-    protected $apiClient = null;
+    protected ?BEditaClient $apiClient = null;
 
     /**
      * Base URL used for mask links.
      *
      * @var string
      */
-    protected $baseUrl = '';
+    protected string $baseUrl = '';
 
     /**
      * @inheritDoc
@@ -88,7 +92,7 @@ public function initialize(): void
      * @param string $path The path on which build base URL
      * @return void
      */
-    protected function setBaseUrl($path): void
+    protected function setBaseUrl(string $path): void
     {
         $requestPath = $this->request->getPath();
         $pos = strpos(rawurldecode($requestPath), $path);
@@ -106,7 +110,7 @@ protected function setBaseUrl($path): void
      * @param string $path The path for API request
      * @return void
      */
-    public function get($path = ''): void
+    public function get(string $path = ''): void
     {
         $this->apiRequest([
             'method' => 'get',
@@ -121,7 +125,7 @@ public function get($path = ''): void
      * @param string $path The path for API request
      * @return void
      */
-    public function post($path = ''): void
+    public function post(string $path = ''): void
     {
         $this->apiRequest([
             'method' => 'post',
@@ -136,7 +140,7 @@ public function post($path = ''): void
      * @param string $path The path for API request
      * @return void
      */
-    public function patch($path = ''): void
+    public function patch(string $path = ''): void
     {
         $this->apiRequest([
             'method' => 'patch',
@@ -151,7 +155,7 @@ public function patch($path = ''): void
      * @param string $path The path for API request
      * @return void
      */
-    public function delete($path = ''): void
+    public function delete(string $path = ''): void
     {
         $this->apiRequest([
             'method' => 'delete',
@@ -216,7 +220,7 @@ protected function apiRequest(array $options): void
             $response = $this->maskResponseLinks($response);
             $this->set($response);
             $this->viewBuilder()->setOption('serialize', array_keys($response));
-        } catch (\Throwable $e) {
+        } catch (Throwable $e) {
             $this->handleError($e);
         }
     }
@@ -228,7 +232,7 @@ protected function apiRequest(array $options): void
      * @param \Throwable $error The error thrown.
      * @return void
      */
-    protected function handleError(\Throwable $error): void
+    protected function handleError(Throwable $error): void
     {
         $status = $error->getCode();
         if ($status < 100 || $status > 599) {

src/Controller/Component/ApiCacheComponent.php

@@ -31,7 +31,7 @@ class ApiCacheComponent extends Component
      *
      * @var array
      */
-    protected $_defaultConfig = [
+    protected array $_defaultConfig = [
         'cache' => '_apicache_',
     ];
 
@@ -40,7 +40,7 @@ class ApiCacheComponent extends Component
      *
      * @var array
      */
-    protected $cacheIndex = [];
+    protected array $cacheIndex = [];
 
     /**
      * Use 'default' as fallback if no cache configuration is found.