XoopsModules25x / oledrion

class/oledrion_plugins.php

Doc Comments +4 added lines, -4 removed lines

@@ -114,7 +114,7 @@ 
     /**
      * Retourne l'instance unique de la classe
      *
-     * @return object
+     * @return Oledrion_plugins
      */
     public static function getInstance()
     {
@@ -199,8 +199,8 @@ 
      * Déclenchement d'une action et appel des plugins liés
      *
      * @param  string                     $eventToFire L'action déclenchée
-     * @param  object|Oledrion_parameters $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)
     {
@@ -234,7 +234,7 @@ 
      * Déclenchement d'un filtre et appel des plugins liés
      *
      * @param  string                     $eventToFire Le filtre appelé
-     * @param  object|Oledrion_parameters $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)

class/oledrion_products.php

Doc Comments +3 added lines, -3 removed lines

@@ -744,7 +744,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
      */
@@ -817,7 +817,7 @@ 
     /**
      * Retourne le nombre total de produits publiés dans la base en tenant compte des préférences du module
      *
-     * @param  int|intefer $product_cid Catégorie du produit
+     * @param  integer $product_cid Catégorie du produit
      * @return int         Le nombre de produits publiés
      */
     public function getTotalPublishedProductsCount($product_cid = 0)
@@ -1223,7 +1223,7 @@ 
     /**
      * Clone d'un produit
      *
-     * @param  object|Oledrion_products $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)

class/oledrion_products_list.php

Doc Comments +1 added lines, -1 removed lines

@@ -74,7 +74,7 @@
      * Supprime un produit de toutes les listes
      *
      * @param  integer $productlist_product_id
-     * @return booelan
+     * @return boolean
      */
     public function deleteProductFromLists($productlist_product_id)
     {

class/oledrion_shelf_parameters.php

Doc Comments +12 added lines, -12 removed lines

@@ -44,7 +44,7 @@ 
     /**
      * Réinitialisation des valeurs
      *
-     * @return object
+     * @return Oledrion_shelf_parameters
      */
     public function resetDefaultValues()
     {
@@ -77,7 +77,7 @@ 
      * Positione la valeur de début
      *
      * @param  integer $value
-     * @return object
+     * @return Oledrion_shelf_parameters
      */
     public function setStart($value)
     {
@@ -90,7 +90,7 @@ 
      * Fixe le nombre maximum d'enregistrements à retourner
      *
      * @param  integer $value
-     * @return object
+     * @return Oledrion_shelf_parameters
      */
     public function setLimit($value)
     {
@@ -103,7 +103,7 @@ 
      * Fixe la catégorie à utiliser
      *
      * @param  integer $value
-     * @return object
+     * @return Oledrion_shelf_parameters
      */
     public function setCategory($value)
     {
@@ -116,7 +116,7 @@ 
      * Fixe la zone qui sert de tri
      *
      * @param  string $value
-     * @return object
+     * @return Oledrion_shelf_parameters
      */
     public function setSort($value)
     {
@@ -129,7 +129,7 @@ 
      * Fixe l'ordre de tri
      *
      * @param  string $value
-     * @return array
+     * @return Oledrion_shelf_parameters
      */
     public function setOrder($value)
     {
@@ -142,7 +142,7 @@ 
      * Fixe la liste des produits à exclure
      *
      * @param  mixed $value
-     * @return string
+     * @return Oledrion_shelf_parameters
      */
     public function setExcluded($value)
     {
@@ -155,7 +155,7 @@ 
      * Indique s'il faut retourner les utilisateurs Xoops
      *
      * @param  boolean $value
-     * @return object
+     * @return Oledrion_shelf_parameters
      */
     public function setWithXoopsUser($value)
     {
@@ -168,7 +168,7 @@ 
      * Indique s'il faut retourner les produits relatifs
      *
      * @param  boolean $value
-     * @return object
+     * @return Oledrion_shelf_parameters
      */
     public function setWithRelatedProducts($value)
     {
@@ -181,7 +181,7 @@ 
      * Indique s'il faut retourner les quantités
      *
      * @param  boolean $value
-     * @return object
+     * @return Oledrion_shelf_parameters
      */
     public function setWithQuantity($value)
     {
@@ -194,7 +194,7 @@ 
      * Fixe le type de produits à retourner
      *
      * @param  string $value
-     * @return object
+     * @return Oledrion_shelf_parameters
      */
     public function setProductsType($value)
     {
@@ -207,7 +207,7 @@ 
      * Indique s'il faut retourner seulement les mois
      *
      * @param  boolean $value
-     * @return object
+     * @return Oledrion_shelf_parameters
      */
     public function setThisMonthOnly($value)
     {

class/oledrion_utils.php

Doc Comments +11 added lines, -11 removed lines

@@ -41,7 +41,7 @@ 
     /**
      * Access the only instance of this class
      *
-     * @return object
+     * @return Oledrion_utils
      *
      * @static
      * @staticvar   object
@@ -297,7 +297,7 @@ 
     /**
      * Send an email from a template to a list of recipients
      *
-     * @param         $tplName
+     * @param         string $tplName
      * @param  array  $recipients List of recipients
      * @param  string $subject    Email's subject
      * @param  array  $variables  Varirables to give to the template
@@ -495,7 +495,7 @@ 
     /**
      * Vérifie que l'utilisateur courant fait partie du groupe des administrateurs
      *
-     * @return booleean Admin or not
+     * @return boolean Admin or not
      */
     public static function isAdmin()
     {
@@ -1133,7 +1133,7 @@ 
      * @param  null    $uploadMaxSize
      * @param  null    $maxWidth
      * @param  null    $maxHeight
-     * @return mixed   True si l'upload s'est bien déroulé sinon le message d'erreur correspondant
+     * @return boolean|string   True si l'upload s'est bien déroulé sinon le message d'erreur correspondant
      */
     public static function uploadFile(
         $indice,
@@ -1293,7 +1293,7 @@ 
     }
 
     /**
-     * @param $string
+     * @param string $string
      * @return string
      */
     public static function close_tags($string)
@@ -1637,7 +1637,7 @@ 
      *
      * @param  string $path     The file's path
      * @param  string $filename The filename
-     * @return mixed  If the copy succeed, the new filename else false
+     * @return string|false  If the copy succeed, the new filename else false
      * @since 2.1
      */
     public function duplicateFile($path, $filename)
@@ -1720,7 +1720,7 @@ 
      * Create the <option> of an html select
      *
      * @param  array $array   Array of index and labels
-     * @param  mixed $default the default value
+     * @param  integer $default the default value
      * @param  bool  $withNull
      * @return string
      * @since 2.3.2009.03.13
@@ -1751,8 +1751,8 @@ 
      * Creates an html select
      *
      * @param  string  $selectName Selector's name
-     * @param  array   $array      Options
-     * @param  mixed   $default    Default's value
+     * @param  string[]   $array      Options
+     * @param  integer   $default    Default's value
      * @param  boolean $withNull   Do we include a null option ?
      * @return string
      * @since 2.3.2009.03.13
@@ -1851,7 +1851,7 @@ 
      * @package       Oledrion
      * @author        Instant Zero (http://xoops.instant-zero.com)
      * @copyright (c) Instant Zero
-     * @param $fieldname
+     * @param string $fieldname
      * @param $table
      * @return bool
      */
@@ -1887,7 +1887,7 @@ 
      * @package       Oledrion
      * @author        Instant Zero (http://xoops.instant-zero.com)
      * @copyright (c) Instant Zero
-     * @param $field
+     * @param string $field
      * @param $table
      * @return
      */

class/tree.php

Doc Comments +3 added lines, -3 removed lines

@@ -244,10 +244,10 @@
 
     /**
      * Internal function used by makeTreeAsArray
-     * @param        $fieldName
-     * @param        $key
+     * @param        string $fieldName
+     * @param        integer $key
      * @param        $ret
-     * @param        $prefix_orig
+     * @param        string $prefix_orig
      * @param string $prefix_curr
      */
     public function _recursiveMakeTreeAsArray($fieldName, $key, &$ret, $prefix_orig, $prefix_curr = '')