XoopsModules25x / oledrion

oledrion/class/oledrion_gateways.php

Doc Comments +2 added lines, -2 removed lines

@@ -101,8 +101,8 @@
     /**
      * Retourne le chemin complet vers le fichier de langue de la passerelle
      *
-     * @param  unknown_type $gatewayName
-     * @return unknown
+     * @param  string $gatewayName
+     * @return string
      */
     public static function getGatewayLanguageFilename($gatewayName)
     {

oledrion/class/oledrion_lists.php

Doc Comments +2 added lines, -9 removed lines

@@ -68,7 +68,7 @@ 
     /**
      * Retourne un tableau associatif qui pour chaque type de liste indique son type sous forme de texte
      *
-     * @return array
+     * @return string[]
      */
     static function getTypesArray()
     {
@@ -218,13 +218,6 @@ 
     /**
      * Retourne la liste des listes récentes
      *
-     * @param  integer $start
-     * @param  integer $limit
-     * @param  string  $sort
-     * @param  string  $order
-     * @param  boolean $idAsKey
-     * @param  integer $listType
-     * @param  integer $list_uid
      * @return array   Tableau d'objets de type oledrion_lists [clé] = id liste
      */
     public function getRecentLists(oledrion_parameters $parameters)
@@ -406,7 +399,7 @@ 
     /**
      * Retourne les x dernières listes qui contiennent des produits dans une certaine catégorie
      *
-     * @param  integer $cateGoryId L'identifiant de la catégorie
+     * @param  integer $categoryId L'identifiant de la catégorie
      * @param  integer $list_type  Le type de liste
      * @param  integer $limit      Le nombre maximum de listes à retourner
      * @return array   Objets de type oledrion_lists, [clé] = id liste

oledrion/class/oledrion_manufacturer.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
      * Retourne l'URL d'une des 5 images du fabricant courant
      *
      * @param  integer $pictureNumber Le numéro (de 1 à 5) de l'image que l'on souhaite récupérer
-     * @return mixed   L'URL    Soit l'url de l'image soit False si l'indice passé en paramètre n'est pas correct
+     * @return string|false   L'URL    Soit l'url de l'image soit False si l'indice passé en paramètre n'est pas correct
      */
     public function getPictureUrl($pictureNumber)
     {

oledrion/class/oledrion_parameters.php

Doc Comments +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
      *
      * @param  string $key   Le nom du champ à traiter
      * @param  mixed  $value La valeur à lui attribuer
-     * @return object
+     * @return oledrion_parameters
      */
     public function __set($key, $value)
     {

oledrion/class/oledrion_plugins.php

Doc Comments +4 added lines, -4 removed lines

@@ -112,7 +112,7 @@ 
     /**
      * Retourne l'instance unique de la classe
      *
-     * @return object
+     * @return oledrion_plugins
      */
     public static function getInstance()
     {
@@ -193,8 +193,8 @@ 
      * Déclenchement d'une action et appel des plugins liés
      *
      * @param  string $eventToFire L'action déclenchée
-     * @param  object $parameters  Les paramètres à passer à chaque plugin
-     * @return object L'objet lui même pour chaîner
+     * @param  oledrion_parameters $parameters  Les paramètres à passer à chaque plugin
+     * @return oledrion_plugins L'objet lui même pour chaîner
      */
     public function fireAction($eventToFire, oledrion_parameters $parameters = null)
     {
@@ -228,7 +228,7 @@ 
      * Déclenchement d'un filtre et appel des plugins liés
      *
      * @param  string $eventToFire Le filtre appelé
-     * @param  object $parameters  Les paramètres à passer à chaque plugin
+     * @param  oledrion_parameters $parameters  Les paramètres à passer à chaque plugin
      * @return object Le contenu de l'objet passé en paramètre
      */
     public function fireFilter($eventToFire, oledrion_parameters &$parameters)

oledrion/class/oledrion_products.php

Doc Comments +4 added lines, -48 removed lines

@@ -514,11 +514,6 @@ 
     /**
      * Retourne la liste des x produits les plus vus par les visiteurs
      *
-     * @param  integer $start    Début des données
-     * @param  integer $limit    Nombre maximum d'enregistrements à renvoyer
-     * @param  integer $category Identifiant de la catégorie (évenutellement)
-     * @param  string  $sort     Champ sur lequel trier
-     * @param  string  $order    Sens du tri
      * @return array   Tableau de produits (sous la forme d'objets)
      */
     public function getMostViewedProducts(oledrion_parameters $parameters)
@@ -552,9 +547,6 @@ 
     /**
      * Retourne la liste des x produits les mieux notés par les visiteurs
      *
-     * @param  integer $start    Début des données
-     * @param  integer $limit    Nombre maximum d'enregistrements à renvoyer
-     * @param  integer $category Identifiant de la catégorie (évenutellement)
      * @return array   Tableau de produits (sous la forme d'objets)
      */
     public function getBestRatedProducts(oledrion_parameters $parameters)
@@ -587,9 +579,6 @@ 
     /**
      * Retourne la liste des x derniers produits recommandés
      *
-     * @param  integer $start    Indice de départ
-     * @param  integer $limit    Nombre maximum d'enregistrements à renvoyer
-     * @param  integer $category Identifiant de la catégorie (évenutellement)
      * @return array   Tableau de produits (sous la forme d'objets)
      */
     public function getRecentRecommended(oledrion_parameters $parameters)
@@ -642,13 +631,6 @@ 
     /**
      * Retourne la liste des x derniers produits parus toutes catégories confondues ou dans une catégorie spécifique
      *
-     * @param  integer $start         Début des données
-     * @param  integer $limit         Nombre maximum d'enregistrements à renvoyer
-     * @param  mixed   $category      Identifiant de la catégorie (évenutellement) ou tableau d'ID ou rien du tout
-     * @param  string  $sort          Champ(s) à utiliser pour le tri
-     * @param  string  $order         Ordre de tri
-     * @param  integer $excluded      Produit à exclure de la liste (éventuellement)
-     * @param  boolean $thisMonthOnly Indique s'il ne faut prendre que les produits du mois
      * @return array   Tableau de produits (sous la forme d'objets)
      */
     public function getRecentProducts(oledrion_parameters $parameters)
@@ -690,7 +672,7 @@ 
     /**
      * Retourne le nombre total de produits récents (éventuellement dans une catégorie)
      *
-     * @param  mixed   $category        Array ou Integer
+     * @param  integer   $category        Array ou Integer
      * @param  integer $excludedProduct ID d'un produit à exclure
      * @return integer
      */
@@ -719,11 +701,6 @@ 
     /**
      * Retourne la liste des produits qui correspondent à des "critères" de manière à les utiliser pour la newsletter
      *
-     * @param  integer $startingDate Date de soumission du produit à prendre comme borne inférieure
-     * @param  integer $endingDate   Date de soumission du produit à prendre comme borne supérieure
-     * @param  mixed   $category     Soit un tableau d'ID de catégories soit un ID unique de catégorie
-     * @param  integer $start        Position de départ
-     * @param  integer $limit        Nombre d'enregistrements à retourner
      * @return array   Des objects de type produits
      */
     public function getProductsForNewsletter(oledrion_parameters $parameters)
@@ -756,7 +733,7 @@ 
     /**
      * Retourne le nombre total de produits publiés dans la base en tenant compte des préférences du module
      *
-     * @param  intefer $product_cid Catégorie du produit
+     * @param  integer $product_cid Catégorie du produit
      * @return integer Le nombre de produits publiés
      */
     public function getTotalPublishedProductsCount($product_cid = 0)
@@ -853,12 +830,6 @@ 
     /**
      * Retourne x produits au hasard
      *
-     * @param  integer $start         Début des données
-     * @param  integer $limit         Nombre maximum d'enregistrements à renvoyer
-     * @param  integer $category      Identifiant de la catégorie (évenutellement)
-     * @param  string  $sort          Zone sur laquelle faire le tri
-     * @param  string  $order         Ordre de tri
-     * @param  boolean $thisMonthOnly Uniquement les produits du mois en cours ?
      * @return array   Tableau de produits (sous la forme d'objets)
      */
     public function getRandomProducts(oledrion_parameters $parameters)
@@ -895,9 +866,6 @@ 
     /**
      * Retourne x produits en promo
      *
-     * @param  integer $start    Début des données
-     * @param  integer $limit    Nombre maximum d'enregistrements à renvoyer
-     * @param  integer $category Identifiant de la catégorie (évenutellement)
      * @return array   Tableau de produits (sous la forme d'objets)
      */
     public function getPromotionalProducts(oledrion_parameters $parameters)
@@ -1013,7 +981,7 @@ 
     /**
      * Indique si la quantité d'alerte d'un produit est atteinte
      *
-     * @param  object  $products L'objet produit concerné
+     * @param  object  $product L'objet produit concerné
      * @return boolean Vrai si la quantité d'alerte est atteinte, sinon faux
      */
     public function isAlertStockReached(&$product)
@@ -1141,7 +1109,7 @@ 
     /**
      * Clone d'un produit
      *
-     * @param  object $originalProduct Le produit à cloner
+     * @param  oledrion_products $originalProduct Le produit à cloner
      * @return mixed  Soit l'objet représentant le nouveau produit soit false
      */
     public function cloneProduct(oledrion_products $originalProduct)
@@ -1246,18 +1214,6 @@ 
      * Construit un sélecteur de produit(s) en fonction des paramètres et en tenant compte du nombre total de produits dans la base
      *
      * @todo: Remplacer les paramètres par un objet paramètre et/ou un tableau
-     * @param  string  $caption     Le titre du sélecteur
-     * @param  string  $name        Le nom du champ qui receuille les produits
-     * @param  mixed   $value       La valeur sélectionnées
-     * @param  integer $size        Le nombre d'éléments visibles dans le sélecteur
-     * @param  boolean $multiple    Indique si c'est un sélecteur multiple ou pas
-     * @param  array   $values      Les valeurs sélectionnées ou les valeurs qui font le sélecteur
-     * @param  boolean $showAll     Indique s'il faut voir tous les produits ou pas (pas publiés et en stock)
-     * @param  string  $sort        Zone de tri
-     * @param  string  $order       Ordre de tri
-     * @param  string  $formName    Nom du formulaire
-     * @param  string  $description Description à rajouter à la zone
-     * @param  mixed   $withNull    Option à rajouter en premier
      * @return object  Retourne soit un objet de type tray {@link XoopsFormElementTray} soit un select {@link XoopsFormSelect}
      */
     public function productSelector(oledrion_parameters $parameters)

oledrion/class/oledrion_products_list.php

Doc Comments +2 added lines, -2 removed lines

@@ -58,7 +58,7 @@ 
      * Supprime un produit de toutes les listes
      *
      * @param  integer $productlist_product_id
-     * @return booelan
+     * @return boolean
      */
     public function deleteProductFromLists($productlist_product_id)
     {
@@ -94,7 +94,7 @@ 
     /**
      * Ajoute un produit à une liste utilisateur
      *
-     * @param  integer $productlist_id         Id de la liste
+     * @param  integer $productlist_list_id         Id de la liste
      * @param  integer $productlist_product_id Id du produit
      * @return boolean
      */

oledrion/class/oledrion_shelf_parameters.php

Doc Comments +12 added lines, -12 removed lines

@@ -42,7 +42,7 @@ 
     /**
      * Réinitialisation des valeurs
      *
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function resetDefaultValues()
     {
@@ -75,7 +75,7 @@ 
      * Positione la valeur de début
      *
      * @param  integer $value
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function setStart($value)
     {
@@ -88,7 +88,7 @@ 
      * Fixe le nombre maximum d'enregistrements à retourner
      *
      * @param  integer $value
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function setLimit($value)
     {
@@ -101,7 +101,7 @@ 
      * Fixe la catégorie à utiliser
      *
      * @param  integer $value
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function setCategory($value)
     {
@@ -114,7 +114,7 @@ 
      * Fixe la zone qui sert de tri
      *
      * @param  string $value
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function setSort($value)
     {
@@ -127,7 +127,7 @@ 
      * Fixe l'ordre de tri
      *
      * @param  string $value
-     * @return array
+     * @return oledrion_shelf_parameters
      */
     public function setOrder($value)
     {
@@ -140,7 +140,7 @@ 
      * Fixe la liste des produits à exclure
      *
      * @param  mixed  $value
-     * @return string
+     * @return oledrion_shelf_parameters
      */
     public function setExcluded($value)
     {
@@ -153,7 +153,7 @@ 
      * Indique s'il faut retourner les utilisateurs Xoops
      *
      * @param  boolean $value
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function setWithXoopsUser($value)
     {
@@ -166,7 +166,7 @@ 
      * Indique s'il faut retourner les produits relatifs
      *
      * @param  boolean $value
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function setWithRelatedProducts($value)
     {
@@ -179,7 +179,7 @@ 
      * Indique s'il faut retourner les quantités
      *
      * @param  boolean $value
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function setWithQuantity($value)
     {
@@ -192,7 +192,7 @@ 
      * Fixe le type de produits à retourner
      *
      * @param  string $value
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function setProductsType($value)
     {
@@ -205,7 +205,7 @@ 
      * Indique s'il faut retourner seulement les mois
      *
      * @param  boolean $value
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function setThisMonthOnly($value)
     {

oledrion/class/oledrion_sms.php

Doc Comments -1 removed lines

@@ -81,7 +81,6 @@
     }
 
     /**
-     * @param string $smsGatewayName
      */
     public static function sendSms($information = array())
     {