release 2023.11.04

CHANGELOG.md

@@ -1,3 +1,11 @@
+periodical 2023.11.04
+===========================================================
+* Require Dotclear 2.28
+* Require PHP 8.1
+* Fix typo
+* Fix perms
+* Code review (phpstan)
+
 periodical 2023.10.20
 ===========================================================
 * Require Dotclear 2.28

README.md

@@ -1,7 +1,7 @@
 # README
 
-[![Release](https://img.shields.io/badge/release-2023.08.15-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/periodical/releases)
-![Date](https://img.shields.io/badge/date-2023.08.15-c44d58.svg)
+[![Release](https://img.shields.io/badge/release-2023.11.04-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/periodical/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)
 [![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/periodical)
 [![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/periodical/src/branch/master/LICENSE)

_define.php

@@ -17,7 +17,7 @@ $this->registerModule(
     'Periodical',
     'Published periodically entries',
     'Jean-Christian Denis and contributors',
-    '2023.10.20',
+    '2023.11.04',
     [
         'requires'    => [['core', '2.28']],
         'permissions' => 'My',

dcstore.xml

@@ -2,10 +2,10 @@
 <modules xmlns:da="http://dotaddict.org/da/">
   <module id="periodical">
     <name>Periodical</name>
-    <version>2023.10.20</version>
+    <version>2023.11.04</version>
     <author>Jean-Christian Denis and contributors</author>
     <desc>Published periodically entries</desc>
-    <file>https://git.dotclear.watch/JcDenis/periodical/releases/download/v2023.10.20/plugin-periodical.zip</file>
+    <file>https://git.dotclear.watch/JcDenis/periodical/releases/download/v2023.11.04/plugin-periodical.zip</file>
     <da:dcmin>2.28</da:dcmin>
     <da:details>https://git.dotclear.watch/JcDenis/periodical/src/branch/master/README.md</da:details>
     <da:support>https://git.dotclear.watch/JcDenis/periodical/issues</da:support>

src/BackendBehaviors.php

@@ -40,6 +40,11 @@ use Exception;
  */
 class BackendBehaviors
 {
+    /**
+     * Periods combo.
+     *
+     * @var     array<string, int>  $combo_period
+     */
     private static array $combo_period = [];
 
     /**
@@ -91,7 +96,7 @@ class BackendBehaviors
     /**
      * User pref for periods columns lists.
      *
-     * @param   ArrayObject     $cols   Columns
+     * @param   ArrayObject<string, mixed>  $cols   Columns
      */
     public static function adminColumnsListsV2(ArrayObject $cols): void
     {
@@ -112,7 +117,7 @@ class BackendBehaviors
     /**
      * User pref periods filters options.
      *
-     * @param   ArrayObject     $sorts  Sort options
+     * @param   ArrayObject<string, mixed>  $sorts  Sort options
      */
     public static function adminFiltersListsV2(ArrayObject $sorts): void
     {
@@ -128,8 +133,8 @@ class BackendBehaviors
     /**
      * Add columns period to posts list header.
      *
-     * @param   MetaRecord      $rs     record instance
-     * @param   ArrayObject     $cols   Columns
+     * @param   MetaRecord                  $rs     Record instance
+     * @param   ArrayObject<string, mixed>  $cols   Columns
      */
     public static function adminPostListHeaderV2(MetaRecord $rs, ArrayObject $cols): void
     {
@@ -141,8 +146,8 @@ class BackendBehaviors
     /**
      * Add columns period to posts list values.
      *
-     * @param   MetaRecord      $rs     record instance
-     * @param   ArrayObject     $cols   Columns
+     * @param   MetaRecord                  $rs     Record instance
+     * @param   ArrayObject<string, mixed>  $cols   Columns
      */
     public static function adminPostListValueV2(MetaRecord $rs, ArrayObject $cols): void
     {
@@ -226,7 +231,7 @@ class BackendBehaviors
      * Posts actions callback to remove period.
      *
      * @param   ActionsPosts                $pa     ActionsPosts instance
-     * @param   ArrayObject     $post   _POST actions
+     * @param   ArrayObject<string, mixed>  $post   _POST actions
      */
     public static function callbackRemove(ActionsPosts $pa, ArrayObject $post): void
     {
@@ -246,7 +251,7 @@ class BackendBehaviors
 
         // Remove linked period
         foreach ($posts_ids as $post_id) {
-            self::delPeriod($post_id);
+            self::delPeriod((int) $post_id);
         }
 
         Notices::addSuccessNotice(__('Posts have been removed from periodical.'));
@@ -257,7 +262,7 @@ class BackendBehaviors
      * Posts actions callback to add period.
      *
      * @param   ActionsPosts                $pa     ActionsPosts instance
-     * @param   ArrayObject     $post   _POST actions
+     * @param   ArrayObject<string, mixed>  $post   _POST actions
      */
     public static function callbackAdd(ActionsPosts $pa, ArrayObject $post): void
     {
@@ -272,8 +277,8 @@ class BackendBehaviors
         // Save action
         if (!empty($post['periodical'])) {
             foreach ($posts_ids as $post_id) {
-                self::delPeriod($post_id);
-                self::addPeriod($post_id, (int) $post['periodical']);
+                self::delPeriod((int) $post_id);
+                self::addPeriod((int) $post_id, (int) $post['periodical']);
             }
 
             Notices::addSuccessNotice(__('Posts have been added to periodical.'));
@@ -309,8 +314,8 @@ class BackendBehaviors
     /**
      * Add form to post sidebar.
      *
-     * @param   ArrayObject         $main_items     Main items
-     * @param   ArrayObject         $sidebar_items  Sidebar items
+     * @param   ArrayObject<string, mixed>  $main_items     Main items
+     * @param   ArrayObject<string, mixed>  $sidebar_items  Sidebar items
      * @param   null|MetaRecord             $post           Post record or null
      */
     public static function adminPostFormItems(ArrayObject $main_items, ArrayObject $sidebar_items, ?MetaRecord $post): void
@@ -365,7 +370,7 @@ class BackendBehaviors
     /**
      * Combo of available periods.
      *
-     * @return  array   List of period
+     * @return  array<string, int>  List of period
      */
     private static function comboPeriod(): array
     {

src/ManagePeriod.php

@@ -225,7 +225,7 @@ class ManagePeriod extends Process
             (new Form('periodicalbhv'))->method('post')->action(App::backend()->getPageURL())->fields([
                 (new Para())->items([
                     (new Label(__('Title:')))->for('period_title'),
-                    (new Input('period_title'))->size(65)->maxlenght(255)->class('maximal')->value(Html::escapeHTML($vars->period_title)),
+                    (new Input('period_title'))->size(65)->maxlength(255)->class('maximal')->value(Html::escapeHTML($vars->period_title)),
                 ]),
                 (new Div())->class('two-boxes')->items([
                     (new Div())->class('box odd')->items([

src/ManageVars.php

@@ -13,46 +13,102 @@ namespace Dotclear\Plugin\periodical;
  */
 class ManageVars
 {
-    /** @var    ManageVars  $container  Self instance  */
+    /**
+     * Self instance.
+     *
+     * @var     ManageVars  $container
+     */
     private static $container;
 
-    /** @var    string  $action     The post form action */
+    /**
+     * The post form action.
+     *
+     * @var     string  $action
+     */
     public readonly string $action;
 
-    /** @var    string  $redir      The post form redirection */
+    /**
+     * The post form redirection.
+     *
+     * @var     string  $redir
+     */
     public readonly string $redir;
 
-    /** @var    array   $periods    The post form periods */
+    /**
+     * The post form periods.
+     *
+     * @var     array<int, int>     $periods
+     */
     public readonly array $periods;
 
-    /** @var    array   $entries    The post form entries */
+    /**
+     * The post form entries.
+     *
+     * @var     array<int, int>     $entries
+     */
     public readonly array $entries;
 
-    /** @var    null|int    $period_id  The post form period id */
+    /**
+     * The post form period id.
+     *
+     * @var     null|int    $period_id
+     */
     public readonly ?int $period_id;
 
-    /** @var    string  $period_title   The psort form period title */
+    /**
+     * The psort form period title.
+     *
+     * @var     string  $period_title
+     */
     public readonly string $period_title;
 
-    /** @var    int    $period_pub_nb   The post form period publication number */
+    /**
+     * The post form period publication number.
+     *
+     * @var     int     $period_pub_nb
+     */
     public readonly int $period_pub_nb;
 
-    /** @var    string  $period_pub_int     The post form period publication interval */
+    /**
+     * The post form period publication interval.
+     *
+     * @var     string  $period_pub_int
+     */
     public readonly string $period_pub_int;
 
-    /** @var    string    $period_curdt     The post form period current date */
+    /**
+     * The post form period current date.
+     *
+     * @var     string  $period_curdt
+     */
     public readonly string $period_curdt;
 
-    /** @var    string    $period_curdt     The post form period end date */
+    /**
+     * The post form period end date.
+     *
+     * @var     string  $period_curdt
+     */
     public readonly string $period_enddt;
 
-    /** @var    bool    $bad_period_id  Is period ID wrong */
+    /**
+     * Is period ID wrong .
+     *
+     * @var     bool    $bad_period_id
+     */
     public readonly bool $bad_period_id;
 
-    /** @var    bool    $bad_period_curdt   Is period current date wrong */
+    /**
+     * Is period current date wrong.
+     *
+     * @var     bool    $bad_period_curdt
+     */
     public readonly bool $bad_period_curdt;
 
-    /** @var    bool    $bad_period_enddt   Is period end date wrong */
+    /**
+     * Is period end date wrong.
+     *
+     * @var     bool    $bad_period_enddt
+     */
     public readonly bool $bad_period_enddt;
 
     /**

src/My.php

@@ -19,6 +19,7 @@ class My extends MyPlugin
     public static function checkCustomContext(int $context): ?bool
     {
         return match ($context) {
+            // Add usage perm to backend
             self::MANAGE, self::MENU => App::task()->checkContext('BACKEND')
             && App::auth()->check(App::auth()->makePermissions([
                 App::auth()::PERMISSION_USAGE,
@@ -32,7 +33,7 @@ class My extends MyPlugin
     /**
      * Periods action combo.
      *
-     * @return  array<string,sting>
+     * @return  array<string, string>
      */
     public static function periodsActionCombo(): array
     {
@@ -45,7 +46,7 @@ class My extends MyPlugin
     /**
      * Period entries action combo.
      *
-     * @return  array<string,array{string,string}>
+     * @return  array<string, array<string, string>>
      */
     public static function entriesActionsCombo(): array
     {

src/Utils.php

@@ -30,8 +30,12 @@ use Exception;
  */
 class Utils
 {
-    /** @var null|string  $lock   File lock for update */
-    private static $lock = null;
+    /**
+     * File lock for update.
+     *
+     * @var     null|string     $lock
+     */
+    private static ?string $lock = null;
 
     /**
      * Get periodical table cursor.
@@ -46,7 +50,7 @@ class Utils
     /**
      * Get periods.
      *
-     * @param   array|ArrayObject   $params         Parameters
+     * @param   array<string, mixed>|ArrayObject<string, mixed>     $params         Parameters
      * @param   bool                                                $count_only     Only counts results
      * @param   SelectStatement                                     $ext_sql        Optional SelectStatement instance
      *
@@ -234,7 +238,7 @@ class Utils
     /**
      * Get posts related to periods.
      *
-     * @param   array|ArrayObject   $params         Parameters
+     * @param   array<string, mixed>|ArrayObject<string, mixed>     $params         Parameters
      * @param   bool                                                $count_only     Only counts results
      * @param   SelectStatement                                     $ext_sql        Optional SelectStatement instance
      *
@@ -304,7 +308,7 @@ class Utils
             $sql->and('P.post_status = ' . App::blog()::POST_PENDING);
         }
 
-        return App::blog()->getPosts($params, $count_only, $sql) ?? MetaRecord::newFromArray([]);
+        return App::blog()->getPosts($params, $count_only, $sql);
     }
 
     /**