From a21bbdd4a85d27c92a5cd124743c06dd794d97d8 Mon Sep 17 00:00:00 2001
From: Jean-Christian Denis <contact@jcdenis.fr>
Date: Fri, 13 Oct 2023 21:23:56 +0200
Subject: [PATCH] release 1.5

---
 CHANGELOG.md             |  6 ++++
 README.md                | 15 ++++++----
 _define.php              | 23 ++++++++-------
 dcstore.xml              |  4 +--
 locales/en/resources.php | 20 ++++++-------
 locales/fr/resources.php | 20 ++++++-------
 src/Backend.php          | 19 ++++++-------
 src/Manage.php           | 19 ++++++-------
 src/ManageVars.php       | 61 ++++++++++++++++++++++++++++------------
 src/My.php               | 22 +++++++--------
 src/Prepend.php          | 19 ++++++-------
 src/Uninstall.php        | 19 ++++++-------
 12 files changed, 130 insertions(+), 117 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index ac33299..acdd5d4 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,9 @@
+dcAdvancedCleaner 1.5 - 2023.10.13
+===========================================================
+* Require Dotclear 2.28
+* Require PHP 8.1
+* Code review
+
 dcAdvancedCleaner 1.4 - 2023.10.07
 ===========================================================
 * Require Dotclear 2.28
diff --git a/README.md b/README.md
index d483c8b..89b56bd 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # README
 
-[![Release](https://img.shields.io/badge/release-1.4-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/dcAdvancedCleaner/releases)
-![Date](https://img.shields.io/badge/date-2023.10.07-c44d58.svg)
+[![Release](https://img.shields.io/badge/release-1.5-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/dcAdvancedCleaner/releases)
+![Date](https://img.shields.io/badge/date-2023.10.13-c44d58.svg)
 [![Dotclear](https://img.shields.io/badge/dotclear-v2.28-137bbb.svg)](https://fr.dotclear.org/download)
 [![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/dcAdvancedCleaner)
 [![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/dcAdvancedCleaner/src/branch/master/LICENSE)
@@ -14,10 +14,10 @@ _dcAdvancedCleaner_ is a plugin for the open-source web publishing software call
 
 ## REQUIREMENTS
 
-* Permissions superadmin
 * Dotclear 2.28
-* PHP >= 8.1
+* PHP 8.1+
 * Plugin Uninstaller
+* Permissions superadmin
 
 ## USAGE
 
@@ -32,7 +32,12 @@ Once it's done you can manage cleaners from menu
 * License : [GNU GPL v2](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html)
 * Source & contribution : [Gitea Page](https://git.dotclear.watch/JcDenis/dcAdvancedCleaner) or [GitHub Page](https://github.com/JcDenis/dcAdvancedCleaner)
 * Packages & details: [Gitea Page](https://git.dotclear.watch/JcDenis/dcAdvancedCleaner/releases) or [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/dcAdvancedCleaner)
-* Discuss and help : [Dotclear Forum](https://forum.dotclear.org/viewtopic.php?id=40381)
+
+* [License](https://git.dotclear.watch/JcDenis/dcAdvancedCleaner/src/branch/master/LICENSE)
+* [Packages & details](https://git.dotclear.watch/JcDenis/dcAdvancedCleaner/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/dcAdvancedCleaner))
+* [Sources & contributions](https://git.dotclear.watch/JcDenis/dcAdvancedCleaner) (or on [GitHub](https://github.com/JcDenis/dcAdvancedCleaner))
+* [Issues & security](https://git.dotclear.watch/JcDenis/dcAdvancedCleaner/issues) (or on [GitHub](https://github.com/JcDenis/dcAdvancedCleaner/issues))
+* [Discuss & help](https://forum.dotclear.org/viewtopic.php?id=40381)
 
 ## CONTRIBUTORS
 
diff --git a/_define.php b/_define.php
index 452cfa5..b74e105 100644
--- a/_define.php
+++ b/_define.php
@@ -1,31 +1,30 @@
 <?php
+
 /**
- * @brief dcAdvancedCleaner, a plugin for Dotclear 2
+ * @file
+ * @brief       The plugin dcAdvancedCleaner definition
+ * @ingroup     dcAdvancedCleaner
  *
- * @package Dotclear
- * @subpackage Plugin
+ * @defgroup    dcAdvancedCleaner Plugin dcAdvancedCleaner.
  *
- * @author Jean-Christian Denis and Contributors
+ * Make a huge cleaning of dotclear.
  *
- * @copyright Jean-Christian Denis
- * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ * @author      Jean-Christian Denis (author)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
  */
-if (!defined('DC_RC_PATH')) {
-    return null;
-}
+declare(strict_types=1);
 
 $this->registerModule(
     'Advanced cleaner',
     'Make a huge cleaning of dotclear',
     'Jean-Christian Denis and Contributors',
-    '1.4',
+    '1.5',
     [
         'requires' => [
-            ['php', '8.1'],
             ['core', '2.28'],
             ['Uninstaller', '1.0'],
         ],
-        'permissions' => null,
+        'permissions' => 'My',
         'type'        => 'plugin',
         'support'     => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/issues',
         'details'     => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/src/branch/master/README.md',
diff --git a/dcstore.xml b/dcstore.xml
index f641440..3b48f1f 100644
--- a/dcstore.xml
+++ b/dcstore.xml
@@ -2,10 +2,10 @@
 <modules xmlns:da="http://dotaddict.org/da/">
   <module id="dcAdvancedCleaner">
     <name>Advanced cleaner</name>
-    <version>1.4</version>
+    <version>1.5</version>
     <author>Jean-Christian Denis and Contributors</author>
     <desc>Make a huge cleaning of dotclear</desc>
-    <file>https://git.dotclear.watch/JcDenis/dcAdvancedCleaner/releases/download/v1.4/plugin-dcAdvancedCleaner.zip</file>
+    <file>https://git.dotclear.watch/JcDenis/dcAdvancedCleaner/releases/download/v1.5/plugin-dcAdvancedCleaner.zip</file>
     <da:dcmin>2.28</da:dcmin>
     <da:details>https://git.dotclear.watch/JcDenis/dcAdvancedCleaner/src/branch/master/README.md</da:details>
     <da:support>https://git.dotclear.watch/JcDenis/dcAdvancedCleaner/issues</da:support>
diff --git a/locales/en/resources.php b/locales/en/resources.php
index a254f38..4ec03e9 100644
--- a/locales/en/resources.php
+++ b/locales/en/resources.php
@@ -1,16 +1,12 @@
 <?php
+
 /**
- * @brief dcAdvancedCleaner, a plugin for Dotclear 2
+ * @file
+ * @brief   dcAdvancedCleaner resources helper.
+ * @ingroup dcAdvancedCleaner
  *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Jean-Christian Denis and Contributors
- *
- * @copyright Jean-Christian Denis
- * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ * @author      Jean-Christian Denis (author)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
  */
-if (!defined('DC_RC_PATH')) {
-    return;
-}
-dcCore::app()->resources['help']['dcAdvancedCleaner'] = __DIR__ . '/help/dcAdvancedCleaner.html';
+
+\Dotclear\App::backend()->resources()->set('help', 'dcAdvancedCleaner', __DIR__ . '/help/dcAdvancedCleaner.html');
\ No newline at end of file
diff --git a/locales/fr/resources.php b/locales/fr/resources.php
index a254f38..4ec03e9 100644
--- a/locales/fr/resources.php
+++ b/locales/fr/resources.php
@@ -1,16 +1,12 @@
 <?php
+
 /**
- * @brief dcAdvancedCleaner, a plugin for Dotclear 2
+ * @file
+ * @brief   dcAdvancedCleaner resources helper.
+ * @ingroup dcAdvancedCleaner
  *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Jean-Christian Denis and Contributors
- *
- * @copyright Jean-Christian Denis
- * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ * @author      Jean-Christian Denis (author)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
  */
-if (!defined('DC_RC_PATH')) {
-    return;
-}
-dcCore::app()->resources['help']['dcAdvancedCleaner'] = __DIR__ . '/help/dcAdvancedCleaner.html';
+
+\Dotclear\App::backend()->resources()->set('help', 'dcAdvancedCleaner', __DIR__ . '/help/dcAdvancedCleaner.html');
\ No newline at end of file
diff --git a/src/Backend.php b/src/Backend.php
index 09f2f1e..6ebfefe 100644
--- a/src/Backend.php
+++ b/src/Backend.php
@@ -1,15 +1,5 @@
 <?php
-/**
- * @brief dcAdvancedCleaner, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Jean-Christian Denis and Contributors
- *
- * @copyright Jean-Christian Denis
- * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
- */
+
 declare(strict_types=1);
 
 namespace Dotclear\Plugin\dcAdvancedCleaner;
@@ -18,6 +8,13 @@ use Dotclear\App;
 use Dotclear\Core\Process;
 use Dotclear\Core\Backend\Favorites;
 
+/**
+ * @brief   dcAdvancedCleaner backend class.
+ * @ingroup dcAdvancedCleaner
+ *
+ * @author      Jean-Christian Denis (author)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ */
 class Backend extends Process
 {
     public static function init(): bool
diff --git a/src/Manage.php b/src/Manage.php
index 3fd4509..7647935 100644
--- a/src/Manage.php
+++ b/src/Manage.php
@@ -1,15 +1,5 @@
 <?php
-/**
- * @brief dcAdvancedCleaner, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Jean-Christian Denis and Contributors
- *
- * @copyright Jean-Christian Denis
- * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
- */
+
 declare(strict_types=1);
 
 namespace Dotclear\Plugin\dcAdvancedCleaner;
@@ -35,6 +25,13 @@ use Dotclear\Helper\Html\Form\{
 use Dotclear\Helper\Html\Html;
 use Exception;
 
+/**
+ * @brief   dcAdvancedCleaner manage class.
+ * @ingroup dcAdvancedCleaner
+ *
+ * @author      Jean-Christian Denis (author)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ */
 class Manage extends Process
 {
     public static function init(): bool
diff --git a/src/ManageVars.php b/src/ManageVars.php
index 90b737f..baffbad 100644
--- a/src/ManageVars.php
+++ b/src/ManageVars.php
@@ -1,15 +1,5 @@
 <?php
-/**
- * @brief dcAdvancedCleaner, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Jean-Christian Denis and Contributors
- *
- * @copyright Jean-Christian Denis
- * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
- */
+
 declare(strict_types=1);
 
 namespace Dotclear\Plugin\dcAdvancedCleaner;
@@ -21,27 +11,62 @@ use Dotclear\Plugin\Uninstaller\{
 };
 use Exception;
 
+/**
+ * @brief   dcAdvancedCleaner vars definition class.
+ * @ingroup dcAdvancedCleaner
+ *
+ * @author      Jean-Christian Denis (author)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ */
 class ManageVars
 {
-    /** @var    ManageVars  self instance */
+    /**
+     * self instance.
+     *
+     * @var     ManageVars  $container
+     */
     private static $container;
 
-    /** @var    CleanersStack   The cleaners stack */
+    /**
+     * The cleaners stack.
+     *
+     * @var     CleanersStack   $cleaners
+     */
     public readonly CleanersStack $cleaners;
 
-    /** @var    null|CleanerParent  The post form cleaner */
+    /**
+     * The post form cleaner.
+     *
+     * @var     null|CleanerParent  $cleaner
+     */
     public readonly ?CleanerParent $cleaner;
 
-    /** @var string     $related    The post form related action id */
+    /**
+     * The post form related action id.
+     *
+     * @var     string  $related
+     */
     public readonly string $related;
 
-    /** @var    array<int,string>   The post form selected ns */
+    /**
+     * The post form selected ns.
+     *
+     * @var     array<int,string>   $entries
+     */
     public readonly array $entries;
 
-    /** @var    string  The post form action id */
+    /**
+     * The post form action id.
+     *
+     * @var     string  $action
+     */
     public readonly string $action;
 
-    /** @var    array<string,string>    The form actions combo */
+    /**
+     * The form actions combo.
+     *
+     * @var     array<string,string>    $combo
+     */
     public readonly array $combo;
 
     protected function __construct()
diff --git a/src/My.php b/src/My.php
index f5eda4c..6aef987 100644
--- a/src/My.php
+++ b/src/My.php
@@ -1,15 +1,5 @@
 <?php
-/**
- * @brief dcAdvancedCleaner, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Jean-Christian Denis and Contributors
- *
- * @copyright Jean-Christian Denis
- * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
- */
+
 declare(strict_types=1);
 
 namespace Dotclear\Plugin\dcAdvancedCleaner;
@@ -17,10 +7,18 @@ namespace Dotclear\Plugin\dcAdvancedCleaner;
 use Dotclear\App;
 use Dotclear\Module\MyPlugin;
 
+/**
+ * @brief   dcAdvancedCleaner My helper.
+ * @ingroup dcAdvancedCleaner
+ *
+ * @author      Jean-Christian Denis (author)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ */
 class My extends MyPlugin
 {
     public static function checkCustomContext(int $context): ?bool
     {
-        return $context === self::PREPEND ? App::auth()->isSuperAdmin() : null;
+        // Limit to backend and super admin
+        return App::task()->checkContext('BACKEND') && App::auth()->isSuperAdmin();
     }
 }
diff --git a/src/Prepend.php b/src/Prepend.php
index 769f1ba..955dee5 100644
--- a/src/Prepend.php
+++ b/src/Prepend.php
@@ -1,15 +1,5 @@
 <?php
-/**
- * @brief dcAdvancedCleaner, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Jean-Christian Denis and Contributors
- *
- * @copyright Jean-Christian Denis
- * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
- */
+
 declare(strict_types=1);
 
 namespace Dotclear\Plugin\dcAdvancedCleaner;
@@ -22,6 +12,13 @@ use Dotclear\Plugin\activityReport\{
 };
 use Dotclear\Plugin\Uninstaller\Uninstaller;
 
+/**
+ * @brief   dcAdvancedCleaner prepend class.
+ * @ingroup dcAdvancedCleaner
+ *
+ * @author      Jean-Christian Denis (author)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ */
 class Prepend extends Process
 {
     public static function init(): bool
diff --git a/src/Uninstall.php b/src/Uninstall.php
index 7225665..8c4c1ba 100644
--- a/src/Uninstall.php
+++ b/src/Uninstall.php
@@ -1,15 +1,5 @@
 <?php
-/**
- * @brief dcAdvancedCleaner, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Jean-Christian Denis and Contributors
- *
- * @copyright Jean-Christian Denis
- * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
- */
+
 declare(strict_types=1);
 
 namespace Dotclear\Plugin\dcAdvancedCleaner;
@@ -17,6 +7,13 @@ namespace Dotclear\Plugin\dcAdvancedCleaner;
 use Dotclear\Core\Process;
 use Dotclear\Plugin\Uninstaller\Uninstaller;
 
+/**
+ * @brief   dcAdvancedCleaner uninstall class.
+ * @ingroup dcAdvancedCleaner
+ *
+ * @author      Jean-Christian Denis (author)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ */
 class Uninstall extends Process
 {
     public static function init(): bool