XoopsModules25x / xhelp

class/Faq/Xoopsfaq.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
 */

namespace XoopsModules\Xhelp\Faq;

use XoopsModules\Xhelp;
use XoopsModules\Xoopsfaq\Helper as AdapterHelper;

The type XoopsModules\Xoopsfaq\Helper was not found. Maybe you did not declare it correctly or list all dependencies?

if (!\defined('XHELP_CLASS_PATH')) {
    exit();
}

\define('XHELP_XFAQ_PATH', XOOPS_ROOT_PATH . '/modules/xoopsfaq');
\define('XHELP_XFAQ_URL', XOOPS_URL . '/modules/xoopsfaq');

/**
 * class Xoopsfaq
 */
class Xoopsfaq extends Xhelp\FaqAdapterAbstract
{
    /**
     * Does application support categories?
     * Possible Values:
     * XHELP_FAQ_CATEGORY_SING - entries can be in 1 category
     * XHELP_FAQ_CATEGORY_MULTI - entries can be in more than 1 category
     * XHELP_FAQ_CATEGORY_NONE - No category support
     */
    public $categoryType = \XHELP_FAQ_CATEGORY_SING;
    /**
     * Adapter Details
     * Required Values:
     * name - name of adapter
     * author - who wrote the plugin
     * author_email - contact email
     * version - version of this plugin
     * tested_versions - supported application versions
     * url - support url for plugin
     * module_dir - module directory name (not needed if class overloads the isActive() function from Xhelp\FaqAdapterAbstract)
     */
    public $meta = [
        'name'            => 'xoopsfaq',
        'author'          => 'Eric Juden',
        'author_email'    => 'eric@3dev.org',
        'description'     => 'Create xoopsfaq entries from xHelp helpdesk tickets',
        'version'         => '1.0',
        'tested_versions' => '1.1',
        'url'             => 'https://xoops.org',
        'module_dir'      => 'xoopsfaq',
    ];

    /**
     * Xhelp\Xoopsfaq constructor.
     */
    public function __construct()
    {
        if (\class_exists(AdapterHelper::class)) {
            $this->helper  = AdapterHelper::getInstance();
            $this->dirname = $this->helper->dirname();
        }

        $this->init();
    }

    /**
     * @return array
     */
    public function &getCategories(): array
    {
        global $xoopsDB;

        $ret = [];

        if (null === $this->helper) {
            return $ret;
        }
        $helper = Xhelp\Helper::getInstance();
        // Create an instance of the Xhelp\FaqCategoryHandler
        $faqCategoryHandler = $helper->getHandler('FaqCategory');

        $sql    = \sprintf('SELECT category_id, category_title FROM `%s` ORDER BY category_order', $xoopsDB->prefix('xoopsfaq_categories'));
        $result = $xoopsDB->query($sql);

        if (!$result) {
            return $ret;
        }

        //Convert the module specific category to the
        //Xhelp\FaqCategory object for standarization
        while (false !== ($myrow = $xoopsDB->fetchArray($result))) {
            $faqcat = $faqCategoryHandler->create();
            $faqcat->setVar('id', $myrow['category_id']);
            $faqcat->setVar('name', $myrow['category_title']);
            $faqcat->setVar('parent', 0);
            $ret[] = $faqcat;
        }

        return $ret;
    }

    /**
     * @param Xhelp\Faq|null $faq The faq to add
     * @return bool true (success)/false (failure)
     */
    public function storeFaq(Xhelp\Faq $faq = null): bool
    {
        global $xoopsDB, $xoopsUser;

        // Set values before storing to db
        //        $newid             = 0;
        $categories        = $faq->getVar('categories');

The method getVar() does not exist on null.

        $category_id       = $categories[0];
        $title             = $faq->getVar('problem');
        $contents          = $faq->getVar('solution');
        $contents_order    = 0;
        $contents_visible  = 1;
        $contents_nohtml   = 0;
        $contents_nosmiley = 0;
        $contents_noxcode  = 0;

        $sql = 'INSERT INTO ' . $xoopsDB->prefix('xoopsfaq_contents') . ' (category_id, contents_title, contents_contents, contents_time, contents_order, contents_visible, contents_nohtml, contents_nosmiley, contents_noxcode) VALUES ('
               //               . $newid
               //               . ', '
               . $category_id . ", '" . $title . "', '" . $contents . "', " . \time() . ', ' . $contents_order . ', ' . $contents_visible . ', ' . $contents_nohtml . ', ' . $contents_nosmiley . ', ' . $contents_noxcode . ')';
        $ret = $xoopsDB->query($sql);

        $newid = $xoopsDB->getInsertId();   // Get new faq id from db
        if ($ret) {
            $faq->setVar('id', $newid);
        }

        return $ret;
    }

    /**
     * @param \XoopsModules\Xhelp\Faq $faq
     * @return string
     */
    public function makeFaqUrl(\XoopsModules\Xhelp\Faq $faq): string
    {
        return \XHELP_XFAQ_URL . '/index.php?cat_id=' . $faq->getVar('categories') . '#q' . $faq->getVar('id');
    }
}