mambax7 / references

class/PEAR.php

Doc Comments +1 added lines, -1 removed lines

@@ -490,7 +490,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)

Spacing +24 added lines, -25 removed lines

@@ -28,11 +28,11 @@ 
 /**#@+
  * ERROR constants
  */
-define('references_PEAR_ERROR_RETURN',     1);
-define('references_PEAR_ERROR_PRINT',      2);
-define('references_PEAR_ERROR_TRIGGER',    4);
-define('references_PEAR_ERROR_DIE',        8);
-define('references_PEAR_ERROR_CALLBACK',  16);
+define('references_PEAR_ERROR_RETURN', 1);
+define('references_PEAR_ERROR_PRINT', 2);
+define('references_PEAR_ERROR_TRIGGER', 4);
+define('references_PEAR_ERROR_DIE', 8);
+define('references_PEAR_ERROR_CALLBACK', 16);
 /**
  * WARNING: obsolete
  * @deprecated
@@ -44,12 +44,12 @@ 
 
 if (substr(PHP_OS, 0, 3) == 'WIN') {
     define('references_OS_WINDOWS', true);
-    define('references_OS_UNIX',    false);
-    define('references_PEAR_OS',    'Windows');
+    define('references_OS_UNIX', false);
+    define('references_PEAR_OS', 'Windows');
 } else {
     define('references_OS_WINDOWS', false);
-    define('references_OS_UNIX',    true);
-    define('references_PEAR_OS',    'Unix'); // blatant assumption
+    define('references_OS_UNIX', true);
+    define('references_PEAR_OS', 'Unix'); // blatant assumption
 }
 
 // instant backwards compatibility
@@ -460,9 +460,9 @@ 
             // $error_code is a non-empty array here;
             // we walk through it trying to unset all
             // values
-            foreach($error_code as $key => $error) {
+            foreach ($error_code as $key => $error) {
                 if ($this->_checkDelExpect($error)) {
-                    $deleted =  true;
+                    $deleted = true;
                 } else {
                     $deleted = false;
                 }
@@ -870,7 +870,7 @@ 
                 unset($this->backtrace[0]['object']);
             }
         }
-        if ($mode & references_PEAR_ERROR_CALLBACK) {
+        if ($mode&references_PEAR_ERROR_CALLBACK) {
             $this->level = E_USER_NOTICE;
             $this->callback = $options;
         } else {
@@ -880,7 +880,7 @@ 
             $this->level = $options;
             $this->callback = null;
         }
-        if ($this->mode & references_PEAR_ERROR_PRINT) {
+        if ($this->mode&references_PEAR_ERROR_PRINT) {
             if (is_null($options) || is_int($options)) {
                 $format = "%s";
             } else {
@@ -888,10 +888,10 @@ 
             }
             printf($format, $this->getMessage());
         }
-        if ($this->mode & references_PEAR_ERROR_TRIGGER) {
+        if ($this->mode&references_PEAR_ERROR_TRIGGER) {
             trigger_error($this->getMessage(), $this->level);
         }
-        if ($this->mode & references_PEAR_ERROR_DIE) {
+        if ($this->mode&references_PEAR_ERROR_DIE) {
             $msg = $this->getMessage();
             if (is_null($options) || is_int($options)) {
                 $format = "%s";
@@ -903,12 +903,12 @@ 
             }
             die(sprintf($format, $msg));
         }
-        if ($this->mode & references_PEAR_ERROR_CALLBACK) {
+        if ($this->mode&references_PEAR_ERROR_CALLBACK) {
             if (is_callable($this->callback)) {
                 call_user_func($this->callback, $this);
             }
         }
-        if ($this->mode & references_PEAR_ERROR_EXCEPTION) {
+        if ($this->mode&references_PEAR_ERROR_EXCEPTION) {
             trigger_error("references_PEAR_ERROR_EXCEPTION is obsolete, use class PEAR_Exception for exceptions", E_USER_WARNING);
             eval('$e = new Exception($this->message, $this->code);throw($e);');
         }
@@ -952,7 +952,7 @@ 
      */
     function getMessage()
     {
-        return ($this->error_message_prefix . $this->message);
+        return ($this->error_message_prefix.$this->message);
     }
 
 
@@ -1060,11 +1060,10 @@ 
         $levels = array(E_USER_NOTICE  => 'notice',
                         E_USER_WARNING => 'warning',
                         E_USER_ERROR   => 'error');
-        if ($this->mode & references_PEAR_ERROR_CALLBACK) {
+        if ($this->mode&references_PEAR_ERROR_CALLBACK) {
             if (is_array($this->callback)) {
                 $callback = (is_object($this->callback[0]) ?
-                    strtolower(get_class($this->callback[0])) :
-                    $this->callback[0]) . '::' .
+                    strtolower(get_class($this->callback[0])) : $this->callback[0]).'::'.
                     $this->callback[1];
             } else {
                 $callback = $this->callback;
@@ -1075,16 +1074,16 @@ 
                            $callback, $this->error_message_prefix,
                            $this->userinfo);
         }
-        if ($this->mode & references_PEAR_ERROR_PRINT) {
+        if ($this->mode&references_PEAR_ERROR_PRINT) {
             $modes[] = 'print';
         }
-        if ($this->mode & references_PEAR_ERROR_TRIGGER) {
+        if ($this->mode&references_PEAR_ERROR_TRIGGER) {
             $modes[] = 'trigger';
         }
-        if ($this->mode & references_PEAR_ERROR_DIE) {
+        if ($this->mode&references_PEAR_ERROR_DIE) {
             $modes[] = 'die';
         }
-        if ($this->mode & references_PEAR_ERROR_RETURN) {
+        if ($this->mode&references_PEAR_ERROR_RETURN) {
             $modes[] = 'return';
         }
         return sprintf('[%s: message="%s" code=%d mode=%s level=%s '.

class/PersistableObjectHandler.php

Doc Comments +2 added lines, -2 removed lines

@@ -230,7 +230,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='*') {
         $ret = array();
@@ -489,7 +489,7 @@ 
     /**
      * delete an object from the database
      *
-     * @param object $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

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

class/references_categories.php

Doc Comments +2 added lines, -2 removed lines

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

class/references_handlers.php

Doc Comments +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
     /**
      * Retourne l'instance unique de la clanss
      *
-     * @return object
+     * @return references_handler
      */
 	public static function getInstance()
 	{

class/references_listFilter.php

Doc Comments +9 added lines, -11 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()
     {
@@ -278,7 +278,7 @@ 
 	 *
 	 * @param string $optionName
 	 * @param mixed $optionValue
-	 * @return object
+	 * @return references_listFilter
 	 */
     public function setOption($optionName, $optionValue)
     {
@@ -401,7 +401,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
      */
     function initFilter($fieldName, $parameters)
     {
@@ -456,7 +456,7 @@ 
     /**
      * Ajoute les critères par défaut au critère général
      *
-     * @return void
+     * @return references_listFilter
      */
     private function addDefaultCriterias()
     {
@@ -581,7 +581,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
      */
     function filter()
     {
@@ -703,7 +703,7 @@ 
 	 *
 	 * @param string $key
 	 * @param string $value
-	 * @return object
+	 * @return references_listFilter
 	 */
     function addAdditionnalParameterToPager($key, $value = '')
     {
@@ -716,7 +716,7 @@ 
 	 *
 	 * @param string $key
 	 * @param string $value
-	 * @return object
+	 * @return references_listFilter
 	 */
     function addAdditionnalParameterToClearButton($key, $value = '')
     {
@@ -727,9 +727,7 @@ 
 	/**
 	 * Permet d'ajouter des paramètres supplémentaires au pager
 	 *
-	 * @param string $key
-	 * @param string $value
-	 * @return object
+	 * @return references_listFilter
 	 */
     function addAditionnalArrayParametersToPager($array)
     {
@@ -744,7 +742,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}
      */
     function getPager()
     {

class/references_parameters.php

Doc Comments +1 added lines, -1 removed lines

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

class/references_plugins.php

Doc Comments +4 added lines, -4 removed lines

@@ -98,7 +98,7 @@ 
     /**
      * Retourne l'instance unique de la classe
      *
-     * @return object
+     * @return references_plugins
      */
 	public static function getInstance()
 	{
@@ -181,8 +181,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 references_parameters $parameters	Les paramètres à passer à chaque plugin
+	 * @return references_plugins				L'objet lui même pour chaîner
 	 */
 	function fireAction($eventToFire, references_parameters $parameters = null)
 	{
@@ -214,7 +214,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 references_parameters $parameters	Les paramètres à passer à chaque plugin
 	 * @return object				Le contenu de l'objet passé en paramètre
 	 */
 	function fireFilter($eventToFire, references_parameters &$parameters)

class/references_utils.php

Doc Comments +11 added lines, -9 removed lines

@@ -48,7 +48,7 @@ 
 	/**
 	 * Access the only instance of this class
      *
-     * @return	object
+     * @return	references_utils
      *
      * @static
      * @staticvar   object
@@ -273,7 +273,7 @@ 
 	/**
 	 * Send an email from a template to a list of recipients
 	 *
-	 * @param string $tpl_name	Template's name
+	 * @param string $tplName	Template's name
 	 * @param array $recipients	List of recipients
 	 * @param string $subject	Email's subject
 	 * @param array $variables	Varirables to give to the template
@@ -386,7 +386,7 @@ 
 	/**
 	 * Internal function used to get the handler of the current module
 	 *
-	 * @return object The module
+	 * @return integer The module
 	 */
 	function getModule()
 	{
@@ -470,7 +470,7 @@ 
 	/**
 	 * Retourne la liste des emails des utilisateurs membres d'un groupe
 	 *
-	 * @param int $group_id	Group's number
+	 * @param int $groupId	Group's number
 	 * @return array Emails list
 	 */
 	function getEmailsFromGroup($groupId)
@@ -487,7 +487,7 @@ 
 	/**
 	 * Vérifie que l'utilisateur courant fait partie du groupe des administrateurs
  	 *
-	 * @return booleean Admin or not
+	 * @return boolean Admin or not
  	*/
 	function isAdmin()
 	{
@@ -589,7 +589,6 @@ 
 	 * Mark the mandatory fields of a form with a star
 	 *
 	 * @param object $sform The form to modify
-	 * @param string $caracter The character to use to mark fields
 	 * @return object The modified form
 	 */
 	function &formMarkRequiredFields(&$sform)
@@ -931,7 +930,7 @@ 
 	 * Fonction chargée de gérer l'upload
 	 *
 	 * @param integer $indice L'indice du fichier à télécharger
-	 * @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
 	 */
 	function uploadFile($indice, $dstpath = XOOPS_UPLOAD_PATH, $mimeTypes = null, $uploadMaxSize = null, $maxWidth = null, $maxHeight = null)
 	{
@@ -1016,7 +1015,7 @@ 
 	/**
 	 * Ajoute des jours à une date et retourne la nouvelle date au format Date de Mysql
 	 *
-	 * @param integer $durations	Durée en jours
+	 * @param integer $duration	Durée en jours
 	 * @param integer $startingDate	Date de départ (timestamp)
 	 */
 	function addDaysToDate($duration = 1, $startingDate = 0)
@@ -1056,6 +1055,9 @@ 
 		return $breadcrumb;
 	}
 
+	/**
+	 * @param string $string
+	 */
 	function close_tags($string)
 	{
 		// match opened tags
@@ -1369,7 +1371,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
  	 * @return string
  	 */
     private function htmlSelectOptions($array, $default = 0, $withNull = true)