XoopsModules25x / xhelp

class/SavedSearchHandler.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';

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

    private const TABLE = 'xhelp_saved_searches';
    private const ENTITY = SavedSearch::class;
    private const ENTITYNAME = 'SavedSearch';
    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, uid, NAME, search, pagenav_vars, hasCustFields) VALUES (%u, %d, %s, %s, %s, %u)', $this->db->prefix($this->dbtable), $id, $uid, $this->db->quoteString($name), $this->db->quoteString($search), $this->db->quoteString($pagenav_vars), $hasCustFields);

The variable $pagenav_vars seems to be never defined.

The variable $id seems to be never defined.

The variable $name seems to be never defined.

The variable $uid seems to be never defined.

The variable $hasCustFields seems to be never defined.

The variable $search 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 uid = %d, NAME = %s, search = %s, pagenav_vars = %s, hasCustFields = %u WHERE id = %u', $this->db->prefix($this->dbtable), $uid, $this->db->quoteString($name), $this->db->quoteString($search), $this->db->quoteString($pagenav_vars), $hasCustFields, $id);

The variable $hasCustFields seems to be never defined.

The variable $search seems to be never defined.

The variable $uid seems to be never defined.

The variable $pagenav_vars seems to be never defined.

The variable $id seems to be never defined.

The variable $name 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  $uid
     * @param bool $has_global
     * @return array
     */
    public function getByUid(int $uid, bool $has_global = false): array
    {
        $uid = $uid;
        if ($has_global) {
            $criteria = new \CriteriaCompo(new \Criteria('uid', $uid), 'OR');
            $criteria->add(new \Criteria('uid', \XHELP_GLOBAL_UID), 'OR');
        } else {
            $criteria = new \Criteria('uid', $uid);
        }
        $criteria->setOrder('ASC');
        $criteria->setSort('name');
        $ret = $this->getObjects($criteria);

        return $ret;
    }

    /**
     * @param \CriteriaElement|\CriteriaCompo $criteria
     * @return string
     */
    public function createSQL($criteria): string
    {
        $sql = $this->selectQuery($criteria);

        return $sql;
    }

    /**
     * delete department matching a set of conditions
     *
     * @param \CriteriaElement|\CriteriaCompo|null $criteria {@link \CriteriaElement}
     * @return bool   FALSE if deletion failed
     */
    public function deleteAll(\CriteriaElement $criteria = null, $force = true, $asObject = false): bool
    {
        $sql = 'DELETE FROM ' . $this->db->prefix($this->dbtable);
        if (($criteria instanceof \CriteriaCompo) || ($criteria instanceof \Criteria)) {
            $sql .= ' ' . $criteria->renderWhere();
        }
        if (!$result = $this->db->query($sql)) {

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

            return false;
        }

        return true;
    }
}