XoopsModules25x / xhelp

class/StatusHandler.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       Eric Juden <ericj@epcusa.com>
 * @author       XOOPS Development Team
 */

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

// require_once XHELP_CLASS_PATH . '/BaseObjectHandler.php';

/**
 * StatusHandler class
 *
 * Status Handler for Status class
 *
 * @author  Eric Juden <ericj@epcusa.com> &
 */
class StatusHandler extends BaseObjectHandler
{
    /**
     * Name of child class
     *
     * @var string
     */
    public $classname = Status::class;
    /**
     * DB table name
     *
     * @var string
     */
    public $dbtable = 'xhelp_status';

    private const TABLE = 'xhelp_status';
    private const ENTITY = Status::class;
    private const ENTITYNAME = 'Status';
    private const KEYNAME = 'id';
    private const IDENTIFIER = 'state';

    /**
     * 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, state, description) VALUES (%u, %u, %s)', $this->db->prefix($this->dbtable), $id, $state, $this->db->quoteString($description));

The variable $description seems to be never defined.

The variable $state seems to be never defined.

The variable $id 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 state = %u, description = %s WHERE id = %u', $this->db->prefix($this->dbtable), $state, $this->db->quoteString($description), $id);

The variable $description seems to be never defined.

The variable $id seems to be never defined.

The variable $state 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;
    }

    /**
     * @param int $state
     * @return array
     */
    public function &getStatusesByState(int $state): array
    {
        $aStatuses = [];

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

        $state     = $state;
        $criteria  = new \Criteria('state', $state);
        $aStatuses = $this->getObjects($criteria, true);

        return $aStatuses;
    }
}