\HTMLPurifier_AttrDef_Enum

Validates a keyword against a list of valid values.

Summary

Methods
Properties
Constants
validate()
parseCDATA()
make()
__construct()
$minimized
$required
$valid_values
No constants found
mungeRgb()
expandCSSEscape()
$case_sensitive
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.

$required

$required

Tells us whether or not an HTML attribute is required.

Has no meaning in other contexts

$valid_values

$valid_values

Lookup table of valid values.

$case_sensitive

$case_sensitive

Bool indicating whether or not enumeration is case sensitive.

Methods

validate()

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

Validates and cleans passed string according to a definition.

Parameters

string $string
\HTMLPurifier_Config $config
\HTMLPurifier_Context $context

Returns

bool|string —

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 —

make()

make(string  $string) : \HTMLPurifier_AttrDef_Enum

Factory method for creating this class from a string.

Parameters

string $string

In form of comma-delimited list of case-insensitive valid values. Example: "foo,bar,baz". Prepend "s:" to make case sensitive

Returns

\HTMLPurifier_AttrDef_Enum —

__construct()

__construct(array  $valid_values = array(), bool  $case_sensitive = false) : mixed

Parameters

array $valid_values

List of valid values

bool $case_sensitive

Whether or not case sensitive

Returns

mixed —

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 —