[evolvis-commits] r14697: Add some bits of doc?==?UTF-8?Q?s↵

mirabilos at evolvis.org mirabilos at evolvis.org
Mon Feb 28 04:45:53 CET 2011


Author: mirabilos
Date: 2011-02-28 04:45:52 +0100 (Mon, 28 Feb 2011)
New Revision: 14697

Modified:
   trunk/gforge_base/evolvisforge-5.1/gforge/common/include/utils.php
Log:
Add some bits of docs


Modified: trunk/gforge_base/evolvisforge-5.1/gforge/common/include/utils.php
===================================================================
--- trunk/gforge_base/evolvisforge-5.1/gforge/common/include/utils.php	2011-02-28 03:45:44 UTC (rev 14696)
+++ trunk/gforge_base/evolvisforge-5.1/gforge/common/include/utils.php	2011-02-28 03:45:52 UTC (rev 14697)
@@ -975,6 +975,11 @@
 	return utf8_encode($find);
 }
 
+/**
+ * Constructs the forge's URL prefix out of $GLOBALS['sys_urlprefix']
+ * 
+ * @return string
+ */
 function normalized_urlprefix () {
 	$prefix = $GLOBALS['sys_urlprefix'] ;
 	$prefix = ereg_replace ("^/", "", $prefix) ;
@@ -985,6 +990,12 @@
 	return $prefix ;
 }
 
+/**
+ * Construct full URL from a relative path
+ * 
+ * @param string $path
+ * @return string URL
+ */
 function util_make_url ($path) {
 	if ($GLOBALS['sys_use_ssl']) 
 		$url = "https://" ;
@@ -996,6 +1007,12 @@
 	return $url ;
 }
 
+/**
+ * Construct proper (relative) URI (prepending prefix)
+ * 
+ * @param string $path
+ * @return string URI
+ */
 function util_make_uri ($path) {
 	$path = ereg_replace ("^/", "", $path) ;
 	$uri = normalized_urlprefix () ;
@@ -1017,10 +1034,25 @@
 	}
 }
 
+/**
+ * Create an HTML link to a user's profile page
+ * 
+ * @param string $username
+ * @param int $user_id
+ * @param string $text
+ * @return string
+ */
 function util_make_link_u ($username, $user_id,$text) {
 	return '<a href="' . util_make_url_u ($username, $user_id) . '">' . $text . '</a>' ;
 }
 
+/**
+ * Create URL for user's profile page
+ * 
+ * @param string $username
+ * @param int $user_id
+ * @return string URL
+ */
 function util_make_url_u ($username, $user_id) {
 	if (isset ($GLOBALS['sys_noforcetype']) && $GLOBALS['sys_noforcetype']) {
 		return util_make_url ("/developer/?user_id=$user_id");
@@ -1029,10 +1061,24 @@
 	}
 }
 
+/**
+ * Create a HTML link to a project's page
+ * @param string $groupame
+ * @param int $group_id
+ * @param string $text
+ * @return string
+ */
 function util_make_link_g ($groupame, $group_id,$text) {
 	return '<a href="' . util_make_url_g ($groupame, $group_id) . '">' . $text . '</a>' ;
 }
 
+/**
+ * Create URL for a project's page
+ * 
+ * @param string $groupame
+ * @param int $group_id
+ * @return string
+ */
 function util_make_url_g ($groupame, $group_id) {
 	if (isset ($GLOBALS['sys_noforcetype']) && $GLOBALS['sys_noforcetype']) {
 		return util_make_url ("/project/?group_id=$group_id");



More information about the evolvis-commits mailing list