Actions

API17

Difference between revisions of "JRequest:: cleanVar"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JRequest::_cleanVar|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JRequest::_cleanVar|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public static JRequest::_cleanVar ($var, $mask=0, $type=null)
+
public static function _cleanVar (
 +
        $var
 +
        $mask=0
 +
        $type=null
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 35: Line 38:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns'''
 
+
* '''Defined''' on line 544 of libraries/joomla/environment/request.php
===Defined in===
+
* '''Referenced by'''
libraries/joomla/environment/request.php (line 543)
+
** [[JModuleHelper::moduleCache/11.1|JModuleHelper::moduleCache]]
* see source code in [[jplatform:environment/request.php#cl-543|BitBucket]]
+
===Referenced by===
+
* [[JModuleHelper::moduleCache/11.1|JModuleHelper::moduleCache]]
+
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JRequest::_cleanVar source code''' on [[jplatform:environment/request.php#cl-536|BitBucket]]
 +
* {{JVer|11.1}} Class [[JRequest/11.1|JRequest]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Environment/11.1|Environment]]
 +
* [[JRequest::_cleanVar|Other versions of JRequest::_cleanVar]]
 +
{{SeeAlso:JRequest::_cleanVar}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JRequest::_cleanVar|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JRequest::_cleanVar|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JRequest/11.1|JRequest]]
+
===User contributed notes===
* [[JRequest::_cleanVar|Other versions of this method]]
+
{{SeeAlso:JRequest::_cleanVar}}
+
===Examples===
+
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 57: Line 59:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JRequest]][[Category:JRequest::_cleanVar]]</noinclude>
 
<noinclude>[[Category:JRequest]][[Category:JRequest::_cleanVar]]</noinclude>

Revision as of 20:32, 27 April 2011

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 JRequest::_cleanVar

Description

Clean up an input variable.

Description:JRequest:: cleanVar [Edit Descripton]

public static function _cleanVar (
        $var
        $mask=0
        $type=null
)
Parameter Type Default Description
$var mixed The input variable.
$mask int 0 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.
$type string null The variable type {

See also

SeeAlso:JRequest:: cleanVar [Edit See Also]

User contributed notes

<CodeExamplesForm />