XoopsModules25x / xhelp

class/RoleHandler.php

<?php declare(strict_types=1);

namespace XoopsModules\Xhelp;

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

if (!\defined('XHELP_CLASS_PATH')) {
    exit();
}
// require_once XHELP_CLASS_PATH . '/BaseObjectHandler.php';

/**
 * class RoleHandler
 */
class RoleHandler extends BaseObjectHandler
{
    /**
     * Name of child class
     *
     * @var string
     */
    public $classname = Role::class;
    /**
     * DB Table Name
     *
     * @var string
     */
    public $dbtable = 'xhelp_roles';

    private const TABLE = 'xhelp_roles';
    private const ENTITY = Role::class;
    private const ENTITYNAME = 'Role';
    private const KEYNAME = 'id';
    private const IDENTIFIER = 'name';

    /**
     * Constructor
     *
     * @param \XoopsMySQLDatabase|null $db reference to a xoopsDB object
     */
    public function __construct(\XoopsMySQLDatabase $db = null)
    {
        $this->init($db);
        $this->helper = Helper::getInstance();
        parent::__construct($db, static::TABLE, static::ENTITY, static::KEYNAME, static::IDENTIFIER);
    }

    /**
     * @param \XoopsObject $object
     * @return string
     */
    public function insertQuery(\XoopsObject $object): string
    {
        //TODO mb replace with individual variables
        // Copy all object vars into local variables
        foreach ($object->cleanVars as $k => $v) {
            ${$k} = $v;
        }

        $sql = \sprintf('INSERT INTO `%s` (id, NAME, description, tasks) VALUES (%u, %s, %s, %u)', $this->db->prefix($this->dbtable), $id, $this->db->quoteString($name), $this->db->quoteString($description), $tasks);

The variable $tasks seems to be never defined.

The variable $name seems to be never defined.

The variable $id seems to be never defined.

The variable $description seems to be never defined.

        return $sql;
    }

    /**
     * @param \XoopsObject $object
     * @return string
     */
    public function updateQuery(\XoopsObject $object): string
    {
        //TODO mb replace with individual variables
        // Copy all object vars into local variables
        foreach ($object->cleanVars as $k => $v) {
            ${$k} = $v;
        }

        $sql = \sprintf('UPDATE `%s` SET NAME = %s, description = %s, tasks = %u WHERE id = %u', $this->db->prefix($this->dbtable), $this->db->quoteString($name), $this->db->quoteString($description), $tasks, $id);

The variable $description seems to be never defined.

The variable $tasks seems to be never defined.

The variable $name seems to be never defined.

The variable $id seems to be never defined.

        return $sql;
    }

    /**
     * @param \XoopsObject $object
     * @return string
     */
    public function deleteQuery(\XoopsObject $object): string
    {
        $sql = \sprintf('DELETE FROM `%s` WHERE id = %u', $this->db->prefix($this->dbtable), $object->getVar('id'));

It seems like $object->getVar('id') can also be of type array and array; however, parameter $values of sprintf() does only seem to accept double|integer|string, maybe add an additional type check?

        return $sql;
    }

    /**
     * delete a role from the database
     *
     * @param \XoopsObject $object    reference to the {@link Role}
     *                                obj to delete
     * @param bool         $force
     * @return bool FALSE if failed.
     */
    public function delete(\XoopsObject $object, $force = false): bool
    {
        // Remove staff roles from db first
        $staffRoleHandler = $this->helper->getHandler('StaffRole');
        if (!$staffRoleHandler->deleteAll(new \Criteria('roleid', $object->getVar('id')))) {

It seems like $object->getVar('id') can also be of type array and array; however, parameter $value of Criteria::__construct() does only seem to accept string, maybe add an additional type check?

            return false;
        }

        $ret = parent::delete($object, $force);

        return $ret;
    }

    /**
     * @param int $task
     * @return array
     */
    public function getRolesByTask(int $task): array
    {
        $task = $task;

        // Get all roles
        $roles = $this->getObjects();

        $aRoles = [];
        foreach ($roles as $role) {
            if (($role->getVar('tasks') & (2 ** $task)) > 0) {
                $aRoles[$role->getVar('id')] = $role;
            }
        }

        return $aRoles;
    }
}