code review

CHANGELOG.md

@@ -1,3 +1,15 @@
+testMail 0.7.1 - 2023.11.04
+===========================================================
+* Require Dotclear 2.28
+* Require PHP 8.1
+* Code review
+
+testMail 0.7 - 2023.10.13
+===========================================================
+* Require Dotclear 2.28
+* Require PHP 8.1
+* Code review
+
 testMail 0.6 - 2023.10.07
 ===========================================================
 * Require Dotclear 2.28

README.md

@@ -1,7 +1,7 @@
 # README
 
-[![Release](https://img.shields.io/badge/release-0.6-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/testMail/releases)
+[![Release](https://img.shields.io/badge/release-0.7.1-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/testMail/releases)
-![Date](https://img.shields.io/badge/date-2023.10.07-c44d58.svg)
+![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/testMail)
 [![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/testMail/src/branch/master/LICENSE)
@@ -10,13 +10,13 @@
 
 _testmail_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
 
-> It helps dev to test dotclear mail system.
+> Help dev to test dotclear mail system.
 
 ## REQUIREMENTS
 
-* super admin permission
 * Dotclear 2.28
 * PHP 8.1+
+* Dotclear super admin permission
 
 ## USAGE
 
@@ -35,6 +35,6 @@ Access mail form from admin sidebar system menu **Mail test**.
 ## CONTRIBUTORS
 
 * Osku (author)
-* Jean-Christian Denis
+* Jean-Christian Denis (latest)
 
 You are welcome to contribute to this code.

_define.php

@@ -1,29 +1,27 @@
 <?php
 /**
- * @brief testMail, a plugin for Dotclear 2
+ * @file
+ * @brief       The plugin testMail definition
+ * @ingroup     testMail
  *
- * @package Dotclear
+ * @defgroup    testMail Plugin testMail.
- * @subpackage Plugin
  *
- * @author Osku and contributors
+ * Send a simple mail from admin.
  *
- * @copyright Jean-Christian Denis
+ * @author      Osku (author)
- * @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
  */
 declare(strict_types=1);
 
-if (!defined('DC_RC_PATH')) {
-    return null;
-}
-
 $this->registerModule(
     'Mail test',
     'Send a simple mail from admin',
     'Osku and contributors',
-    '0.6',
+    '0.7.1',
     [
         'requires'    => [['core', '2.28']],
-        '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',

dcstore.xml

@@ -2,10 +2,10 @@
 <modules xmlns:da="http://dotaddict.org/da/">
   <module id="testMail">
     <name>Mail test</name>
-    <version>0.6</version>
+    <version>0.7.1</version>
     <author>Osku and contributors</author>
     <desc>Send a simple mail from admin</desc>
-    <file>https://git.dotclear.watch/JcDenis/testMail/releases/download/v0.6/plugin-testMail.zip</file>
+    <file>https://git.dotclear.watch/JcDenis/testMail/releases/download/v0.7.1/plugin-testMail.zip</file>
     <da:dcmin>2.28</da:dcmin>
     <da:details>https://git.dotclear.watch/JcDenis/testMail/src/branch/master/README.md</da:details>
     <da:support>https://git.dotclear.watch/JcDenis/testMail/issues</da:support>

src/Backend.php

@@ -1,21 +1,19 @@
 <?php
-/**
+
- * @brief testMail, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Osku 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\testMail;
 
 use Dotclear\Core\Process;
 
+/**
+ * @brief       testMail backend class.
+ * @ingroup     testMail
+ *
+ * @author      Osku (author)
+ * @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

src/Manage.php

@@ -1,15 +1,5 @@
 <?php
-/**
+
- * @brief testMail, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Osku 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\testMail;
@@ -35,6 +25,14 @@ use Dotclear\Helper\Network\Mail\Mail;
 use Dotclear\Helper\Text;
 use Exception;
 
+/**
+ * @brief       testMail manage class.
+ * @ingroup     testMail
+ *
+ * @author      Osku (author)
+ * @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
@@ -110,7 +108,7 @@ class Manage extends Process
                                 (new Input('mail_to'))
                                     ->__call('class', ['maximal'])
                                     ->__call('size', [30])
-                                    ->__call('maxlenght', [255])
+                                    ->__call('maxlength', [255])
                                     ->__call('value', ['']),
                             ]]),
                         (new Para())
@@ -120,7 +118,7 @@ class Manage extends Process
                                 (new Input('mail_subject'))
                                     ->__call('class', ['maximal'])
                                     ->__call('size', [30])
-                                    ->__call('maxlenght', [255])
+                                    ->__call('maxlength', [255])
                                     ->__call('value', ['']),
                             ]]),
                         (new Para())
@@ -154,6 +152,9 @@ class Manage extends Process
         Page::closeModule();
     }
 
+    /**
+     * @return  array<int, string>
+     */
     private static function getHeaders(): array
     {
         return [

src/My.php

@@ -1,15 +1,5 @@
 <?php
-/**
+
- * @brief testMail, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Osku 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\testMail;
@@ -18,15 +8,28 @@ use Dotclear\App;
 use Dotclear\Module\MyPlugin;
 
 /**
- * This module definitions.
+ * @brief       testMail My helper.
+ * @ingroup     testMail
+ *
+ * @author      Osku (author)
+ * @author      Jean-Christian Denis (author)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
  */
 class My extends MyPlugin
 {
-    /** @var    string  Mailer name */
+    /**
+     * Mailer name.
+     *
+     * @var     string  X_MAILER
+     */
     public const X_MAILER = 'Dotclear';
 
-    public static function checkXustomContext(int $context): ?bool
+    public static function checkCustomContext(int $context): ?bool
     {
-        return defined('DC_CONTEXT_ADMIN') && App::auth()->isSuperAdmin();
+        return match ($context) {
+            // Limit to super admin
+            self::MODULE => App::auth()->isSuperAdmin(),
+            default      => null,
+        };
     }
 }