XoopsModules\Yogurt\SuspensionsHandler

Complexity

Total Complexity

35

Size/Duplication

Total Lines	320
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	get2()	0	21	3
A	delete()	0	25	4
A	create()	0	14	2
B	getObjects()	0	44	7
A	__construct()	0	15	2
B	insert2()	0	84	9
A	deleteAll()	0	16	4
A	getCount()	0	18	4

<?php

declare(strict_types=1);

namespace XoopsModules\Yogurt;

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

/**
 * @category        Module
 * @package         yogurt
 * @copyright       {@link https://xoops.org/ XOOPS Project}
 * @license         GNU GPL 2 or later (https://www.gnu.org/licenses/gpl-2.0.html)
 * @author          Bruno Barthez, Marcello Brandão aka  Suico, Mamba, LioMJ  <https://xoops.org>
 */

use CriteriaElement;
use XoopsDatabase;
use XoopsObject;
use XoopsPersistableObjectHandler;

require_once XOOPS_ROOT_PATH . '/kernel/object.php';

// -------------------------------------------------------------------------
// ------------------Suspensions user handler class -------------------
// -------------------------------------------------------------------------

/**
 * Suspensionshandler class.
 * This class provides simple mecanisme for Suspensions object
 */
class SuspensionsHandler extends XoopsPersistableObjectHandler
{
    public $helper;

    public $isAdmin;

    /**
     * Constructor
     * @param \XoopsDatabase|null              $xoopsDatabase
     * @param \XoopsModules\Yogurt\Helper|null $helper
     */

    public function __construct(
        ?XoopsDatabase $xoopsDatabase = null,
        $helper = null
    ) {
        /** @var \XoopsModules\Yogurt\Helper $this ->helper */

        if (null === $helper) {
            $this->helper = Helper::getInstance();

The property helper does not seem to exist on XoopsModules\Yogurt\Helper.

        } else {
            $this->helper = $helper;
        }

        $isAdmin = $this->helper->isUserAdmin();

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

        parent::__construct($xoopsDatabase, 'yogurt_suspensions', Suspensions::class, 'uid', 'uid');
    }

    /**
     * create a new Groups
     *
     * @param bool $isNew flag the new objects as "new"?
     * @return \XoopsObject Groups
     */

    public function create(
        $isNew = true
    ) {
        $obj = parent::create($isNew);

        if ($isNew) {
            $obj->setNew();
        } else {
            $obj->unsetNew();
        }

        $obj->helper = $this->helper;

        return $obj;
    }

    /**
     * retrieve a Suspensions
     *
     * @param int  $id of the Suspensions
     * @param null $fields

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

     * @return mixed reference to the {@link Suspensions} object, FALSE if failed
     */

    public function get2(
        $id = null,
        $fields = null

The parameter $fields is not used and could be removed.

    ) {
        $sql = 'SELECT * FROM ' . $this->db->prefix('yogurt_suspensions') . ' WHERE uid=' . $id;

        if (!$result = $this->db->query($sql)) {
            return false;
        }

        $numrows = $this->db->getRowsNum($result);

        if (1 === $numrows) {
            $suspensions = new Suspensions();

            $suspensions->assignVars($this->db->fetchArray($result));

            return $suspensions;
        }

        return false;
    }

    /**
     * insert a new Suspensions in the database
     *
     * @param \XoopsObject $xoopsObject        reference to the {@link Suspensions}
     *                                         object
     * @param bool         $force
     * @return bool FALSE if failed, TRUE if already present and unchanged or successful
     */

    public function insert2(
        XoopsObject $xoopsObject,
        $force = false
    ) {
        global $xoopsConfig;

        if (!$xoopsObject instanceof Suspensions) {
            return false;
        }

        if (!$xoopsObject->isDirty()) {
            return true;
        }

        if (!$xoopsObject->cleanVars()) {
            return false;
        }

        $suspension_time = '';

        foreach ($xoopsObject->cleanVars as $k => $v) {
            ${$k} = $v;
        }

        //        $now = 'date_add(now(), interval ' . $xoopsConfig['server_TZ'] . ' hour)';

        $uid = 0;

        if ($xoopsObject->isNew()) {
            // ajout/modification d'un Suspensions

            $xoopsObject = new Suspensions();

            $format = 'INSERT INTO %s (uid, old_pass, old_email, old_signature, suspension_time)';

            $format .= 'VALUES (%u, %s, %s, %s, %u)';

            $sql = \sprintf(
                $format,
                $this->db->prefix('yogurt_suspensions'),
                $uid,
                $this->db->quoteString($old_pass),

The variable $old_pass seems to be never defined.

                $this->db->quoteString($old_email),

The variable $old_email seems to be never defined.

                $this->db->quoteString($old_signature),

The variable $old_signature seems to be never defined.

                $suspension_time
            );

            $force = true;
        } else {
            $format = 'UPDATE %s SET ';

            $format .= 'uid=%u, old_pass=%s, old_email=%s, old_signature=%s, suspension_time=%u';

            $format .= ' WHERE uid = %u';

            $sql = \sprintf(
                $format,
                $this->db->prefix('yogurt_suspensions'),
                $uid,
                $this->db->quoteString($old_pass),
                $this->db->quoteString($old_email),
                $this->db->quoteString($old_signature),
                $suspension_time,
                $uid
            );
        }

        if ($force) {
            $result = $this->db->queryF($sql);
        } else {
            $result = $this->db->query($sql);
        }

        if (!$result) {
            return false;
        }

        if (empty($uid)) {

The condition empty($uid) is always true.

            $uid = $this->db->getInsertId();
        }

        $xoopsObject->assignVar('uid', $uid);

        return true;
    }

    /**
     * delete a Suspensions from the database
     *
     * @param \XoopsObject $xoopsObject reference to the Suspensions to delete
     * @param bool         $force
     * @return bool FALSE if failed.
     */

    public function delete(
        XoopsObject $xoopsObject,
        $force = false
    ) {
        if (!$xoopsObject instanceof Suspensions) {
            return false;
        }

        $sql = \sprintf(
            'DELETE FROM %s WHERE uid = %u',
            $this->db->prefix('yogurt_suspensions'),
            $xoopsObject->getVar('uid')

It seems like $xoopsObject->getVar('uid') can also be of type array and array; however, parameter $args of sprintf() does only seem to accept string, maybe add an additional type check?

        );

        if ($force) {
            $result = $this->db->queryF($sql);
        } else {
            $result = $this->db->query($sql);
        }

        if (!$result) {
            return false;
        }

        return true;
    }

    /**
     * retrieve yogurt_suspensionss from the database
     *
     * @param \CriteriaElement|\CriteriaCompo|null $criteriaElement {@link \CriteriaElement} conditions to be met
     * @param bool                                 $id_as_key       use the UID as key for the array?
     * @param bool                                 $as_object
     * @return array array of {@link Suspensions} objects
     */

    public function &getObjects(
        ?CriteriaElement $criteriaElement = null,
        $id_as_key = false,
        $as_object = true
    ) {
        $ret = [];

        $limit = $start = 0;

        $sql = 'SELECT * FROM ' . $this->db->prefix('yogurt_suspensions');

        if (isset($criteriaElement) && $criteriaElement instanceof CriteriaElement) {
            $sql .= ' ' . $criteriaElement->renderWhere();

The method renderWhere() does not exist on CriteriaElement. Did you maybe mean render()?

            if ('' !== $criteriaElement->getSort()) {
                $sql .= ' ORDER BY ' . $criteriaElement->getSort() . ' ' . $criteriaElement->getOrder();
            }

            $limit = $criteriaElement->getLimit();

            $start = $criteriaElement->getStart();
        }

        $result = $this->db->query($sql, $limit, $start);

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

        while (false !== ($myrow = $this->db->fetchArray($result))) {
            $suspensions = new Suspensions();

            $suspensions->assignVars($myrow);

            if (!$id_as_key) {
                $ret[] = &$suspensions;
            } else {
                $ret[$myrow['uid']] = &$suspensions;
            }

            unset($suspensions);
        }

        return $ret;
    }

    /**
     * count yogurt_suspensionss matching a condition
     *
     * @param \CriteriaElement|\CriteriaCompo|null $criteriaElement {@link \CriteriaElement} to match
     * @return int count of yogurt_suspensionss
     */

    public function getCount(
        ?CriteriaElement $criteriaElement = null
    ) {
        $sql = 'SELECT COUNT(*) FROM ' . $this->db->prefix('yogurt_suspensions');

        if (isset($criteriaElement) && $criteriaElement instanceof CriteriaElement) {
            $sql .= ' ' . $criteriaElement->renderWhere();
        }

        $result = $this->db->query($sql);

        if (!$result) {
            return 0;
        }

        [$count] = $this->db->fetchRow($result);

        return (int)$count;
    }

    /**
     * delete yogurt_suspensionss matching a set of conditions
     *
     * @param \CriteriaElement|\CriteriaCompo|null $criteriaElement {@link \CriteriaElement}
     * @param bool                                 $force
     * @param bool                                 $asObject
     * @return bool FALSE if deletion failed
     */

    public function deleteAll(
        ?CriteriaElement $criteriaElement = null,
        $force = true,
        $asObject = false
    ) {
        $sql = 'DELETE FROM ' . $this->db->prefix('yogurt_suspensions');

        if (isset($criteriaElement) && $criteriaElement instanceof CriteriaElement) {
            $sql .= ' ' . $criteriaElement->renderWhere();
        }

        if (!$result = $this->db->queryF($sql)) {

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

            return false;
        }

        return true;
    }
}