Docs For Class HTMLPurifier_AttrDef

Description

Validates a keyword against a list of valid values.

Located in /library/HTMLPurifier/AttrDef/Enum.php (line 10)

HTMLPurifier_AttrDef
   |
   --HTMLPurifier_AttrDef_Enum

Direct descendents

Class	Description
HTMLPurifier_AttrDef_HTML_FrameTarget	Special-case enum attribute definition that lazy loads allowed frame targets

Variable Summary

mixed $case_sensitive

mixed $valid_values

Method Summary

HTMLPurifier_AttrDef_Enum __construct ([$valid_values $valid_values = array()], [$case_sensitive $case_sensitive = false])

void make ($string $string)

void validate ( $string, $config, $context)

Variables

mixed $case_sensitive = false (line 23)

Bool indicating whether or not enumeration is case sensitive.

access: protected

Redefined in descendants as:

HTMLPurifier_AttrDef_HTML_FrameTarget::$case_sensitive

mixed $valid_values = array() (line 17)

Lookup table of valid values.

todo: Make protected
access: public

Redefined in descendants as:

HTMLPurifier_AttrDef_HTML_FrameTarget::$valid_values

Inherited Variables

Inherited from HTMLPurifier_AttrDef

HTMLPurifier_AttrDef::$minimized
HTMLPurifier_AttrDef::$required

Methods

Constructor __construct (line 29)

access: public

HTMLPurifier_AttrDef_Enum __construct ([$valid_values $valid_values = array()], [$case_sensitive $case_sensitive = false])

$valid_values $valid_values: List of valid values
$case_sensitive $case_sensitive: Bool indicating whether or not case sensitive

Redefined in descendants as:

HTMLPurifier_AttrDef_HTML_FrameTarget::__construct()

make (line 52)

access: public

void make ($string $string)

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

Redefinition of:

HTMLPurifier_AttrDef::make(): Factory method for creating this class from a string.

validate (line 36)

access: public

void validate ( $string, $config, $context)

$string
$config
$context

Redefinition of:

HTMLPurifier_AttrDef::validate(): Validates and cleans passed string according to a definition.

Redefined in descendants as:

HTMLPurifier_AttrDef_HTML_FrameTarget::validate()

Inherited Methods

Inherited From HTMLPurifier_AttrDef

HTMLPurifier_AttrDef::make()
HTMLPurifier_AttrDef::mungeRgb()
HTMLPurifier_AttrDef::parseCDATA()
HTMLPurifier_AttrDef::validate()

Class HTMLPurifier_AttrDef_Enum

Inherited Variables

Inherited Methods