Error collection class that enables HTML Purifier to report HTML problems back to the user. More...

Collaboration diagram for HTMLPurifier_ErrorCollector:

Public Member Functions
	__construct ($context)

	send ($severity, $msg)
	Sends an error message to the collector for later use. More...

	getRaw ()
	Retrieves raw error data for custom formatter to use. More...

	getHTMLFormatted ($config, $errors=null)
	Default HTML formatting implementation for error messages. More...

Data Fields
const	LINENO = 0
	Identifiers for the returned error array. More...

const	SEVERITY = 1

const	MESSAGE = 2

const	CHILDREN = 3

Protected Attributes
	$errors

	$_current

	$_stacks = array(array())

	$locale

	$generator

	$context

	$lines = array()

Private Member Functions
	_renderStruct (&$ret, $struct, $line=null, $col=null)

Detailed Description

Error collection class that enables HTML Purifier to report HTML problems back to the user.

Definition at line 7 of file ErrorCollector.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLPurifier_ErrorCollector::__construct ( $context )

Definition at line 28 of file ErrorCollector.php.

References $context.

                                           {
         $this->locale    =& $context->get('Locale');
         $this->context   = $context;
         $this->_current  =& $this->_stacks[0];
         $this->errors    =& $this->_stacks[0];
     }

Member Function Documentation

◆ _renderStruct()

HTMLPurifier_ErrorCollector::_renderStruct	(	&	$ret,
			$struct,
			$line = `null`,
			$col = `null`
	)

private

Definition at line 171 of file ErrorCollector.php.

References $context, and $ret.

Referenced by getHTMLFormatted().

                                                                               {
         $stack = array($struct);
         $context_stack = array(array());
         while ($current = array_pop($stack)) {
             $context = array_pop($context_stack);
             foreach ($current->errors as $error) {
                 list($severity, $msg) = $error;
                 $string = '';
                 $string .= '<div>';
                 // W3C uses an icon to indicate the severity of the error.
                 $error = $this->locale->getErrorName($severity);
                 $string .= "<span class=\"error e$severity\"><strong>$error</strong></span> ";
                 if (!is_null($line) && !is_null($col)) {
                     $string .= "<em class=\"location\">Line $line, Column $col: </em> ";
                 } else {
                     $string .= '<em class="location">End of Document: </em> ';
                 }
                 $string .= '<strong class="description">' . $this->generator->escape($msg) . '</strong> ';
                 $string .= '</div>';
                 // Here, have a marker for the character on the column appropriate.
                 // Be sure to clip extremely long lines.
                 //$string .= '<pre>';
                 //$string .= '';
                 //$string .= '</pre>';
                 $ret[] = $string;
             }
             foreach ($current->children as $type => $array) {
                 $context[] = $current;
                 $stack = array_merge($stack, array_reverse($array, true));
                 for ($i = count($array); $i > 0; $i--) {
                     $context_stack[] = $context;
                 }
             }
         }
     }

Here is the caller graph for this function:

◆ getHTMLFormatted()

HTMLPurifier_ErrorCollector::getHTMLFormatted	(	$config,
		$errors = `null`
	)

Default HTML formatting implementation for error messages.

Parameters

$config	Configuration array, vital for HTML output nature
$errors	Errors array to display; used for recursion.

Definition at line 144 of file ErrorCollector.php.

References $errors, $ret, and _renderStruct().

                                                               {
         $ret = array();
 
         $this->generator = new HTMLPurifier_Generator($config, $this->context);
         if ($errors === null) $errors = $this->errors;
 
         // 'At line' message needs to be removed
 
         // generation code for new structure goes here. It needs to be recursive.
         foreach ($this->lines as $line => $col_array) {
             if ($line == -1) continue;
             foreach ($col_array as $col => $struct) {
                 $this->_renderStruct($ret, $struct, $line, $col);
             }
         }
         if (isset($this->lines[-1])) {
             $this->_renderStruct($ret, $this->lines[-1]);
         }
 
         if (empty($errors)) {
             return '<p>' . $this->locale->getMessage('ErrorCollector: No errors') . '</p>';
         } else {
             return '<ul><li>' . implode('</li><li>', $ret) . '</li></ul>';
         }
 
     }

Here is the call graph for this function:

◆ getRaw()

HTMLPurifier_ErrorCollector::getRaw ( )

Retrieves raw error data for custom formatter to use.

Parameters

List	of arrays in format of array(line of error, error severity, error message, recursive sub-errors array)

Definition at line 135 of file ErrorCollector.php.

References $errors.

                              {
         return $this->errors;
     }

◆ send()

HTMLPurifier_ErrorCollector::send	(	$severity,
		$msg
	)

Sends an error message to the collector for later use.

Parameters

$severity	int Error severity, PHP error style (don't use E_USER_)
$msg	string Error message text
$subst1	string First substitution for $msg
$subst2	string ...

Definition at line 42 of file ErrorCollector.php.

References HTMLPurifier_ErrorStruct\ATTR, HTMLPurifier_ErrorStruct\CSSPROP, and HTMLPurifier_ErrorStruct\TOKEN.

                                           {
 
         $args = array();
         if (func_num_args() > 2) {
             $args = func_get_args();
             array_shift($args);
             unset($args[0]);
         }
 
         $token = $this->context->get('CurrentToken', true);
         $line  = $token ? $token->line : $this->context->get('CurrentLine', true);
         $col   = $token ? $token->col  : $this->context->get('CurrentCol',  true);
         $attr  = $this->context->get('CurrentAttr', true);
 
         // perform special substitutions, also add custom parameters
         $subst = array();
         if (!is_null($token)) {
             $args['CurrentToken'] = $token;
         }
         if (!is_null($attr)) {
             $subst['$CurrentAttr.Name'] = $attr;
             if (isset($token->attr[$attr])) $subst['$CurrentAttr.Value'] = $token->attr[$attr];
         }
 
         if (empty($args)) {
             $msg = $this->locale->getMessage($msg);
         } else {
             $msg = $this->locale->formatMessage($msg, $args);
         }
 
         if (!empty($subst)) $msg = strtr($msg, $subst);
 
         // (numerically indexed)
         $error = array(
             self::LINENO   => $line,
             self::SEVERITY => $severity,
             self::MESSAGE  => $msg,
             self::CHILDREN => array()
         );
         $this->_current[] = $error;
 
 
         // NEW CODE BELOW ...
 
         $struct = null;
         // Top-level errors are either:
         //  TOKEN type, if $value is set appropriately, or
         //  "syntax" type, if $value is null
         $new_struct = new HTMLPurifier_ErrorStruct();
         $new_struct->type = HTMLPurifier_ErrorStruct::TOKEN;
         if ($token) $new_struct->value = clone $token;
         if (is_int($line) && is_int($col)) {
             if (isset($this->lines[$line][$col])) {
                 $struct = $this->lines[$line][$col];
             } else {
                 $struct = $this->lines[$line][$col] = $new_struct;
             }
             // These ksorts may present a performance problem
             ksort($this->lines[$line], SORT_NUMERIC);
         } else {
             if (isset($this->lines[-1])) {
                 $struct = $this->lines[-1];
             } else {
                 $struct = $this->lines[-1] = $new_struct;
             }
         }
         ksort($this->lines, SORT_NUMERIC);
 
         // Now, check if we need to operate on a lower structure
         if (!empty($attr)) {
             $struct = $struct->getChild(HTMLPurifier_ErrorStruct::ATTR, $attr);
             if (!$struct->value) {
                 $struct->value = array($attr, 'PUT VALUE HERE');
             }
         }
         if (!empty($cssprop)) {
             $struct = $struct->getChild(HTMLPurifier_ErrorStruct::CSSPROP, $cssprop);
             if (!$struct->value) {
                 // if we tokenize CSS this might be a little more difficult to do
                 $struct->value = array($cssprop, 'PUT VALUE HERE');
             }
         }
 
         // Ok, structs are all setup, now time to register the error
         $struct->addError($severity, $msg);
     }

Field Documentation

◆ $_current

HTMLPurifier_ErrorCollector::$_current

protected

Definition at line 20 of file ErrorCollector.php.

◆ $_stacks

HTMLPurifier_ErrorCollector::$_stacks = array(array())

protected

Definition at line 21 of file ErrorCollector.php.

◆ $context

HTMLPurifier_ErrorCollector::$context

protected

Definition at line 24 of file ErrorCollector.php.

Referenced by __construct(), and _renderStruct().

◆ $errors

HTMLPurifier_ErrorCollector::$errors

protected

Definition at line 19 of file ErrorCollector.php.

Referenced by getHTMLFormatted(), and getRaw().

◆ $generator

HTMLPurifier_ErrorCollector::$generator

protected

Definition at line 23 of file ErrorCollector.php.

◆ $lines

HTMLPurifier_ErrorCollector::$lines = array()

protected

Definition at line 26 of file ErrorCollector.php.

◆ $locale

HTMLPurifier_ErrorCollector::$locale

protected

Definition at line 22 of file ErrorCollector.php.

◆ CHILDREN

const HTMLPurifier_ErrorCollector::CHILDREN = 3

Definition at line 17 of file ErrorCollector.php.

◆ LINENO

const HTMLPurifier_ErrorCollector::LINENO = 0

Identifiers for the returned error array.

These are purposely numeric so list() can be used.

Definition at line 14 of file ErrorCollector.php.

◆ MESSAGE

const HTMLPurifier_ErrorCollector::MESSAGE = 2

Definition at line 16 of file ErrorCollector.php.

◆ SEVERITY

const HTMLPurifier_ErrorCollector::SEVERITY = 1

Definition at line 15 of file ErrorCollector.php.

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

Services/Html/HtmlPurifier/library/HTMLPurifier/ErrorCollector.php

Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _renderStruct()

◆ getHTMLFormatted()

◆ getRaw()

◆ send()

Field Documentation

◆ $_current

◆ $_stacks

◆ $context

◆ $errors

◆ $generator

◆ $lines

◆ $locale

◆ CHILDREN

◆ LINENO

◆ MESSAGE

◆ SEVERITY