Merge pull request #157 from mambax7/master

cleanup
XoopsModules25x · May 3, 2020 · 702889c · 702889c
2 parents bdf7ae6 + e23cdb3
commit 702889c
Show file tree

Hide file tree

Showing 25 changed files with 96 additions and 90 deletions.
diff --git a/activate.php b/activate.php
@@ -1,5 +1,6 @@
 <?php
 
+declare(strict_types=1);
 /**
  * Extended User Profile
  *

diff --git a/admin/blocksadmin.php b/admin/blocksadmin.php
@@ -410,6 +410,7 @@ function isBlockCloned(
      * @param bool   $visible
      * @param string $side
      * @param int    $bcachetime
+     * @param        $bmodule
      */
     function setOrder(
         $bid,
@@ -420,7 +421,6 @@ function setOrder(
         $bcachetime,
         $bmodule
     ) {
-        /** @var \XoopsBlock $myblock */
         $myblock = new XoopsBlock($bid);
         $myblock->setVar('title', $title);
         $myblock->setVar('weight', $weight);

diff --git a/admin/fieldscategory.php b/admin/fieldscategory.php
@@ -1,4 +1,6 @@
 <?php
+
+declare(strict_types=1);
 /*
  * You may not change or alter any portion of this comment or credits
  * of supporting developers from this source code or any supporting source code

diff --git a/admin/fieldslist.php b/admin/fieldslist.php
@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 /**
  * Extended User Profile
  *
@@ -316,6 +319,7 @@
 /**
  * @param $field_id
  * @param $field_required
+ * @param $helper
  */
 function suico_visible_toggle($field_id, $field_required, $helper)
 {

diff --git a/admin/fieldspermissions.php b/admin/fieldspermissions.php
@@ -1,5 +1,6 @@
 <?php
 
+declare(strict_types=1);
 /**
  * Extended User Profile
  *

diff --git a/admin/fieldsvisibility.php b/admin/fieldsvisibility.php
@@ -1,5 +1,6 @@
 <?php
 
+declare(strict_types=1);
 /**
  * Extended User Profile
  *

diff --git a/admin/registrationstep.php b/admin/registrationstep.php
@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 /**
  * Extended User Profile
  *

diff --git a/admin/user.php b/admin/user.php
@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 /**
  * Extended User Profile
  *
@@ -18,6 +21,7 @@
  */
 
 use Xmf\Request;
+use XoopsModules\Suico;
 use XoopsModules\Suico\Form\UserForm;
 
 include_once __DIR__ . '/admin_header.php';
@@ -29,7 +33,7 @@
 if ('editordelete' === $op) {
     $op = isset($_REQUEST['delete']) ? 'delete' : 'edit';
 }
-/* @var XoopsMemberHandler $handler */
+/* @var \XoopsMemberHandler $handler */
 $handler = xoops_getHandler('member');
 switch ($op) {
     default:
@@ -75,7 +79,7 @@
         $fields     = $profileHandler->loadFields();
         $userfields = $profileHandler->getUserVars();
         // Get ids of fields that can be edited
-        /* @var  XoopsGroupPermHandler $grouppermHandler */
+        /* @var  \XoopsGroupPermHandler $grouppermHandler */
         $grouppermHandler = xoops_getHandler('groupperm');
         $editable_fields  = $grouppermHandler->getItemIds('profile_edit', $GLOBALS['xoopsUser']->getGroups(), $GLOBALS['xoopsModule']->getVar('mid'));
         $uid              = empty($_POST['uid']) ? 0 : (int)$_POST['uid'];

diff --git a/changemail.php b/changemail.php
@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 /**
  * Extended User Profile
  *

diff --git a/changepass.php b/changepass.php
@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 /**
  * Extended User Profile
  *

diff --git a/class/AudioHandler.php b/class/AudioHandler.php
@@ -310,6 +310,7 @@ public function deleteAll(
      * @param string $path_upload The path to where the file should be uploaded
      * @param string $author      the author of the music or audio file
      * @param        $maxfilebytes
+     * @param        $description
      * @return bool FALSE if upload fails or database fails
      */
     public function receiveAudio(

diff --git a/class/Common/FilesManagement.php b/class/Common/FilesManagement.php
@@ -28,6 +28,10 @@
 use Throwable;
 use XoopsUser;
 
+/**
+ * Trait FilesManagement
+ * @package XoopsModules\Suico\Common
+ */
 trait FilesManagement
 {
     /**

diff --git a/class/Field.php b/class/Field.php
@@ -28,8 +28,13 @@
  * @copyright       (c) 2000-2016 XOOPS Project (www.xoops.org)
  */
 
+use XoopsModules\Suico;
 use XoopsModules\Suico\Profile;
 
+/**
+ * Class Field
+ * @package XoopsModules\Suico
+ */
 class Field extends \XoopsObject
 {
     public function __construct()
@@ -231,7 +236,7 @@ public function getOutputValue($user, $profile)
                 $value   = \is_array($value) ? $value[0] : $value;
                 $options = $this->getVar('field_options');
                 if (isset($options[$value])) {
-                    $value = \htmlspecialchars(\defined($options[$value]) ? \constant($options[$value]) : $options[$value]);
+                    $value = \htmlspecialchars(\defined($options[$value]) ? \constant($options[$value]) : $options[$value], ENT_QUOTES | ENT_HTML5);
                 } else {
                     $value = '';
                 }
@@ -244,7 +249,7 @@ public function getOutputValue($user, $profile)
                 if (\count($options) > 0) {
                     foreach (\array_keys($options) as $key) {
                         if (\in_array($key, $value)) {
-                            $ret[$key] = \htmlspecialchars(\defined($options[$key]) ? \constant($options[$key]) : $options[$key]);
+                            $ret[$key] = \htmlspecialchars(\defined($options[$key]) ? \constant($options[$key]) : $options[$key], ENT_QUOTES | ENT_HTML5);
                         }
                     }
                 }

diff --git a/class/FieldHandler.php b/class/FieldHandler.php
@@ -26,6 +26,9 @@
  * @package             kernel
  * @copyright       (c) 2000-2016 XOOPS Project (www.xoops.org)
  */
+
+use XoopsModules\Suico;
+
 class FieldHandler extends \XoopsPersistableObjectHandler
 {
     /**

diff --git a/class/Form/FieldForm.php b/class/Form/FieldForm.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace XoopsModules\Suico\Form;
 
 use XoopsModules\Suico;
@@ -13,13 +15,17 @@
 use XoopsFormLabel;
 use XoopsFormTextDateSelect;
 
+/**
+ * Class FieldForm
+ * @package XoopsModules\Suico\Form
+ */
 class FieldForm extends XoopsThemeForm
 {
     /**
      * @param Suico\Field $field  {@link Suico\Field} object to get edit form for
      * @param mixed       $action URL to submit to - or false for $_SERVER['REQUEST_URI']
      */
-    function __construct(Suico\Field $field, $action = false)
+    public function __construct(Suico\Field $field, $action = false)
     {
         if (!$action) {
             $action = $_SERVER['REQUEST_URI'];

diff --git a/class/Form/RegisterForm.php b/class/Form/RegisterForm.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace XoopsModules\Suico\Form;
 
 use XoopsModules\Suico;
@@ -20,7 +22,13 @@
  */
 class RegisterForm extends XoopsThemeForm
 {
-    function __construct(\XoopsUser $user, $profile, $step = null)
+    /**
+     * RegisterForm constructor.
+     * @param \XoopsUser $user
+     * @param            $profile
+     * @param null       $step
+     */
+    public function __construct(\XoopsUser $user, $profile, $step = null)
     {
         global $opkey; // should be set in register.php
         if (empty($opkey)) {

diff --git a/class/Form/StepForm.php b/class/Form/StepForm.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace XoopsModules\Suico\Form;
 
 use XoopsModules\Suico;
@@ -17,7 +19,12 @@
  */
 class StepForm extends XoopsThemeForm
 {
-    function __construct(Regstep $step = null, $action = false)
+    /**
+     * StepForm constructor.
+     * @param \XoopsModules\Suico\Regstep|null $step
+     * @param bool                             $action
+     */
+    public function __construct(Regstep $step = null, $action = false)
     {
         if (!$action) {
             $action = $_SERVER['REQUEST_URI'];

diff --git a/class/Form/UserForm.php b/class/Form/UserForm.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace XoopsModules\Suico\Form;
 
 use XoopsModules\Suico;
@@ -21,7 +23,13 @@
  */
 class UserForm extends XoopsThemeForm
 {
-    function __construct(\XoopsUser $user, Profile $profile = null, $action = false)
+    /**
+     * UserForm constructor.
+     * @param \XoopsUser                       $user
+     * @param \XoopsModules\Suico\Profile|null $profile
+     * @param bool                             $action
+     */
+    public function __construct(\XoopsUser $user, Profile $profile = null, $action = false)
     {
         $helper = \XoopsModules\Suico\Helper::getInstance();
         if (!$action) {

diff --git a/class/GroupsHandler.php b/class/GroupsHandler.php
@@ -542,6 +542,10 @@ public function receiveGroup(
         return true;
     }
 
+    /**
+     * @param $owner_id
+     * @return mixed
+     */
     public function isGroupMember($owner_id)
     {
         $query               = 'SELECT COUNT(rel_id) AS grouptotalmembers FROM ' . $GLOBALS['xoopsDB']->prefix('suico_relgroupuser') . ' WHERE rel_group_id=' . $group_id . '';
@@ -551,17 +555,25 @@ public function isGroupMember($owner_id)
         return $group_total_members;
     }
 
+    /**
+     * @param $group_id
+     * @return mixed
+     */
     public function getComment($group_id)
     {
         $moduleSuico = Helper::getInstance()->getModule();
-        $sql         = "SELECT count(com_id) FROM " . $GLOBALS['xoopsDB']->prefix('xoopscomments') . " WHERE com_modid = '" . $moduleSuico->getVar('mid') . "' AND com_itemid = '" . $group_id . "'";
+        $sql         = 'SELECT count(com_id) FROM ' . $GLOBALS['xoopsDB']->prefix('xoopscomments') . " WHERE com_modid = '" . $moduleSuico->getVar('mid') . "' AND com_itemid = '" . $group_id . "'";
         $result      = $GLOBALS['xoopsDB']->query($sql);
         while ($row = $GLOBALS['xoopsDB']->fetchArray($result)) {
             $group_total_comments = $row['count(com_id)'];
         }
         return $group_total_comments;
     }
 
+    /**
+     * @param $group_id
+     * @return mixed
+     */
     public function getGroupTotalMembers($group_id)
     {
         $query               = 'SELECT COUNT(rel_id) AS grouptotalmembers FROM ' . $GLOBALS['xoopsDB']->prefix('suico_relgroupuser') . ' WHERE rel_group_id=' . $group_id . '';

diff --git a/class/ProfileHandler.php b/class/ProfileHandler.php
@@ -40,7 +40,7 @@ class ProfileHandler extends \XoopsPersistableObjectHandler
      */
     public $_fHandler;
     /**
-     * Array of {@link XoopsSuico\Field} objects
+     * Array of {@link Suico\Field} objects
      * @var array
      */
     public $_fields = [];

diff --git a/class/SuicoController.php b/class/SuicoController.php
@@ -70,6 +70,7 @@ class SuicoController extends \XoopsObject
      *
      * @param \XoopsDatabase $xoopsDatabase
      * @param                $user
+     * @param null           $xoopsModule
      */
     public function __construct(\XoopsDatabase $xoopsDatabase, $user, $xoopsModule = null)
     {

diff --git a/class/VideoHandler.php b/class/VideoHandler.php
@@ -335,6 +335,7 @@ public function renderFormSubmit(
     /**
      * Render a form to edit the description of the pictures
      *
+     * @param        $title
      * @param string $caption  The description of the picture
      * @param int    $video_id the id of the image in database
      * @param string $filename the url to the thumb of the image so it can be displayed