Inheritance diagram for HTMLPurifier_Injector:

Public Member Functions
	rewindOffset ($offset)

	getRewindOffset ()

	prepare ($config, $context)

	checkNeeded ($config)

	allowsElement ($name)

	handleText (&$token)

	handleElement (&$token)

	handleEnd (&$token)

	notifyEnd ($token)

Public Attributes
	$name

	$needed = array()

Protected Member Functions
	forward (&$i, &$current)

	forwardUntilEndToken (&$i, &$current, &$nesting)

	backward (&$i, &$current)

Protected Attributes
	$htmlDefinition

	$currentNesting

	$currentToken

	$inputZipper

	$rewindOffset = false

Detailed Description

Injects tokens into the document while parsing for well-formedness. This enables "formatter-like" functionality such as auto-paragraphing, smiley-ification and linkification to take place.

A note on how handlers create changes; this is done by assigning a new value to the $token reference. These values can take a variety of forms and are best described HTMLPurifier_Strategy_MakeWellFormed->processToken() documentation.

Definition at line 6776 of file HTMLPurifier.standalone.php.

Member Function Documentation

◆ allowsElement()

HTMLPurifier_Injector::allowsElement ( $name )

Tests if the context node allows a certain element

Parameters

string $name Name of element to test for

Returns: bool True if element is allowed, false if it is not

Definition at line 6907 of file HTMLPurifier.standalone.php.

◆ backward()

HTMLPurifier_Injector::backward	(	&	$i,
		&	$current
	)

protected

Iterator function, starts with the previous token and continues until you reach the beginning of input tokens.

Warning: Please prevent previous references from interfering with this functions by setting $i = null beforehand!

Parameters

int	$i	Current integer index variable for inputTokens
HTMLPurifier_Token	$current	Current token variable. Do NOT use $token, as that variable is also a reference

Returns: bool

Definition at line 6996 of file HTMLPurifier.standalone.php.

◆ checkNeeded()

HTMLPurifier_Injector::checkNeeded ( $config )

This function checks if the HTML environment will work with the Injector: if p tags are not allowed, the Auto-Paragraphing injector should not be enabled.

Parameters

HTMLPurifier_Config $config

Returns: bool|string Boolean false if success, string of missing needed element/attribute if failure

Definition at line 6880 of file HTMLPurifier.standalone.php.

◆ forward()

HTMLPurifier_Injector::forward	(	&	$i,
		&	$current
	)

protected

Iterator function, which starts with the next token and continues until you reach the end of the input tokens.

Warning: Please prevent previous references from interfering with this functions by setting $i = null beforehand!

Parameters

int	$i	Current integer index variable for inputTokens
HTMLPurifier_Token	$current	Current token variable. Do NOT use $token, as that variable is also a reference

Returns: bool

Definition at line 6942 of file HTMLPurifier.standalone.php.

◆ forwardUntilEndToken()

HTMLPurifier_Injector::forwardUntilEndToken	(	&	$i,
		&	$current,
		&	$nesting
	)

protected

Similar to _forward, but accepts a third parameter $nesting (which should be initialized at 0) and stops when we hit the end tag for the node $this->inputIndex starts in.

Parameters

int	$i	Current integer index variable for inputTokens
HTMLPurifier_Token	$current	Current token variable. Do NOT use $token, as that variable is also a reference
int	$nesting

Returns: bool

Definition at line 6966 of file HTMLPurifier.standalone.php.

◆ getRewindOffset()

HTMLPurifier_Injector::getRewindOffset ( )

Retrieves rewind offset, and then unsets it.

Returns: bool|int

Definition at line 6841 of file HTMLPurifier.standalone.php.

◆ handleElement()

HTMLPurifier_Injector::handleElement ( & $token )

Handler that is called when a start or empty token is processed

Reimplemented in HTMLPurifier_Injector_SafeObject, HTMLPurifier_Injector_RemoveSpansWithoutAttributes, HTMLPurifier_Injector_RemoveEmpty, HTMLPurifier_Injector_DisplayLinkURI, and HTMLPurifier_Injector_AutoParagraph.

Definition at line 7020 of file HTMLPurifier.standalone.php.

◆ handleEnd()

HTMLPurifier_Injector::handleEnd ( & $token )

Handler that is called when an end token is processed

Reimplemented in HTMLPurifier_Injector_SafeObject, HTMLPurifier_Injector_RemoveSpansWithoutAttributes, and HTMLPurifier_Injector_DisplayLinkURI.

Definition at line 7027 of file HTMLPurifier.standalone.php.

◆ handleText()

HTMLPurifier_Injector::handleText ( & $token )

Handler that is called when a text token is processed

Reimplemented in HTMLPurifier_Injector_PurifierLinkify, HTMLPurifier_Injector_Linkify, and HTMLPurifier_Injector_AutoParagraph.

Definition at line 7013 of file HTMLPurifier.standalone.php.

◆ notifyEnd()

HTMLPurifier_Injector::notifyEnd ( $token )

Notifier that is called when an end token is processed

Parameters

HTMLPurifier_Token $token Current token variable.

Note: This differs from handlers in that the token is read-only

Definition at line 7038 of file HTMLPurifier.standalone.php.

◆ prepare()

HTMLPurifier_Injector::prepare	(	$config,
		$context
	)

Prepares the injector by giving it the config and context objects: this allows references to important variables to be made within the injector. This function also checks if the HTML environment will work with the Injector (see checkNeeded()).

Parameters

HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns: bool|string Boolean false if success, string of missing needed element/attribute if failure

Reimplemented in HTMLPurifier_Injector_SafeObject, HTMLPurifier_Injector_RemoveSpansWithoutAttributes, HTMLPurifier_Injector_RemoveEmpty, and HTMLPurifier_Injector_PurifierLinkify.

Definition at line 6857 of file HTMLPurifier.standalone.php.

◆ rewindOffset()

HTMLPurifier_Injector::rewindOffset ( $offset )

Rewind to a spot to re-perform processing. This is useful if you deleted a node, and now need to see if this change affected any earlier nodes. Rewinding does not affect other injectors, and can result in infinite loops if not used carefully.

Parameters

bool | int $offset

Warning: HTML Purifier will prevent you from fast-forwarding with this function.

Definition at line 6832 of file HTMLPurifier.standalone.php.

Member Data Documentation

◆ $currentNesting

HTMLPurifier_Injector::$currentNesting

protected

Reference to CurrentNesting variable in Context. This is an array list of tokens that we are currently "inside" @type array

Definition at line 6795 of file HTMLPurifier.standalone.php.

◆ $currentToken

HTMLPurifier_Injector::$currentToken

protected

Reference to current token. @type HTMLPurifier_Token

Definition at line 6801 of file HTMLPurifier.standalone.php.

◆ $htmlDefinition

HTMLPurifier_Injector::$htmlDefinition

protected

@type HTMLPurifier_HTMLDefinition

Definition at line 6788 of file HTMLPurifier.standalone.php.

◆ $inputZipper

HTMLPurifier_Injector::$inputZipper

protected

Reference to InputZipper variable in Context. @type HTMLPurifier_Zipper

Definition at line 6807 of file HTMLPurifier.standalone.php.

◆ $name

HTMLPurifier_Injector::$name

Advisory name of injector, this is for friendly error messages. @type string

Definition at line 6783 of file HTMLPurifier.standalone.php.

◆ $needed

HTMLPurifier_Injector::$needed = array()

Array of elements and attributes this injector creates and therefore need to be allowed by the definition. Takes form of array('element' => array('attr', 'attr2'), 'element2') @type array

Definition at line 6815 of file HTMLPurifier.standalone.php.

◆ $rewindOffset

HTMLPurifier_Injector::$rewindOffset = false

protected

Number of elements to rewind backwards (relative). @type bool|int

Definition at line 6821 of file HTMLPurifier.standalone.php.

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

plugins/htmlpurifier/HTMLPurifier.standalone.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ allowsElement()

◆ backward()

◆ checkNeeded()

◆ forward()

◆ forwardUntilEndToken()

◆ getRewindOffset()

◆ handleElement()

◆ handleEnd()

◆ handleText()

◆ notifyEnd()

◆ prepare()

◆ rewindOffset()

Member Data Documentation

◆ $currentNesting

◆ $currentToken

◆ $htmlDefinition

◆ $inputZipper

◆ $name

◆ $needed

◆ $rewindOffset