JRequest:: cleanVar
From Joomla! Documentation
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
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.
Template:Description:JRequest:: cleanVar [Edit Descripton]
Synopsis[edit]
public static JRequest::_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[edit]
Defined in[edit]
libraries/joomla/environment/request.php (line 543)
- see source code in BitBucket
Referenced by[edit]
See also[edit]
Template:SeeAlso:JRequest:: cleanVar
Examples[edit]
<CodeExamplesForm />