Merge pull request #130 from mambax7/master

1.08 Alpha 1

Author: mambax7

CONTRIBUTING.md

@@ -1,7 +1,7 @@
 ![alt XOOPS CMS](https://xoops.org/images/logoXoops4GithubRepository.png)
 # Contributing to [XOOPS CMS](https://xoops.org)
 [![XOOPS CMS Module](https://img.shields.io/badge/XOOPS%20CMS-Module-blue.svg)](https://xoops.org)
-[![Software License](https://img.shields.io/badge/license-GPL-brightgreen.svg?style=flat)](http://www.gnu.org/licenses/gpl-2.0.html)
+[![Software License](https://img.shields.io/badge/license-GPL-brightgreen.svg?style=flat)](https://www.gnu.org/licenses/gpl-2.0.html)
 
 Contributions are **welcome** and will be fully **credited**.
 
@@ -10,7 +10,7 @@ We accept contributions via Pull Requests on [Github](https://github.com/XoopsMo
 ## Pull Requests
 
 - **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
-- **Add tests!** - We encourage to provide tests for your contributions.
+- **Add tests!** - We encourage providing tests for your contributions.
 - **Document any change in behavior** - Make sure the `/docs/changelog.txt` and any other relevant documentation are kept up-to-date.
 - **Consider our release cycle** - We try to follow [Semantic Versioning v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
 - **Create feature branches** - Don't ask us to pull from your master branch.

README.md

@@ -1,7 +1,7 @@
 ![alt XOOPS CMS](https://xoops.org/images/logoXoops4GithubRepository.png)
-## Publisher module for [XOOPS CMS 2.5.9+](https://xoops.org)
+## Publisher module for [XOOPS CMS 2.5.10+](https://xoops.org)
 [![XOOPS CMS Module](https://img.shields.io/badge/XOOPS%20CMS-Module-blue.svg)](https://xoops.org)
-[![Software License](https://img.shields.io/badge/license-GPL-brightgreen.svg?style=flat)](http://www.gnu.org/licenses/gpl-2.0.html)
+[![Software License](https://img.shields.io/badge/license-GPL-brightgreen.svg?style=flat)](https://www.gnu.org/licenses/gpl-2.0.html)
 
 [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/mambax7/publisher.svg?style=flat)](https://scrutinizer-ci.com/g/mambax7/publisher/?branch=master)
 [![Codacy Badge](https://api.codacy.com/project/badge/grade/2d27c0023ee54f0b9ba2b5d17a68b2a5)](https://www.codacy.com/app/mambax7/publisher)
@@ -15,7 +15,7 @@
 [![Tutorial Available](https://xoops.org/images/tutorial-available-blue.svg)](https://xoops.gitbook.io/publisher-tutorial/) Tutorial: see [GitBook](https://xoops.gitbook.io/publisher-tutorial/).
 To contribute to the Tutorial, [fork it on GitHub](https://github.com/XoopsDocs/publisher-tutorial)
 
-[![Translations on Transifex](https://xoops.org/images/translations-transifex-blue.svg)](https://www.transifex.com/xoops) 
+[![Translations on Transifex](https://xoops.org/images/translations-transifex-blue.svg)](https://www.transifex.com/xoops)
 
 Please visit us on https://xoops.org
 

admin/about.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
@@ -13,7 +15,7 @@
  * Publisher
  *
  * @copyright    The XOOPS Project (https://xoops.org)
- * @license      GNU GPL (http://www.gnu.org/licenses/gpl-2.0.html/)
+ * @license      GNU GPL (https://www.gnu.org/licenses/gpl-2.0.html/)
  * @package      Publisher
  * @since        1.0
  * @author       Mage, Mamba

admin/admin_footer.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
@@ -11,7 +13,7 @@
 
 /**
  * @copyright    XOOPS Project (https://xoops.org)
- * @license      GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
+ * @license      GNU GPL 2 or later (https://www.gnu.org/licenses/gpl-2.0.html)
  * @package
  * @since
  * @author       XOOPS Development Team

admin/admin_header.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
@@ -20,10 +22,11 @@
 
 use XoopsModules\Publisher;
 
+require dirname(__DIR__) . '/preloads/autoloader.php';
+
 require_once dirname(dirname(dirname(__DIR__))) . '/include/cp_header.php';
 //require_once $GLOBALS['xoops']->path('www/class/xoopsformloader.php');
 
-require dirname(__DIR__) . '/preloads/autoloader.php';
 require_once dirname(__DIR__) . '/include/common.php';
 
 $moduleDirName = basename(dirname(__DIR__));

admin/blockform.php

@@ -1,5 +1,7 @@
 <?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
@@ -10,8 +12,8 @@
  * @category        Module
  * @author          XOOPS Development Team
  * @copyright       XOOPS Project
- * @link            https://www.xoops.org
- * @license         GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
+ * @link            https://xoops.org
+ * @license         GNU GPL 2 or later (https://www.gnu.org/licenses/gpl-2.0.html)
  */
 require_once XOOPS_ROOT_PATH . '/class/xoopsformloader.php';
 
@@ -23,16 +25,18 @@
     $form->addElement(new \XoopsFormLabel(_AM_SYSTEM_BLOCKS_NAME, $block['name']));
 }
 $side_select = new \XoopsFormSelect(_AM_SYSTEM_BLOCKS_TYPE, 'bside', $block['side']);
-$side_select->addOptionArray([
-                                 0 => _AM_SYSTEM_BLOCKS_SBLEFT,
-                                 1 => _AM_SYSTEM_BLOCKS_SBRIGHT,
-                                 3 => _AM_SYSTEM_BLOCKS_CBLEFT,
-                                 4 => _AM_SYSTEM_BLOCKS_CBRIGHT,
-                                 5 => _AM_SYSTEM_BLOCKS_CBCENTER,
-                                 7 => _AM_SYSTEM_BLOCKS_CBBOTTOMLEFT,
-                                 8 => _AM_SYSTEM_BLOCKS_CBBOTTOMRIGHT,
-                                 9 => _AM_SYSTEM_BLOCKS_CBBOTTOM,
-                             ]);
+$side_select->addOptionArray(
+    [
+        0 => _AM_SYSTEM_BLOCKS_SBLEFT,
+        1 => _AM_SYSTEM_BLOCKS_SBRIGHT,
+        3 => _AM_SYSTEM_BLOCKS_CBLEFT,
+        4 => _AM_SYSTEM_BLOCKS_CBRIGHT,
+        5 => _AM_SYSTEM_BLOCKS_CBCENTER,
+        7 => _AM_SYSTEM_BLOCKS_CBBOTTOMLEFT,
+        8 => _AM_SYSTEM_BLOCKS_CBBOTTOMRIGHT,
+        9 => _AM_SYSTEM_BLOCKS_CBBOTTOM,
+    ]
+);
 $form->addElement($side_select);
 $form->addElement(new \XoopsFormText(constant('CO_' . $moduleDirNameUpper . '_' . 'WEIGHT'), 'bweight', 2, 5, $block['weight']));
 $form->addElement(new \XoopsFormRadioYN(constant('CO_' . $moduleDirNameUpper . '_' . 'VISIBLE'), 'bvisible', $block['visible']));
@@ -53,12 +57,14 @@
     $textarea->setDescription('<span style="font-size:x-small;font-weight:bold;">' . _AM_SYSTEM_BLOCKS_USEFULTAGS . '</span><br><span style="font-size:x-small;font-weight:normal;">' . sprintf(_AM_BLOCKTAG1, '{X_SITEURL}', XOOPS_URL . '/') . '</span>');
     $form->addElement($textarea, true);
     $ctype_select = new \XoopsFormSelect(_AM_SYSTEM_BLOCKS_CTYPE, 'bctype', $block['ctype']);
-    $ctype_select->addOptionArray([
-                                      'H' => _AM_SYSTEM_BLOCKS_HTML,
-                                      'P' => _AM_SYSTEM_BLOCKS_PHP,
-                                      'S' => _AM_SYSTEM_BLOCKS_AFWSMILE,
-                                      'T' => _AM_SYSTEM_BLOCKS_AFNOSMILE,
-                                  ]);
+    $ctype_select->addOptionArray(
+        [
+            'H' => _AM_SYSTEM_BLOCKS_HTML,
+            'P' => _AM_SYSTEM_BLOCKS_PHP,
+            'S' => _AM_SYSTEM_BLOCKS_AFWSMILE,
+            'T' => _AM_SYSTEM_BLOCKS_AFNOSMILE,
+        ]
+    );
     $form->addElement($ctype_select);
 } else {
     if ('' !== $block['template']) {
@@ -79,19 +85,21 @@
     }
 }
 $cache_select = new \XoopsFormSelect(_AM_SYSTEM_BLOCKS_BCACHETIME, 'bcachetime', $block['bcachetime']);
-$cache_select->addOptionArray([
-                                  '0'       => _NOCACHE,
-                                  '30'      => sprintf(_SECONDS, 30),
-                                  '60'      => _MINUTE,
-                                  '300'     => sprintf(_MINUTES, 5),
-                                  '1800'    => sprintf(_MINUTES, 30),
-                                  '3600'    => _HOUR,
-                                  '18000'   => sprintf(_HOURS, 5),
-                                  '86400'   => _DAY,
-                                  '259200'  => sprintf(_DAYS, 3),
-                                  '604800'  => _WEEK,
-                                  '2592000' => _MONTH,
-                              ]);
+$cache_select->addOptionArray(
+    [
+        '0'       => _NOCACHE,
+        '30'      => sprintf(_SECONDS, 30),
+        '60'      => _MINUTE,
+        '300'     => sprintf(_MINUTES, 5),
+        '1800'    => sprintf(_MINUTES, 30),
+        '3600'    => _HOUR,
+        '18000'   => sprintf(_HOURS, 5),
+        '86400'   => _DAY,
+        '259200'  => sprintf(_DAYS, 3),
+        '604800'  => _WEEK,
+        '2592000' => _MONTH,
+    ]
+);
 $form->addElement($cache_select);
 
 /** @var \XoopsGroupPermHandler $grouppermHandler */

admin/blocksadmin.php

@@ -1,4 +1,7 @@
 <?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
@@ -9,8 +12,8 @@
  * @category        Module
  * @author          XOOPS Development Team
  * @copyright       XOOPS Project
- * @link            https://www.xoops.org
- * @license         GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
+ * @link            https://xoops.org
+ * @license         GNU GPL 2 or later (https://www.gnu.org/licenses/gpl-2.0.html)
  */
 
 use Xmf\Request;
@@ -51,13 +54,13 @@
     function listBlocks()
     {
         global $xoopsModule, $pathIcon16;
-//        require_once XOOPS_ROOT_PATH . '/class/xoopslists.php';
+        //        require_once XOOPS_ROOT_PATH . '/class/xoopslists.php';
         xoops_load('xoopslist');
         require_once XOOPS_ROOT_PATH . '/class/xoopsblock.php';
         $moduleDirName      = basename(dirname(__DIR__));
         $moduleDirNameUpper = mb_strtoupper($moduleDirName); //$capsDirName
         /** @var \XoopsDatabase $db */
-        $db                 = \XoopsDatabaseFactory::getDatabaseConnection();
+        $db = \XoopsDatabaseFactory::getDatabaseConnection();
         xoops_loadLanguage('admin', 'system');
         xoops_loadLanguage('admin/blocksadmin', 'system');
         xoops_loadLanguage('admin/groups', 'system');
@@ -77,8 +80,8 @@ function listBlocks()
         ksort($module_list);
         echo "
         <h4 style='text-align:left;'>" . constant('CO_' . $moduleDirNameUpper . '_' . 'BADMIN') . '</h4>';
-//        $moduleHandler = xoops_getHandler('module');
-        echo "<form action='" . \Xmf\Request::getString('PHP_SELF', '', 'SERVER') . "' name='blockadmin' method='post'>";
+        //        $moduleHandler = xoops_getHandler('module');
+        echo "<form action='" . \Xmf\Request::getString('SCRIPT_NAME', '', 'SERVER') . "' name='blockadmin' method='post'>";
         echo $GLOBALS['xoopsSecurity']->getTokenHTML();
         echo "<table width='100%' class='outer' cellpadding='4' cellspacing='1'>
         <tr valign='middle'><th align='center'>"
@@ -92,10 +95,9 @@ function listBlocks()
              . '-'
              . _RIGHT
              . "</th><th align='center'>"
-             . constant('CO_'
-                        . $moduleDirNameUpper
-                        . '_'
-                        . 'WEIGHT')
+             . constant(
+                 'CO_' . $moduleDirNameUpper . '_' . 'WEIGHT'
+             )
              . "</th><th align='center'>"
              . constant('CO_' . $moduleDirNameUpper . '_' . 'VISIBLE')
              . "</th><th align='center'>"
@@ -283,7 +285,7 @@ function listBlocks()
     }
 
     /**
-     * @param $bid
+     * @param int $bid
      */
     function cloneBlock($bid)
     {
@@ -331,6 +333,7 @@ function cloneBlock($bid)
         ];
         echo '<a href="blocksadmin.php">' . constant('CO_' . $moduleDirNameUpper . '_' . 'BADMIN') . '</a>&nbsp;<span style="font-weight:bold;">&raquo;&raquo;</span>&nbsp;' . _AM_SYSTEM_BLOCKS_CLONEBLOCK . '<br><br>';
         require_once __DIR__ . '/blockform.php';
+        /* @var  XoopsThemeForm $form */
         $form->display();
         //        xoops_cp_footer();
         require_once __DIR__ . '/admin_footer.php';
@@ -410,12 +413,12 @@ function isBlockCloned($bid, $bside, $bweight, $bvisible, $bcachetime, $bmodule,
     }
 
     /**
-     * @param $bid
-     * @param $title
-     * @param $weight
-     * @param $visible
-     * @param $side
-     * @param $bcachetime
+     * @param int    $bid
+     * @param string $title
+     * @param int    $weight
+     * @param bool   $visible
+     * @param string $side
+     * @param int    $bcachetime
      */
     function setOrder($bid, $title, $weight, $visible, $side, $bcachetime)
     {
@@ -429,7 +432,7 @@ function setOrder($bid, $title, $weight, $visible, $side, $bcachetime)
     }
 
     /**
-     * @param $bid
+     * @param int $bid
      */
     function editBlock($bid)
     {
@@ -474,32 +477,50 @@ function editBlock($bid)
         ];
         echo '<a href="blocksadmin.php">' . constant('CO_' . $moduleDirNameUpper . '_' . 'BADMIN') . '</a>&nbsp;<span style="font-weight:bold;">&raquo;&raquo;</span>&nbsp;' . _AM_SYSTEM_BLOCKS_EDITBLOCK . '<br><br>';
         require_once __DIR__ . '/blockform.php';
+        /* @var  XoopsThemeForm $form */
         $form->display();
         //        xoops_cp_footer();
         require_once __DIR__ . '/admin_footer.php';
         exit();
     }
 
     /**
-     * @param $bid
-     * @param $btitle
-     * @param $bside
-     * @param $bweight
-     * @param $bvisible
-     * @param $bcachetime
-     * @param $bmodule
-     * @param $options
-     * @param $groups
+     * @param int               $bid
+     * @param string            $btitle
+     * @param string            $bside
+     * @param int               $bweight
+     * @param bool              $bvisible
+     * @param int               $bcachetime
+     * @param array             $bmodule
+     * @param null|array|string $options
+     * @param null|array        $groups
      */
+
     function updateBlock($bid, $btitle, $bside, $bweight, $bvisible, $bcachetime, $bmodule, $options, $groups)
     {
-        $myblock = new \XoopsBlock($bid);
+        $myblock = new XoopsBlock($bid);
         $myblock->setVar('title', $btitle);
         $myblock->setVar('weight', $bweight);
         $myblock->setVar('visible', $bvisible);
         $myblock->setVar('side', $bside);
         $myblock->setVar('bcachetime', $bcachetime);
+        //update block options
+        if (isset($options)) {
+            $options_count = count($options);
+            if ($options_count > 0) {
+                //Convert array values to comma-separated
+                for ($i = 0; $i < $options_count; ++$i) {
+                    if (is_array($options[$i])) {
+                        $options[$i] = implode(',', $options[$i]);
+                    }
+                }
+                $options = implode('|', $options);
+                $myblock->setVar('options', $options);
+            }
+        }
         $myblock->store();
+        $moduleDirName      = basename(dirname(__DIR__));
+        $moduleDirNameUpper = mb_strtoupper($moduleDirName);
 
         if (!empty($bmodule) && count($bmodule) > 0) {
             $sql = sprintf('DELETE FROM `%s` WHERE block_id = %u', $GLOBALS['xoopsDB']->prefix('block_module_link'), $bid);
@@ -522,7 +543,7 @@ function updateBlock($bid, $btitle, $bside, $bweight, $bvisible, $bcachetime, $b
                 $GLOBALS['xoopsDB']->query($sql);
             }
         }
-        redirect_header($_SERVER['PHP_SELF'], 1, constant('CO_' . $moduleDirNameUpper . '_' . 'UPDATE_SUCCESS'));
+        redirect_header($_SERVER['SCRIPT_NAME'], 1, constant('CO_' . $moduleDirNameUpper . '_' . 'UPDATE_SUCCESS'));
     }
 
     if ('list' === $op) {
@@ -535,7 +556,7 @@ function updateBlock($bid, $btitle, $bside, $bweight, $bvisible, $bcachetime, $b
 
     if ('order' === $op) {
         if (!$GLOBALS['xoopsSecurity']->check()) {
-            redirect_header($_SERVER['PHP_SELF'], 3, implode('<br>', $GLOBALS['xoopsSecurity']->getErrors()));
+            redirect_header($_SERVER['SCRIPT_NAME'], 3, implode('<br>', $GLOBALS['xoopsSecurity']->getErrors()));
         }
         foreach (array_keys($bid) as $i) {
             if ($oldtitle[$i] !== $title[$i] || $oldweight[$i] !== $weight[$i] || $oldvisible[$i] !== $visible[$i]
@@ -565,7 +586,7 @@ function updateBlock($bid, $btitle, $bside, $bweight, $bvisible, $bcachetime, $b
                 }
             }
         }
-        redirect_header($_SERVER['PHP_SELF'], 1, constant('CO_' . $moduleDirNameUpper . '_' . 'UPDATE_SUCCESS'));
+        redirect_header($_SERVER['SCRIPT_NAME'], 1, constant('CO_' . $moduleDirNameUpper . '_' . 'UPDATE_SUCCESS'));
     }
     if ('clone' === $op) {
         cloneBlock($bid);