\HTMLPurifier_AttrDef_HTML_Class

Implements special behavior for class attribute (normally NMTOKENS)

Summary

Methods

Properties

Constants

validate()
parseCDATA()
make()

$minimized
$required

No constants found

split()
filter()
mungeRgb()
expandCSSEscape()

No protected properties found

N/A

No private methods found

No private properties found

N/A

Properties

$minimized

$minimized

Tells us whether or not an HTML attribute is minimized.

Has no meaning in other contexts.

Inherited from: \HTMLPurifier_AttrDef
Uses

Methods

validate()

validate(string  $string, \HTMLPurifier_Config  $config, \HTMLPurifier_Context  $context) : mixed

Validates and cleans passed string according to a definition.

Parameters

string	$string	String to be validated and cleaned.
\HTMLPurifier_Config	$config	Mandatory HTMLPurifier_Config object.
\HTMLPurifier_Context	$context	Mandatory HTMLPurifier_Context object.

Returns

mixed —

parseCDATA()

parseCDATA(mixed  $string) : mixed

Convenience method that parses a string as if it were CDATA.

This method process a string in the manner specified at http://www.w3.org/TR/html4/types.html#h-6.2 by removing leading and trailing whitespace, ignoring line feeds, and replacing carriage returns and tabs with spaces. While most useful for HTML attributes specified as CDATA, it can also be applied to most CSS values.

Parameters

mixed

$string

Returns

mixed —

Inherited from: \HTMLPurifier_AttrDef
Uses

Tags

note	This method is not entirely standards compliant, as trim() removes more types of whitespace than specified in the spec. In practice, this is rarely a problem, as those extra characters usually have already been removed by HTMLPurifier_Encoder.
warning	This processing is inconsistent with XML's whitespace handling as specified by section 3.3.3 and referenced XHTML 1.0 section 4.7. However, note that we are NOT necessarily parsing XML, thus, this behavior may still be correct. We assume that newlines have been normalized.

make()

make(string  $string) : \HTMLPurifier_AttrDef

Factory method for creating this class from a string.

Parameters

string

$string

String construction info

Returns

\HTMLPurifier_AttrDef —

Created AttrDef object corresponding to $string

split()

split(string  $string, \HTMLPurifier_Config  $config, \HTMLPurifier_Context  $context) : bool|string

Splits a space separated list of tokens into its constituent parts.

Parameters

string	$string
\HTMLPurifier_Config	$config
\HTMLPurifier_Context	$context

Returns

bool|string —

filter()

filter(array  $tokens, \HTMLPurifier_Config  $config, \HTMLPurifier_Context  $context) : array

Template method for removing certain tokens based on arbitrary criteria.

Parameters

array	$tokens
\HTMLPurifier_Config	$config
\HTMLPurifier_Context	$context

Returns

array —

mungeRgb()

mungeRgb(string  $string) : string

Removes spaces from rgb(0, 0, 0) so that shorthand CSS properties work properly. THIS IS A HACK!

Parameters

string

$string

a CSS colour definition

Returns

string —

expandCSSEscape()

expandCSSEscape(mixed  $string) : mixed

Parses a possibly escaped CSS string and returns the "pure" version of it.

Parameters

mixed

$string

Returns

mixed —