HTMLPurifier_AttrDef_Enum Class Reference

Inheritance diagram for HTMLPurifier_AttrDef_Enum:

Collaboration diagram for HTMLPurifier_AttrDef_Enum:

Public Member Functions
	__construct ($valid_values=array(), $case_sensitive=false)
	validate ($string, $config, $context)
	make ($string)
Data Fields
	$valid_values = array()
Protected Attributes
	$case_sensitive = false

---

Detailed Description

Validates a keyword against a list of valid values.

Warning:

The case-insensitive compare of this function uses PHP's built-in strtolower and ctype_lower functions, which may cause problems with international comparisons

Definition at line 10 of file Enum.php.

---

Constructor & Destructor Documentation

__construct	(	$	valid_values = array(),
		$	case_sensitive = false
	)

Parameters:

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

Definition at line 29 of file Enum.php.

---

Member Function Documentation

make

(

$

string

)

Parameters:

$string

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

Reimplemented from HTMLPurifier_AttrDef.

Definition at line 52 of file Enum.php.

validate	(	$	string,
		$	config,
		$	context
	)

Validates and cleans passed string according to a definition.

Parameters:

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

Reimplemented from HTMLPurifier_AttrDef.

Reimplemented in HTMLPurifier_AttrDef_HTML_FrameTarget.

Definition at line 36 of file Enum.php.

---

Field Documentation

$case_sensitive = false [protected]

Bool indicating whether or not enumeration is case sensitive.

Note:

In general this is always case insensitive.

Reimplemented in HTMLPurifier_AttrDef_HTML_FrameTarget.

Definition at line 23 of file Enum.php.

$valid_values = array()

Lookup table of valid values.

Todo:

Make protected

Reimplemented in HTMLPurifier_AttrDef_HTML_FrameTarget.

Definition at line 17 of file Enum.php.

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/lib/htmlpurifier/HTMLPurifier/AttrDef/Enum.php