API16

JFilterInput/getInstance: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 68: Line 68:


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=getInstance
  category=getInstance
  category=JFilterInput
  category=JFilterInput
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*

Latest revision as of 01:40, 25 March 2017

Description

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


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

Syntax

static& getInstance($tagsArray=array(), $attrArray=array(), $tagsMethod=0, $attrMethod=0, $xssAuto=1)
Parameter Name Default Value Description
$tagsArray array() List of user-defined tags
$attrArray array() List of user-defined attributes
$tagsMethod 0 WhiteList method = 0, BlackList method = 1
$attrMethod 0 WhiteList method = 0, BlackList method = 1
$xssAuto 1 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

public static 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

Code Examples