API17

Difference between revisions of "JRequest"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
m (preparing for archive only)
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
−
<span class="editsection" style="font-size:76%;">
+
=={{JVer|11.1}} JRequest==
−
<nowiki>[</nowiki>[[Description:JRequest|Edit Descripton]]<nowiki>]</nowiki>
+
===Description===
−
</span>
+
[[API15:JRequest|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.
−
{{Description:JRequest}}
+
 
−
===Defined in===
+
===Note===
−
libraries/joomla/environment/request.php
+
JRequest is deprecated get the [[API17:JInput]] object from the application instead
−
===Subpackage===
 
−
[[Subpackage Environment/11.1|Environment]]
 
−
===Extends===
 
−
===Extended by===
 
 
===Methods===
 
===Methods===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 +
!Visibility
 
!Method name
 
!Method name
 
!Description
 
!Description
 
|-
 
|-
−
|[[JRequest::_cleanArray/11.1|_cleanArray]]
+
|public static
 +
|[[API17:JRequest::_cleanArray|_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.  
 
|-
 
|-
−
|[[JRequest::_cleanVar/11.1|_cleanVar]]
+
|public static
 +
|[[API17:JRequest::_cleanVar|_cleanVar]]
 
|Clean up an input variable.  
 
|Clean up an input variable.  
 
|-
 
|-
−
|[[JRequest::checkToken/11.1|checkToken]]
+
|public static
 +
|[[API17:JRequest::checkToken|checkToken]]
 
|Checks for a form token in the request.  
 
|Checks for a form token in the request.  
 
|-
 
|-
−
|[[JRequest::clean/11.1|clean]]
+
|public static
 +
|[[API17:JRequest::clean|clean]]
 
|Cleans the request from script injection.  
 
|Cleans the request from script injection.  
 
|-
 
|-
−
|[[JRequest::get/11.1|get]]
+
|public static
 +
|[[API17:JRequest::get|get]]
 
|Fetches and returns a request array.  
 
|Fetches and returns a request array.  
 
|-
 
|-
−
|[[JRequest::getBool/11.1|getBool]]
+
|public static
 +
|[[API17:JRequest::getBool|getBool]]
 
|Fetches and returns a given filtered variable.  
 
|Fetches and returns a given filtered variable.  
 
|-
 
|-
−
|[[JRequest::getCmd/11.1|getCmd]]
+
|public static
 +
|[[API17:JRequest::getCmd|getCmd]]
 
|Fetches and returns a given filtered variable.  
 
|Fetches and returns a given filtered variable.  
 
|-
 
|-
−
|[[JRequest::getFloat/11.1|getFloat]]
+
|public static
 +
|[[API17:JRequest::getFloat|getFloat]]
 
|Fetches and returns a given filtered variable.  
 
|Fetches and returns a given filtered variable.  
 
|-
 
|-
−
|[[JRequest::getInt/11.1|getInt]]
+
|public static
 +
|[[API17:JRequest::getInt|getInt]]
 
|Fetches and returns a given filtered variable.  
 
|Fetches and returns a given filtered variable.  
 
|-
 
|-
−
|[[JRequest::getMethod/11.1|getMethod]]
+
|public static
 +
|[[API17:JRequest::getMethod|getMethod]]
 
|Gets the request method.  
 
|Gets the request method.  
 
|-
 
|-
−
|[[JRequest::getString/11.1|getString]]
+
|public static
 +
|[[API17:JRequest::getString|getString]]
 
|Fetches and returns a given filtered variable.  
 
|Fetches and returns a given filtered variable.  
 
|-
 
|-
−
|[[JRequest::getURI/11.1|getURI]]
+
|public static
 +
|[[API17:JRequest::getURI|getURI]]
 
|Gets the full request path.  
 
|Gets the full request path.  
 
|-
 
|-
−
|[[JRequest::getVar/11.1|getVar]]
+
|public static
 +
|[[API17:JRequest::getVar|getVar]]
 
|Fetches and returns a given variable.  
 
|Fetches and returns a given variable.  
 
|-
 
|-
−
|[[JRequest::getWord/11.1|getWord]]
+
|public static
 +
|[[API17:JRequest::getWord|getWord]]
 
|Fetches and returns a given filtered variable.  
 
|Fetches and returns a given filtered variable.  
 
|-
 
|-
−
|[[JRequest::set/11.1|set]]
+
|public static
 +
|[[API17:JRequest::set|set]]
 
|Sets a request variable.  
 
|Sets a request variable.  
 
|-
 
|-
−
|[[JRequest::setVar/11.1|setVar]]
+
|public static
 +
|[[API17:JRequest::setVar|setVar]]
 
|Set a variabe in one of the request variables.  
 
|Set a variabe in one of the request variables.  
 
|-
 
|-
−
|[[JRequest::_stripSlashesRecursive/11.1|_stripSlashesRecursive]]
+
|protected static
 +
|[[API17:JRequest::_stripSlashesRecursive|_stripSlashesRecursive]]
 
|Strips slashes recursively on an array.  
 
|Strips slashes recursively on an array.  
 
|-
 
|-
 
|}
 
|}
 +
* '''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===
−
* [[JRequest|Other versions of this class]]
+
* {{JVer|11.1}} '''JRequest source code''' on [[jplatform:environment/request.php|BitBucket]]
−
{{SeeAlso:JRequest}}
+
* {{JVer|11.1}} Subpackage [[API17:Subpackage Environment|Environment]]
−
<span class="editsection" style="font-size:76%;">
+
* [[API17:JRequest|Other versions of JRequest]]
−
<nowiki>[</nowiki>[[SeeAlso:JRequest|Edit See Also]]<nowiki>]</nowiki>
+
* [[Retrieving_and_Filtering_GET_and_POST_requests_with_JRequest::getVar|Retrieving and Filtering GET and POST requests with JRequest::getVar]]
−
</span>
+
* [[Retrieving data from GET and POST requests]]
−
===Examples===
+
 
−
<CodeExamplesForm />
+
 
 +
===User contributed notes===
 +
=== Code Examples ===
 
<dpl>
 
<dpl>
 
noresultsheader=\n
 
noresultsheader=\n
 
category=JRequest
 
category=JRequest
−
category=CodeExample
+
namespace=CodeExample
 
category=ClassExample
 
category=ClassExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
−
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JRequest]]</noinclude>
+
<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

Latest revision as of 22:35, 24 March 2017

The "API17" 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.

Joomla 11.1 JRequest[edit]

Description[edit]

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.

Note[edit]

JRequest is deprecated get the API17:JInput object from the application instead

Methods[edit]

Visibility Method name Description
public static _cleanArray Adds an array to the GLOBALS array and checks that the GLOBALS variable is not being attacked.
public static _cleanVar Clean up an input variable.
public static checkToken Checks for a form token in the request.
public static clean Cleans the request from script injection.
public static get Fetches and returns a request array.
public static getBool Fetches and returns a given filtered variable.
public static getCmd Fetches and returns a given filtered variable.
public static getFloat Fetches and returns a given filtered variable.
public static getInt Fetches and returns a given filtered variable.
public static getMethod Gets the request method.
public static getString Fetches and returns a given filtered variable.
public static getURI Gets the full request path.
public static getVar Fetches and returns a given variable.
public static getWord Fetches and returns a given filtered variable.
public static set Sets a request variable.
public static setVar Set a variabe in one of the request variables.
protected static _stripSlashesRecursive Strips slashes recursively on an array.
  • Defined in libraries/joomla/environment/request.php

Importing[edit]

jimport( 'joomla.environment.request' );

See also[edit]


User contributed notes[edit]

Code Examples[edit]


Retrieved from "https://docs.joomla.org/index.php?title=API17:JRequest&oldid=385901"