XoopsModules25x / songlist

class/ArtistsHandler.php

<?php declare(strict_types=1);

namespace XoopsModules\Songlist;

use Criteria;
use CriteriaCompo;
use XoopsDatabase;

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

/**
 * Class ArtistsHandler
 */
class ArtistsHandler extends \XoopsPersistableObjectHandler
{
    /**
     * ArtistsHandler constructor.
     * @param \XoopsDatabase $db
     */
    public function __construct(XoopsDatabase $db)
    {
        parent::__construct($db, 'songlist_artists', Artists::class, 'aid', 'name');
    }

    /**
     * @return array
     */
    public function filterFields(): array
    {
        return ['aid', 'cids', 'singer', 'name', 'albums', 'songs', 'hits', 'rank', 'votes', 'created', 'updated'];
    }

    /**
     * @param $filter
     * @return \CriteriaCompo
     */
    public function getFilterCriteria($filter): CriteriaCompo
    {
        $parts    = \explode('|', $filter);
        $criteria = new CriteriaCompo();
        foreach ($parts as $part) {
            $var = \explode(',', $part);
            if (!empty($var[1]) && !\is_numeric($var[0])) {
                $object = $this->create();
                if (\XOBJ_DTYPE_TXTBOX == $object->vars[$var[0]]['data_type']
                    || \XOBJ_DTYPE_TXTAREA == $object->vars[$var[0]]['data_type']) {
                    $criteria->add(new Criteria('`' . $var[0] . '`', '%' . $var[1] . '%', ($var[2] ?? 'LIKE')));
                } elseif (in_array($object->vars[$var[0]]['data_type'], [XOBJ_DTYPE_INT, XOBJ_DTYPE_DECIMAL, XOBJ_DTYPE_FLOAT])) {
                    $criteria->add(new Criteria('`' . $var[0] . '`', $var[1], ($var[2] ?? '=')));
                } elseif (\XOBJ_DTYPE_ENUM == $object->vars[$var[0]]['data_type']) {
                    $criteria->add(new Criteria('`' . $var[0] . '`', $var[1], ($var[2] ?? '=')));
                } elseif (\XOBJ_DTYPE_ARRAY == $object->vars[$var[0]]['data_type']) {
                    $criteria->add(new Criteria('`' . $var[0] . '`', '%"' . $var[1] . '";%', ($var[2] ?? 'LIKE')));
                }
            } elseif (!empty($var[1]) && \is_numeric($var[0])) {
                $criteria->add(new Criteria($var[0], $var[1]));
            }
        }

        return $criteria;
    }

    /**
     * @param        $filter
     * @param        $field
     * @param string $sort
     * @param string $op
     * @param string $fct
     * @return string
     */
    public function getFilterForm($filter, $field, $sort = 'created', $op = 'dashboard', $fct = 'list'): string
    {
        $ele = Utility::getFilterElement($filter, $field, $sort, $op, $fct);
        if (\is_object($ele)) {
            return $ele->render();
        }

        return '&nbsp;';
    }

    /**
     * @param bool $force
     * @param null $object

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

     * @return bool|mixed
     */
    public function insert(\XoopsObject $obj, $force = true, $object = null)
    {
        if ($obj->isNew()) {
            $new = true;

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

            $old = $this->create();
            $obj->setVar('created', \time());
        } else {
            $new = false;
            $old = $this->get($obj->getVar('aid'));
            $obj->setVar('updated', \time());
        }

        $albumsHandler   = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Albums');
        $songsHandler    = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Songs');

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

        $genreHandler    = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Genre');
        $voiceHandler    = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Voice');
        $categoryHandler = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Category');

        if ($object instanceof Songs) {
            if (true === $object->vars['cid']['changed']) {
                foreach ($obj->vars['cids']['value'] as $cid) {
                    if (is_array( $object->getVar('cid')) && !\in_array($cid, $object->getVar('cid'), true) && 0 != $cid) {

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

                        $obj->setVar('cids', \array_merge($obj->getVar('cids'), [$object->getVar('cid') => $object->getVar('cid')]));

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

                        $category = $categoryHandler->get($cid);
                        if (\is_object($category)) {
                            $category->setVar('artists', $category->getVar('artists') + 1);
                            $categoryHandler->insert($category, true, $obj);

The call to XoopsModules\Songlist\CategoryHandler::insert() has too many arguments starting with $obj.

                        }
                    }
                }
                if (!$old->isNew()) {
                    foreach ($old->getVar('cids') as $cid) {
                        if (!\in_array($cid, $obj->vars['cids']['value'], true) && 0 != $cid) {
                            $category = $categoryHandler->get($cid);
                            if (\is_object($category)) {
                                $category->setVar('artists', $category->getVar('artists') - 1);
                                $categoryHandler->insert($category, true, $obj);
                            }
                        }
                    }
                }
            }

            if (0 != $object->vars['abid']['value'] && true === $object->vars['aids']['changed']) {
                $album = $albumsHandler->get($object->vars['abid']['value']);
                if (\is_object($album)) {
                    $album->setVar('artists', $album->getVar('artists') + 1);
                    $albumsHandler->insert($album, true, $obj);
                }
            }

            if (0 != $object->vars['gid']['value'] && true === $object->vars['gid']['changed']) {
                $genre = $genreHandler->get($object->vars['gid']['value']);
                if (\is_object($genre)) {
                    $genre->setVar('artists', $genre->getVar('artists') + 1);
                    $genreHandler->insert($genre, true, $obj);

The call to XoopsModules\Songlist\GenreHandler::insert() has too many arguments starting with $obj.

                }
            }
            if (0 != $object->vars['vid']['value'] && true === $object->vars['vid']['changed']) {
                $voice = $voiceHandler->get($object->vars['vid']['value']);
                if (\is_object($voice)) {
                    $voice->setVar('artists', $voice->getVar('artists') + 1);
                    $voiceHandler->insert($voice, true, $obj);

The call to XoopsModules\Songlist\VoiceHandler::insert() has too many arguments starting with $obj.

                }
            }
        }

        if ('' == $obj->getVar('name')) {
            return false;
        }

        return parent::insert($obj, $force);
    }

    public $_objects = ['object' => [], 'array' => []];

    /**
     * @param null $id

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

     * @param null $fields

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

     * @return \XoopsObject
     */
    public function get($id = null, $fields = null): \XoopsObject//get($id, $fields = '*')
    {
        $fields = $fields ?: '*';

$fields is of type null, thus it always evaluated to false.

        if (!isset($this->_objects['object'][$id])) {
            $this->_objects['object'][$id] = parent::get($id, $fields);

$fields of type string is incompatible with the type array expected by parameter $fields of XoopsPersistableObjectHandler::get().

            if (!isset($GLOBALS['songlistAdmin']) && \is_object($this->_objects['object'][$id])) {
                $sql = 'UPDATE `' . $this->table . '` set hits=hits+1 where `' . $this->keyName . '` = ' . $this->_objects['object'][$id]->getVar($this->keyName);
                $GLOBALS['xoopsDB']->queryF($sql);
            }
        }

        return $this->_objects['object'][$id];
    }

    /**
     * @param \CriteriaElement|\CriteriaCompo $criteria
     * @param bool $id_as_key
     * @param bool $as_object
     * @return array
     */
    public function &getObjects($criteria = null, $id_as_key = false, $as_object = true): array
    {
        $ret = parent::getObjects($criteria, $id_as_key, $as_object);

        /*if (!isset($GLOBALS['songlistAdmin'])) {
            $id = [];
            foreach($ret as $data) {
                if ($as_object==true) {
                    if (!in_array($data->getVar($this->keyName), array_keys($this->_objects['object']))) {
                        $this->_objects['object'][$data->getVar($this->keyName)] = $data;
                        $id[$data->getVar($this->keyName)] = $data->getVar($this->keyName);
                    }
                } else {
                    if (!in_array($data[$this->keyName], array_keys($this->_objects['array']))) {
                        $this->_objects['array'][$data[$this->keyName]] = $data;
                        $id[$data[$this->keyName]] = $data[$this->keyName];;
                    }
                }
            }
        }
        if (!isset($GLOBALS['songlistAdmin'])&&count($id)>0) {
            $sql = 'UPDATE `'.$this->table.'` set hits=hits+1 where `'.$this->keyName.'` IN ('.implode(',', $id).')';
            $GLOBALS['xoopsDB']->queryF($sql);
        }*/

        return $ret;
    }

    /**
     * @return string
     */
    public function getURL(): string
    {
        global $file, $op, $fct, $id, $value, $gid, $vid, $cid, $start, $limit;
        if ($GLOBALS['songlistModuleConfig']['htaccess']) {
            if (0 != $cid) {
                $artistHandler = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Artists');
                $artist        = $artistHandler->get($cid);
                if (\is_object($artist) && !$artist->isNew()) {
                    return XOOPS_URL
                           . '/'
                           . $GLOBALS['songlistModuleConfig']['baseofurl']
                           . '/'
                           . $file
                           . '/'
                           . \urlencode(\str_replace([' ', \chr(9)], '-', $artist->getVar('name')))
                           . '/'
                           . $start
                           . '-'
                           . $id
                           . '-'
                           . $op
                           . '-'
                           . $fct
                           . '-'
                           . $gid
                           . '-'
                           . $cid
                           . '/'
                           . \urlencode($value)
                           . $GLOBALS['songlistModuleConfig']['endofurl'];
                }

                return XOOPS_URL . '/' . $GLOBALS['songlistModuleConfig']['baseofurl'] . '/' . $file . '/' . $start . '-' . $id . '-' . $op . '-' . $fct . '-' . $gid . '-' . $cid . '/' . \urlencode($value) . $GLOBALS['songlistModuleConfig']['endofurl'];
            }

            return XOOPS_URL . '/' . $GLOBALS['songlistModuleConfig']['baseofurl'] . '/' . $file . '/' . $start . '-' . $id . '-' . $op . '-' . $fct . '-' . $gid . '-' . $cid . '/' . \urlencode($value) . $GLOBALS['songlistModuleConfig']['endofurl'];
        }

        return XOOPS_URL . '/modules/songlist/' . $file . '.php?op=' . $op . '&fct=' . $fct . '&id=' . $id . '&value=' . \urlencode($value ?? '') . '&gid=' . $gid . '&vid=' . $vid . '&cid=' . $cid . '&start=' . $start;
    }

    /**
     * @param null $criteria

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

     * @return array
     */
    public function getSIDs($criteria = null): array
    {
        $ret         = [];
        $songHandler = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Songs');
        foreach ($this->getObjects($criteria, true) as $aid => $object) {
            $crita = new Criteria('aids', '%"' . $aid . '"%', 'LIKE');
            foreach ($songHandler->getObjects($crita, true) as $sid => $song) {
                $ret[$sid] = $sid;
            }
        }

        return $ret;
    }

    /**
     * @param int $limit
     * @return array
     */
    public function getTop($limit = 1): array
    {
        $sql     = 'SELECT * FROM `' . $this->table . '` WHERE `rank`>=0 ORDER BY (`rank`/`votes`) DESC LIMIT ' . $limit;
        $results = $GLOBALS['xoopsDB']->queryF($sql);
        $ret     = [];
        $i       = 0;
        while (false !== ($row = $GLOBALS['xoopsDB']->fetchArray($results))) {
            $ret[$i] = $this->create();
            $ret[$i]->assignVars($row);
            ++$i;
        }

        return $ret;
    }
}