XoopsModules25x / oledrion

class/ShelfParameters.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/)
 */

/**
 * Internal class whose purpose is to pass parameters to the Shelf class
 */

use XoopsModules\Oledrion;

// defined('XOOPS_ROOT_PATH') || die('Restricted access');

/**
 * Utilisé comme paramètre dans la façcade Shelf
 */
class ShelfParameters
{
    /**
     * Le conteneur de paramètres
     *
     * @var array
     */
    private $parameters = [];

    /**
     * ShelfParameters constructor.
     */
    public function __construct()
    {
        $this->resetDefaultValues();
    }

    /**
     * Réinitialisation des valeurs
     *
     * @return ShelfParameters
     */
    public function resetDefaultValues()
    {
        $this->parameters['start']               = 0;
        $this->parameters['limit']               = 0;
        $this->parameters['category']            = 0;
        $this->parameters['sort']                = 'product_submitted DESC, product_title';
        $this->parameters['order']               = 'ASC';
        $this->parameters['excluded']            = 0;
        $this->parameters['withXoopsUser']       = false;
        $this->parameters['withRelatedProducts'] = false;
        $this->parameters['withQuantity']        = false;
        $this->parameters['thisMonthOnly']       = false;
        $this->parameters['productsType']        = '';

        return $this;
    }

    /**
     * Retourne le tableau des paramètres
     *
     * @return array
     */
    public function getParameters()
    {
        return $this->parameters;
    }

    /**
     * Positione la valeur de début
     *
     * @param int $value
     * @return ShelfParameters
     */
    public function setStart($value)
    {
        $this->parameters['start'] = (int)$value;

        return $this;
    }

    /**
     * Fixe le nombre maximum d'enregistrements à retourner
     *
     * @param int $value
     * @return ShelfParameters
     */
    public function setLimit($value)
    {
        $this->parameters['limit'] = (int)$value;

        return $this;
    }

    /**
     * Fixe la catégorie à utiliser
     *
     * @param int $value
     * @return ShelfParameters
     */
    public function setCategory($value)
    {
        $this->parameters['category'] = $value;

        return $this;
    }

    /**
     * Fixe la zone qui sert de tri
     *
     * @param  string $value
     * @return ShelfParameters
     */
    public function setSort($value)
    {
        $this->parameters['sort'] = $value;

        return $this;
    }

    /**
     * Fixe l'ordre de tri
     *
     * @param  string $value
     * @return \XoopsModules\Oledrion\ShelfParameters
     */
    public function setOrder($value)
    {
        $this->parameters['order'] = $value;

        return $this;
    }

    /**
     * Set the list of products to exclude
     *
     * @param  mixed $value
     * @return string
     */
    public function setExcluded($value)
    {
        $this->parameters['excluded'] = $value;

        return $this;

The expression return $this returns the type XoopsModules\Oledrion\ShelfParameters which is incompatible with the documented return type string.

    }

    /**
     * Indique s'il faut retourner les utilisateurs Xoops
     *
     * @param  bool $value
     * @return ShelfParameters
     */
    public function setWithXoopsUser($value)
    {
        $this->parameters['withXoopsUser'] = $value;

        return $this;
    }

    /**
     * Indique s'il faut retourner les produits relatifs
     *
     * @param  bool $value
     * @return ShelfParameters
     */
    public function setWithRelatedProducts($value)
    {
        $this->parameters['withRelatedProducts'] = $value;

        return $this;
    }

    /**
     * Indique s'il faut retourner les quantités
     *
     * @param  bool $value
     * @return ShelfParameters
     */
    public function setWithQuantity($value)
    {
        $this->parameters['withQuantity'] = $value;

        return $this;
    }

    /**
     * Fixe le type de produits à retourner
     *
     * @param  string $value
     * @return ShelfParameters
     */
    public function setProductsType($value)
    {
        $this->parameters['productsType'] = $value;

        return $this;
    }

    /**
     * Indique s'il faut retourner seulement les mois
     *
     * @param  bool $value
     * @return ShelfParameters
     */
    public function setThisMonthOnly($value)
    {
        $this->parameters['thisMonthOnly'] = $value;

        return $this;
    }
}