XoopsModules25x/xoopsfaq

<?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
 which is considered copyrighted (c) material of the original comment or credit
 authors.

 This program is distributed in the hope that it will be useful, but
 WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 */

/**
 * Display/Edit Category Block
 *
 * @author    ZySpec
 * @author    XOOPS Module Development Team
 * @copyright Copyright (c) 2001-2020 {@link https://xoops.org XOOPS Project}
 * @license   https://www.gnu.org/licenses/gpl-2.0.html GNU Public License
 * @since     ::   1.25
 *
 * @see       \XoopsModules\Xoopsfaq\Helper
 * @see       \MyTextSanitizer
 */

use Xmf\Module\Helper\Permission;
use XoopsModules\Xoopsfaq\{
    CategoryHandler,
    ContentsHandler,
    Helper
};

/**
 * Show FAQ Categories Block
 *
 * Display the most recent FAQs added
 *
 * @param array $options for display parameters
 *                       [0] = only show cats with active FAQs
 *
 * @return array containing category titles and links
 */
function b_xoopsfaq_category_show(array $options)
{
    $moduleDirName = \basename(\dirname(__DIR__));

    $myts = \MyTextSanitizer::getInstance();

    /** @var CategoryHandler $categoryHandler */
    /** @var ContentsHandler $contentsHandler */
    /** @var Helper $helper */
    $helper          = Helper::getInstance();
    $permHelper      = new Permission($moduleDirName);
    $categoryHandler = $helper->getHandler('Category');
    $block           = [];

    // Get a list of all cats this user can access
    $catListArray = $categoryHandler->getList();
    $cTu          = $catsToUse = array_keys($catListArray);
    // Remove any cats this user doesn't have rights to view
    foreach ($cTu as $key => $thisCat) {
        if (false === $permHelper->checkPermission('viewcat', $thisCat)) {
            unset($catsToUse[$key]);
        }
    }
    // catsToUse contains all categories user has rights to view

    $criteria = new \CriteriaCompo();
    $criteria->setSort('category_order ASC, category_title');
    $criteria->order = 'ASC';
    if (!isset($options[0]) || 0 === (int)$options[0]) { // only show cats with FAQs
        $contentsHandler = $helper->getHandler('Contents');
        $faqCountArray   = $contentsHandler->getCategoriesIdsWithContent();
        if (is_array($faqCountArray) && !empty($faqCountArray)) {
            $catsToShow = array_intersect($catsToUse, array_keys($faqCountArray));
            $criteria->add(new \Criteria('category_id', '(' . implode(',', $catsToShow) . ')', 'IN'));
        } else {
            // there are no categories to show
            return $block;
        }
        unset($contentsHandler, $faqCountArray, $catsToShow);
    } else {
        $criteria->add(new \Criteria('category_id', '(' . implode(',', $catsToUse) . ')', 'IN'));
    }
    $fieldsArray = ['category_id', 'category_title'];
    $catObjArray = $categoryHandler->getAll($criteria, $fieldsArray);
    $catCount    = is_array($catObjArray) ? count($catObjArray) : 0;
    if ($catCount > 0) {
        $block['title'] = _MB_XOOPSFAQ_CATTITLE;
        foreach ($catObjArray as $cId => $catObj) {
            $block['cat'][] = [
                'title' => $myts->displayTarea($catObj->getVar('category_title')),
                'link'  => $helper->url('index.php?cat_id=' . $cId),
            ];
        }
    }
    unset($catObjArray, $categoryHandler);

    return $block;
}

/**
 * Edit Recent FAQ Block preferences
 *
 * @param array $options for display parameters
 *                       [0] = only show cats with active FAQs
 *
 * @return string HTML to display to get input from user
 */
function b_xoopsfaq_category_edit(array $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[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;
}