Back to InputFilter class

Method getInstance

public static \Joomla\CMS\Filter\InputFilter
getInstance
(mixed $tagsArray = array(), mixed $attrArray = array(), mixed $tagsMethod = 0, mixed $attrMethod = 0, mixed $xssAuto = 1, mixed $stripUSC = 0)
Returns an input filter object, only creating it if it doesn't already exist.
Parameters
  • array $tagsArray List of user-defined tags
  • array $attrArray List of user-defined attributes
  • int $tagsMethod The constant static::ONLY_ALLOW_DEFINED_TAGS or static::BLOCK_DEFINED_TAGS
  • int $attrMethod The constant static::ONLY_ALLOW_DEFINED_ATTRIBUTES or static::BLOCK_DEFINED_ATTRIBUTES
  • int $xssAuto Only auto clean essentials = 0, Allow clean blocked tags/attributes = 1
  • int $stripUSC Strip 4-byte unicode characters = 1, no strip = 0
Returns
  • \Joomla\CMS\Filter\InputFilter The InputFilter object.
Since
  • 1.7.0
Class: InputFilter
Project: Joomla

Method getInstance - Source code

/**
 * Returns an input filter object, only creating it if it doesn't already exist.
 *
 * @param   array    $tagsArray   List of user-defined tags
 * @param   array    $attrArray   List of user-defined attributes
 * @param   integer  $tagsMethod  The constant static::ONLY_ALLOW_DEFINED_TAGS or static::BLOCK_DEFINED_TAGS
 * @param   integer  $attrMethod  The constant static::ONLY_ALLOW_DEFINED_ATTRIBUTES or static::BLOCK_DEFINED_ATTRIBUTES
 * @param   integer  $xssAuto     Only auto clean essentials = 0, Allow clean blocked tags/attributes = 1
 * @param   integer  $stripUSC    Strip 4-byte unicode characters = 1, no strip = 0
 *
 * @return  InputFilter  The InputFilter object.
 *
 * @since   1.7.0
 */
public static function getInstance($tagsArray = array(), $attrArray = array(), $tagsMethod = 0, $attrMethod = 0, $xssAuto = 1, $stripUSC = 0)
{
    $sig = md5(serialize(array($tagsArray, $attrArray, $tagsMethod, $attrMethod, $xssAuto)));
    if (empty(self::$instances[$sig])) {
        self::$instances[$sig] = new InputFilter($tagsArray, $attrArray, $tagsMethod, $attrMethod, $xssAuto, $stripUSC);
    }
    return self::$instances[$sig];
}