HTMLPurifier_ErrorStruct Class Reference

Public Member Functions
	getChild ($type, $id)
	addError ($severity, $message)

Data Fields
const	TOKEN = 0
const	ATTR = 1
const	CSSPROP = 2
	$type
	$value
	$errors = array()
	$children = array()

Detailed Description

Records errors for particular segments of an HTML document such as tokens, attributes or CSS properties. They can contain error structs (which apply to components of what they represent), but their main purpose is to hold errors applying to whatever struct is being used.

Member Function Documentation

addError()

addError	(		$severity,
			$message
	)

Parameters

int	$severity
string	$message

getChild()

getChild	(		$type,
			$id
	)

Parameters

string	$type
string	$id

Returns

mixed

Field Documentation

$children

$children = array()

Child ErrorStructs that are from this structure. For example, a TOKEN ErrorStruct would contain ATTR ErrorStructs. This is a multi-dimensional array in structure: [TYPE]['identifier'] @type array

$errors

$errors = array()

Errors registered for this structure. @type array

$type

$type

Type of this struct. @type string

$value

$value

Value of the struct we are recording errors for. There are various values for this:

• TOKEN: Instance of HTMLPurifier_Token
• ATTR: array('attr-name', 'value')
• CSSPROP: array('prop-name', 'value') @type mixed

ATTR

const ATTR = 1

CSSPROP

const CSSPROP = 2

TOKEN

const TOKEN = 0

Possible values for $children first-key. Note that top-level structures are automatically token-level.

---

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

• C:/xoops2511b2/htdocs/xoops_lib/modules/protector/library/HTMLPurifier/ErrorStruct.php