JRequest/1.5
From Joomla! Documentation
< JRequest(Difference between revisions)
(Bulk upload by Doxiki2) |
(Layout updates) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|1.5}} JRequest== | ||
| + | ===Description=== | ||
| + | {{Description:JRequest}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JRequest|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JRequest|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public | ||
|[[JRequest::_cleanArray/1.5|_cleanArray]] | |[[JRequest::_cleanArray/1.5|_cleanArray]] | ||
|Adds an array to the GLOBALS array and checks that the GLOBALS variable is not being attacked. | |Adds an array to the GLOBALS array and checks that the GLOBALS variable is not being attacked. | ||
|- | |- | ||
| + | |public | ||
|[[JRequest::_cleanVar/1.5|_cleanVar]] | |[[JRequest::_cleanVar/1.5|_cleanVar]] | ||
|Clean up an input variable. | |Clean up an input variable. | ||
|- | |- | ||
| + | |public | ||
|[[JRequest::_stripSlashesRecursive/1.5|_stripSlashesRecursive]] | |[[JRequest::_stripSlashesRecursive/1.5|_stripSlashesRecursive]] | ||
|Strips slashes recursively on an array. | |Strips slashes recursively on an array. | ||
|- | |- | ||
| + | |public | ||
|[[JRequest::checkToken/1.5|checkToken]] | |[[JRequest::checkToken/1.5|checkToken]] | ||
|Checks for a form token in the request. | |Checks for a form token in the request. | ||
|- | |- | ||
| + | |public | ||
|[[JRequest::getMethod/1.5|getMethod]] | |[[JRequest::getMethod/1.5|getMethod]] | ||
|Gets the request method. | |Gets the request method. | ||
|- | |- | ||
| + | |public | ||
|[[JRequest::getURI/1.5|getURI]] | |[[JRequest::getURI/1.5|getURI]] | ||
|Gets the full request path. | |Gets the full request path. | ||
|- | |- | ||
| + | |public | ||
|[[JRequest::set/1.5|set]] | |[[JRequest::set/1.5|set]] | ||
|Sets a request variable. | |Sets a request variable. | ||
|- | |- | ||
| + | |public | ||
|[[JRequest::setVar/1.5|setVar]] | |[[JRequest::setVar/1.5|setVar]] | ||
|Set a variabe in on of the request variables. | |Set a variabe in on of the request variables. | ||
|- | |- | ||
| + | |public | ||
|[[JRequest::clean/1.5|clean]] | |[[JRequest::clean/1.5|clean]] | ||
|Cleans the request from script injection. | |Cleans the request from script injection. | ||
|- | |- | ||
| + | |public | ||
|[[JRequest::get/1.5|get]] | |[[JRequest::get/1.5|get]] | ||
|Fetches and returns a request array. | |Fetches and returns a request array. | ||
|- | |- | ||
| + | |public | ||
|[[JRequest::getBool/1.5|getBool]] | |[[JRequest::getBool/1.5|getBool]] | ||
|Fetches and returns a given filtered variable. | |Fetches and returns a given filtered variable. | ||
|- | |- | ||
| + | |public | ||
|[[JRequest::getCmd/1.5|getCmd]] | |[[JRequest::getCmd/1.5|getCmd]] | ||
|Fetches and returns a given filtered variable. | |Fetches and returns a given filtered variable. | ||
|- | |- | ||
| + | |public | ||
|[[JRequest::getFloat/1.5|getFloat]] | |[[JRequest::getFloat/1.5|getFloat]] | ||
|Fetches and returns a given filtered variable. | |Fetches and returns a given filtered variable. | ||
|- | |- | ||
| + | |public | ||
|[[JRequest::getInt/1.5|getInt]] | |[[JRequest::getInt/1.5|getInt]] | ||
|Fetches and returns a given filtered variable. | |Fetches and returns a given filtered variable. | ||
|- | |- | ||
| + | |public | ||
|[[JRequest::getString/1.5|getString]] | |[[JRequest::getString/1.5|getString]] | ||
|Fetches and returns a given filtered variable. | |Fetches and returns a given filtered variable. | ||
|- | |- | ||
| + | |public | ||
|[[JRequest::getVar/1.5|getVar]] | |[[JRequest::getVar/1.5|getVar]] | ||
|Fetches and returns a given variable. | |Fetches and returns a given variable. | ||
|- | |- | ||
| + | |public | ||
|[[JRequest::getWord/1.5|getWord]] | |[[JRequest::getWord/1.5|getWord]] | ||
|Fetches and returns a given filtered variable. | |Fetches and returns a given filtered variable. | ||
|- | |- | ||
|} | |} | ||
| + | * '''Defined in''' libraries/joomla/environment/request.php | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.environment.request' );</source> | <source lang="php">jimport( 'joomla.environment.request' );</source> | ||
===See also=== | ===See also=== | ||
| + | * {{JVer|1.5}} '''JRequest''' on [http://api.joomla.org/Joomla-Framework/Environment/JRequest.html api.joomla.org] | ||
| + | * {{JVer|1.5}} '''JRequest source code''' on [[jframework15:environment/request.php|JoomlaCode]] | ||
| + | * {{JVer|1.5}} Subpackage [[Subpackage Environment/1.5|Environment]] | ||
| + | * [[JRequest|Other versions of JRequest]] | ||
| + | {{SeeAlso:JRequest}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JRequest|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JRequest|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | + | ===User contributed notes=== | |
| − | + | ||
| − | + | ||
| − | === | + | |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 85: | Line 102: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:Framework]][[Category:Framework 1.5]][[Category:JRequest]]</noinclude> | <noinclude>[[Category:Framework]][[Category:Framework 1.5]][[Category:JRequest]]</noinclude> | ||
Revision as of 18:12, 25 April 2011
JRequest
Description
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. [Edit Descripton]
Methods
| Visibility | Method name | Description |
|---|---|---|
| public | _cleanArray | Adds an array to the GLOBALS array and checks that the GLOBALS variable is not being attacked. |
| public | _cleanVar | Clean up an input variable. |
| public | _stripSlashesRecursive | Strips slashes recursively on an array. |
| public | checkToken | Checks for a form token in the request. |
| public | getMethod | Gets the request method. |
| public | getURI | Gets the full request path. |
| public | set | Sets a request variable. |
| public | setVar | Set a variabe in on of the request variables. |
| public | clean | Cleans the request from script injection. |
| public | get | Fetches and returns a request array. |
| public | getBool | Fetches and returns a given filtered variable. |
| public | getCmd | Fetches and returns a given filtered variable. |
| public | getFloat | Fetches and returns a given filtered variable. |
| public | getInt | Fetches and returns a given filtered variable. |
| public | getString | Fetches and returns a given filtered variable. |
| public | getVar | Fetches and returns a given variable. |
| public | getWord | Fetches and returns a given filtered variable. |
- Defined in libraries/joomla/environment/request.php
Importing
jimport( 'joomla.environment.request' );
See also
-
JRequest on api.joomla.org
-
JRequest source code on JoomlaCode
-
Subpackage Environment
- Other versions of JRequest
- Retrieving data from GET and POST requests
User contributed notes
<CodeExamplesForm />