mambax7 / references

class/PEAR.php

Doc Comments +1 added lines, -1 removed lines

@@ -492,7 +492,7 @@
      * handling applied.  If the $mode and $options parameters are not
      * specified, the object's defaults are used.
      *
-     * @param mixed  $message     a text error message or a PEAR error object
+     * @param string|null  $message     a text error message or a PEAR error object
      *
      * @param int    $code        a numeric error code (it is up to your class
      *                            to define these if you want to use codes)

class/PersistableObjectHandler.php

Doc Comments +2 added lines, -2 removed lines

@@ -235,7 +235,7 @@ 
      * @param boolean $as_object
      * @param string  $fields    Requested fields from the query
      *
-     * @return array
+     * @return string
      */
     protected function convertResultSet($result, $id_as_key = false, $as_object = true, $fields = '*')
     {
@@ -502,7 +502,7 @@ 
     /**
      * delete an object from the database
      *
-     * @param  XoopsObject $obj reference to the object to delete
+     * @param  references_articles $obj reference to the object to delete
      * @param  bool        $force
      * @return bool   FALSE if failed.
      */

class/references_articles.php

Doc Comments +2 added lines, -2 removed lines

@@ -499,7 +499,7 @@ 
     /**
      * Notification de la publication d'une nouvelle référence
      *
-     * @param object|references_articles $article L'annonce pour laquelle on fait la notification
+     * @param references_articles $article L'annonce pour laquelle on fait la notification
      * @return bool
      */
     public function notifyNewArticle(references_articles $article)
@@ -574,7 +574,7 @@ 
     /**
      * Indique si une référence est visible d'un utilisateur
      *
-     * @param object|references_articles $article L'article à controler
+     * @param references_articles $article L'article à controler
      * @param integer                    $uid     L'id de l'utilisateur à controler
      * @return bool
      */

class/references_categories.php

Doc Comments +2 added lines, -2 removed lines

@@ -185,7 +185,7 @@ 
     /**
      * Notification de la création d'une nouvelle catégorie
      *
-     * @param object|references_categories $category
+     * @param references_categories $category
      * @return bool
      */
     public function notifyNewCategory(references_categories $category)
@@ -199,7 +199,7 @@ 
     /**
      * Indique si une catégorie est visible d'un utilisateur
      *
-     * @param object|references_categories $category La catégorie à controler
+     * @param references_categories $category La catégorie à controler
      * @param integer                      $uid      L'id de l'utilisateur à controler
      * @return bool
      */

class/references_listFilter.php

Doc Comments +9 added lines, -9 removed lines

@@ -253,7 +253,7 @@ 
     /**
      * Retourne les noms à utiliser pour les champs de tri (sélecteur de champ et ordre de tri)
      *
-     * @return array [0] = Nom du sélecteur de champs, [1] = Nom du sélecteur pour le sens du tri
+     * @return string[] [0] = Nom du sélecteur de champs, [1] = Nom du sélecteur pour le sens du tri
      */
     private function getSortPlaceHolderNames()
     {
@@ -279,7 +279,7 @@ 
      *
      * @param  string $optionName
      * @param  mixed  $optionValue
-     * @return object
+     * @return references_listFilter
      */
     public function setOption($optionName, $optionValue)
     {
@@ -408,7 +408,7 @@ 
      *                            [data]            A ne pas renseigner, contient la valeur saisie par l'utilisateur
      *                            [operator]        Opérateur de comparaison pour le Criteria
      *                            [autoComplete]  Indique si on active l'auto complétion sur le champs
-     * @return object L'objet courant pour pouvoir chainer
+     * @return references_listFilter L'objet courant pour pouvoir chainer
      */
     public function initFilter($fieldName, $parameters)
     {
@@ -464,7 +464,7 @@ 
     /**
      * Ajoute les critères par défaut au critère général
      *
-     * @return void
+     * @return references_listFilter
      */
     private function addDefaultCriterias()
     {
@@ -592,7 +592,7 @@ 
     /**
      * Méthode à appeler juste après le constructeur pour qu'elle récupère les données saisies
      *
-     * @return object L'objet courant pour pouvoir chainer
+     * @return references_listFilter L'objet courant pour pouvoir chainer
      */
     public function filter()
     {
@@ -717,7 +717,7 @@ 
      *
      * @param  string $key
      * @param  string $value
-     * @return object
+     * @return references_listFilter
      */
     public function addAdditionnalParameterToPager($key, $value = '')
     {
@@ -731,7 +731,7 @@ 
      *
      * @param  string $key
      * @param  string $value
-     * @return object
+     * @return references_listFilter
      */
     public function addAdditionnalParameterToClearButton($key, $value = '')
     {
@@ -744,7 +744,7 @@ 
      * Permet d'ajouter des paramètres supplémentaires au pager
      *
      * @param $array
-     * @return object
+     * @return references_listFilter
      * @internal param string $key
      * @internal param string $value
      */
@@ -762,7 +762,7 @@ 
     /**
      * Retourne le pager à utiliser
      *
-     * @return mixed Null s'il n'y a pas lieu d'y avoir un pager, sinon un objet de type {@link XoopsPageNav}
+     * @return XoopsPageNav|null Null s'il n'y a pas lieu d'y avoir un pager, sinon un objet de type {@link XoopsPageNav}
      */
     public function getPager()
     {

class/references_plugins.php

Doc Comments +4 added lines, -4 removed lines

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

class/references_utils.php

Doc Comments +10 added lines, -7 removed lines

@@ -48,7 +48,7 @@ 
     /**
      * Access the only instance of this class
      *
-     * @return object
+     * @return references_utils
      *
      * @static
      * @staticvar   object
@@ -386,7 +386,7 @@ 
     /**
      * Internal function used to get the handler of the current module
      *
-     * @return object The module
+     * @return integer The module
      */
     public static function getModule()
     {
@@ -489,7 +489,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()
     {
@@ -550,7 +550,7 @@ 
     /**
      * Conversion d'un dateTime Mysql en date lisible en fran�ais
      * @param $dateTime
-     * @return bool|string
+     * @return string
      */
     public static function sqlDateTimeToFrench($dateTime)
     {
@@ -943,7 +943,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, $dstpath = XOOPS_UPLOAD_PATH, $mimeTypes = null, $uploadMaxSize = null, $maxWidth = null, $maxHeight = null)
     {
@@ -1031,7 +1031,7 @@ 
      *
      * @param int     $duration
      * @param integer $startingDate Date de départ (timestamp)
-     * @return bool|string
+     * @return string
      * @internal param int $durations Durée en jours
      */
     public static function addDaysToDate($duration = 1, $startingDate = 0)
@@ -1073,6 +1073,9 @@ 
         return $breadcrumb;
     }
 
+    /**
+     * @param string $string
+     */
     public static function close_tags($string)
     {
         // match opened tags
@@ -1394,7 +1397,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
      */

class/registryfile.php

Doc Comments +1 added lines, -1 removed lines

@@ -26,7 +26,7 @@
     /**
      * Access the only instance of this class
      *
-     * @return object
+     * @return references_registryfile
      *
      * @static
      * @staticvar   object

plugins/actions/twitter/Twitter.class.php

Doc Comments +7 added lines

@@ -16,6 +16,10 @@ 
     private $debug = false;
     public  $error = false;
 
+    /**
+     * @param string $user
+     * @param string $pass
+     */
     function __construct($user, $pass, $debug = false)
     {
         // Store an auth key for the HTTP Authorization: header
@@ -23,6 +27,9 @@ 
         $this->debug = $debug;
     }
 
+    /**
+     * @param string $new_status
+     */
     function update($new_status)
     {
         if (strlen($new_status) > 140) {

Braces +6 added lines, -2 removed lines

@@ -48,7 +48,9 @@ 
             $this->error = 'Socket error: Could not send all data.';
             return false;
         }
-        if ($this->debug) echo "Sent:\n{$to_send}\n\n";
+        if ($this->debug) {
+        	echo "Sent:\n{$to_send}\n\n";
+        }
         $response = '';
         while (!feof($fp)) {
             $buf = fread($fp, 1024);
@@ -58,7 +60,9 @@ 
             }
             $response .= $buf;
         }
-        if ($this->debug) echo "Received:\n{$response}";
+        if ($this->debug) {
+        	echo "Received:\n{$response}";
+        }
         $was_error = preg_match('#' . preg_quote('<error>') . '(.+)' . preg_quote('</error>') . '#i', $response, $matches);
         if ($was_error) {
             $this->error = "Twitter error: {$matches[1]}";