mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-03-13 20:26:32 +01:00
Code Issues Projects Releases Wiki Activity

MDL-24063 finally after so many years developers have to specify parameter types in optional_param() and required_param() - the developers get standard PHP notices and debugging info, hopefully that will be enough to persuade everybody to stop abusing default PARAM_CLEAN; fixing php docs

Browse Source
This commit is contained in:
Petr Skoda 2010-09-02 17:51:59 +00:00
parent 40ea93a4fe
commit 44913c8d47
1 changed files with 24 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
lib/moodlelib.php
View File

@ -236,6 +236,7 @@ define('PARAM_STRINGID', 'stringid');
/**
* PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
* It was one of the first types, that is why it is abused so much ;-)
* @deprecated since 2.0
*/
define('PARAM_CLEAN', 'clean');
@ -429,12 +430,18 @@ define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
* used like this:
* $id = required_param('id', PARAM_INT);
*
* @param string $parname the name of the page parameter we want,
* default PARAM_CLEAN
* @param int $type expected type of parameter
* Please note the $type parameter is now required,
* for now PARAM_CLEAN is used for backwards compatibility only.
*
* @param string $parname the name of the page parameter we want
* @param string $type expected type of parameter
* @return mixed
*/
function required_param($parname, $type=PARAM_CLEAN) {
function required_param($parname, $type) {
if (!isset($type)) {
debugging('required_param() requires $type to be specified.');
$type = PARAM_CLEAN; // for now let's use this deprecated type
}
if (isset($_POST[$parname])) { // POST has precedence
$param = $_POST[$parname];
} else if (isset($_GET[$parname])) {
@ -455,12 +462,23 @@ function required_param($parname, $type=PARAM_CLEAN) {
* used like this:
* $name = optional_param('name', 'Fred', PARAM_TEXT);
*
* Please note $default and $type parameters are now required,
* for now PARAM_CLEAN is used for backwards compatibility only.
*
* @param string $parname the name of the page parameter we want
* @param mixed $default the default value to return if nothing is found
* @param int $type expected type of parameter, default PARAM_CLEAN
* @param string $type expected type of parameter
* @return mixed
*/
function optional_param($parname, $default=NULL, $type=PARAM_CLEAN) {
function optional_param($parname, $default, $type) {
if (!isset($type)) {
debugging('optional_param() requires $default and $type to be specified.');
$type = PARAM_CLEAN; // for now let's use this deprecated type
}
if (!isset($default)) {
$default = null;
}
if (isset($_POST[$parname])) { // POST has precedence
$param = $_POST[$parname];
} else if (isset($_GET[$parname])) {