[Fusionforge-commits] FusionForge branch master updated. v6.1-129-g0640ca2

Franck Villaume nerville at libremir.placard.fr.eu.org
Fri Dec 7 20:15:03 CET 2018


This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "FusionForge".

The branch, master has been updated
       via  0640ca2f19a9b337d4a9e7eb351216a700cbea48 (commit)
      from  a5a3788f9f15f3accc41648be85ebfba950ad7b0 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
https://scm.fusionforge.org/anonscm/gitweb/?p=fusionforge/fusionforge.git;a=commitdiff;h=0640ca2f19a9b337d4a9e7eb351216a700cbea48

commit 0640ca2f19a9b337d4a9e7eb351216a700cbea48
Author: Franck Villaume <franck.villaume at trivialdev.com>
Date:   Fri Dec 7 20:14:40 2018 +0100

    clean-up & fix comment

diff --git a/src/common/include/User.class.php b/src/common/include/User.class.php
index 0f17a94..2e1f0b2 100644
--- a/src/common/include/User.class.php
+++ b/src/common/include/User.class.php
@@ -5,7 +5,7 @@
  * Copyright 1999-2001, VA Linux Systems, Inc.
  * Copyright 2009-2010, Roland Mas
  * Copyright 2011, Franck Villaume - Capgemini
- * Copyright 2012-2015, Franck Villaume - TrivialDev
+ * Copyright 2012-2015,2018, Franck Villaume - TrivialDev
  * Copyright (C) 2012 Alain Peyrat - Alcatel-Lucent
  * http://fusionforge.org
  *
@@ -34,9 +34,9 @@ $USER_OBJ = array();
  * user_get_object is useful so you can pool user objects/save database queries
  * You should always use this instead of instantiating the object directly
  *
- * @param string       $user_name The unix username - required
- * @param bool|int     $res       The result set handle ("SELECT * FROM USERS WHERE user_id=xx")
- * @return FFUser User object or false on failure
+ * @param	string		$user_name	The unix username - required
+ * @param	bool|int	$res		The result set handle ("SELECT * FROM USERS WHERE user_id=xx")
+ * @return	FFUser User object or false on failure
  */
 function &user_get_object_by_name($user_name, $res = false) {
 	$user_name = strtolower($user_name);
@@ -49,11 +49,11 @@ function &user_get_object_by_name($user_name, $res = false) {
 
 /**
  * user_get_object_by_email() - Get User object by email address
- * Only works if sys_require_unique_email is true
+ * Only works if require_unique_email is true
  *
- * @param string    $email The unix username - required
- * @param bool|int  $res   The result set handle ("SELECT * FROM USERS WHERE user_id=xx")
- * @return FFUser|bool User object or false on failure
+ * @param	string		$email	The unix username - required
+ * @param	bool|int	$res	The result set handle ("SELECT * FROM USERS WHERE user_id=xx")
+ * @return	FFUser|bool User object or false on failure
  */
 function user_get_object_by_email($email, $res = false) {
 	if (!validate_email($email)
@@ -72,9 +72,9 @@ function user_get_object_by_email($email, $res = false) {
  * user_get_object is useful so you can pool user objects/save database queries
  * You should always use this instead of instantiating the object directly
  *
- * @param    string $user_name The unix username - required
- * @param bool|int $res The result set handle ("SELECT * FROM USERS WHERE user_id=xx")
- * @return    object a user object or false on failure
+ * @param	string		$user_name	The unix username - required
+ * @param	bool|int	$res		The result set handle ("SELECT * FROM USERS WHERE user_id=xx")
+ * @return	object a user object or false on failure
  */
 function &user_get_object_by_name_or_email($user_name, $res = false) {
 	$user = user_get_object_by_name($user_name, $res);
@@ -95,9 +95,9 @@ function &user_get_object_by_name_or_email($user_name, $res = false) {
  * user_get_object is useful so you can pool user objects/save database queries
  * You should always use this instead of instantiating the object directly
  *
- * @param int      $user_id The ID of the user - required
- * @param int|bool $res     The result set handle ("SELECT * FROM USERS WHERE user_id=xx")
- * @return FFUser a user object or false on failure
+ * @param	int		$user_id	The ID of the user - required
+ * @param	int|bool	$res		The result set handle ("SELECT * FROM USERS WHERE user_id=xx")
+ * @return	FFUser a user object or false on failure
  */
 function &user_get_object($user_id, $res = false) {
 	//create a common set of group objects
@@ -124,8 +124,8 @@ function &user_get_object($user_id, $res = false) {
 }
 
 /**
- * @param $id_arr
- * @return FFUser[]
+ * @param	$id_arr
+ * @return	FFUser[]
  */
 function &user_get_objects($id_arr) {
 	global $USER_OBJ;
@@ -154,8 +154,8 @@ function &user_get_objects($id_arr) {
 }
 
 /**
- * @param string $username_arr
- * @return FFUser[]
+ * @param	string	$username_arr
+ * @return	FFUser[]
  */
 function &user_get_objects_by_name($username_arr) {
 	$res = db_query_params('SELECT user_id FROM users WHERE lower(user_name) = ANY ($1)',
@@ -165,8 +165,8 @@ function &user_get_objects_by_name($username_arr) {
 }
 
 /**
- * @param string $email_arr
- * @return FFUser[]
+ * @param	string	$email_arr
+ * @return	FFUser[]
  */
 function &user_get_objects_by_email($email_arr) {
 	$res = db_query_params('SELECT user_id FROM users WHERE lower(email) = ANY ($1)',
@@ -238,8 +238,8 @@ class FFUser extends FFError {
 	 * CONSTRUCTOR - GENERALLY DON'T USE THIS
 	 * instead use the user_get_object() function call
 	 *
-	 * @param bool|int $id  The user_id
-	 * @param bool|int $res The database result set OR array of data
+	 * @param	bool|int	$id	The user_id
+	 * @param	bool|int	$res	The database result set OR array of data
 	 */
 	function __construct($id = false, $res = false) {
 		parent::__construct();

-----------------------------------------------------------------------

Summary of changes:
 src/common/include/User.class.php | 44 +++++++++++++++++++--------------------
 1 file changed, 22 insertions(+), 22 deletions(-)


hooks/post-receive
-- 
FusionForge



More information about the Fusionforge-commits mailing list