JRequest
JRequest Class
This class serves to provide the Joomla Platform with a common interface to access request variables. This includes $_POST, $_GET, and naturally $_REQUEST. Variables can be passed through an input filter to avoid injection or returned raw.
Located in /libraries/joomla/environment/request.php (line 38)
JRequest (Subpackage Environment)
static string
getString
(string $name, [string $default = ''], [string $hash = 'default'], [integer $mask = 0])
static mixed
getVar
(string $name, [string $default = null], [string $hash = 'default'], [string $type = 'none'], [integer $mask = 0])
static string
setVar
(string $name, [string $value = null], [string $hash = 'method'], [boolean $overwrite = true])
Checks for a form token in the request.
Use in conjunction with JHtml::_('form.token').
- string $method: The request method in which to look for the token key.
Fetches and returns a request array.
The default behaviour is fetching variables depending on the current request method: GET and HEAD will result in returning $_GET, POST and PUT will result in returning $_POST.
You can force the source by setting the $hash parameter:
post $_POST get $_GET files $_FILES cookie $_COOKIE env $_ENV server $_SERVER method via current $_SERVER['REQUEST_METHOD'] default $_REQUEST
- string $hash: to get (POST, GET, FILES, METHOD).
- integer $mask: Filter mask for the variable.
Fetches and returns a given filtered variable. The bool filter will only return true/false bool values. This is currently only a proxy function for getVar().
See getVar() for more in-depth documentation on the parameters.
- string $name: Variable name.
- string $default: Default value if the variable does not exist.
- string $hash: Where the var should come from (POST, GET, FILES, COOKIE, METHOD).
Cmd (Word and Integer0 filter
Fetches and returns a given filtered variable. The cmd filter only allows the characters [A-Za-z0-9.-_]. This is currently only a proxy function for getVar().
See getVar() for more in-depth documentation on the parameters.
- string $name: Variable name
- string $default: Default value if the variable does not exist
- string $hash: Where the var should come from (POST, GET, FILES, COOKIE, METHOD)
Fetches and returns a given filtered variable. The float filter only allows digits and periods. This is currently only a proxy function for getVar().
See getVar() for more in-depth documentation on the parameters.
- string $name: Variable name.
- string $default: Default value if the variable does not exist.
- string $hash: Where the var should come from (POST, GET, FILES, COOKIE, METHOD).
Fetches and returns a given filtered variable. The integer filter will allow only digits and the - sign to be returned. This is currently only a proxy function for getVar().
See getVar() for more in-depth documentation on the parameters.
- string $name: Variable name.
- string $default: Default value if the variable does not exist.
- string $hash: Where the var should come from (POST, GET, FILES, COOKIE, METHOD).
Fetches and returns a given filtered variable. The string filter deletes 'bad' HTML code, if not overridden by the mask.
This is currently only a proxy function for getVar().
See getVar() for more in-depth documentation on the parameters.
- string $name: Variable name
- string $default: Default value if the variable does not exist
- string $hash: Where the var should come from (POST, GET, FILES, COOKIE, METHOD)
- integer $mask: Filter mask for the variable
Fetches and returns a given filtered variable. The unsigned integer filter will allow only digits to be returned. This is currently only a proxy function for getVar().
See getVar() for more in-depth documentation on the parameters.
- string $name: Variable name.
- string $default: Default value if the variable does not exist.
- string $hash: Where the var should come from (POST, GET, FILES, COOKIE, METHOD).
Fetches and returns a given variable.
The default behaviour is fetching variables depending on the current request method: GET and HEAD will result in returning an entry from $_GET, POST and PUT will result in returning an entry from $_POST.
You can force the source by setting the $hash parameter:
post $_POST get $_GET files $_FILES cookie $_COOKIE env $_ENV server $_SERVER method via current $_SERVER['REQUEST_METHOD'] default $_REQUEST
- string $name: Variable name.
- string $default: Default value if the variable does not exist.
- string $hash: Where the var should come from (POST, GET, FILES, COOKIE, METHOD).
- string $type: Return type for the variable, for valid values see JFilterInput::clean().
- integer $mask: Filter mask for the variable.
Fetches and returns a given filtered variable. The word filter only allows the characters [A-Za-z_]. This is currently only a proxy function for getVar().
See getVar() for more in-depth documentation on the parameters.
- string $name: Variable name.
- string $default: Default value if the variable does not exist.
- string $hash: Where the var should come from (POST, GET, FILES, COOKIE, METHOD).
Sets a request variable.
- array $array: An associative array of key-value pairs.
- string $hash: The request variable to set (POST, GET, FILES, METHOD).
- boolean $overwrite: If true and an existing key is found, the value is overwritten, otherwise it is ignored.
Set a variable in one of the request variables.
- string $name: Name
- string $value: Value
- string $hash: Hash
- boolean $overwrite: Boolean
Clean up an input variable.
- mixed $var: The input variable.
-
integer
$mask: Filter bit mask.
- = no trim: If this flag is cleared and the input is a string, the string will have leading and trailing whitespace trimmed.
- = allow_raw: If set, no more filtering is performed, higher bits are ignored.
- string $type: The variable type {@see JFilterInput::clean()}.
Strips slashes recursively on an array.
- array $value: Array or (nested arrays) of strings.