API16

JRequest

From Joomla! Documentation

The "API16" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

JRequest provides 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.

Defined in[edit]

libraries/joomla/environment/request.php

Methods[edit]

Method name Description
getURI Gets the full request path.
getMethod Gets the request method.
getVar Fetches and returns a given variable.
getInt 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().
getFloat Fetches and returns a given filtered variable. The float filter only allows digits and periods. This is currently only a proxy function for getVar().
getBool 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().
getWord 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().
getCmd 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().
getString 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().
setVar Set a variabe in on of the request variables.
get Fetches and returns a request array.
set Sets a request variable.
checkToken Checks for a form token in the request.
clean Cleans the request from script injection.

Importing[edit]

jimport( 'joomla.environment.request' );


Examples[edit]

Code Examples[edit]