VoteHandler::get() - Code Metrics - Inspection of "multi-voting updates" - mambax7/publisher - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Branch — master (160f79)

by Michael
created 2020-12-25 11:44 UTC
VoteHandler::get() A

↳ Parent: VoteHandler
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	2
dl	0
loc	3
rs	10
<?php

namespace XoopsModules\Publisher;

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

/**
 * Publisher module for xoops
 *
 * @copyright      module for xoops
 * @license        GPL 3.0 or later
 * @package        Publisher
 * @since          1.0
 * @min_xoops      2.5.10
 * @author         XOOPS Development Team
 */

/** @var Helper $helper */

\defined('XOOPS_ROOT_PATH') || exit('Restricted access');

/**
 * Class Object VoteHandler
 */
class VoteHandler extends \XoopsPersistableObjectHandler
{
    private const TABLE = 'publisher_rating';
    private const ENTITY = Vote::class;
    private const ENTITYNAME = 'Vote';
    private const KEYNAME = 'ratingid';
    private const IDENTIFIER = 'itemid';
    private const SOURCE = 'source';

    /**
     * @var Helper
     */
    public $helper;

    /**
     * Constructor
     * @param \XoopsDatabase $db
     * @param Helper $helper
     */
    public function __construct(\XoopsDatabase $db = null, Helper $helper = null)
    {
        $this->db = $db;
        /** @var Helper $this->helper */
        $this->helper = $helper ?? Helper::getInstance();

        parent::__construct($db, static::TABLE, static::ENTITY, static::KEYNAME, static::IDENTIFIER);
    }

    /**
     * get inserted id
     *
     * @param null
     * @return int reference to the {@link Get} object
     */
    public function getInsertId(): int
    {
        return $this->db->getInsertId();
    }

    /**
     * Get Rating per item in the database
     * @param int|null $itemId
     * @param int|null $source
     * @return array
     */
    public function getItemRating($itemId = null, $source = null): array
    {
        $itemId    = $itemId ?? 0;
        $source    = $source ?? 0;
        $helper    = Helper::getInstance();
        $xoopsUser = $GLOBALS['xoopsUser'];

        $itemRating            = [];
        $itemRating['nb_vote'] = 0;
        $uid                   = \is_object($xoopsUser) ? $xoopsUser->getVar('uid') : 0;
        $voted                 = false;
        $ip                    = \getenv('REMOTE_ADDR');
        $currentRating         = 0;
        $count                 = 0;

        $max_units   = 10;
        $ratingBars  = (int)$helper->getConfig('ratingbars');
        $ratingArray = [Constants::RATING_5STARS, Constants::RATING_10STARS, Constants::RATING_10NUM];

        if (in_array($ratingBars, $ratingArray)) {
            $rating_unitwidth = 25;
            if (Constants::RATING_5STARS === (int)$helper->getConfig('ratingbars')) {
                $max_units = 5;
            }

            $criteria = new \CriteriaCompo();
            $criteria->add(new \Criteria(static::IDENTIFIER, $itemId));
            $criteria->add(new \Criteria(static::SOURCE, $source));

            $voteObjs              = $helper->getHandler(static::ENTITYNAME)->getObjects($criteria);
            $voteObjs              = $helper->getHandler(static::ENTITYNAME)->/** @scrutinizer ignore-call */ getObjects($criteria);
            $count                 = \count($voteObjs);
            $itemRating['nb_vote'] = $count;

            foreach ($voteObjs as $voteObj) {
                $currentRating += $voteObj->getVar('rate');
                if (($voteObj->getVar('ip') == $ip && 0 == $uid) || ($uid > 0 && $uid == $voteObj->getVar('uid'))) {
                    $voted            = true;
                    $itemRating['id'] = $voteObj->getVar('ratingid');
                }
            }
            unset($criteria);

            $itemRating['avg_rate_value'] = 0;
            if ($count > 0) {
                $itemRating['avg_rate_value'] = \number_format($currentRating / $count, 2);
            }
            if (1 == $count) {
                $text      = \str_replace('%c', $itemRating['avg_rate_value'], \_MA_BLOG_RATING_CURRENT_1);
                $shorttext = \str_replace('%c', $itemRating['avg_rate_value'], \_MA_BLOG_RATING_CURRENT_SHORT_1);
            } else {
                $text      = \str_replace('%c', $itemRating['avg_rate_value'], \_MA_BLOG_RATING_CURRENT_X);
                $shorttext = \str_replace('%c', $itemRating['avg_rate_value'], \_MA_BLOG_RATING_CURRENT_SHORT_X);
            }
            $text                    = \str_replace('%m', $max_units, $text);
            $text                    = \str_replace('%t', $itemRating['nb_vote'], $text);
            $shorttext               = \str_replace('%t', $itemRating['nb_vote'], $shorttext);
            $itemRating['text']      = $text;
            $itemRating['shorttext'] = $shorttext;
            $itemRating['size']      = ($itemRating['avg_rate_value'] * $rating_unitwidth) . 'px';
            $itemRating['maxsize']   = ($max_units * $rating_unitwidth) . 'px';

            $itemRating['ip']    = $ip;
            $itemRating['uid']   = $uid;
            $itemRating['voted'] = $voted;
            // YouTube Liking  ==========================================
        } elseif (Constants::RATING_LIKES === (int)$helper->getConfig('ratingbars')) {
            // get count of "dislikes"
            $criteria = new \CriteriaCompo();
            $criteria->add(new \Criteria(static::IDENTIFIER, $itemId));
            $criteria->add(new \Criteria(static::SOURCE, $source));
            $criteria->add(new \Criteria('rate', 0, '<'));

            $voteObjs = $helper->getHandler(static::ENTITYNAME)->getObjects($criteria);
            $count    = \count($voteObjs);

            foreach ($voteObjs as $voteObj) {
                $currentRating += $voteObj->getVar('rate');
                if (($voteObj->getVar('ip') == $ip && 0 == $uid) || ($uid > 0 && $uid == $voteObj->getVar('uid'))) {
                    $voted            = true;
                    $itemRating['id'] = $voteObj->getVar('ratingid');
                }
            }
            unset($criteria);
            $itemRating['dislikes'] = $count;

            // get count of "likes"
            $criteria = new \CriteriaCompo();
            $criteria->add(new \Criteria(static::IDENTIFIER, $itemId));
            $criteria->add(new \Criteria(static::SOURCE, $source));
            $criteria->add(new \Criteria('rate', 0, '>'));

            $voteObjs      = $helper->getHandler(static::ENTITYNAME)->getObjects($criteria);
            $count         = \count($voteObjs);
            $currentRating = 0;
            foreach ($voteObjs as $voteObj) {
                $currentRating += $voteObj->getVar('rate');
                if (($voteObj->getVar('ip') == $ip && 0 == $uid) || ($uid > 0 && $uid == $voteObj->getVar('uid'))) {
                    $voted            = true;
                    $itemRating['id'] = $voteObj->getVar('ratingid');
                }
            }
            unset($criteria);
            $itemRating['likes'] = $count;

            $itemRating['nb_vote'] = $itemRating['likes'] + $itemRating['dislikes'];
            $itemRating['ip']      = $ip;
            $itemRating['uid']     = $uid;
            $itemRating['voted']   = $voted;
            // Facebook Reactions  ==========================================
        } elseif (Constants::RATING_REACTION === (int)$helper->getConfig('ratingbars')) {
            $criteria = new \CriteriaCompo();
            $criteria->add(new \Criteria(static::IDENTIFIER, $itemId));
            $criteria->add(new \Criteria(static::SOURCE, $source));
            $criteria->add(new \Criteria('rate', 0, '<'));

            $voteObjs              = $helper->getHandler(static::ENTITYNAME)->getObjects($criteria);
            $count                 = \count($voteObjs);
            $itemRating['nb_vote'] = $count;

            foreach ($voteObjs as $voteObj) {
                $currentRating += $voteObj->getVar('rate');
                if (($voteObj->getVar('ip') == $ip && 0 == $uid) || ($uid > 0 && $uid == $voteObj->getVar('uid'))) {
                    $voted            = true;
                    $itemRating['id'] = $voteObj->getVar('ratingid');
                }
            }
            unset($criteria);
            $itemRating['dislikes'] = $count;

            $criteria = new \CriteriaCompo();
            $criteria->add(new \Criteria(static::IDENTIFIER, $itemId));
            $criteria->add(new \Criteria(static::SOURCE, $source));
            $criteria->add(new \Criteria('rate', 0, '>'));

            $voteObjs      = $helper->getHandler(static::ENTITYNAME)->getObjects($criteria);
            $count         = \count($voteObjs);
            $currentRating = 0;
            foreach ($voteObjs as $voteObj) {
                $currentRating += $voteObj->getVar('rate');
                if (($voteObj->getVar('ip') == $ip && 0 == $uid) || ($uid > 0 && $uid == $voteObj->getVar('uid'))) {
                    $voted            = true;
                    $itemRating['id'] = $voteObj->getVar('ratingid');
                }
            }
            unset($criteria);
            $itemRating['likes'] = $count;

            $itemRating['nb_vote'] = $itemRating['likes'] + $itemRating['dislikes'];
            $itemRating['ip']      = $ip;
            $itemRating['uid']     = $uid;
            $itemRating['voted']   = $voted;
        } else {
            $itemRating['uid']     = $uid;
            $itemRating['nb_vote'] = $count;
            $itemRating['voted']   = $voted;
            $itemRating['ip']      = $ip;
        }
        return $itemRating;
    }

    /**
     * delete vote of given item
     * @param mixed $itemId
     * @param mixed $source
     * @return bool
     */
    public function deleteAllVote($itemId, $source): bool
    {
        $criteria = new \CriteriaCompo();
        $criteria->add(new \Criteria(static::IDENTIFIER, $itemId));
        $criteria->add(new \Criteria(static::SOURCE, $source));

        return $this->deleteAll($criteria);
    }
}

mambax7 / publisher

Branch — master (160f79)

VoteHandler::get() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
