XoopsModules25x / suico

class/VisitorsHandler.php

<?php declare(strict_types=1);

namespace XoopsModules\Suico;

/*
 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
 * @copyright       {@link https://xoops.org/ XOOPS Project}
 * @license         GNU GPL 2.0 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';

/**
 * suico_visitorshandler class.
 * This class provides simple mechanism for Suico\Visitors object
 */
class VisitorsHandler extends XoopsPersistableObjectHandler
{
    public Helper $helper;
    public        $isAdmin;

    /**
     * Constructor
     * @param \XoopsDatabase|null             $xoopsDatabase
     * @param \XoopsModules\Suico\Helper|null $helper
     */
    public function __construct(
        ?XoopsDatabase $xoopsDatabase = null,
        $helper = null
    ) {
        /** @var \XoopsModules\Suico\Helper $this- >helper */
        if (null === $helper) {
            $this->helper = Helper::getInstance();
        } else {
            $this->helper = $helper;
        }
        $this->isAdmin = $this->helper->isUserAdmin();
        parent::__construct($xoopsDatabase, 'suico_visitors', Visitors::class, 'visit_id', 'uname_visitor');
    }

    /**
     * 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 Suico\Visitors
     *
     * @param int|null $id of the Suico\Visitors
     * @param null     $fields

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

     * @return false|\XoopsModules\Suico\Visitors reference to the {@link suico_visitors} 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('suico_visitors') . ' WHERE visit_id=' . $id;
        if (!$result = $this->db->query($sql)) {
            return false;
        }
        $numrows = $this->db->getRowsNum($result);
        if (1 === $numrows) {
            $visitors = new Visitors();
            $visitors->assignVars($this->db->fetchArray($result));

            return $visitors;
        }

        return false;
    }

    /**
     * insert a new Visitors in the database
     *
     * @param \XoopsObject $xoopsObject     reference to the {@link Visitors}
     *                                      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 Visitors) {
            return false;
        }
        if (!$xoopsObject->isDirty()) {
            return true;
        }
        if (!$xoopsObject->cleanVars()) {
            return false;
        }
        $uid_visitor = '';
        $uid_owner   = '';
        $visit_id    = '';
        foreach ($xoopsObject->cleanVars as $k => $v) {
            ${$k} = $v;
        }
        //        $now = 'date_add(now(), interval ' . $xoopsConfig['server_TZ'] . ' hour)';
        if ($xoopsObject->isNew()) {
            // ajout/modification d'un Suico\Visitors
            $xoopsObject = new Visitors();
            $format      = 'INSERT INTO %s (visit_id, uid_owner, uid_visitor, uname_visitor, date_visited)';
            $format      .= 'VALUES (%u, %u, %u, %s, %u)';
            $sql         = \sprintf(
                $format,
                $this->db->prefix('suico_visitors'),
                $visit_id,
                $uid_owner,
                $uid_visitor,
                $this->db->quoteString($uname_visitor),

The variable $uname_visitor seems to be never defined.

                \time()
            );
            $force       = true;
        } else {
            $format = 'UPDATE %s SET ';
            $format .= 'visit_id=%u, uid_owner=%u, uid_visitor=%u, uname_visitor=%s, date_visited=%u ';
            $format .= ' WHERE visit_id = %u';
            $sql    = \sprintf(
                $format,
                $this->db->prefix('suico_visitors'),
                $visit_id,
                $uid_owner,
                $uid_visitor,
                \time(),
                $this->db->quoteString($uname_visitor),
                $visit_id
            );
        }
        if ($force) {
            $result = $this->db->queryF($sql);
        } else {
            $result = $this->db->query($sql);
        }
        if (!$result) {
            return false;
        }
        if (empty($visit_id)) {
            $visit_id = $this->db->getInsertId();
        }
        $xoopsObject->assignVar('visit_id', $visit_id);

        return true;
    }

    /**
     * delete a suico_visitors from the database
     *
     * @param \XoopsObject $xoopsObject reference to the Suico\Visitors to delete
     * @param bool         $force
     * @return bool FALSE if failed.
     */
    public function delete2(
        XoopsObject $xoopsObject,
        $force = false
    ) {
        if (!$xoopsObject instanceof Visitors) {
            return false;
        }
        $sql = \sprintf(
            'DELETE FROM %s WHERE visit_id = %u',
            $this->db->prefix('suico_visitors'),
            (int)$xoopsObject->getVar('visit_id')
        );
        if ($force) {
            $result = $this->db->queryF($sql);
        } else {
            $result = $this->db->query($sql);
        }
        if (!$result) {
            return false;
        }

        return true;
    }

    /**
     * count suico_visitorss matching a condition
     *
     * @param \CriteriaElement|\CriteriaCompo|null $criteria {@link \CriteriaElement} to match
     * @return int count of suico_visitorss
     */
    public function getCount(
        ?CriteriaElement $criteria = null
    ) {
        $sql = 'SELECT COUNT(*) FROM ' . $this->db->prefix('suico_visitors');
        if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
            $sql .= ' ' . $criteria->renderWhere();

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

        }
        $result = $this->db->query($sql);
        if (!$result) {
            return 0;
        }
        [$count] = $this->db->fetchRow($result);

        return $count;
    }

    /**
     * delete suico_visitorss matching a set of conditions
     *
     * @param \CriteriaElement|\CriteriaCompo|null $criteria {@link \CriteriaElement}
     * @param bool                                 $force
     * @param bool                                 $asObject
     * @return bool FALSE if deletion failed
     */
    public function deleteAll(
        ?CriteriaElement $criteria = null,
        $force = true,
        $asObject = false
    ) {
        $sql = 'DELETE FROM ' . $this->db->prefix('suico_visitors');
        if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
            $sql .= ' ' . $criteria->renderWhere();
        }
        if ($force) {
            if (!$result = $this->db->queryF($sql)) {

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

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

        return true;
    }

    /**
     * @return bool
     */
    public function purgeVisits()
    {
        $sql = 'DELETE FROM ' . $this->db->prefix(
                'suico_visitors'
            ) . ' WHERE (date_visited<UNIX_TIMESTAMP(DATE_SUB(NOW(), INTERVAL 7 DAY))) ';
        if (!$result = $this->db->queryF($sql)) {

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

            return false;
        }

        return true;
    }
}