Class HTMLPurifier_Injector

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.

Direct known subclasses

HTMLPurifier_Injector_AutoParagraph, HTMLPurifier_Injector_DisplayLinkURI, HTMLPurifier_Injector_Linkify, HTMLPurifier_Injector_PurifierLinkify, HTMLPurifier_Injector_RemoveEmpty, HTMLPurifier_Injector_RemoveSpansWithoutAttributes, HTMLPurifier_Injector_SafeObject

Abstract
Located at x2engine/framework/vendors/htmlpurifier/HTMLPurifier.standalone.php

Methods summary
`public`	# `rewindOffset( boolean\|integer $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. 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 `$offset` `boolean\|integer` $offset Warning HTML Purifier will prevent you from fast-forwarding with this function.
`public boolean\|integer`	# `getRewindOffset( )` Retrieves rewind offset, and then unsets it. Retrieves rewind offset, and then unsets it. Returns `boolean\|integer`
`public boolean\|string`	# `prepare( HTMLPurifier_Config $config, HTMLPurifier_Context $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()). 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 `$config` `HTMLPurifier_Config` $config `$context` `HTMLPurifier_Context` $context Returns `boolean\|string` Boolean false if success, string of missing needed element/attribute if failure
`public boolean\|string`	# `checkNeeded( HTMLPurifier_Config $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. 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 `$config` `HTMLPurifier_Config` $config Returns `boolean\|string` Boolean false if success, string of missing needed element/attribute if failure
`public boolean`	# `allowsElement( string $name )` Tests if the context node allows a certain element Tests if the context node allows a certain element Parameters `$name` `string` $name Name of element to test for Returns `boolean` True if element is allowed, false if it is not
`protected boolean`	# `forward( integer & $i, HTMLPurifier_Token & $current )` Iterator function, which starts with the next token and continues until you reach the end of the input tokens. Iterator function, which starts with the next token and continues until you reach the end of the input tokens. Parameters `$i` `integer` $i Current integer index variable for inputTokens `$current` `HTMLPurifier_Token` $current Current token variable. Do NOT use $token, as that variable is also a reference Returns `boolean` Warning Please prevent previous references from interfering with this functions by setting $i = null beforehand!
`protected boolean`	# `forwardUntilEndToken( integer & $i, HTMLPurifier_Token & $current, integer & $nesting )` 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. 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 `$i` `integer` $i Current integer index variable for inputTokens `$current` `HTMLPurifier_Token` $current Current token variable. Do NOT use $token, as that variable is also a reference `$nesting` `integer` $nesting Returns `boolean`
`protected boolean`	# `backward( integer & $i, HTMLPurifier_Token & $current )` Iterator function, starts with the previous token and continues until you reach the beginning of input tokens. Iterator function, starts with the previous token and continues until you reach the beginning of input tokens. Parameters `$i` `integer` $i Current integer index variable for inputTokens `$current` `HTMLPurifier_Token` $current Current token variable. Do NOT use $token, as that variable is also a reference Returns `boolean` Warning Please prevent previous references from interfering with this functions by setting $i = null beforehand!
`public`	# `handleText( mixed & $token )` Handler that is called when a text token is processed Handler that is called when a text token is processed
`public`	# `handleElement( mixed & $token )` Handler that is called when a start or empty token is processed Handler that is called when a start or empty token is processed
`public`	# `handleEnd( mixed & $token )` Handler that is called when an end token is processed Handler that is called when an end token is processed

Properties summary
`public mixed`	`$name`		# Advisory name of injector, this is for friendly error messages. Advisory name of injector, this is for friendly error messages. Type string
`protected mixed`	`$htmlDefinition`		# Type HTMLPurifier_HTMLDefinition
`protected mixed`	`$currentNesting`		# Reference to CurrentNesting variable in Context. This is an array list of tokens that we are currently "inside" Reference to CurrentNesting variable in Context. This is an array list of tokens that we are currently "inside" Type array
`protected mixed`	`$currentToken`		# Reference to current token. Reference to current token. Type HTMLPurifier_Token
`protected mixed`	`$inputZipper`		# Reference to InputZipper variable in Context. Reference to InputZipper variable in Context. Type HTMLPurifier_Zipper
`public array`	`$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') 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
`protected boolean`	`$rewindOffset`	`false`	# Number of elements to rewind backwards (relative). Number of elements to rewind backwards (relative). Type bool\|int

Packages

Classes

Interfaces

Exceptions

Functions

Class HTMLPurifier_Injector

Direct known subclasses

Parameters

Warning

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Warning

Parameters

Returns

Parameters

Returns

Warning

Type

Type

Type

Type

Type

Type

Type