XoopsModules\Xoopspoll\Renderer

Complexity

Total Complexity

26

Size/Duplication

Total Lines	196
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	renderResults()	0	6	1
A	renderForm()	0	6	1
A	__construct()	0	18	5
C	assignResults()	0	69	11
B	assignForm()	0	52	8

<?php

namespace XoopsModules\Xoopspoll;

/*
               XOOPS - PHP Content Management System
                   Copyright (c) 2000-2020 XOOPS.org
                      <https://xoops.org>
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or
 (at your option) any later version.

 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.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
*/

/**
 * Poll Renderer class for the XoopsPoll Module
 *
 * @copyright ::  {@link https://xoops.org/ XOOPS Project}
 * @license   ::  {@link http://www.fsf.org/copyleft/gpl.html GNU public license}
 * @package   ::  xoopspoll
 * @subpackage::  admin
 * @since     ::  1.0
 * @author    ::  {@link http://www.myweb.ne.jp/ Kazumi Ono (AKA onokazu)}
 */

use Xmf\Request;

Helper::getInstance()->loadLanguage('main');


/**
 * Class Renderer
 */
class Renderer
{
    // XoopsPoll class object
    protected $pollObj;
    protected $pollHandler;
    protected $optionHandler;
    protected $logHandler;
    protected $helper;

    // constructor(s)

    /**
     * @param null $poll

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

     * @param null $helper

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

     */
    public function __construct($poll = null, $helper = null)
    {
        if (null === $helper) {

The condition null === $helper is always true.

            $this->helper = Helper::getInstance();
        } else {
            $this->helper = $helper;
        }
        // setup handlers
        $this->pollHandler   =  $this->helper->getHandler('Poll');
        $this->optionHandler =  $this->helper->getHandler('Option');
        $this->logHandler    =  $this->helper->getHandler('Log');

        if ($poll instanceof Poll) {
            $this->pollObj = $poll;
        } elseif (!empty($poll) && ((int)$poll > 0)) {
            $this->pollObj = $this->pollHandler->get((int)$poll);
        } else {
            $this->pollObj = $this->pollHandler->create();
        }
    }

    /**
     * create html form to display poll
     * @access public
     * @return string html form for display
     */
    public function renderForm()
    {
        $myTpl = new \XoopsTpl();
        $this->assignForm($myTpl);  // get the poll information

        return $myTpl->fetch($GLOBALS['xoops']->path('modules/xoopspoll/templates/xoopspoll_view.tpl'));
    }

    /**
     * assigns form values to template for display
     * @access public
     * @var    \XoopsTpl $tpl
     */
    public function assignForm(\XoopsTpl $tpl)
    {
        $myts       = \MyTextSanitizer::getInstance();
        $optionObjs = $this->optionHandler->getAllByPollId($this->pollObj->getVar('poll_id'));

        if (empty($optionObjs)) {
            /* there was a problem with missing Options */
            //            redirect_header(Request::getString('HTTP_REFERER', '', 'SERVER'), Constants::REDIRECT_DELAY_MEDIUM, _MD_XOOPSPOLL_ERROR_OPTIONS_MISSING);
        }

        if (Constants::MULTIPLE_SELECT_POLL === $this->pollObj->getVar('multiple')) {
            $optionType = 'checkbox';
            $optionName = 'option_id[]';
        } else {
            $optionType = 'radio';
            $optionName = 'option_id';
        }
        foreach ($optionObjs as $optionObj) {
            $options[] = [
                'input' => "<input type='{$optionType}' " . "name='{$optionName}' " . "value='" . $optionObj->getVar('option_id') . "'>",
                'text'  => $optionObj->getVar('option_text'),
            ];
        }
        $uid = (isset($GLOBALS['xoopsUser'])
                     && \is_object($GLOBALS['xoopsUser'])) ? $GLOBALS['xoopsUser']->getVar('uid') : 0;
        $can_vote = false;
        if ($this->pollObj->isAllowedToVote()

The method isAllowedToVote() does not exist on XoopsObject. It seems like you code against a sub-type of XoopsObject such as XoopsModules\Xoopspoll\Poll.

            && (!$this->logHandler->hasVoted($this->pollObj->getVar('poll_id'), \xoops_getenv('REMOTE_ADDR'), $uid))) {
            $can_vote = true;
        }
        /*
                $tpl->assign('poll', array(
                                       'question'     => $myts->htmlSpecialChars($this->pollObj->getVar('question')),
                                       'pollId'       => $this->pollObj->getVar('poll_id'),
                                       'viewresults'  => $GLOBALS['xoops']->url("modules/xoopspoll/pollresults.php") . "?poll_id=" . $this->pollObj->getVar('poll_id'),
                                       'options'      => $options,
                                       'description'  => $myts->displayTarea($myts->undoHtmlSpecialChars($this->pollObj->getVar('description')), 1))
                );
        */
        $tpl->assign(
            [
                'poll'         => [
                    'question'    => $myts->htmlSpecialChars($this->pollObj->getVar('question')),
                    'pollId'      => $this->pollObj->getVar('poll_id'),
                    'viewresults' => $GLOBALS['xoops']->url('modules/xoopspoll/pollresults.php') . '?poll_id=' . $this->pollObj->getVar('poll_id'),
                    'options'     => $options ?? '',
                    'description' => $myts->displayTarea($myts->undoHtmlSpecialChars($this->pollObj->getVar('description')), 1),
                ],
                         'can_vote'     => $can_vote,
                         'action'       => $GLOBALS['xoops']->url('modules/xoopspoll/index.php'),
                'lang_vote'    => \_MD_XOOPSPOLL_VOTE,
                'lang_results' => \_MD_XOOPSPOLL_RESULTS,
            ]
        );
    }

    /**
     * display html results to screen (echo)
     * @access public
     */
    public function renderResults()
    {
        $myTpl = new \XoopsTpl();
        $this->assignResults($myTpl);  // get the poll information

        return $myTpl->fetch($GLOBALS['xoops']->path('modules/xoopspoll/templates/xoopspoll_results_renderer.tpl'));
    }

    /**
     * assigns form results to template
     * @access public
     * @var    \XoopsTpl tpl
     */
    public function assignResults(\XoopsTpl $tpl)
    {
        $myts             = \MyTextSanitizer::getInstance();
        $xuEndTimestamp   = \xoops_getUserTimestamp($this->pollObj->getVar('end_time'));
        $xuEndFormatted   = \ucfirst(\date(_MEDIUMDATESTRING, $xuEndTimestamp));
        $xuStartTimestamp = \xoops_getUserTimestamp($this->pollObj->getVar('start_time'));
        $xuStartFormatted = \ucfirst(\date(_MEDIUMDATESTRING, $xuStartTimestamp));

        //        $logHandler =  $this->helper->getHandler('Log');
        $criteria = new \CriteriaCompo();
        $criteria->add(new \Criteria('poll_id', $this->pollObj->getVar('poll_id'), '='));

It seems like $this->pollObj->getVar('poll_id') can also be of type array and array; however, parameter $value of Criteria::__construct() does only seem to accept string, maybe add an additional type check?

        $criteria->setSort('option_id');
        $optObjsArray = $this->optionHandler->getAll($criteria);
        $total        = $this->pollObj->getVar('votes');
        $i            = 0;
        foreach ($optObjsArray as $optObj) {
            $optionVars = $optObj->getValues();
            $percent    = ($total > 0) ? (100 * $optionVars['option_count'] / $total) : 0;
            if ($percent > 0) {
                $width                = (int)($percent * 2);
                $options[$i]['image'] = "<img src='" . $GLOBALS['xoops']->url("modules/xoopspoll/assets/images/colorbars/{$optionVars['option_color']}'") . " style='height: 14px; width: {$width}px; vertical-align: middle;' alt='" . (int)$percent . "%'>";
            } else {
                $options[$i]['image'] = '';
            }

            /* setup module config handler - required since this is called by newbb too */
            /** @var \XoopsModuleHandler $moduleHandler */
            $moduleHandler = \xoops_getHandler('module');
            $configHandler = \xoops_getHandler('config');
            $xp_module      = $moduleHandler->getByDirname('xoopspoll');
            $module_id      = $xp_module->getVar('mid');
            $xp_config      = $configHandler->getConfigsByCat(0, $module_id);

The method getConfigsByCat() does not exist on XoopsObjectHandler. It seems like you code against a sub-type of XoopsObjectHandler such as XoopsPersistableObjectHandler.

            if ($xp_config['disp_vote_nums']) {
                $options[$i]['percent'] = \sprintf(' %01.1f%% (%d)', $percent, $optionVars['option_count']);
            } else {
                $options[$i]['percent'] = \sprintf(' %01.1f%%', $percent);
            }
            $options[$i]['text']  = $optionVars['option_text'];
            $options[$i]['total'] = $optionVars['option_count'];
            $options[$i]['value'] = (int) $percent;
            ++$i;
            unset($optionVars);
        }
        $uid = (isset($GLOBALS['xoopsUser'])
                 && \is_object($GLOBALS['xoopsUser'])) ? $GLOBALS['xoopsUser']->getVar('uid') : 0;
            $vote = null;
        if (!$this->pollObj->hasExpired() && $this->pollObj->isAllowedToVote()

The method hasExpired() does not exist on XoopsObject. It seems like you code against a sub-type of XoopsObject such as XoopsModules\Xoopspoll\Poll.

            && !$this->logHandler->hasVoted($this->pollObj->getVar('poll_id'), \xoops_getenv('REMOTE_ADDR'), $uid)) {
            $vote = "<a href='" . $GLOBALS['xoops']->url('modules/xoopspoll/index.php') . '?poll_id=' . $this->pollObj->getVar('poll_id') . "'>" . \_MD_XOOPSPOLL_VOTE_NOW . '</a>';
        }
        if ($xp_config['disp_vote_nums']) {

The variable $xp_config seems to be defined by a foreach iteration on line 190. Are you sure the iterator is never empty, otherwise this variable is not defined?

            $totalVotes  = \sprintf(\_MD_XOOPSPOLL_TOTALVOTES, $total);

It seems like $total 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?

            $totalVoters = \sprintf(\_MD_XOOPSPOLL_TOTALVOTERS, $this->pollObj->getVar('voters'));
        } else {
            $totalVotes = $totalVoters = '';
        }

        $tpl->assign(
            'poll',
            [
            'question'    => $myts->htmlSpecialChars($this->pollObj->getVar('question')),
            'end_text'    => $xuEndFormatted,
            'start_text'  => $xuStartFormatted,
            'totalVotes'  => $totalVotes,
            'totalVoters' => $totalVoters,
            'vote'        => $vote,
            'options'     => $options,

The variable $options seems to be defined by a foreach iteration on line 190. Are you sure the iterator is never empty, otherwise this variable is not defined?

                'description' => $this->pollObj->getVar('description'), //allow html
            ]
        );
    }
}