XoopsModules25x / oledrion

class/Lists.php

<?php

namespace XoopsModules\Oledrion;

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

/**
 * oledrion
 *
 * @copyright   {@link https://xoops.org/ XOOPS Project}
 * @license     {@link http://www.fsf.org/copyleft/gpl.html GNU public license}
 * @author      Hervé Thouzard (http://www.herve-thouzard.com/)
 */

/**
 * Gestion des listes utilisateurs
 *
 * @since 2.3.2009.06.13
 */

use XoopsModules\Oledrion;

/**
 * Class Lists
 */
class Lists extends OledrionObject
{
    /**
     * constructor
     *
     * normally, this is called from child classes only
     */
    public function __construct()
    {
        $this->initVar('list_id', XOBJ_DTYPE_INT, null, false);
        $this->initVar('list_uid', XOBJ_DTYPE_INT, null, false);
        $this->initVar('list_title', XOBJ_DTYPE_TXTBOX, null, false);
        $this->initVar('list_date', XOBJ_DTYPE_INT, null, false);
        $this->initVar('list_productscount', XOBJ_DTYPE_INT, null, false);
        $this->initVar('list_views', XOBJ_DTYPE_INT, null, false);
        $this->initVar('list_password', XOBJ_DTYPE_TXTBOX, null, false);
        $this->initVar('list_type', XOBJ_DTYPE_INT, null, false);
        $this->initVar('list_description', XOBJ_DTYPE_OTHER, null, false);
    }

    /**
     * Indique si la liste courante est accessible de l'utilisateur courant
     *
     * @return bool
     */
    public function isSuitableForCurrentUser()
    {
        $uid = Oledrion\Utility::getCurrentUserID();
        if (Constants::OLEDRION_LISTS_PRIVATE == $this->getVar('list_type')) {
            if (0 == $uid || $uid != $this->getVar('list_uid')) {
                return false;
            }
        }

        return true;
    }

    /**
     * Retourne un tableau associatif qui pour chaque type de liste indique son type sous forme de texte
     *
     * @return array
     */
    public static function getTypesArray()
    {
        return [
            Constants::OLEDRION_LISTS_PRIVATE   => _OLEDRION_LIST_PRIVATE,
            Constants::OLEDRION_LISTS_WISH      => _OLEDRION_LIST_PUBLIC_WISH_LIST,
            Constants::OLEDRION_LISTS_RECOMMEND => _OLEDRION_LIST_PUBLIC_RECOMMENDED_LIST,
        ];
    }

    /**
     * Retourne la description de la liste courante
     *
     * @return string
     */
    public function getListTypeDescription()
    {
        $description = static::getTypesArray();

        return $description[$this->list_type];

The property list_type does not exist on XoopsModules\Oledrion\Lists. Since you implemented __get, consider adding a @property annotation.

    }

    /**
     * Retourne l'url à utiliser pour accéder à la liste en tenant compte des préférences du module
     *
     * @return string L'url à utiliser
     */
    public function getLink()
    {
        $url = '';
        if (1 == Oledrion\Utility::getModuleOption('urlrewriting')) {
            // On utilise l'url rewriting
            $url = OLEDRION_URL . 'list-' . $this->getVar('list_id') . Oledrion\Utility::makeSeoUrl($this->getVar('list_title', 'n')) . '.html';

It seems like $this->getVar('list_title', 'n') can also be of type array and array; however, parameter $content of XoopsModules\Oledrion\Utility::makeSeoUrl() does only seem to accept string, maybe add an additional type check?

        } else {
            // Pas d'utilisation de l'url rewriting
            $url = OLEDRION_URL . 'list.php?list_id=' . $this->getVar('list_id');
        }

        return $url;
    }

    /**
     * Retourne la date de création de la liste formatée
     *
     * @param  string $format
     * @return string
     */
    public function getFormatedDate($format = 's')
    {
        return formatTimestamp($this->list_date, $format);

The property list_date does not exist on XoopsModules\Oledrion\Lists. Since you implemented __get, consider adding a @property annotation.

    }

    /**
     * Rentourne la chaine à utiliser dans une balise <a> pour l'attribut href
     *
     * @return string
     */
    public function getHrefTitle()
    {
        return Oledrion\Utility::makeHrefTitle($this->getVar('list_title'));

It seems like $this->getVar('list_title') can also be of type array and array; however, parameter $title of XoopsModules\Oledrion\Utility::makeHrefTitle() does only seem to accept string, maybe add an additional type check?

    }

    /**
     * Retourne le nom de l'auteur de la liste courante
     *
     * @return string
     */
    public function getListAuthorName()
    {
        return \XoopsUser::getUnameFromId($this->getVar('list_uid', true));

true of type true is incompatible with the type null|string expected by parameter $format of XoopsObject::getVar().

    }

    /**
     * Retourne les éléments formatés pour affichage (en général)
     *
     * @param  string $format
     * @return array
     */
    public function toArray($format = 's')
    {
        $ret                          = [];

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

        $ret                          = parent::toArray($format);
        $ret['list_type_description'] = $this->getListTypeDescription();
        $ret['list_href_title']       = $this->getHrefTitle();
        $ret['list_url_rewrited']     = $this->getLink();
        $ret['list_formated_date']    = $this->getFormatedDate();
        $ret['list_username']         = $this->getListAuthorName();
        $ret['list_formated_count']   = sprintf(_OLEDRION_PRODUCTS_COUNT, $this->getVar('list_productscount'));

It seems like $this->getVar('list_productscount') can also be of type array and array; however, parameter $values of sprintf() does only seem to accept double|integer|string, maybe add an additional type check?

        return $ret;
    }
}