cosmetic code review

CHANGELOG.md

@@ -1,3 +1,27 @@
+tinyPacker 1.4.3 - 2023.11.04
+===========================================================
+* Require Dotclear 2.28
+* Require PHP 8.1+
+* Code review
+
+tinyPacker 1.4.2 - 2023.10.20
+===========================================================
+* Require Dotclear 2.28
+* Require PHP 8.1+
+* Code review
+
+tinyPacker 1.4.1 - 2023.10.09
+===========================================================
+* Require Dotclear 2.28
+* Require PHP 8.1+
+* Code review
+
+tinyPacker 1.4 - 2023.10.07
+===========================================================
+* Require Dotclear 2.28
+* Require PHP 8.1
+* Update to Dotclear 2.28
+
 tinyPacker 1.3 - 2023.08.13
 ===========================================================
 * Require Dotclear 2.27

README.md

@@ -1,27 +1,23 @@
 # README
 
-[![Release](https://img.shields.io/badge/release-1.3-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/tinyPacker/releases)
+[![Release](https://img.shields.io/badge/release-1.4.3-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/tinyPacker/releases)
-[![Date](https://img.shields.io/badge/date-2023.08.13-c44d58.svg)](https://git.dotclear.watch/JcDenis/tinyPacker/releases)
+![Date](https://img.shields.io/badge/date-2023.11.04-c44d58.svg)
-[![Dotclear](https://img.shields.io/badge/dotclear-v2.27-137bbb.svg)](https://fr.dotclear.org/download)
+[![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/tinyPacker)
-[![License](https://img.shields.io/github/license/JcDenis/tinyPacker)](https://git.dotclear.watch/JcDenis/tinyPacker/blob/master/LICENSE)
+[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/tinyPacker/src/branch/master/LICENSE)
 
-## WHAT IS tinyPacker ?
+## ABOUT
 
-_tinyPacker_ is a plugin for the open-source 
+_tinyPacker_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
-web publishing software called Dotclear.
 
-It is a one button packager for plugins and theme 
+> One button packager for plugins and themes direct from Dotclear blog manager.
-direct from Dotclear blog manager.
 
 ## REQUIREMENTS
 
-_tinyPacker_ requires: 
+* Dotclear 2.28
-
+* PHP 8.1+
-* Super administrator permissions
+* System writable public directory
-* A writable public directory.
+* Dotlear super admin permissions
-* Dotclear 2.27
-* PHP 7.4+
 
 ## USAGE
 
@@ -34,12 +30,13 @@ and it's pack into current blog public directory.
 
 ## MORE
 
-* License : [GNU GPL v2](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html)
+* [License](https://git.dotclear.watch/JcDenis/tinyPacker/src/branch/master/LICENSE)
-* Source & contribution : [Gitea Page](https://git.dotclear.watch/JcDenis/tinyPacker) or [GitHub Page](https://github.com/JcDenis/tinyPacker)
+* [Packages & details](https://git.dotclear.watch/JcDenis/tinyPacker/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/tinyPacker))
-* Packages & details: [Gitea Page](https://git.dotclear.watch/JcDenis/tinyPacker/releases) or [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/tinyPacker)
+* [Sources & contributions](https://git.dotclear.watch/JcDenis/tinyPacker) (or on [GitHub](https://github.com/JcDenis/tinyPacker))
+* [Issues & security](https://git.dotclear.watch/JcDenis/tinyPacker/issues) (or on [GitHub](https://github.com/JcDenis/tinyPacker/issues))
 
 ## CONTRIBUTORS
 
-* Jean-Christian Denis
+* Jean-Christian Denis (author)
 
 You are welcome to contribute to this code.

_define.php

@@ -1,27 +1,26 @@
 <?php
 /**
- * @brief tinyPacker, a plugin for Dotclear 2
+ * @file
+ * @brief       The plugin tinyPacker definition
+ * @ingroup     tinyPacker
  *
- * @package Dotclear
+ * @defgroup    tinyPacker Plugin tinyPacker.
- * @subpackage Plugin
  *
- * @author Jean-Christian Denis
+ * Quick pack theme or plugin into public dir.
  *
- * @copyright Jean-Christian Denis
+ * @author      Jean-Christian Denis
- * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
  */
-if (!defined('DC_RC_PATH')) {
+declare(strict_types=1);
-    return null;
-}
 
 $this->registerModule(
     'Tiny packer',
     'Quick pack theme or plugin into public dir',
     'Jean-Christian Denis',
-    '1.3',
+    '1.4.3',
     [
-        'requires'    => [['core', '2.27']],
+        '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,11 +2,11 @@
 <modules xmlns:da="http://dotaddict.org/da/">
   <module id="tinyPacker">
     <name>Tiny packer</name>
-    <version>1.3</version>
+    <version>1.4.3</version>
     <author>Jean-Christian Denis</author>
     <desc>Quick pack theme or plugin into public dir</desc>
-    <file>https://git.dotclear.watch/JcDenis/tinyPacker/releases/download/v1.3/plugin-tinyPacker.zip</file>
+    <file>https://git.dotclear.watch/JcDenis/tinyPacker/releases/download/v1.4.3/plugin-tinyPacker.zip</file>
-    <da:dcmin>2.27</da:dcmin>
+    <da:dcmin>2.28</da:dcmin>
     <da:details>https://git.dotclear.watch/JcDenis/tinyPacker/src/branch/master/README.md</da:details>
     <da:support>https://git.dotclear.watch/JcDenis/tinyPacker/issues</da:support>
   </module>

src/Backend.php

@@ -1,20 +1,10 @@
 <?php
-/**
+
- * @brief tinyPacker, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Jean-Christian Denis
- *
- * @copyright Jean-Christian Denis
- * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
- */
 declare(strict_types=1);
 
 namespace Dotclear\Plugin\tinyPacker;
 
-use dcCore;
+use Dotclear\App;
 use Dotclear\Core\Process;
 use Dotclear\Core\Backend\ModulesList;
 use Dotclear\Core\Backend\Notices;
@@ -27,9 +17,13 @@ use Dotclear\Helper\Network\Http;
 use Exception;
 
 /**
- * tinyPacker admin class.
+ * @brief       tinyPacker admin class.
+ * @ingroup     tinyPacker
  *
  * Add action and button to modules lists.
+ *
+ * @author      Jean-Christian Denis
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
  */
 class Backend extends Process
 {
@@ -44,12 +38,12 @@ class Backend extends Process
             return false;
         }
 
-        dcCore::app()->addBehaviors([
+        App::behavior()->addBehaviors([
             'adminModulesListGetActions' => function (ModulesList $list, string $id, array $_): string {
                 return in_array($list->getList(), [
                     'plugin-activate',
                     'theme-activate',
-                ]) ? (new Submit([My::id() . '[' . Html::escapeHTML($id) . ']']))->value(__('Pack'))->render() : '';
+                ]) ? (new Submit([My::id() . '[' . Html::escapeHTML($id) . ']']))->__call('value', [__('Pack')])->render() : '';
             },
             'adminModulesListDoActions' => function (ModulesList $list, array $modules, string $type): void {
                 # Pack action
@@ -60,7 +54,7 @@ class Backend extends Process
 
                 # Repository directory
                 $dir = (string) Path::real(
-                    dcCore::app()->blog->public_path . DIRECTORY_SEPARATOR . My::TINYPACKER_DIR,
+                    App::blog()->publicPath() . DIRECTORY_SEPARATOR . My::TINYPACKER_DIR,
                     false
                 );
                 if (!empty($dir) && !is_dir($dir)) {
@@ -74,7 +68,7 @@ class Backend extends Process
                 $modules = array_keys($_POST[My::id()]);
                 $id      = $modules[0];
 
-                $module = $list->modules->getDefine($id);
+                $module = $list->modules->getDefine((string) $id);
                 if (!$module->isDefined()) {
                     throw new Exception(__('No such module.'));
                 }
@@ -98,7 +92,7 @@ class Backend extends Process
                         ));
                     }
 
-                    $zip->addDirectory((string) Path::real($module->get('root')), $id, true);
+                    $zip->addDirectory((string) Path::real($module->get('root')), (string) $id, true);
                     $zip->write();
                     $zip->close();
                     unset($zip, $fp);

src/My.php

@@ -1,28 +1,33 @@
 <?php
-/**
+
- * @brief tinyPacker, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Jean-Christian Denis
- *
- * @copyright Jean-Christian Denis
- * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
- */
 declare(strict_types=1);
 
 namespace Dotclear\Plugin\tinyPacker;
 
-use dcCore;
+use Dotclear\App;
 use Dotclear\Module\MyPlugin;
 
+/**
+ * @brief       tinyPacker My helper.
+ * @ingroup     tinyPacker
+ *
+ * @author      Jean-Christian Denis
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ */
 class My extends MyPlugin
 {
-    /** @var string Public packages folder */
+    /**
+     * Public packages folder.
+     *
+     * @var     string  TINYPACKER_DIR
+     */
     public const TINYPACKER_DIR = 'packages';
 
-    /** @var array Excluded files and dirs */
+    /**
+     * Excluded files and dirs.
+     *
+     * @var     array<int,string>   TINYPACKER_EXCLUDE
+     */
     public const TINYPACKER_EXCLUDE = [
         '\.',
         '\.\.',
@@ -39,6 +44,10 @@ class My extends MyPlugin
 
     public static function checkCustomContext(int $context): ?bool
     {
-        return defined('DC_CONTEXT_ADMIN') && dcCore::app()->auth->isSuperAdmin();
+        return match ($context) {
+            // Limit to super admin
+            self::MODULE => App::auth()->isSuperAdmin(),
+            default      => null,
+        };
     }
 }