JRequest
JRequest Class
This class serves to provide the Joomla Framework 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 /joomla/environment/request.php (line 42)
JRequest (Subpackage Environment)
static string
getString
(string $name, [string $default = ''], [string $hash = 'default'], [int $mask = 0])
static mixed
getVar
(string $name, [string $default = null], [string $hash = 'default'], [string $type = 'none'], [int $mask = 0])
string
setVar
(string $name, [string $value = null], [string $hash = 'method'], [boolean $overwrite = true])
Checks for a form token in the request
Use in conjuction 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)
- int $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)
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 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)
- int $mask: Filter mask for the variable
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()
- int $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 ingored
Set a variabe in on of the request variables
- string $name: Name
- string $value: Value
- string $hash: Hash
- boolean $overwrite: Boolean
Adds an array to the GLOBALS array and checks that the GLOBALS variable is not being attacked
- array $array: Array to clean
- boolean $globalise: True if the array is to be added to the GLOBALS
- &$array
Clean up an input variable.
- mixed $var: The input variable.
- int $mask: Filter bit mask. 1=no trim: If this flag is cleared and the input is a string, the string will have leading and trailing whitespace trimmed. 2=allow_raw: If set, no more filtering is performed, higher bits are ignored. 4=allow_html: HTML is allowed, but passed through a safe HTML filter first. If set, no more filtering is performed. If no bits other than the 1 bit is set, a strict filter is applied.
- string $type: The variable type {@see JFilterInput::clean()}.
Strips slashes recursively on an array
- array $array: Array of (nested arrays of) strings
- $value