Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
HTMLPurifier_ErrorStruct Class Reference

Public Member Functions

 addError ($severity, $message)
 
 getChild ($type, $id)
 

Public Attributes

 $children = array()
 Child ErrorStructs that are from this structure.
 
 $errors = array()
 Errors registered for this structure.
 
 $type
 Type of this struct.
 
 $value
 Value of the struct we are recording errors for.
 
const ATTR = 1
 
const CSSPROP = 2
 
const TOKEN = 0
 Possible values for $children first-key.
 

Member Function Documentation

◆ addError()

HTMLPurifier_ErrorStruct::addError ( $severity,
$message )
Parameters
int$severity
string$message

◆ getChild()

HTMLPurifier_ErrorStruct::getChild ( $type,
$id )
Parameters
string$type
string$id
Return values
mixed

Member Data Documentation

◆ $children

HTMLPurifier_ErrorStruct::$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

HTMLPurifier_ErrorStruct::$errors = array()

Errors registered for this structure.

@type array

◆ $type

HTMLPurifier_ErrorStruct::$type

Type of this struct.

@type string

◆ $value

HTMLPurifier_ErrorStruct::$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

◆ TOKEN

const HTMLPurifier_ErrorStruct::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: