HumHub Documentation (unofficial)

HTMLPurifier_Injector_AutoParagraph extends HTMLPurifier_Injector

in package

• Application

Injector that auto paragraphs text in the root node based on double-spacing.

Tags

todo

Ensure all states are unit tested, including variations as well.

todo

Make a graph of the flow control for this Injector.

Table of Contents

Properties

$name  : mixed

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

$needed  : mixed

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')

$currentNesting  : mixed

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

$currentToken  : mixed

Reference to current token.

$htmlDefinition  : mixed

$inputZipper  : mixed

Reference to InputZipper variable in Context.

$rewindOffset  : mixed

Number of elements to rewind backwards (relative).

Methods

allowsElement()  : bool

Tests if the context node allows a certain element

checkNeeded()  : bool|string

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.

getRewindOffset()  : bool|int

Retrieves rewind offset, and then unsets it.

handleElement()  : mixed

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

handleEnd()  : mixed

Handler that is called when an end token is processed

handleText()  : mixed

Handler that is called when a text token is processed

notifyEnd()  : mixed

Notifier that is called when an end token is processed

prepare()  : bool|string

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()).

rewindOffset()  : mixed

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.

backward()  : bool

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

forward()  : bool

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

forwardUntilEndToken()  : bool

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.

_checkNeedsP()  : bool

Determines if a particular token requires an earlier inline token to get a paragraph. This should be used with _forwardUntilEndToken

_isInline()  : bool

Returns true if passed token is inline (and, ergo, allowed in paragraph tags)

_pLookAhead()  : bool

Looks ahead in the token list and determines whether or not we need to insert a <p> tag.

_pStart()  : HTMLPurifier_Token_Start

_splitText()  : mixed

Splits up a text in paragraph tokens and appends them to the result stream that will replace the original