mambax7 / newbb5

class/CategoryHandler.php

<?php

namespace XoopsModules\Newbb;

/**
 * NewBB 5.0x,  the forum module for XOOPS project
 *
 * @copyright      XOOPS Project (https://xoops.org)
 * @license        GNU GPL 2 or later (https://www.gnu.org/licenses/gpl-2.0.html)
 * @author         Taiwen Jiang (phppp or D.J.) <phppp@users.sourceforge.net>
 * @since          4.00
 * @package        module::newbb
 */

use XoopsModules\Newbb;

 /**
 * Class CategoryHandler
 */
class CategoryHandler extends \XoopsPersistableObjectHandler
{
    /**
     * @param null|\XoopsDatabase $db
     */
    public function __construct(\XoopsDatabase $db = null)
    {
        parent::__construct($db, 'newbb_categories', Category::class, 'cat_id', 'cat_title');
    }

    /**
     * @param string $perm
     * @return mixed
     */
    public function getIdsByPermission($perm = 'access')
    {
        /** var Newbb\PermissionHandler $permHandler */
        $permHandler = \XoopsModules\Newbb\Helper::getInstance()->getHandler('Permission');

        return $permHandler->getCategories($perm);
    }

    /**
     * @param string $permission
     * @param null   $tags

Are you sure the doc-type for parameter $tags is correct as it would always require null to be passed?

     * @param bool   $asObject
     * @return array
     */
    public function &getByPermission($permission = 'access', $tags = null, $asObject = true)
    {
        $categories = [];
        if (!$valid_ids = $this->getIdsByPermission($permission)) {
            return $categories;
        }
        $criteria = new \Criteria('cat_id', '(' . \implode(', ', $valid_ids) . ')', 'IN');
        $criteria->setSort('cat_order');
        $categories = $this->getAll($criteria, $tags, $asObject);

        return $categories;
    }

    /**
     * @param \XoopsObject $category
     * @param bool         $force
     * @return mixed
     */
    public function insert(\XoopsObject $category, $force = true)
    {
        $className = Category::class;
        if (!($category instanceof $className)) {
            return false;
        }
        parent::insert($category, $force);
        if ($category->isNew()) {
            $this->applyPermissionTemplate($category);
        }

        return $category->getVar('cat_id');
    }

    /**
     * @param \XoopsObject $category
     * @param bool         $force
     * @return bool|mixed
     * @internal param Category $category
     */
    public function delete(\XoopsObject $category, $force = false)//delete(Category $category)
    {
        $className = Category::class;
        if (!($category instanceof $className)) {
            return false;
        }
        /** @var Newbb\ForumHandler $forumHandler */
        $forumHandler = \XoopsModules\Newbb\Helper::getInstance()->getHandler('Forum');
        $forumHandler->deleteAll(new \Criteria('cat_id', $category->getVar('cat_id')), true, true);
        $result = parent::delete($category);
        if ($result) {
            // Delete group permissions
            return $this->deletePermission($category);
        }
        $category->setErrors('delete category error');

        return false;
    }

    /**
     * Check permission for a category
     *
     * @param Category|int $category object or id
     * @param string       $perm     permission name
     *
     * @return bool
     */
    public function getPermission($category, $perm = 'access')
    {
        if ($GLOBALS['xoopsUserIsAdmin'] && 'newbb' === $GLOBALS['xoopsModule']->getVar('dirname')) {
            return true;
        }

        $cat_id = \is_object($category) ? $category->getVar('cat_id') : (int)$category;
        /** @var PermissionHandler $permHandler */
        $permHandler = \XoopsModules\Newbb\Helper::getInstance()->getHandler('Permission');

        return $permHandler->getPermission('category', $perm, $cat_id);
    }

    /**
     * @param Category $category
     * @return mixed
     */
    public function deletePermission(Category $category)
    {
        /** @var PermissionHandler $permHandler */
        $permHandler = \XoopsModules\Newbb\Helper::getInstance()->getHandler('Permission');

        return $permHandler->deleteByCategory($category->getVar('cat_id'));
    }

    /**
     * @param Category $category
     * @return mixed
     */
    public function applyPermissionTemplate(Category $category)
    {
        /** @var PermissionHandler $permHandler */
        $permHandler = \XoopsModules\Newbb\Helper::getInstance()->getHandler('Permission');

        return $permHandler->setCategoryPermission($category->getVar('cat_id'));
    }

    /**
     * @param mixed $object
     * @return bool
     */
    public function synchronization($object = null)
    {
        return true;
    }
}