cosmetic code doc

CHANGELOG.md

@@ -1,3 +1,15 @@
+dcLog 1.7.3 - 2023.11.04
+===========================================================
+* Require Dotclear 2.28
+* Require PHP 8.1
+* Cosmetic code doc
+
+dcLog 1.7.2 - 2023.10.13
+===========================================================
+* Require Dotclear 2.28
+* Require PHP 8.1
+* Upgrade to last minute change to Dotclear 2.28
+
 dcLog 1.7.1 - 2023.10.11
 ===========================================================
 * Require Dotclear 2.28

README.md

@@ -1,7 +1,7 @@
 # README
 
-[![Release](https://img.shields.io/badge/release-1.7-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/dcLog/releases)
-![Date](https://img.shields.io/badge/date-2023.10.07-c44d58.svg)
+[![Release](https://img.shields.io/badge/release-1.7.3-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/dcLog/releases)
+![Date](https://img.shields.io/badge/date-2023.11.04-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/dcLog)
 [![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/dcLog/src/branch/master/LICENSE)
@@ -16,7 +16,7 @@ _dcLog_ is a plugin for the open-source web publishing software called [Dotclear
 
 * PHP 8.1+
 * Dotclear 2.28
-* super admin permission
+* Dotclear super admin permission
 
 ## USAGE
 

_define.php

@@ -18,7 +18,7 @@ $this->registerModule(
     "Dotclear's logs",
     'Displays Dotclear logs',
     'Tomtom and Contributors',
-    '1.7.1',
+    '1.7.3',
     [
         'requires'    => [['core', '2.28']],
         'permissions' => null,

dcstore.xml

@@ -2,10 +2,10 @@
 <modules xmlns:da="http://dotaddict.org/da/">
   <module id="dcLog">
     <name>Dotclear's logs</name>
-    <version>1.7.1</version>
+    <version>1.7.3</version>
     <author>Tomtom and Contributors</author>
     <desc>Displays Dotclear logs</desc>
-    <file>https://git.dotclear.watch/JcDenis/dcLog/releases/download/v1.7.1/plugin-dcLog.zip</file>
+    <file>https://git.dotclear.watch/JcDenis/dcLog/releases/download/v1.7.3/plugin-dcLog.zip</file>
     <da:dcmin>2.28</da:dcmin>
     <da:details>https://git.dotclear.watch/JcDenis/dcLog/src/branch/master/README.md</da:details>
     <da:support>https://git.dotclear.watch/JcDenis/dcLog/issues</da:support>

src/Backend.php

@@ -10,8 +10,8 @@ use Dotclear\Core\Process;
 use Dotclear\Core\Backend\Favorites;
 
 /**
- * @brief   dcLog backend class.
- * @ingroup dcLog
+ * @brief       dcLog backend class.
+ * @ingroup     dcLog
  *
  * @author      Tomtom (author)
  * @author      Jean-Christian Denis (latest)
@@ -30,7 +30,7 @@ class Backend extends Process
             return false;
         }
 
-        My::addBackendMenuItem(App::backend()->menus::MENU_SYSTEM);
+        My::addBackendMenuItem(App::backend()->menus()::MENU_SYSTEM);
 
         App::behavior()->addBehaviors([
             // backend user preference for logs list columns

src/BackendList.php

@@ -20,8 +20,8 @@ use Dotclear\Helper\Html\Form\{
 };
 
 /**
- * @brief   dcLog logs list class.
- * @ingroup dcLog
+ * @brief       dcLog logs list class.
+ * @ingroup     dcLog
  *
  * @author      Tomtom (author)
  * @author      Jean-Christian Denis (latest)

src/Manage.php

@@ -1,15 +1,5 @@
 <?php
-/**
- * @brief dcLog, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Tomtom 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\dcLog;
@@ -31,8 +21,8 @@ use Dotclear\Helper\Html\Form\{
 use Exception;
 
 /**
- * @brief   dcLog manage class.
- * @ingroup dcLog
+ * @brief       dcLog manage class.
+ * @ingroup     dcLog
  *
  * @author      Tomtom (author)
  * @author      Jean-Christian Denis (latest)

src/ManageVars.php

@@ -13,8 +13,8 @@ use Dotclear\Database\MetaRecord;
 use Exception;
 
 /**
- * @brief   dcLog properties helper.
- * @ingroup dcLog
+ * @brief       dcLog properties helper.
+ * @ingroup     dcLog
  *
  * @author      Tomtom (author)
  * @author      Jean-Christian Denis (latest)

src/My.php

@@ -8,8 +8,8 @@ use Dotclear\App;
 use Dotclear\Module\MyPlugin;
 
 /**
- * @brief   dcLog My helper.
- * @ingroup dcLog
+ * @brief       dcLog My helper.
+ * @ingroup     dcLog
  *
  * @author      Tomtom (author)
  * @author      Jean-Christian Denis (latest)
@@ -26,7 +26,10 @@ class My extends MyPlugin
 
     public static function checkCustomContext(int $context): ?bool
     {
-        // Limit module to super admin
-        return App::auth()->isSuperAdmin();
+        return match ($context) {
+            // Limit to super admin
+            self::MODULE => App::auth()->isSuperAdmin(),
+            default      => null,
+        };
     }
 }