Some changes and small bug fixes

admin/category.php

@@ -27,6 +27,9 @@
 require_once __DIR__ . '/admin_header.php';
 xoops_cp_header();
 
+/** @var XoopsfaqCategoryHandler $xfCatHandler */
+/** @var XoopsfaqContentsHandler $xfFaqHandler */
+/** @var Xmf\Module\Helper\GenericHelper $xfHelper */
 $xfCatHandler = $xfHelper->getHandler('category');
 
 $op = Request::getCmd('op', 'default');

admin/index.php

@@ -24,6 +24,10 @@
 include_once __DIR__ . '/admin_header.php';
 xoops_cp_header();
 
+/** @var XoopsfaqCategoryHandler $xfCatHandler */
+/** @var XoopsfaqContentsHandler $xfFaqHandler */
+/** @var Xmf\Module\Helper\GenericHelper $xfHelper */
+
 //-----------------------
 $xfFaqHandler = $xfHelper->getHandler('contents');
 $totalFaqs    = $xfFaqHandler->getCount();

admin/main.php

@@ -22,11 +22,15 @@
  * @see Xmf\Module\Admin
  */
 use Xmf\Request;
-use Xmf\Module\Admin;
+#use Xmf\Module\Admin;
 
 include __DIR__ . '/admin_header.php';
 xoops_cp_header();
 
+/** @var XoopsfaqCategoryHandler $xfCatHandler */
+/** @var XoopsfaqContentsHandler $xfFaqHandler */
+/** @var Xmf\Module\Helper\GenericHelper $xfHelper */
+
 $xfFaqHandler = $xfHelper->getHandler('contents');
 $adminObject  = Xmf\Module\Admin::getInstance();
 
@@ -89,8 +93,8 @@
             if ($ret) {
                 $xfHelper->redirect('admin/main.php', XoopsfaqConstants::REDIRECT_DELAY_MEDIUM, _AM_XOOPSFAQ_DBSUCCESS);
             }
+            $xfFaqHandler->displayError($ret);
         }
-        $xfFaqHandler->displayError($ret);
         break;
 
     case 'default':

admin/menu.php

@@ -22,29 +22,29 @@
  * @see \Xmf\Module\Admin
  */
 use Xmf\Module\Admin;
-use Xmf\Module\Helper;
+#use Xmf\Module\Helper;
 
 defined('XOOPS_ROOT_PATH') || exit('Restricted access');
 
 $adminmenu = array(
     array('title' => _MI_XOOPSFAQ_MENU_ADMIN_INDEX,
            'link' => 'admin/index.php',
            'desc' => _MI_XOOPSFAQ_ADMIN_INDEX_DESC,
-           'icon' => Admin::menuIconPath('home.png', '32')
+           'icon' => Admin::menuIconPath('home.png')
     ),
     array('title' => _MI_XOOPSFAQ_MENU_ADMIN_CATEGORY,
            'link' => 'admin/category.php',
            'desc' => _MI_XOOPSFAQ_ADMIN_CATEGORY_DESC,
-           'icon' => Admin::menuIconPath('category.png', '32')
+           'icon' => Admin::menuIconPath('category.png')
     ),
     array('title' => _MI_XOOPSFAQ_MENU_ADMIN_FAQ,
            'link' => 'admin/main.php',
            'desc' => _MI_XOOPSFAQ_ADMIN_FAQ_DESC,
-           'icon' => Admin::menuIconPath('faq.png', '32')
+           'icon' => Admin::menuIconPath('faq.png')
     ),
     array('title' => _MI_XOOPSFAQ_MENU_ADMIN_ABOUT,
            'link' => 'admin/about.php',
            'desc' => _MI_XOOPSFAQ_ADMIN_ABOUT_DESC,
-           'icon' => Admin::menuIconPath('about.png', '32')
+           'icon' => Admin::menuIconPath('about.png')
     )
 );

blocks/xoopsfaq_category.php

@@ -40,6 +40,9 @@ function b_xoopsfaq_category_show($options)
 
     $myts         = MyTextSanitizer::getInstance();
 
+    /** @var XoopsfaqCategoryHandler $xfCatHandler */
+    /** @var XoopsfaqContentsHandler $xfFaqHandler */
+    /** @var Xmf\Module\Helper\GenericHelper $xfHelper */
     $xfHelper     = Xmf\Module\Helper::getHelper($moduleDirName);
     $permHelper   = new Xmf\Module\Helper\Permission($moduleDirName);
     $xfCatHandler = $xfHelper->getHandler('category');
@@ -63,7 +66,7 @@ function b_xoopsfaq_category_show($options)
         $xfFaqHandler = $xfHelper->getHandler('contents');
         $faqCriteria = new CriteriaCompo(new Criteria('contents_active', XoopsfaqConstants::ACTIVE));
         $faqCriteria->setGroupBy('contents_cid');
-        $faqCountArray = $xfFaqHandler->getCount($faqCriteria, null, false, false);
+        $faqCountArray = $xfFaqHandler->getCategoriesIdsWithContent();
         if (is_array($faqCountArray) && !empty($faqCountArray)) {
             $catsToShow = array_intersect($catsToUse, array_keys($faqCountArray));
             $criteria->add(new Criteria('category_id', '(' . implode(',', $catsToShow) . ')', 'IN'));
@@ -102,6 +105,6 @@ function b_xoopsfaq_category_edit($options)
 {
     $ychck = (isset($options[0]) && ($options[0] > 0)) ? ' checked' : '';
     $nchck = !empty($ychck) ? '' : ' checked';
-    $form = '<div class="line140">' . _MB_XOOPSFAQ_SHOW_EMPTY . '&nbsp;<label for="r0">' . _NO . '</label><input type="radio" name="options[2]" id="r0" value="0"' . $nchck . '>&nbsp;<label for="r1">' . _YES . '</label><input type="radio" name="options[2]" id="r1" value="1"' . $ychck . '></div>' . "\n";
+    $form = '<div class="line140">' . _MB_XOOPSFAQ_SHOW_EMPTY . '&nbsp;<label for="r0">' . _NO . '</label><input type="radio" name="options[0]" id="r0" value="0"' . $nchck . '>&nbsp;<label for="r1">' . _YES . '</label><input type="radio" name="options[0]" id="r1" value="1"' . $ychck . '></div>' . "\n";
     return $form;
 }

blocks/xoopsfaq_rand.php

@@ -38,6 +38,9 @@ function b_xoopsfaq_random_show($options)
 
     $myts          = MyTextSanitizer::getInstance();
 
+    /** @var XoopsfaqCategoryHandler $xfCatHandler */
+    /** @var XoopsfaqContentsHandler $xfFaqHandler */
+    /** @var Xmf\Module\Helper\GenericHelper $xfHelper */
     $xfHelper      = Xmf\Module\Helper::getHelper($moduleDirName);
     $permHelper    = new Xmf\Module\Helper\Permission($moduleDirName);
     $xfFaqHandler  = $xfHelper->getHandler('contents');
@@ -105,6 +108,8 @@ function b_xoopsfaq_rand_edit($options)
     $moduleDirName = basename(dirname(__DIR__));
     xoops_load('XoopsFormSelect');
 
+    /** @var XoopsfaqCategoryHandler $xfCatHandler */
+    /** @var Xmf\Module\Helper\GenericHelper $xfHelper */
     $xfHelper      = Xmf\Module\Helper::getHelper($moduleDirName);
     $xfCatHandler  = $xfHelper->getHandler('category');
 

blocks/xoopsfaq_recent.php

@@ -41,6 +41,9 @@ function b_xoopsfaq_recent_show($options)
 
     $myts         = MyTextSanitizer::getInstance();
 
+    /** @var XoopsfaqCategoryHandler $xfCatHandler */
+    /** @var XoopsfaqContentsHandler $xfFaqHandler */
+    /** @var Xmf\Module\Helper\GenericHelper $xfHelper */
     $xfHelper     = Xmf\Module\Helper::getHelper($moduleDirName);
     $xfFaqHandler = $xfHelper->getHandler('contents');
     $permHelper   = new Xmf\Module\Helper\Permission($moduleDirName);
@@ -116,6 +119,8 @@ function b_xoopsfaq_recent_edit($options)
     $moduleDirName = basename(dirname(__DIR__));
     xoops_load('XoopsFormSelect');
 
+    /** @var XoopsfaqCategoryHandler $xfCatHandler */
+    /** @var Xmf\Module\Helper\GenericHelper $xfHelper */
     $xfHelper      = Xmf\Module\Helper::getHelper($moduleDirName);
     $xfCatHandler  = $xfHelper->getHandler('category');
 
@@ -138,7 +143,7 @@ function b_xoopsfaq_recent_edit($options)
           . '<label for="r0">' . _NO . '</label>'
           . '<input type="radio" name="options[2]" id="r0" value="0"' . $nchck . '>&nbsp;'
           . '<label for="r1">' . _YES . '</label>'
-          . '<input type="radio" name="options[2]" id="r1" value="1"' . $ychck
+          . '<input type="radio" name="options[2]" id="r1" value="1"' . $ychck . '>'
           . '<br><br>' . _MB_XOOPSFAQ_ALL_CATS_INTRO . '&nbsp;&nbsp;' . $selectCat
           . '</div>';
     return $form;

class/category.php

@@ -116,13 +116,13 @@ public function __construct($db)
     /**
      * XoopsfaqCategoryHandler::getObj()
      *
-     * @param string sort order ('id', order', or 'title') - default: id
+     * @param string $sort order ('id', order', or 'title') - default: id
      *
      * @return mixed XoopsfaqCategory | false on failure
      */
     public function getObj($sort = 'id')
     {
-        $myts = MyTextSanitizer::getInstance();
+        #$myts = MyTextSanitizer::getInstance();
         $obj = false;
         if ((null !== $sort) && (!$sort instanceof CriteriaElement)) {
             $criteria = new CriteriaCompo();
@@ -132,12 +132,12 @@ public function getObj($sort = 'id')
             $criteria->setSort($sort);
             $criteria->setStart(0);
             $criteria->setLimit(0);
+            $obj['list'] = $this->getObjects($criteria, false);
         } else {
             $criteria = $sort;
             $obj['list'] = $this->getObjects($criteria, false);
             $obj['count'] = count($obj['list']);
         }
-        $obj['list'] = $this->getObjects($criteria, false);
         return $obj;
     }
 
@@ -180,6 +180,7 @@ public function renderAdminListing($sort = 'id')
              . '  </thead>'
              . '  <tbody>';
         if ($objects['count'] > 0) {
+            /** @var XoopsObject $object */
             foreach ($objects['list'] as $object) {
                 $ret .= '  <tr class="xoopsCenter">'
                       . '    <td class="even txtcenter">' . $object->getVar('category_order') . '</td>'

class/contents.php

@@ -78,12 +78,12 @@ public function displayForm()
         echo $this->renderForm();
     }
     /**
-     * Render the Content (FAQ) Editor form for Admin
-     *
-     * @return string HTML to be displayed for Admin
+     * Displays the Content (FAQ) Editor form for Admin
      */
     public function renderForm()
     {
+        /** @var XoopsfaqCategoryHandler $xfCatHandler */
+        /** @var Xmf\Module\Helper\GenericHelper $xfHelper */
         $xfHelper      = Xmf\Module\Helper::getHelper($this->dirname);
         $xfCatHandler  = $xfHelper->getHandler('category');
         $catCount      = $xfCatHandler->getCount();
@@ -129,7 +129,7 @@ public function renderForm()
         // Editor
         $options_tray  = new XoopsFormElementTray(_AM_XOOPSFAQ_E_CONTENTS_CONTENT, '<br>');
         if (class_exists('XoopsFormEditor')) {
-//            $editorConfigs = array('editor' => $GLOBALS['xoopsConfig']['general_editor'],
+            // $editorConfigs = array('editor' => $GLOBALS['xoopsConfig']['general_editor'],
             $editorConfigs = array('editor' => $xfHelper->getConfig('use_wysiwyg', 'dhtmltextarea'),
                                      'rows' => 25,
                                      'cols' => '100%',
@@ -181,7 +181,7 @@ public function renderForm()
 
         $form->addElement(new XoopsFormButtonTray('contents_form', _SUBMIT, 'submit'));
 
-        return $form->display();
+        $form->display();
     }
 
     /**
@@ -247,16 +247,16 @@ public function getObj($sort = 'id')
         $obj = false;
         if (!$sort instanceof CriteriaElement) {
             $criteria = new CriteriaCompo();
-//            $obj['count'] = $this->getCount($criteria);
+            // $obj['count'] = $this->getCount($criteria);
             $sort = in_array(mb_strtolower($sort), array('id', 'cid', 'title', 'publish', 'weight')) ? 'contents_' . mb_strtolower($sort) : 'contents_id';
             $criteria->setSort($sort);
             $criteria->order = 'ASC';
             $criteria->setStart(0);
             $criteria->setLimit(0);
+            $obj['list'] = $this->getObjects($criteria, false);
         } else {
             $obj['list']  = $this->getObjects($sort, false);
         }
-        $obj['list'] = $this->getObjects($criteria, false);
         $obj['count'] = (false !== $obj['list']) ? count($obj['list']) : 0;
         return $obj;
     }
@@ -297,6 +297,26 @@ public function getPublished($id = '')
         return $obj;
     }
 
+    /**
+     * Returns categories ids of categories that have content
+     */
+    public function getCategoriesIdsWithContent()
+    {
+        $ret = array();
+        $sql  = "SELECT contents_cid ";
+        $sql .= "FROM `{$this->table}` ";
+        $sql .= "WHERE (contents_active = '1') ";
+        $sql .= "GROUP BY contents_cid";
+        if (!$result = $this->db->query($sql)) {
+            return $ret;
+        }
+        while ($myrow = $this->db->fetchArray($result)) {
+            $ret[$myrow['contents_cid']] = $myrow['contents_cid'];
+        }
+
+        return $ret;
+    }
+
     /**
      * XoopsfaqContentsHandler::displayAdminListing()
      *
@@ -322,6 +342,7 @@ public function renderAdminListing($sort = 'id')
             xoops_load('utility', basename(dirname(__DIR__)));
         }
 
+        /** @var XoopsfaqCategoryHandler $xfCatHandler */
         $objects      = $this->getObj($sort);
         $xfHelper     = Xmf\Module\Helper::getHelper(basename(dirname(__DIR__)));
         $xfCatHandler = $xfHelper->getHandler('category');
@@ -345,10 +366,11 @@ public function renderAdminListing($sort = 'id')
              . '  <tbody>';
         if ($objects['count'] > 0) {
             $tdClass = 0;
+            /** @var \XoopsfaqContents $object */
             foreach ($objects['list'] as $object) {
                 $thisCatId = $object->getVar('contents_cid');
                 $thisCatTitle = $catArray[$thisCatId]['category_title'];
-                $thisContentTitle = '<a href="' . $xfHelper->url('index.php?cat_id=' . $thisCatId . '#q' . $object->getVar('contents_id')) . '" alt="' . _AM_XOOPSFAQ_CONTENTS_VIEW . '">' . $object->getVar('contents_title') . '</a>';
+                $thisContentTitle = '<a href="' . $xfHelper->url('index.php?cat_id=' . $thisCatId . '#q' . $object->getVar('contents_id')) . '" title="' . _AM_XOOPSFAQ_CONTENTS_VIEW . '">' . $object->getVar('contents_title') . '</a>';
                 ++$tdClass;
                 $dispClass = ($tdClass % 1) ? 'even' : 'odd';
                 $ret .= '  <tr class="center middle">'

class/utility.php

@@ -76,7 +76,7 @@ public static function checkVerXoops($module)
      *
      * Verifies PHP version meets minimum requirements for this module
      * @static
-     * @param XoopsModule
+     * @param XoopsModule $module
      *
      * @return bool true if meets requirements, false if not
      */
@@ -166,11 +166,11 @@ public static function rrmdir($src)
             return false;
         }
 
-        $success = true;
+        #$success = true;
 
         // Open the source directory to read in files
         $iterator = new DirectoryIterator($src);
-       foreach ($iterator as $fObj) {
+        foreach ($iterator as $fObj) {
             if ($fObj->isFile()) {
                 $filename = $fObj->getPathname();
                 $fObj = null; // clear this iterator object to close the file

include/oninstall.inc.php

@@ -42,6 +42,7 @@
  */
 function xoops_module_pre_install_xoopsfaq(XoopsModule $module)
 {
+    /** @var XoopsfaqUtility $utilsClass */
     $utilsClass = ucfirst($module->dirname()) . 'Utility';
     if (!class_exists($utilsClass)) {
         xoops_load('utility', $module->dirname());

include/onupdate.inc.php

@@ -21,9 +21,9 @@
  * @since     File available since version 1.25
  */
 //use Xmf\Debug;
-use Xmf\Database\Tables;
-use Xmf\Module\Helper;
-use Xmf\Request;
+#use Xmf\Database\Tables;
+#use Xmf\Module\Helper;
+#use Xmf\Request;
 
 /**
  * @internal {Make sure you PROTECT THIS FILE}
@@ -49,6 +49,7 @@
  */
 function xoops_module_pre_update_xoopsfaq(XoopsModule $module, $prev_version)
 {
+    /** @var XoopsfaqUtility $utilsClass */
     $utilsClass = ucfirst($module->dirname()) . 'Utility';
     if (!class_exists($utilsClass)) {
         xoops_load('utility', $module->dirname());
@@ -128,7 +129,7 @@ function xoops_module_update_xoopsfaq(XoopsModule $module, $prev_version)
         // Now remove a some misc files that were renamed or deprecated
         //-----------------------------------------------------------------------
         $oldFiles = array($xfHelper->path('include/functions.php'),
-                            $xsHelper->path('class/utilities.php')
+                            $xfHelper->path('class/utilities.php')
         );
         foreach($oldFiles as $file) {
             if (is_file($file)) {

include/rss.inc.php

@@ -28,6 +28,9 @@ function xoopsfaq_rss($max = 10)
     $moduleDirName = basename(dirname(__DIR__));
     xoops_load('constants', $moduleDirName);
 
+    /** @var XoopsfaqCategoryHandler $xfCatHandler */
+    /** @var XoopsfaqContentsHandler $xfFaqHandler */
+    /** @var Xmf\Module\Helper\GenericHelper $xfHelper */
     $xfHelper      = Xmf\Module\Helper::getHelper($moduleDirName);
     $xfCatHandler  = $xfHelper->getHandler('category');
     $xfFaqHandler  = $xfHelper->getHandler('contents');
@@ -53,6 +56,7 @@ function xoopsfaq_rss($max = 10)
 
     $retVal = array();
 
+    /** @var XoopsObject $contentObj */
     foreach ($contentObjs as $contentObj) {
         $retVal[] = array ('image' => '',
                            'title' => $contentObj->getVar('contents_title'),

include/search.inc.php

@@ -46,6 +46,10 @@ function xoopsfaq_search($queryarray, $andor, $limit, $offset, $userid) {
     $moduleDirName = basename(dirname(__DIR__)) ;
     xoops_load('constants', $moduleDirName);
 
+    /** @var XoopsfaqCategoryHandler $xfCatHandler */
+    /** @var XoopsfaqContentsHandler $xfFaqHandler */
+    /** @var Xmf\Module\Helper\GenericHelper $xfHelper */
+
     $xfHelper = Xmf\Module\Helper::getHelper($moduleDirName);
 
     // Find the search term in the Category

include/sitemap.plugin.php

@@ -23,6 +23,8 @@
  */
 function b_sitemap_xoopsfaq() {
 
+    /** @var XoopsfaqCategoryHandler $xfCatHandler */
+    /** @var Xmf\Module\Helper\GenericHelper $xfHelper */
     $myts = MyTextSanitizer::getInstance();
 
     $moduleDirName = basename(dirname(__DIR__)) ;