Difference between revisions of "JRequest:: cleanVar"

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.

JRequest::_cleanVar[edit]

Description[edit]

Clean up an input variable.

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 {

Returns
Defined on line 544 of libraries/joomla/environment/request.php
Referenced by
- JModuleHelper::moduleCache

User contributed notes[edit]

Code Examples[edit]

@@ Line 4: / Line 4: @@
 Clean up an input variable.
-{{Description:JRequest::_cleanVar}}
-<span class="editsection" style="font-size:76%;">
-<nowiki>[</nowiki>[[Description:JRequest::_cleanVar|Edit Descripton]]<nowiki>]</nowiki>
-</span>
-===Synopsis===
 <source lang="php">
-public static JRequest::_cleanVar ($var, $mask=0, $type=null)
+public static function _cleanVar (
+        $var
+        $mask=0
+        $type=null
+)
 </source>
 {| class="wikitable"
@@ Line 35: / Line 36: @@
 |-
 |}
-===Returns===
+* '''Returns'''
+* '''Defined''' on line 544 of libraries/joomla/environment/request.php
+* '''Referenced by'''
+** [[API17:JModuleHelper::moduleCache|JModuleHelper::moduleCache]]
+===See also===
+* {{JVer|11.1}} '''JRequest::_cleanVar source code''' on [[jplatform:environment/request.php#cl-536|BitBucket]]
+* {{JVer|11.1}} Class [[API17:JRequest|JRequest]]
+* {{JVer|11.1}} Subpackage [[API17:Subpackage_Environment|Environment]]
+* [[API17:JRequest::_cleanVar|Other versions of JRequest::_cleanVar]]
-===Defined in===
-libraries/joomla/environment/request.php (line 543)
+===User contributed notes===
-* see source code in [[jplatform:environment/request.php#cl-543|BitBucket]]
+=== Code Examples ===
-===Referenced by===
-* [[JModuleHelper::moduleCache/11.1|JModuleHelper::moduleCache]]
-===See also===
-<span class="editsection" style="font-size:76%;">
-<nowiki>[</nowiki>[[SeeAlso:JRequest::_cleanVar|Edit See Also]]<nowiki>]</nowiki>
-</span>
-* [[JRequest/11.1|JRequest]]
-* [[JRequest::_cleanVar|Other versions of this method]]
-{{SeeAlso:JRequest::_cleanVar}}
-===Examples===
-<CodeExamplesForm />
 <dpl>
 noresultsheader=\n
 category=JRequest::_cleanVar
-category=CodeExample
+namespace=CodeExample
 category=MethodExample
 include=*
+namespace=CodeExample
 format= ,,,
 </dpl>
-<noinclude>[[Category:JRequest]][[Category:JRequest::_cleanVar]]</noinclude>
+<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

API17