From 2d055f0a6e3d271fd435e5d7c18fa999224d6dc4 Mon Sep 17 00:00:00 2001 From: jervfors Date: Sat, 5 Nov 2005 21:30:50 +0000 Subject: [PATCH] Documentation update git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@10257 7612ce4b-ef26-0410-bec9-ea0150e637f0 --- functions/global.php | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/functions/global.php b/functions/global.php index 0f37590d..610a9b2e 100644 --- a/functions/global.php +++ b/functions/global.php @@ -129,20 +129,19 @@ function sqsession_is_registered ($name) { } /** - * Search for the var $name in $_SESSION, $_POST, $_GET, - * $_COOKIE, or $_SERVER and set it in provided var. + * Search for the var $name in $_SESSION, $_POST, $_GET, $_COOKIE, or $_SERVER + * and set it in provided var. * - * If $search is not provided, or == SQ_INORDER, it will search - * $_SESSION, then $_POST, then $_GET. Otherwise, - * use one of the defined constants to look for - * a var in one place specifically. + * If $search is not provided, or if it is SQ_INORDER, it will search $_SESSION, + * then $_POST, then $_GET. If $search is SQ_FORM it will search $_POST and + * $_GET. Otherwise, use one of the defined constants to look for a var in one + * place specifically. * - * Note: $search is an int value equal to one of the - * constants defined above. + * Note: $search is an int value equal to one of the constants defined above. * - * example: - * sqgetGlobalVar('username',$username,SQ_SESSION); - * -- no quotes around last param! + * Example: + * sqgetGlobalVar('username',$username,SQ_SESSION); + * // No quotes around last param, it's a constant - not a string! * * @param string name the name of the var to search * @param mixed value the variable to return @@ -369,5 +368,4 @@ $PHP_SELF = php_self(); sqsession_is_active(); -// vim: et ts=4 ?> \ No newline at end of file -- 2.25.1