API17:JRequest:: cleanVar
From Joomla! Documentation
(Difference between revisions)
(Bulk upload by Doxiki2) |
(Updated to r1448:247ba8d88526) |
||
| (One intermediate revision by one user not shown) | |||
| Line 8: | Line 8: | ||
<nowiki>[</nowiki>[[Description:JRequest::_cleanVar|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JRequest::_cleanVar|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
<source lang="php"> | <source lang="php"> | ||
| − | public static | + | public static function _cleanVar ( |
| + | $var | ||
| + | $mask=0 | ||
| + | $type=null | ||
| + | ) | ||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 35: | Line 38: | ||
|- | |- | ||
|} | |} | ||
| − | + | * '''Returns''' | |
| − | + | * '''Defined''' on line 544 of libraries/joomla/environment/request.php | |
| − | + | * '''Referenced by''' | |
| − | libraries/joomla/environment/request.php | + | ** [[JModuleHelper::moduleCache/11.1|JModuleHelper::moduleCache]] |
| − | + | ||
| − | * [[JModuleHelper | + | |
===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> | ||
| − | + | ===User contributed notes=== | |
| − | + | ||
| − | + | ||
| − | === | + | |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 56: | 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 21:32, 27 April 2011
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 { |
- Returns
- Defined on line 544 of libraries/joomla/environment/request.php
- Referenced by
See also
- JRequest::_cleanVar source code on BitBucket
- Class JRequest
- Subpackage Environment
- Other versions of JRequest::_cleanVar
SeeAlso:JRequest:: cleanVar [Edit See Also]
User contributed notes
<CodeExamplesForm />
