XoopsModules25x / xfguestbook

class/MessageHandler.php

<?php

namespace XoopsModules\Xfguestbook;

/*
 * 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}
 * @package
 * @since
 * @author       XOOPS Development Team
 */

/**
 * Class MessageHandler
 */
class MessageHandler extends \XoopsPersistableObjectHandler
{
    /** @var \XoopsMySQLDatabase $db */
    public $db;

    /**
     * MessageHandler constructor.
     * @param \XoopsDatabase|null $db
     */
    public function __construct(\XoopsDatabase $db = null)
    {
        $this->db = $db;
    }

    /**
     * @param bool $isNew
     * @return Message
     */
    public function create($isNew = true)
    {
        return new Message();
    }

    /**
     * @param int|null $id
     * @param null     $fields

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

     * @return bool|string
     */
    public function get($id = null, $fields = null)
    {
        $id = (int)$id;
        if ($id > 0) {
            $sql = 'SELECT * FROM ' . $this->db->prefix('xfguestbook_msg') . ' WHERE msg_id=' . $id;
            if (!$result = $this->db->query($sql)) {
                return false;
            }
            $numrows = $this->db->getRowsNum($result);

It seems like $result can also be of type true; however, parameter $result of XoopsMySQLDatabase::getRowsNum() does only seem to accept mysqli_result, maybe add an additional type check?

            if (1 == $numrows) {
                $msg = new Message();
                $msg->assignVars($this->db->fetchArray($result));

It seems like $result can also be of type true; however, parameter $result of XoopsMySQLDatabase::fetchArray() does only seem to accept mysqli_result, maybe add an additional type check?

                return $msg;

The expression return $msg returns the type XoopsModules\Xfguestbook\Message which is incompatible with the documented return type boolean|string.

            }
        }

        return false;
    }

    /**
     * @param \XoopsObject $msg
     * @param bool         $force
     * @return bool
     */
    public function insert(\XoopsObject $msg, $force = true)
    {
        if (Message::class !== \get_class($msg)) {
            return false;
        }
        if (!$msg->cleanVars()) {
            return false;
        }
        foreach ($msg->cleanVars as $k => $v) {
            ${$k} = $v;
        }
        if (empty($msg_id)) {

The variable $msg_id seems to never exist and therefore empty should always be true.

            $msg_id = $this->db->genId('xfguestbook_msg_msg_id_seq');
            $sql    = 'INSERT INTO '
                      . $this->db->prefix('xfguestbook_msg')
                      . ' (msg_id, user_id, uname, title, message, note, post_time, email, url, poster_ip, moderate, gender, country, photo, flagdir, other) VALUES ('
                      . $msg_id
                      . ','
                      . $user_id

The variable $user_id seems to be never defined.

                      . ', '
                      . $this->db->quoteString($uname)

The variable $uname seems to be never defined.

                      . ', '
                      . $this->db->quoteString($title)

The variable $title seems to be never defined.

                      . ', '
                      . $this->db->quoteString($message)

The variable $message seems to be never defined.

                      . ', '
                      . $this->db->quoteString($note)

The variable $note seems to be never defined.

                      . ', '
                      . $post_time

The variable $post_time seems to be never defined.

                      . ',  '
                      . $this->db->quoteString($email)

The variable $email seems to be never defined.

                      . ', '
                      . $this->db->quoteString($url)

The variable $url seems to be never defined.

                      . ', '
                      . $this->db->quoteString($poster_ip)

The variable $poster_ip seems to be never defined.

                      . ', '
                      . $moderate

The variable $moderate seems to be never defined.

                      . ', '
                      . $this->db->quoteString($gender)

The variable $gender seems to be never defined.

                      . ', '
                      . $this->db->quoteString($country)

The variable $country seems to be never defined.

                      . ', '
                      . $this->db->quoteString($photo)

The variable $photo seems to be never defined.

                      . ', '
                      . $this->db->quoteString($flagdir)

The variable $flagdir seems to be never defined.

                      . ', '
                      . $this->db->quoteString($other)

The variable $other seems to be never defined.

                      . ')';
        } else {
            $sql = 'UPDATE '
                   . $this->db->prefix('xfguestbook_msg')
                   . ' SET user_id='
                   . $user_id
                   . ', uname='
                   . $this->db->quoteString($uname)
                   . ', title='
                   . $this->db->quoteString($title)
                   . ', message='
                   . $this->db->quoteString($message)
                   . ', note='
                   . $this->db->quoteString($note)
                   . ', email='
                   . $this->db->quoteString($email)
                   . ', url='
                   . $this->db->quoteString($url)
                   . ', moderate='
                   . $moderate
                   . ', gender='
                   . $this->db->quoteString($gender)
                   . ', country='
                   . $this->db->quoteString($country)
                   . ', photo='
                   . $this->db->quoteString($photo)
                   . ', flagdir='
                   . $this->db->quoteString($flagdir)
                   . ', other='
                   . $this->db->quoteString($other)
                   . ' WHERE msg_id='
                   . $msg_id;
        }
        if (!$result = $this->db->queryF($sql)) {

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

            return false;
        }
        if (empty($msg_id)) {
            $msg_id = $this->db->getInsertId();
        }
        $msg->assignVar('msg_id', $msg_id);

        return $msg_id;
    }

    /**
     * @param \XoopsObject $msg
     * @param bool         $force
     * @return bool
     */
    public function delete(\XoopsObject $msg, $force = false)
    {
        global $xoopsModule;
        if (Message::class !== \get_class($msg)) {
            return false;
        }
        $sql = \sprintf('DELETE FROM `%s` WHERE msg_id = %u', $this->db->prefix('xfguestbook_msg'), $msg->getVar('msg_id'));

It seems like $msg->getVar('msg_id') 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 (isset($this->commentstable) && '' !== $this->commentstable) {
            \xoops_comment_delete($xoopsModule->getVar('mid'), $msg_id);

The variable $msg_id seems to be never defined.

        }

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

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

            return false;
        }

        return true;
    }

    /**
     * @param null|\CriteriaElement|\CriteriaCompo $criteria
     * @param bool                                 $id_as_key
     * @param bool                                 $as_object
     * @return array
     */
    public function &getObjects(\CriteriaElement $criteria = null, $id_as_key = false, $as_object = true)//getObjects(\CriteriaElement $criteria = null)
    {
        $ret   = [];
        $limit = $start = 0;
        $sql   = 'SELECT * FROM ' . $this->db->prefix('xfguestbook_msg');
        if (null !== $criteria && $criteria instanceof \CriteriaElement) {
            $sql   .= ' ' . $criteria->renderWhere();

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

            $sort  = ('' !== $criteria->getSort()) ? $criteria->getSort() : 'msg_id';
            $sql   .= ' ORDER BY ' . $sort . ' ' . $criteria->getOrder();
            $limit = $criteria->getLimit();
            $start = $criteria->getStart();
        }
        $result = $this->db->query($sql, $limit, $start);
        if (!$result) {
            return $ret;
        }
        while (false !== ($myrow = $this->db->fetchArray($result))) {

It seems like $result can also be of type true; however, parameter $result of XoopsMySQLDatabase::fetchArray() does only seem to accept mysqli_result, maybe add an additional type check?

            $msg = new Message();
            $msg->assignVars($myrow);
            $ret[] = $msg;
            unset($msg);
        }

        return $ret;
    }

    /**
     * @param null|\CriteriaElement|\CriteriaCompo $criteria
     * @return int
     */
    public function countMsg(\CriteriaElement $criteria = null)
    {
        $sql = 'SELECT COUNT(*) FROM ' . $this->db->prefix('xfguestbook_msg');
        if (null !== $criteria && $criteria instanceof \CriteriaElement) {
            $sql .= ' ' . $criteria->renderWhere();
        }
        if (!$result = $this->db->query($sql)) {
            return 0;
        }
        [$count] = $this->db->fetchRow($result);

It seems like $result can also be of type true; however, parameter $result of XoopsMySQLDatabase::fetchRow() does only seem to accept mysqli_result, maybe add an additional type check?

        return $count;
    }

    /**
     * @param null|\CriteriaElement|\CriteriaCompo $criteria
     * @return array|bool
     */
    public function countMsgByCountry(\CriteriaElement $criteria = null)
    {
        $arr = [];
        $sql = 'SELECT country, flagdir FROM ' . $this->db->prefix('xfguestbook_msg');
        if (null !== $criteria && $criteria instanceof \CriteriaElement) {
            $sql .= ' ' . $criteria->renderWhere();
        }
        if (!$result = $this->db->query($sql)) {
            return false;
        }
        while (list($country, $flagdir) = $this->db->fetchRow($result)) {

It seems like $result can also be of type true; however, parameter $result of XoopsMySQLDatabase::fetchRow() does only seem to accept mysqli_result, maybe add an additional type check?

            $arr[] = $flagdir . '/' . $country;
        }
        $ret = \array_count_values($arr);
        \arsort($ret);

        return $ret;
    }

    /**
     * @param \CriteriaElement|\CriteriaCompo|null $criteria
     * @return array|bool
     */
    public function countMsgByGender(\CriteriaElement $criteria = null)
    {
        $arr = [];
        $sql = 'SELECT gender FROM ' . $this->db->prefix('xfguestbook_msg');
        if (null !== $criteria && $criteria instanceof \CriteriaElement) {
            $sql .= ' ' . $criteria->renderWhere();
        }
        if (!$result = $this->db->query($sql)) {
            return false;
        }
        while (list($gender) = $this->db->fetchRow($result)) {

It seems like $result can also be of type true; however, parameter $result of XoopsMySQLDatabase::fetchRow() does only seem to accept mysqli_result, maybe add an additional type check?

            $arr[] = $gender;
        }
        $ret = \array_count_values($arr);

        return $ret;
    }

    /**
     * @param null|\CriteriaElement|\CriteriaCompo $criteria
     * @return array|int
     */
    public function getMsgImg(\CriteriaElement $criteria = null)
    {
        $arr = [];
        $sql = 'SELECT photo FROM ' . $this->db->prefix('xfguestbook_msg') . " WHERE `photo` LIKE 'msg_%'";
        if (null !== $criteria && $criteria instanceof \CriteriaElement) {
            $sql .= ' ' . $criteria->renderWhere();
        }
        if (!$result = $this->db->query($sql)) {
            return 0;
        }
        while (list($photo) = $this->db->fetchRow($result)) {

It seems like $result can also be of type true; however, parameter $result of XoopsMySQLDatabase::fetchRow() does only seem to accept mysqli_result, maybe add an additional type check?

            $arr[] = $photo;
        }

        return $arr;
    }
}