XoopsModules25x / xhelp

faq.php

<?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.
 */

/**
 * @copyright    {@link https://xoops.org/ XOOPS Project}
 * @license      {@link https://www.gnu.org/licenses/gpl-2.0.html GNU GPL 2 or later}
 * @author       Brian Wahoff <ackbarr@xoops.org>
 * @author       Eric Juden <ericj@epcusa.com>
 * @author       XOOPS Development Team
 */

use Xmf\Request;
use XoopsModules\Xhelp;

require_once __DIR__ . '/header.php';

$helper = Xhelp\Helper::getInstance();

$op = 'default';
//require_once XHELP_INCLUDE_PATH . '/events.php';
// require_once XHELP_CLASS_PATH . '/faqAdapterFactory.php';
// require_once XHELP_CLASS_PATH . '/faqCategory.php';
// require_once XHELP_CLASS_PATH . '/Tree.php';

if (Request::hasVar('op', 'REQUEST')) {
    $op = Request::getString('op', 'default');
}

if (!$xoopsUser) {
    $helper->redirect('', 3, _NOPERM);
} elseif (!$xhelp_isStaff) {
    $helper->redirect('', 3, _NOPERM);
}

switch ($op) {
    case 'add':
        if (isset($_POST['addFaq'])) {
            addFaq_action();
        } else {
            addFaq_display();
        }
        break;
    default:
        addFaq_display();
        break;
}

/**
 *
 */
function addFaq_display()
{
    global $xoopsOption, $xoopsTpl, $xoopsConfig, $xoopsUser, $xoopsLogger, $xoopsUserIsAdmin, $session, $staff;
    $helper = Xhelp\Helper::getInstance();

    if (!isset($_POST['ticketid']) && 0 === Request::getInt('ticketid', 0, 'POST')) {
        $helper->redirect('', 3, _XHELP_MSG_NO_ID);
    }
    $ticketid = Request::getInt('ticketid', 0, 'POST');
    /** @var \XoopsModules\Xhelp\TicketHandler $ticketHandler */
    $ticketHandler = $helper->getHandler('Ticket');
    /** @var \XoopsModules\Xhelp\ResponseHandler $responseHandler */
    $responseHandler = $helper->getHandler('Response');
    $ticket          = $ticketHandler->get($ticketid);

    if (!$hasRights = $staff->checkRoleRights(XHELP_SEC_FAQ_ADD, $ticket->getVar('department'))) {

The assignment to $hasRights is dead and can be removed.

        $helper->redirect("ticket.php?id=$ticketid", 3, _AM_XHELP_MESSAGE_NO_ADD_FAQ);
    }

    $GLOBALS['xoopsOption']['template_main'] = 'xhelp_addFaq.tpl';
    require_once XOOPS_ROOT_PATH . '/header.php';

    $criteria     = new \Criteria('ticketid', $ticketid);
    $responses    = $responseHandler->getObjects($criteria, true);
    $responseText = '';

    $allUsers = [];
    foreach ($responses as $response) {
        $allUsers[$response->getVar('uid')] = '';
    }

    $criteria = new \Criteria('uid', '(' . implode(',', array_keys($allUsers)) . ')', 'IN');
    $users    = Xhelp\Utility::getUsers($criteria, $helper->getConfig('xhelp_displayName'));

It seems like $helper->getConfig('xhelp_displayName') can also be of type null; however, parameter $displayName of XoopsModules\Xhelp\Utility::getUsers() does only seem to accept integer, maybe add an additional type check?

    unset($allUsers);

    foreach ($responses as $response) {
        $responseText .= sprintf(_XHELP_TEXT_USER_SAID, $users[$response->getVar('uid')]) . "\n";
        $responseText .= $response->getVar('message', 'e') . "\n";
    }

    // Get current faq adapter
    /** @var \XoopsModules\Xhelp\FaqAdapterAbstract $oAdapter */
    $oAdapter = Xhelp\FaqAdapterFactory::getFaqAdapter();
    if (!$oAdapter) {

$oAdapter is of type XoopsModules\Xhelp\FaqAdapterAbstract, thus it always evaluated to true.

        $helper->redirect('', 3, _XHELP_MESSAGE_NO_FAQ);
    }
    $categories = &$oAdapter->getCategories();

Are you sure the usage of $oAdapter->getCategories() targeting XoopsModules\Xhelp\FaqAdapterAbstract::getCategories() seems to always return null.

    $tree = new Xhelp\Tree($categories, 'id', 'parent');

    //    $xoopsTpl->assign('xhelp_categories', $tree->makeSelBox('categories', 'name', '--', 0, false, 0, $oAdapter->categoryType));

    $categorySelect = $tree->makeSelectElement('categories', 'name', '--', 0, false, 0, $oAdapter->categoryType, '');
    $xoopsTpl->assign('xhelp_categories', $categorySelect->render());

    $xoopsTpl->assign('xhelp_imagePath', XHELP_IMAGE_URL . '/');
    $xoopsTpl->assign('xhelp_baseURL', XHELP_BASE_URL);
    $xoopsTpl->assign('xhelp_faqProblem', $ticket->getVar('description', 'e'));
    $xoopsTpl->assign('xhelp_faqSolution', $responseText);
    $xoopsTpl->assign('xhelp_hasMultiCats', $oAdapter->categoryType);
    $xoopsTpl->assign('xhelp_ticketID', $ticketid);
    $xoopsTpl->assign('xhelp_faqSubject', $ticket->getVar('subject', 'e'));

    require_once XOOPS_ROOT_PATH . '/footer.php';
}

/**
 *
 */
function addFaq_action()
{
    global $xoopsUser, $eventService;
    $helper = Xhelp\Helper::getInstance();
    /** @var \XoopsModules\Xhelp\TicketHandler $ticketHandler */
    $ticketHandler = $helper->getHandler('Ticket');

    // Retrieve ticket information
    $ticketid = $_POST['ticketid'];
    $ticket   = $ticketHandler->get($ticketid);

    $adapter = Xhelp\FaqAdapterFactory::getFaqAdapter();
    $faq     = $adapter->createFaq();

    // @todo - Make subject user editable
    $faq->setVar('subject', $_POST['subject']);
    $faq->setVar('problem', $_POST['problem']);
    $faq->setVar('solution', $_POST['solution']);
    // BTW - XOBJ_DTYPE_ARRAY vars must be serialized prior to calling setVar in XOOPS 2.0
    $faq->setVar('categories', serialize($_POST['categories']));

    if ($adapter->storeFaq($faq)) {

The call to XoopsModules\Xhelp\FaqAdapterAbstract::storeFaq() has too many arguments starting with $faq.

        // Todo: Run events here
        $eventService->trigger('new_faq', [&$ticket, &$faq]);

        $helper->redirect("ticket.php?id=$ticketid", 3, _XHELP_MESSAGE_ADD_FAQ);
    } else {
        $helper->redirect("ticket.php?id=$ticketid", 3, _XHELP_MESSAGE_ERR_ADD_FAQ);
    }
}