API15:JFilterInput/getInstance

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.

Description

Returns a reference to an input filter object, only creating it if it doesn't already exist.

<! removed transcluded page call, red link never existed >

Syntax

& getInstance($tagsArray=array(), $attrArray=array(), $tagsMethod=0, $attrMethod=0, $xssAuto=1)

Parameter Name	Default Value	Description
$tagsArray	array()	$tagsArray list of user-defined tags
$attrArray	array()	$attrArray list of user-defined attributes
$tagsMethod	0	$tagsMethod WhiteList method = 0, BlackList method = 1
$attrMethod	0	$attrMethod WhiteList method = 0, BlackList method = 1
$xssAuto	1	$xssAuto Only auto clean essentials = 0, Allow clean blacklisted tags/attr = 1

Returns

object The object.

Defined in

libraries/joomla/filter/filterinput.php

Importing

jimport( 'joomla.filter.filterinput' );

Source Body

function & getInstance($tagsArray = array(), $attrArray = array(), $tagsMethod = 0, $attrMethod = 0, $xssAuto = 1)
{
        static $instances;
 
        $sig = md5(serialize(array($tagsArray,$attrArray,$tagsMethod,$attrMethod,$xssAuto)));
 
        if (!isset ($instances)) {
                $instances = array();
        }
 
        if (empty ($instances[$sig])) {
                $instances[$sig] = new JFilterInput($tagsArray, $attrArray, $tagsMethod, $attrMethod, $xssAuto);
        }
 
        return $instances[$sig];
}

<! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />