XoopsModules\Songlist\Songs

Complexity

Total Complexity

32

Size/Duplication

Total Lines	166
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getForm()	0	3	1
A	__construct()	0	19	1
F	toArray()	0	113	28
A	getURL()	0	8	2

<?php declare(strict_types=1);

namespace XoopsModules\Songlist;

use Criteria;
use MyTextSanitizer;
use XoopsObject;

require_once \dirname(__DIR__) . '/include/songlist.object.php';
// require_once \dirname(__DIR__) . '/include/songlist.form.php';
use  XoopsModules\Songlist\Form\FormController;

/**
 * Class Songs
 */
class Songs extends XoopsObject
{
    /**
     * Songs constructor.
     * @param null $fid

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

     */
    public function __construct($fid = null)
    {
        $this->initVar('sid', \XOBJ_DTYPE_INT, 0, false);
        $this->initVar('cid', \XOBJ_DTYPE_INT, 0, false);
        $this->initVar('gids', \XOBJ_DTYPE_ARRAY, 0, false);
        $this->initVar('vcid', \XOBJ_DTYPE_INT, 0, false);
        $this->initVar('aids', \XOBJ_DTYPE_ARRAY, [], false);
        $this->initVar('abid', \XOBJ_DTYPE_INT, 0, false);
        $this->initVar('songid', \XOBJ_DTYPE_TXTBOX, null, false, 32);
        $this->initVar('traxid', \XOBJ_DTYPE_TXTBOX, null, false, 32);
        $this->initVar('title', \XOBJ_DTYPE_TXTBOX, null, false, 128);
        $this->initVar('lyrics', \XOBJ_DTYPE_OTHER, null, false);
        $this->initVar('hits', \XOBJ_DTYPE_INT, 0, false);
        $this->initVar('rank', \XOBJ_DTYPE_DECIMAL, 0, false);
        $this->initVar('votes', \XOBJ_DTYPE_INT, 0, false);
        $this->initVar('tags', \XOBJ_DTYPE_TXTBOX, null, false, 255);
        $this->initVar('mp3', \XOBJ_DTYPE_OTHER, null, false, 500);
        $this->initVar('created', \XOBJ_DTYPE_INT, 0, false);
        $this->initVar('updated', \XOBJ_DTYPE_INT, 0, false);
    }

    /**
     * @param bool $as_array
     * @return array|string
     */
    public function getForm($as_array = false)
    {
        return FormController::getFormSongs($this, $as_array);
    }

    /**
     * @param bool $extra
     * @return array
     */
    public function toArray($extra = true): array
    {
        $ret = parent::toArray();

        $GLOBALS['myts'] = MyTextSanitizer::getInstance();

        $ret['lyrics'] = $GLOBALS['myts']->displayTarea($this->getVar('lyrics'), true, true, true, true, true);

        $form = $this->getForm(true);
        foreach ($form as $key => $element) {
            $ret['form'][$key] = $element->render();
        }
        foreach (['created', 'updated'] as $key) {
            if ($this->getVar($key) > 0) {
                $ret['form'][$key] = \date(_DATESTRING, $this->getVar($key));
                $ret[$key]         = \date(_DATESTRING, $this->getVar($key));
            }
        }

        $ret['url'] = $this->getURL();

        $ret['rank'] = \number_format(($this->getVar('rank') > 0 && $this->getVar('votes') > 0 ? $this->getVar('rank') / $this->getVar('votes') : 0), 2) . \_MI_SONGLIST_OFTEN;

        if (!empty($ret['mp3'])) {
            $ret['mp3'] = '<embed flashvars="playerID=1&amp;bg=0xf8f8f8&amp;leftbg=0x3786b3&amp;lefticon=0x78bee3&amp;rightbg=0x3786b3&amp;rightbghover=0x78bee3&amp;righticon=0x78bee3&amp;righticonhover=0x3786b3&amp;text=0x666666&amp;slider=0x3786b3&amp;track=0xcccccc&amp;border=0x666666&amp;loader=0x78bee3&amp;loop=no&amp;soundFile='
                          . $ret['mp3']
                          . "\" quality='high' menu='false' wmode='transparent' pluginspage='https://www.macromedia.com/go/getflashplayer' src='"
                          . XOOPS_URL
                          . "/images/form/player.swf'  width=290 height=24 type='application/x-shockwave-flash'></embed>";
        }

        $helper = Helper::getInstance();
        if (1 == $helper->getConfig('tags')
            && \class_exists(\XoopsModules\Tag\Tagbar::class)
            && \xoops_isActiveModule('tag')) {
            $tagbarObj     = new \XoopsModules\Tag\Tagbar();
            $ret['tagbar'] = $tagbarObj->getTagbar($this->getVar('sid'), $this->getVar('cid'));

It seems like $this->getVar('sid') can also be of type boolean and string; however, parameter $tags of XoopsModules\Tag\Tagbar::getTagbar() does only seem to accept array|integer, maybe add an additional type check?

        }

        $extrasHandler     = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Extras');
        $fieldHandler      = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Field');
        $visibilityHandler = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Visibility');

        $extras = $extrasHandler->get($this->getVar('sid'));
        if ($extras) {

$extras is of type object, thus it always evaluated to true.

            if (\is_object($GLOBALS['xoopsUser'])) {
                $fields_id = $visibilityHandler->getVisibleFields([], $GLOBALS['xoopsUser']->getGroups());
            } elseif (!\is_object($GLOBALS['xoopsUser'])) {
                $fields_id = $visibilityHandler->getVisibleFields([], []);
            }

            if (\count($fields_id) > 0) {

The variable $fields_id does not seem to be defined for all execution paths leading up to this point.

                $criteria = new Criteria('field_id', '(' . \implode(',', $fields_id) . ')', 'IN');
                $criteria->setSort('field_weight');
                $fields = $fieldHandler->getObjects($criteria, true);
                foreach ($fields as $id => $field) {
                    if (\in_array($this->getVar('cid'), $field->getVar('cids'), true)) {
                        $ret['fields'][$id]['title'] = $field->getVar('field_title');
                        if (\is_object($GLOBALS['xoopsUser'])) {
                            $ret['fields'][$id]['value'] = htmlspecialchars_decode($field->getOutputValue($GLOBALS['xoopsUser'], $extras));
                        } elseif (!\is_object($GLOBALS['xoopsUser'])) {
                            $ret['fields'][$id]['value'] = htmlspecialchars_decode($extras->getVar($field->getVar('field_name')));
                        }
                    }
                }
            }
        }

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

        if (0 != $this->getVar('cid')) {
            $categoryHandler = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Category');
            $category        = $categoryHandler->get($this->getVar('cid'));
            $ret['category'] = $category->toArray(false);

The call to XoopsObject::toArray() has too many arguments starting with false.

        }

        if (0 != \count($this->getVar('gids'))) {

It seems like $this->getVar('gids') can also be of type boolean and null and string; however, parameter $value of count() does only seem to accept Countable|array, maybe add an additional type check?

            $i            = 0;
            $genreHandler = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Genre');
            $ret['genre'] = '';
            $genres       = $genreHandler->getObjects(new Criteria('gid', '(' . \implode(',', $this->getVar('gids')) . ')', 'IN'), true);

It seems like $this->getVar('gids') can also be of type boolean and null and string; however, parameter $pieces of implode() does only seem to accept array, maybe add an additional type check?

            foreach ($genres as $gid => $genre) {
                $ret['genre_array'][$gid] = $genre->toArray(false);
                ++$i;
                $ret['genre'] .= $genre->getVar('name') . ($i < \count($genres) ? ', ' : '');
            }
        }
        if (0 != $this->getVar('vcid')) {
            $voiceHandler = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Voice');
            $voice        = $voiceHandler->get($this->getVar('vcid'));
            $ret['voice'] = $voice->toArray(false);
        }

        if (0 != \count($this->getVar('aids'))) {
            $artistsHandler = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Artists');
            foreach ($this->getVar('aids') as $aid) {
                $artist                     = $artistsHandler->get($aid);
                $ret['artists_array'][$aid] = $artist->toArray(false);
            }
        }

        if (0 != $this->getVar('abid')) {
            $albumsHandler = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Albums');
            $albums        = $albumsHandler->get($this->getVar('abid'));
            if (null !== $albums) {
                $ret['albums'] = $albums->toArray(false);
            }

        }

        return $ret;
    }

    /**
     * @return string
     */
    public function getURL(): string
    {
        global $file, $op, $fct, $id, $value, $vcid, $gid, $cid, $start, $limit;
        if ($GLOBALS['songlistModuleConfig']['htaccess']) {
            return XOOPS_URL . '/' . $GLOBALS['songlistModuleConfig']['baseofurl'] . '/index/' . \urlencode(\str_replace([' ', \chr(9)], '-', $this->getVar('title'))) . '/item-item-' . $this->getVar('sid') . $GLOBALS['songlistModuleConfig']['endofurl'];
        }

        return XOOPS_URL . '/modules/songlist/index.php?op=item&fct=item&id=' . $this->getVar('sid') . '&value=' . \urlencode($value ?? '') . '&vcid=' . $vcid . '&gid=' . $gid . '&cid=' . $cid;
    }
}