[Fusionforge-commits] FusionForge branch master updated. 0d2acea17d4ce3f966c3685c75d2aa6a6317306c
Marc-Etienne VARGENAU
vargenau at fusionforge.org
Wed Feb 5 21:23:00 CET 2014
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 0d2acea17d4ce3f966c3685c75d2aa6a6317306c (commit)
from 85881ad39a8faddfce73515a7552eadf8cdddec0 (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 -----------------------------------------------------------------
commit 0d2acea17d4ce3f966c3685c75d2aa6a6317306c
Author: vargenau <Marc-Etienne.Vargenau at alcatel-lucent.com>
Date: Wed Feb 5 21:25:31 2014 +0100
Update PHP Doc
diff --git a/src/common/include/PluginManager.class.php b/src/common/include/PluginManager.class.php
index 4007e5c..c5a472c 100644
--- a/src/common/include/PluginManager.class.php
+++ b/src/common/include/PluginManager.class.php
@@ -49,7 +49,7 @@ class PluginManager extends Error {
/**
* GetPlugins() - get a list of installed plugins
*
- * @return hash of plugin id => plugin names
+ * @return array hash of plugin id => plugin names
*/
function GetPlugins() {
if (!isset($this->plugins_data)) {
diff --git a/src/common/include/TroveCat.class.php b/src/common/include/TroveCat.class.php
index 9d91397..1e3dc9e 100644
--- a/src/common/include/TroveCat.class.php
+++ b/src/common/include/TroveCat.class.php
@@ -44,13 +44,15 @@ class TroveCat extends Error {
return $this->fetchData($cat_id);
}
- /**
- * fetchData - May need to refresh database fields.
- *
- * If an update occurred and you need to access the updated info.
- *
- * @return bool success;
- */
+ /**
+ * fetchData - May need to refresh database fields.
+ *
+ * If an update occurred and you need to access the updated info.
+ *
+ * @param int $cat_id
+ * @param bool $res
+ * @return bool success;
+ */
function fetchData($cat_id, &$res = false) {
unset($this->data_array);
@@ -64,11 +66,10 @@ class TroveCat extends Error {
}
}
$row = db_fetch_array($res);
- if($row) {
+ if ($row) {
$this->data_array = $row;
return true;
- }
- else {
+ } else {
return false;
}
}
diff --git a/src/common/include/User.class.php b/src/common/include/User.class.php
index 4bcd88a..52dcf78 100644
--- a/src/common/include/User.class.php
+++ b/src/common/include/User.class.php
@@ -70,9 +70,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 The unix username - required
- * @param int The result set handle ("SELECT * FROM USERS WHERE user_id=xx")
- * @return 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);
@@ -1195,11 +1195,12 @@ Use one below, but make sure it is entered as the single line.)
return $this->data_array['title'];
}
- /**
- * getGroups - get an array of groups this user is a member of.
- *
- * @return array Array of groups.
- */
+ /**
+ * getGroups - get an array of groups this user is a member of.
+ *
+ * @param bool $onlylocal
+ * @return array Array of groups.
+ */
function &getGroups($onlylocal = true) {
$ids = array();
foreach ($this->getRoles() as $r) {
@@ -1226,12 +1227,12 @@ Use one below, but make sure it is entered as the single line.)
return $this->data_array['authorized_keys'];
}
- /**
- * addAuthorizedKey - add the SSH authorized key for the user.
- *
- * @param string $keys The users public keys.
- * @return boolean success.
- */
+ /**
+ * addAuthorizedKey - add the SSH authorized key for the user.
+ *
+ * @param string $key
+ * @return boolean success.
+ */
function addAuthorizedKey($key) {
$key = trim($key);
$key = preg_replace("/\r\n/", "\n", $key); // Convert to Unix EOL
@@ -1613,7 +1614,7 @@ Use one below, but make sure it is entered as the single line.)
* @return boolean success.
*/
function unsubscribeFromMailings($all = false) {
- $res1 = $res2 = $res3 = true;
+ $res2 = $res3 = true;
$res1 = db_query_params('UPDATE users SET mail_siteupdates=0, mail_va=0 WHERE user_id=$1',
array($this->getID()));
if ($all) {
@@ -1780,10 +1781,9 @@ function user_ismember($group_id, $type = 0) {
/**
* user_getname() - DEPRECATED; DO NOT USE! (TODO: document what should be used instead)
*
- * @param int $user_id The User ID
+ * @param bool|int $user_id The User ID
* @return string
* @deprecated
- *
*/
function user_getname($user_id = false) {
// use current user if one is not passed in
-----------------------------------------------------------------------
Summary of changes:
src/common/include/PluginManager.class.php | 2 +-
src/common/include/TroveCat.class.php | 21 +++++++++--------
src/common/include/User.class.php | 34 ++++++++++++++--------------
3 files changed, 29 insertions(+), 28 deletions(-)
hooks/post-receive
--
FusionForge
More information about the Fusionforge-commits
mailing list