Merge pull request #299 from mirko-pagliai/develop

Develop
mirko-pagliai · Apr 5, 2023 · 9c3524d · 9c3524d
2 parents a049061 + 29fcc78
commit 9c3524d
Show file tree

Hide file tree

Showing 66 changed files with 382 additions and 224 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,7 +7,9 @@
 * custom messages have been restored when, at login, the user account has been banned or is not yet active. Improved all
   tests related to the login code;
 * improved admin view for users;
+* added the `PriorityBadgeHelper`. This replaces the `priority-badge` template element;
 * every user can view his last logins;
+* little fixes for admin template elements;
 * vertical alignment is used for admin interface tables.
 
 ### 2.31.6

diff --git a/phpstan.neon b/phpstan.neon
@@ -24,7 +24,12 @@ parameters:
         - '#^Parameter \#[12] \$callback of function array_(map|walk) expects \(?callable\([^\)]+\): mixed\)?(\|null)?, (array{[^}]+}|Closure\([^\)]+\))(: string)? given\.$#'
         -
             message: '#^Variable \$\w+ might not be defined\.$#'
-            path: templates/
+            paths:
+                - templates/email
+                - templates/layout/ajax
+                - templates/layout/email
+                - templates/layout/json
+                - templates/layout/rss
         -
             message: '#^Property MeTools\\TestSuite\\CommandTestCase::\$_(err|in) \(Cake\\Console\\TestSuite\\StubConsole(Input|Output)\) does not accept null\.$#'
             path: tests/TestCase/Command

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -6,6 +6,12 @@
       <code>empty($this-&gt;Users)</code>
     </TypeDoesNotContainType>
   </file>
+  <file src="src/Controller/SystemsController.php">
+    <RedundantPropertyInitializationCheck occurrences="2">
+      <code>$this-&gt;ContactUsForm</code>
+      <code>new ContactUsForm()</code>
+    </RedundantPropertyInitializationCheck>
+  </file>
   <file src="src/Controller/Traits/GetStartAndEndDateTrait.php">
     <RedundantCast occurrences="2">
       <code>(int)($day ?: 1)</code>
@@ -15,16 +21,31 @@
       <code>1</code>
       <code>1</code>
     </RedundantCondition>
+    <TypeDoesNotContainType occurrences="11">
+      <code>$day</code>
+      <code>$day</code>
+      <code>$day</code>
+      <code>$month</code>
+      <code>$month</code>
+      <code>$month</code>
+      <code>$month</code>
+      <code>$year</code>
+      <code>$year</code>
+      <code>$year</code>
+      <code>$year</code>
+    </TypeDoesNotContainType>
   </file>
-  <file src="src/Model/Table/PostsTable.php">
-    <TooManyTemplateParams occurrences="1">
-      <code>\Cake\Collection\CollectionInterface&lt;\MeCms\Model\Entity\Post&gt;</code>
-    </TooManyTemplateParams>
+  <file src="src/Form/ContactUsForm.php">
+    <RedundantPropertyInitializationCheck occurrences="2">
+      <code>$this-&gt;SpamDetector</code>
+      <code>new SpamDetector()</code>
+    </RedundantPropertyInitializationCheck>
   </file>
-  <file src="src/Model/Table/Traits/GetPreviewsFromTextTrait.php">
-    <TooManyTemplateParams occurrences="1">
-      <code>\Cake\Collection\CollectionInterface&lt;array{url: string, width: int, height: int}&gt;</code>
-    </TooManyTemplateParams>
+  <file src="src/Model/Table/AppTable.php">
+    <RedundantPropertyInitializationCheck occurrences="2">
+      <code>$this-&gt;cache</code>
+      <code>''</code>
+    </RedundantPropertyInitializationCheck>
   </file>
   <file src="src/Policy/ControllerResolver.php">
     <MoreSpecificImplementedParamType occurrences="1">
@@ -36,29 +57,58 @@
       <code>parent::__construct($name, $data, $dataName)</code>
     </InternalMethod>
   </file>
-  <file src="templates/Admin/Pages/form.php">
-    <TooManyTemplateParams occurrences="1">
-      <code>$this-&gt;extend('MeCms./common/form');</code>
-    </TooManyTemplateParams>
-  </file>
-  <file src="templates/Admin/Posts/form.php">
-    <TooManyTemplateParams occurrences="1">
-      <code>$this-&gt;extend('MeCms./common/form');</code>
-    </TooManyTemplateParams>
+  <file src="templates/PagesCategories/index.php">
+    <UndefinedGlobalVariable occurrences="1">
+      <code>$categories</code>
+    </UndefinedGlobalVariable>
+  </file>
+  <file src="templates/PagesCategories/view.php">
+    <UndefinedGlobalVariable occurrences="4">
+      <code>$category</code>
+      <code>$category</code>
+      <code>$category</code>
+      <code>$category</code>
+    </UndefinedGlobalVariable>
+  </file>
+  <file src="templates/Posts/index_by_date.php">
+    <TypeDoesNotContainType occurrences="7">
+      <code>$day</code>
+      <code>$month</code>
+      <code>$month</code>
+      <code>$year</code>
+      <code>$year</code>
+      <code>$year</code>
+      <code>$year</code>
+    </TypeDoesNotContainType>
   </file>
   <file src="templates/Posts/view.php">
-    <TooManyTemplateParams occurrences="1">
-      <code>$this-&gt;extend('/common/view');</code>
-    </TooManyTemplateParams>
-  </file>
-  <file src="templates/cell/PostsTagsWidgets/popular_as_cloud.php">
-    <TooManyTemplateParams occurrences="1"/>
-  </file>
-  <file src="templates/cell/PostsWidgets/months_as_form.php">
-    <TooManyTemplateParams occurrences="1"/>
-  </file>
-  <file src="templates/cell/PostsWidgets/months_as_list.php">
-    <TooManyTemplateParams occurrences="1"/>
+    <UndefinedGlobalVariable occurrences="15">
+      <code>$post</code>
+      <code>$post</code>
+      <code>$post</code>
+      <code>$post</code>
+      <code>$post</code>
+      <code>$post</code>
+      <code>$post</code>
+      <code>$post</code>
+      <code>$post</code>
+      <code>$post</code>
+      <code>$post</code>
+      <code>$related</code>
+      <code>$related</code>
+      <code>$related</code>
+      <code>'post'</code>
+    </UndefinedGlobalVariable>
+  </file>
+  <file src="templates/PostsCategories/index.php">
+    <UndefinedGlobalVariable occurrences="1">
+      <code>$categories</code>
+    </UndefinedGlobalVariable>
+  </file>
+  <file src="templates/PostsTags/index.php">
+    <UndefinedGlobalVariable occurrences="1">
+      <code>$tags</code>
+    </UndefinedGlobalVariable>
   </file>
   <file src="tests/TestCase/Command/UsersCommandTest.php">
     <UndefinedPropertyAssignment occurrences="1">
@@ -75,6 +125,11 @@
       <code>new \stdClass()</code>
     </InvalidArgument>
   </file>
+  <file src="tests/TestCase/TestSuite/TestCaseTest.php">
+    <UndefinedThisPropertyFetch occurrences="1">
+      <code>$this-&gt;noExistingProperty</code>
+    </UndefinedThisPropertyFetch>
+  </file>
   <file src="tests/TestCase/View/View/Admin/AppViewTest.php">
     <TypeDoesNotContainType occurrences="1">
       <code>empty($this-&gt;View)</code>

diff --git a/psalm.xml b/psalm.xml
@@ -22,8 +22,6 @@
     </projectFiles>
 
     <issueHandlers>
-        <DuplicateArrayKey errorLevel="suppress" />
-
         <InternalMethod>
             <errorLevel type="suppress">
                 <directory name="tests/TestCase" />
@@ -36,19 +34,20 @@
             </errorLevel>
         </InvalidScope>
 
-        <RedundantPropertyInitializationCheck errorLevel="suppress" />
+        <RedundantPropertyInitializationCheck>
+            <errorLevel type="suppress">
+                <directory name="tests/TestCase" />
+            </errorLevel>
+        </RedundantPropertyInitializationCheck>
 
-        <TypeDoesNotContainType>
+        <UndefinedGlobalVariable>
             <errorLevel type="suppress">
-                <file name="src/Controller/Traits/GetStartAndEndDateTrait.php" />
-                <file name="templates/Posts/index_by_date.php" />
+                <directory name="templates/email" />
             </errorLevel>
-        </TypeDoesNotContainType>
+        </UndefinedGlobalVariable>
 
+        <DuplicateArrayKey errorLevel="suppress" />
         <UndefinedConstant errorLevel="suppress" />
-        <UndefinedGlobalVariable errorLevel="suppress" />
-        <UndefinedMagicMethod errorLevel="suppress" />
-        <UndefinedMethod errorLevel="suppress" />
-        <UndefinedThisPropertyFetch errorLevel="suppress" />
+        <TooManyTemplateParams errorLevel="suppress" />
     </issueHandlers>
 </psalm>
diff --git a/src/Controller/Admin/UsersController.php b/src/Controller/Admin/UsersController.php
@@ -241,7 +241,7 @@ public function changePassword()
      */
     public function changePicture()
     {
-        /** @var ?\Laminas\Diactoros\UploadedFile $UploadedFile */
+        /** @var \Laminas\Diactoros\UploadedFile|array|null $UploadedFile */
         $UploadedFile = $this->getRequest()->getData('file');
 
         if ($this->getRequest()->is(['patch', 'post', 'put']) && $UploadedFile) {

diff --git a/src/Controller/Traits/GetStartAndEndDateTrait.php b/src/Controller/Traits/GetStartAndEndDateTrait.php
@@ -28,7 +28,7 @@ trait GetStartAndEndDateTrait
      * Gets start and end date as `FrozenTime` instances starting from a string.
      * These can be used for a `where` condition to search for records based on a date.
      * @param string $date Date as `today`, `yesterday`, `YYYY/MM/dd`, `YYYY/MM` or `YYYY`
-     * @return array Array with start and end date as `FrozenTime` instances
+     * @return \Cake\I18n\FrozenTime[] Array with start and end date
      */
     protected function getStartAndEndDate(string $date): array
     {

diff --git a/src/Validation/AppValidator.php b/src/Validation/AppValidator.php
@@ -20,8 +20,7 @@
 /**
  * Application validator class.
  *
- * This class adds some common rules and provides some common methods for all
- *  validators.
+ * This class adds some common rules and provides some common methods for all validators.
  */
 class AppValidator extends Validator
 {

diff --git a/src/View/Helper/PriorityBadgeHelper.php b/src/View/Helper/PriorityBadgeHelper.php
@@ -0,0 +1,60 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * This file is part of me-cms.
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright   Copyright (c) Mirko Pagliai
+ * @link        https://github.com/mirko-pagliai/me-cms
+ * @license     https://opensource.org/licenses/mit-license.php MIT License
+ * @since       2.31.7
+ */
+
+namespace MeCms\View\Helper;
+
+use Cake\View\Helper;
+
+/**
+ * PriorityBadge helper
+ * @property \MeTools\View\Helper\HtmlHelper $Html
+ */
+class PriorityBadgeHelper extends Helper
+{
+    /**
+     * Helpers
+     * @var array
+     */
+    public $helpers = ['MeTools.Html'];
+
+    /**
+     * Creates a "priority" badge
+     * @param int $priority Priority value
+     * @return string Html string
+     */
+    public function badge(int $priority): string
+    {
+        switch ($priority) {
+            case '1':
+                [$priority, $class, $tooltip] = ['1', 'priority-verylow', __d('me_cms', 'Very low')];
+                break;
+            case '2':
+                [$priority, $class, $tooltip] = ['2', 'priority-low', __d('me_cms', 'Low')];
+                break;
+            case '4':
+                [$priority, $class, $tooltip] = ['4', 'priority-high', __d('me_cms', 'High')];
+                break;
+            case '5':
+                [$priority, $class, $tooltip] = ['5', 'priority-veryhigh', __d('me_cms', 'Very high')];
+                break;
+            default:
+                [$priority, $class, $tooltip] = ['3', 'priority-normal', __d('me_cms', 'Normal')];
+                break;
+        }
+
+        return $this->Html->badge($priority, compact('class', 'tooltip'));
+    }
+}
diff --git a/src/View/View/Admin/AppView.php b/src/View/View/Admin/AppView.php
@@ -20,6 +20,7 @@
 /**
  * Application view class for admin views
  * @property \MeCms\View\Helper\MenuBuilderHelper $MenuBuilder
+ * @property \MeCms\View\Helper\PriorityBadgeHelper $PriorityBadge
  */
 class AppView extends View
 {
@@ -37,6 +38,7 @@ public function initialize(): void
     {
         parent::initialize();
 
+        $this->loadHelper('MeCms.PriorityBadge');
         $this->loadHelper('MeCms.MenuBuilder');
     }
 

diff --git a/templates/Admin/Pages/form.php b/templates/Admin/Pages/form.php
@@ -12,11 +12,12 @@
  * @link        https://github.com/mirko-pagliai/me-cms
  * @license     https://opensource.org/licenses/mit-license.php MIT License
  *
- * @var \Cake\Collection\Collection<string> $categories
+ * @var \Cake\ORM\ResultSet<\MeCms\Model\Entity\PagesCategory> $categories
  * @var \MeCms\Model\Entity\Page $page
  * @var \MeCms\View\View\Admin\AppView $this
  * @var string $title
  */
+
 $this->extend('MeCms./common/form');
 $this->Library->ckeditor();
 $this->Library->slugify();

diff --git a/templates/Admin/Pages/index.php b/templates/Admin/Pages/index.php
@@ -12,9 +12,10 @@
  * @link        https://github.com/mirko-pagliai/me-cms
  * @license     https://opensource.org/licenses/mit-license.php MIT License
  *
- * @var \MeCms\Model\Entity\Page[] $pages
+ * @var \Cake\ORM\ResultSet<\MeCms\Model\Entity\Page> $pages
  * @var \MeCms\View\View\Admin\AppView $this
  */
+
 $this->extend('MeCms./Admin/common/index');
 $this->assign('title', I18N_PAGES);
 $this->append('actions', $this->Html->button(
@@ -136,7 +137,7 @@
                 </td>
 
                 <td class="text-nowrap text-center align-middle">
-                    <?= $this->element('admin/priority-badge', ['priority' => $page->get('priority')]) ?>
+                    <?= $this->PriorityBadge->badge($page->get('priority')) ?>
                 </td>
                 <td class="text-nowrap text-center align-middle">
                     <div class="d-none d-lg-block">

diff --git a/templates/Admin/PagesCategories/form.php b/templates/Admin/PagesCategories/form.php
@@ -11,5 +11,8 @@
  * @copyright   Copyright (c) Mirko Pagliai
  * @link        https://github.com/mirko-pagliai/me-cms
  * @license     https://opensource.org/licenses/mit-license.php MIT License
+ *
+ * @var \MeCms\View\View\Admin\AppView $this
  */
+
 $this->extend('/Admin/PostsCategories/form');
diff --git a/templates/Admin/PagesCategories/index.php b/templates/Admin/PagesCategories/index.php
@@ -12,7 +12,7 @@
  * @link        https://github.com/mirko-pagliai/me-cms
  * @license     https://opensource.org/licenses/mit-license.php MIT License
  *
- * @var \MeCms\Model\Entity\PagesCategory[] $categories
+ * @var \Cake\ORM\ResultSet<\MeCms\Model\Entity\PagesCategory> $categories
  * @var \MeCms\View\View\Admin\AppView $this
  */
 

diff --git a/templates/Admin/Posts/form.php b/templates/Admin/Posts/form.php
@@ -12,11 +12,12 @@
  * @link        https://github.com/mirko-pagliai/me-cms
  * @license     https://opensource.org/licenses/mit-license.php MIT License
  *
- * @var \Cake\Collection\Collection<string> $categories
+ * @var \Cake\ORM\ResultSet<\MeCms\Model\Entity\PostsCategory> $categories
  * @var \MeCms\Model\Entity\Post $post
  * @var \MeCms\View\View\Admin\AppView $this
  * @var string $title
  */
+
 $this->extend('MeCms./common/form');
 $this->Library->ckeditor();
 $this->Library->slugify();

diff --git a/templates/Admin/Posts/index.php b/templates/Admin/Posts/index.php
@@ -12,7 +12,7 @@
  * @link        https://github.com/mirko-pagliai/me-cms
  * @license     https://opensource.org/licenses/mit-license.php MIT License
  *
- * @var \MeCms\Model\Entity\Post[] $posts
+ * @var \Cake\ORM\ResultSet<\MeCms\Model\Entity\Post> $posts
  * @var \MeCms\View\View\Admin\AppView $this
  */
 
@@ -171,7 +171,7 @@
                     ) ?>
                 </td>
                 <td class="text-nowrap text-center align-middle">
-                    <?= $this->element('admin/priority-badge', ['priority' => $post->get('priority')]) ?>
+                    <?= $this->PriorityBadge->badge($post->get('priority')) ?>
                 </td>
                 <td class="text-nowrap text-center align-middle">
                     <div class="d-none d-lg-block">