mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-03-14 04:30:15 +01:00
Code Issues Projects Releases Wiki Activity

Merged parameter function from STABLE (and added phpdoc)

Browse Source
This commit is contained in:
moodler 2004-09-28 15:41:36 +00:00
parent 7d492dde2a
commit 7ecd7c616d
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
lib/moodlelib.php
View File

@ -69,6 +69,7 @@ define('HOURMINS', 60);
* Ensure that a variable is set or display error
*
* If $var is undefined display an error message using the {@link error()} function.
* This function will soon be made obsolete by {@link parameter()}
*
* @param mixed $var the variable which may not be set
*/
@ -85,6 +86,7 @@ function require_variable($var) {
*
* If $var is undefined set it (by reference), otherwise return $var.
* This function is very similar to {@link nvl()}
* This function will soon be made obsolete by {@link parameter()}
*
* @param mixed $var the variable which may be unset
* @param mixed $default the value to return if $var is unset
@ -96,6 +98,32 @@ function optional_variable(&$var, $default=0) {
}
}
/**
* Returns a particular value for the named variable, taken from
* POST or GET, otherwise returning a given default.
*
* This function should be used to initialise all values in a script
* that are based on parameters. Usually it will be used like this:
*
* $id = (int)parameter('id');
*
* @param string $varname the name of the parameter variable we want
* @param mixed $default the default value to return if nothing is found
* @return mixed
*/
function parameter($varname, $default=NULL) {
if (isset($_POST[$varname])) { // POST has precedence
return $_POST[$varname];
}
if (isset($_GET[$varname])) {
return $_GET[$varname];
}
return $default;
}
/**
* Set a key in global configuration
*