From 95fc8c4aa475028bfa31fc57922291703d0b4e08 Mon Sep 17 00:00:00 2001
From: Dennis Reilard <d.reilard@web.de>
Date: Fri, 16 Aug 2024 19:31:11 +0200
Subject: [PATCH] Forum-Module (1.35.1): Variable descriptions (#1038)

---
 .../modules/forum/boxes/views/forum.php       |  6 ++++-
 .../views/Showunansweredtopics/index.php      |  3 +++
 .../modules/forum/views/admin/index/index.php | 23 ++++++++++++++-----
 .../forum/views/admin/prefixes/treat.php      |  7 ++++--
 .../modules/forum/views/admin/ranks/treat.php |  9 +++++---
 .../modules/forum/views/edittopic/index.php   |  6 +++++
 .../modules/forum/views/index/index.php       | 14 +++++++++--
 .../modules/forum/views/newtopic/index.php    |  4 ++--
 .../forum/views/rememberedposts/index.php     |  3 +--
 .../forum/views/rememberedposts/treat.php     |  5 +++-
 .../forum/views/showactivetopics/index.php    |  5 ++--
 .../modules/forum/views/showcat/index.php     |  8 ++++++-
 .../forum/views/shownewposts/index.php        |  3 +++
 .../modules/forum/views/showposts/index.php   |  7 ++++--
 .../modules/forum/views/showtopics/index.php  |  9 ++++++--
 15 files changed, 86 insertions(+), 26 deletions(-)

diff --git a/application/modules/forum/boxes/views/forum.php b/application/modules/forum/boxes/views/forum.php
index 53943dd85..3aa724cea 100644
--- a/application/modules/forum/boxes/views/forum.php
+++ b/application/modules/forum/boxes/views/forum.php
@@ -4,13 +4,17 @@
 
 use Ilch\Date;
 
+/** @var bool $DESCPostorder */
 $DESCPostorder = $this->get('DESCPostorder');
+/** @var int $postsPerPage */
 $postsPerPage = $this->get('postsPerPage');
 ?>
 
 <?php if (!empty($this->get('lastActiveTopicsToShow'))) : ?>
     <ul class="list-unstyled">
-        <?php foreach ($this->get('lastActiveTopicsToShow') as $topic) : ?>
+        <?php
+        /** @var \Modules\Forum\Models\ForumTopic $topic */
+        foreach ($this->get('lastActiveTopicsToShow') as $topic) : ?>
             <li style="line-height: 15px;">
                 <?php if ($this->getUser()) : ?>
                     <?php if ($topic['lastPost']->getRead()) : ?>
diff --git a/application/modules/forum/views/Showunansweredtopics/index.php b/application/modules/forum/views/Showunansweredtopics/index.php
index 534b27805..a8da732a6 100644
--- a/application/modules/forum/views/Showunansweredtopics/index.php
+++ b/application/modules/forum/views/Showunansweredtopics/index.php
@@ -6,8 +6,11 @@
 
 use Ilch\Date;
 
+/** @var \Modules\Forum\Models\ForumTopic[] $topics */
 $topics = $this->get('topics');
+/** @var bool $DESCPostorder */
 $DESCPostorder = $this->get('DESCPostorder');
+/** @var int $postsPerPage */
 $postsPerPage = $this->get('postsPerPage');
 ?>
 
diff --git a/application/modules/forum/views/admin/index/index.php b/application/modules/forum/views/admin/index/index.php
index 4a85b3a36..323bd070d 100644
--- a/application/modules/forum/views/admin/index/index.php
+++ b/application/modules/forum/views/admin/index/index.php
@@ -7,6 +7,10 @@
 /** @var ForumItem|null $forumItems */
 $forumItems = $this->get('forumItems');
 
+/**
+ * @param ForumItem $item
+ * @param \Ilch\View $obj
+ */
 function rec(ForumItem $item, \Ilch\View $obj)
 {
     $class = 'mjs-nestedSortable-branch mjs-nestedSortable-expanded';
@@ -173,22 +177,28 @@ function () {
                         <div class="row mb-3"><label for="assignedGroupsRead" class="col-xl-3 col-form-label"><?=$this->getTrans('see') ?></label>\n\
                         <div class="col-xl-6"><select class="chosen-select form-control" id="assignedGroupsRead" name="user[groups][]" data-placeholder="<?=$this->getTrans('selectAssignedGroups') ?>" multiple>\n\
                         \n\
-                        <?php foreach ($this->get('userGroupList') as $groupList) : ?>\n\
-                        <option value="<?=$groupList->getId() ?>"><?=$this->escape($groupList->getName()) ?></option>\n\
+                        <?php
+                        /** @var \Modules\User\Models\Group $group */
+                        foreach ($this->get('userGroupList') as $group) : ?>\n\
+                        <option value="<?=$group->getId() ?>"><?=$this->escape($group->getName()) ?></option>\n\
                         <?php endforeach; ?>\n\
                         </select></div></div>\n\
                         <div class="row mb-3"><label for="assignedGroupsReply" class="col-xl-3 col-form-label"><?=$this->getTrans('answer') ?></label>\n\
                         <div class="col-xl-6"><select class="chosen-select form-control" id="assignedGroupsReply" name="user[groups][]" data-placeholder="<?=$this->getTrans('selectAssignedGroups') ?>" multiple>\n\
                         \n\
-                        <?php foreach ($this->get('userGroupList') as $groupList) : ?>\n\
-                        <option value="<?=$groupList->getId() ?>"><?=$this->escape($groupList->getName()) ?></option>\n\
+                        <?php
+                        /** @var \Modules\User\Models\Group $group */
+                        foreach ($this->get('userGroupList') as $group) : ?>\n\
+                        <option value="<?=$group->getId() ?>"><?=$this->escape($group->getName()) ?></option>\n\
                         <?php endforeach; ?>\n\
                         </select></div></div>\n\
                         <div class="row mb-3"><label for="assignedGroupsCreate" class="col-xl-3 col-form-label"><?=$this->getTrans('create') ?></label>\n\
                         <div class="col-xl-6"><select class="chosen-select form-control" id="assignedGroupsCreate" name="user[groups][]" data-placeholder="<?=$this->getTrans('selectAssignedGroups') ?>" multiple>\n\
                         \n\
-                        <?php foreach ($this->get('userGroupList') as $groupList) : ?>\n\
-                        <option value="<?=$groupList->getId() ?>"><?=$this->escape($groupList->getName()) ?></option>\n\
+                        <?php
+                        /** @var \Modules\User\Models\Group $group */
+                        foreach ($this->get('userGroupList') as $group) : ?>\n\
+                        <option value="<?=$group->getId() ?>"><?=$this->escape($group->getName()) ?></option>\n\
                         <?php endforeach; ?>\n\
                         </select></div></div>';
 
@@ -198,6 +208,7 @@ function () {
                 $('.dyn').html(menuHtml);
                 <?php
                 $prefixes = [];
+                /** @var \Modules\Forum\Models\Prefix $prefix */
                 foreach ($this->get('prefixes') ?? [] as $prefix) {
                     $prefixes[] = ['value' => $prefix->getId(), 'label' => $prefix->getPrefix()];
                 }
diff --git a/application/modules/forum/views/admin/prefixes/treat.php b/application/modules/forum/views/admin/prefixes/treat.php
index 1deb86ac7..2422072ac 100644
--- a/application/modules/forum/views/admin/prefixes/treat.php
+++ b/application/modules/forum/views/admin/prefixes/treat.php
@@ -1,8 +1,11 @@
 <?php
 
 /** @var \Ilch\View $this */
+
+/** @var \Modules\Forum\Models\Prefix|null $prefix */
+$prefix = $this->get('prefix');
 ?>
-<h1><?=($this->get('prefix')) ? $this->getTrans('edit') : $this->getTrans('add') ?></h1>
+<h1><?=($prefix) ? $this->getTrans('edit') : $this->getTrans('add') ?></h1>
 <form method="POST">
     <?=$this->getTokenField() ?>
     <div class="row mb-3<?=$this->validation()->hasError('prefix') ? ' has-error' : '' ?>">
@@ -14,7 +17,7 @@
                    class="form-control"
                    id="prefix"
                    name="prefix"
-                   value="<?=($this->get('prefix')) ? $this->escape($this->get('prefix')->getPrefix()) : '' ?>"
+                   value="<?=($prefix) ? $this->escape($prefix->getPrefix()) : '' ?>"
                    required />
         </div>
     </div>
diff --git a/application/modules/forum/views/admin/ranks/treat.php b/application/modules/forum/views/admin/ranks/treat.php
index 23945cfb7..447de617c 100644
--- a/application/modules/forum/views/admin/ranks/treat.php
+++ b/application/modules/forum/views/admin/ranks/treat.php
@@ -1,8 +1,11 @@
 <?php
 
 /** @var \Ilch\View $this */
+
+/** @var \Modules\Forum\Models\Rank|null $rank */
+$rank = $this->get('rank');
 ?>
-<h1><?=($this->get('rank')) ? $this->getTrans('edit') : $this->getTrans('add') ?></h1>
+<h1><?=($rank) ? $this->getTrans('edit') : $this->getTrans('add') ?></h1>
 <form method="POST">
     <?=$this->getTokenField() ?>
     <div class="row mb-3<?=$this->validation()->hasError('title') ? ' has-error' : '' ?>">
@@ -14,7 +17,7 @@
                    class="form-control"
                    id="title"
                    name="title"
-                   value="<?=($this->get('rank')) ? $this->escape($this->get('rank')->getTitle()) : '' ?>"
+                   value="<?=($rank) ? $this->escape($rank->getTitle()) : '' ?>"
                    required />
         </div>
     </div>
@@ -28,7 +31,7 @@ class="form-control"
                    id="posts"
                    name="posts"
                    min="0"
-                   value="<?=($this->get('rank')) ? $this->escape($this->get('rank')->getPosts()) : '' ?>"
+                   value="<?=($rank) ? $this->escape($rank->getPosts()) : '' ?>"
                    required />
         </div>
     </div>
diff --git a/application/modules/forum/views/edittopic/index.php b/application/modules/forum/views/edittopic/index.php
index c872bea9b..b58416290 100644
--- a/application/modules/forum/views/edittopic/index.php
+++ b/application/modules/forum/views/edittopic/index.php
@@ -10,8 +10,14 @@
 <?php
 /** @var ForumItem[]|null $forumItems */
 $forumItems = $this->get('forumItems');
+/** @var int[] $editTopicItems */
 $editTopicItems = $this->get('editTopicItems');
 
+/**
+ * @param ForumItem $item
+ * @param View $obj
+ * @param int|null $i
+ */
 function rec(ForumItem $item, View $obj, ?int $i)
 {
     $subItems = $item->getSubItems();
diff --git a/application/modules/forum/views/index/index.php b/application/modules/forum/views/index/index.php
index 95b9a3452..a4c446309 100644
--- a/application/modules/forum/views/index/index.php
+++ b/application/modules/forum/views/index/index.php
@@ -23,6 +23,14 @@
 /** @var array $onlineUsersHighestRankedGroup */
 $onlineUsersHighestRankedGroup = $this->get('onlineUsersHighestRankedGroup');
 
+/** @var \Modules\User\Models\User $registNewUser */
+$registNewUser = $this->get('registNewUser');
+
+/**
+ * @param ForumItem $item
+ * @param View $obj
+ * @param int|null $i
+ */
 function rec(ForumItem $item, View $obj, ?int $i)
 {
     $DESCPostorder = $obj->get('DESCPostorder');
@@ -190,7 +198,9 @@ function rec(ForumItem $item, View $obj, ?int $i)
                 <div class="small">
                     <ul class="group-legend">
                         <li><i class="fa-solid fa-bars"></i> <?=$this->getTrans('legend') ?>:</li>
-                        <?php foreach ($this->get('listGroups') as $group) : ?>
+                        <?php
+                        /** @var \Modules\User\Models\Group $group */
+                        foreach ($this->get('listGroups') as $group) : ?>
                             <?php if ($group->getName() !== 'Guest') : ?>
                                 <li class="group"><span class="forum appearance<?=$group->getId() ?>"><?=$group->getName() ?></span></li>
                             <?php endif; ?>
@@ -214,7 +224,7 @@ function rec(ForumItem $item, View $obj, ?int $i)
                     <li><?=$this->getTrans('totalPosts') ?>: <?=$forumStatistics->getCountPosts() ?></li>
                     <li><?=$this->getTrans('totalTopics') ?>: <?=$forumStatistics->getCountTopics() ?></li>
                     <li><?=$this->getTrans('totalMembers') ?>: <?=$forumStatistics->getCountUsers() ?></li>
-                    <li><?=$this->getTrans('newMember') ?> <a href="<?=$this->getUrl(['module' => 'user', 'controller' => 'profil', 'action' => 'index', 'user' => $this->get('registNewUser')->getId()]) ?>" class="ilch-link" title="<?=$this->escape($this->get('registNewUser')->getName()) ?>"><?=$this->escape($this->get('registNewUser')->getName()) ?></a></li>
+                    <li><?=$this->getTrans('newMember') ?> <a href="<?=$this->getUrl(['module' => 'user', 'controller' => 'profil', 'action' => 'index', 'user' => $registNewUser->getId()]) ?>" class="ilch-link" title="<?=$this->escape($registNewUser->getName()) ?>"><?=$this->escape($registNewUser->getName()) ?></a></li>
                 </ul>
             </div>
             <hr />
diff --git a/application/modules/forum/views/newtopic/index.php b/application/modules/forum/views/newtopic/index.php
index f74fee50e..22ead2b0a 100644
--- a/application/modules/forum/views/newtopic/index.php
+++ b/application/modules/forum/views/newtopic/index.php
@@ -39,7 +39,7 @@
                             <div class="col-xl-12">
                                 <div class="row mb-3<?=$this->validation()->hasError('topicTitle') ? ' has-error' : '' ?>">
                                     <label for="topicTitle" class="col-lg-2 col-form-label">
-                                        <?=$this->getTrans('topicTitle') ?>
+                                         <?=$this->getTrans('topicTitle') ?>
                                     </label>
                                     <?php if ($forum->getPrefixes() != '') : ?>
                                         <?php $prefixIds = explode(',', $forum->getPrefixes()); ?>
@@ -69,7 +69,7 @@ class="form-control"
                                     </div>
                                 </div>
                                 <div class="row mb-3<?=$this->validation()->hasError('text') ? ' has-error' : '' ?>">
-                                    <label class="col-xl-2 col-form-label">
+                                    <label class="col-xl-2 col-form-label" for="ck_1">
                                         <?=$this->getTrans('text') ?>
                                     </label>
                                     <div class="col-xl-10">
diff --git a/application/modules/forum/views/rememberedposts/index.php b/application/modules/forum/views/rememberedposts/index.php
index 690767466..5f6a09490 100644
--- a/application/modules/forum/views/rememberedposts/index.php
+++ b/application/modules/forum/views/rememberedposts/index.php
@@ -2,10 +2,9 @@
 
 /** @var \Ilch\View $this */
 
-/** @var \Modules\Forum\Models\ForumPost[]|null $rememberedPosts */
-
 use Ilch\Date;
 
+/** @var \Modules\Forum\Models\Remember[]|null $rememberedPosts */
 $rememberedPosts = $this->get('rememberedPosts');
 ?>
 <link href="<?=$this->getModuleUrl('static/css/forum.css') ?>" rel="stylesheet">
diff --git a/application/modules/forum/views/rememberedposts/treat.php b/application/modules/forum/views/rememberedposts/treat.php
index f07a24f0e..7ab0a9157 100644
--- a/application/modules/forum/views/rememberedposts/treat.php
+++ b/application/modules/forum/views/rememberedposts/treat.php
@@ -1,6 +1,9 @@
 <?php
 
 /** @var \Ilch\View $this */
+
+/** @var \Modules\Forum\Models\Remember|null $rememberedPost */
+$rememberedPost = $this->get('rememberedPost');
 ?>
 <link href="<?=$this->getModuleUrl('static/css/forum.css') ?>" rel="stylesheet">
 
@@ -19,7 +22,7 @@ class="form-control"
                        id="note"
                        name="note"
                        maxlength="255"
-                       value="<?=($this->originalInput('note') == '') ? $this->escape($this->get('rememberedPost')->getNote()) : $this->originalInput('note') ?>" />
+                       value="<?=($this->originalInput('note') == '') ? $this->escape($rememberedPost->getNote()) : $this->originalInput('note') ?>" />
             </div>
         </div>
         <button type="submit" class="btn btn-sm btn-primary"><?=$this->getTrans('saveNoteRememberedPost') ?></button>
diff --git a/application/modules/forum/views/showactivetopics/index.php b/application/modules/forum/views/showactivetopics/index.php
index 5a4a2992f..1dea1ae19 100644
--- a/application/modules/forum/views/showactivetopics/index.php
+++ b/application/modules/forum/views/showactivetopics/index.php
@@ -2,12 +2,13 @@
 
 /** @var \Ilch\View $this */
 
-/** @var array $topics */
-
 use Ilch\Date;
 
+/** @var array $topics */
 $topics = $this->get('topics');
+/** @var bool $DESCPostorder */
 $DESCPostorder = $this->get('DESCPostorder');
+/** @var int $postsPerPage */
 $postsPerPage = $this->get('postsPerPage');
 ?>
 
diff --git a/application/modules/forum/views/showcat/index.php b/application/modules/forum/views/showcat/index.php
index 81421f3cd..6427c3754 100644
--- a/application/modules/forum/views/showcat/index.php
+++ b/application/modules/forum/views/showcat/index.php
@@ -10,12 +10,18 @@
 /** @var \Modules\Forum\Models\ForumItem $cat */
 $cat = $this->get('cat');
 
-function rec($item, \Ilch\View $obj)
+/**
+ * @param \Modules\Forum\Models\ForumItem $item
+ * @param \Ilch\View $obj
+ */
+function rec(\Modules\Forum\Models\ForumItem $item, \Ilch\View $obj)
 {
     /** @var Forum $forumMapper */
     $forumMapper = $obj->get('forumMapper');
 
+    /** @var bool $DESCPostorder */
     $DESCPostorder = $obj->get('DESCPostorder');
+    /** @var int $postsPerPage */
     $postsPerPage = $obj->get('postsPerPage');
     $subItems = $item->getSubItems();
     $topics = $item->getTopics();
diff --git a/application/modules/forum/views/shownewposts/index.php b/application/modules/forum/views/shownewposts/index.php
index 8ba05bc3e..2e6b47c9e 100644
--- a/application/modules/forum/views/shownewposts/index.php
+++ b/application/modules/forum/views/shownewposts/index.php
@@ -6,8 +6,11 @@
 
 use Ilch\Date;
 
+/** @var \Modules\Forum\Models\ForumTopic[] $topics */
 $topics = $this->get('topics');
+/** @var int $postsPerPage */
 $DESCPostorder = $this->get('DESCPostorder');
+/** @var int $postsPerPage */
 $postsPerPage = $this->get('postsPerPage');
 ?>
 
diff --git a/application/modules/forum/views/showposts/index.php b/application/modules/forum/views/showposts/index.php
index 88514e7fa..c1c5abce9 100644
--- a/application/modules/forum/views/showposts/index.php
+++ b/application/modules/forum/views/showposts/index.php
@@ -24,6 +24,9 @@
 if ($this->getUser()) {
     $adminAccess = $this->getUser()->isAdmin();
 }
+
+/** @var \Ilch\Pagination $pagination */
+$pagination = $this->get('pagination');
 ?>
 
 <link href="<?=$this->getModuleUrl('static/css/forum.css') ?>" rel="stylesheet">
@@ -77,7 +80,7 @@
                         </span><?=$this->getTrans('lockPost') ?>
                     </div>
                 <?php endif; ?>
-                <?=$this->get('pagination')->getHtml($this, ['action' => 'index', 'topicid' => $this->getRequest()->getParam('topicid')]) ?>
+                <?=$pagination->getHtml($this, ['action' => 'index', 'topicid' => $this->getRequest()->getParam('topicid')]) ?>
             </div>
             <div class="col-xl-12">
                 <div class="posts-head ilch-head">
@@ -262,7 +265,7 @@
                     </span><?=$this->getTrans('lockPost') ?>
                 </div>
             <?php endif; ?>
-            <?=$this->get('pagination')->getHtml($this, ['action' => 'index', 'topicid' => $this->getRequest()->getParam('topicid')]) ?>
+            <?=$pagination->getHtml($this, ['action' => 'index', 'topicid' => $this->getRequest()->getParam('topicid')]) ?>
         </div>
     </div>
 
diff --git a/application/modules/forum/views/showtopics/index.php b/application/modules/forum/views/showtopics/index.php
index 6ffcd25a5..bad981c0a 100644
--- a/application/modules/forum/views/showtopics/index.php
+++ b/application/modules/forum/views/showtopics/index.php
@@ -21,8 +21,13 @@
 if ($this->getUser()) {
     $adminAccess = $this->getUser()->isAdmin();
 }
+/** @var bool $DESCPostorder */
 $DESCPostorder = $this->get('DESCPostorder');
+/** @var int $postsPerPage */
 $postsPerPage = $this->get('postsPerPage');
+
+/** @var \Ilch\Pagination $pagination */
+$pagination = $this->get('pagination');
 ?>
 <link href="<?=$this->getModuleUrl('static/css/forum.css') ?>" rel="stylesheet">
 
@@ -48,7 +53,7 @@
                     </span><?=$this->getTrans('loginTopic') ?>
                 </a>
             <?php endif; ?>
-            <?=$this->get('pagination')->getHtml($this, ['action' => 'index', 'forumid' => $this->getRequest()->getParam('forumid')]) ?>
+            <?=$pagination->getHtml($this, ['action' => 'index', 'forumid' => $this->getRequest()->getParam('forumid')]) ?>
         </div>
         <?php if ($forumEdit) : ?>
             <form name="editForm" method="POST">
@@ -177,7 +182,7 @@
                     </span><?=$this->getTrans('loginTopic') ?>
                 </a>
             <?php endif; ?>
-            <?=$this->get('pagination')->getHtml($this, ['action' => 'index', 'forumid' => $this->getRequest()->getParam('forumid')]) ?>
+            <?=$pagination->getHtml($this, ['action' => 'index', 'forumid' => $this->getRequest()->getParam('forumid')]) ?>
         </div>
         <div class="topic-actions">
             <?php if ($adminAccess || ($this->getUser() && $this->getUser()->hasAccess('module_forum'))) : ?>