HTMLPurifier_Injector_AutoParagraph

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

• Full name: \HTMLPurifier_Injector_AutoParagraph
• Parent class: \HTMLPurifier_Injector

Properties

name

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

public $name

---

needed

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

public $needed

---

Methods

_pStart

private _pStart(): \HTMLPurifier_Token_Start

---

handleText

Handler that is called when a text token is processed

public handleText(\HTMLPurifier_Token_Text& $token): mixed

Parameters:

Parameter	Type	Description
$token	\HTMLPurifier_Token_Text

---

handleElement

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

public handleElement(\HTMLPurifier_Token& $token): mixed

Parameters:

Parameter	Type	Description
$token	\HTMLPurifier_Token

---

_splitText

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

private _splitText(string $data, \HTMLPurifier_Token[]& $result): mixed

Parameters:

Parameter	Type	Description
$data	string	String text data that will be processed into paragraphs
$result	\HTMLPurifier_Token[]	Reference to array of tokens that the tags will be appended onto

---

_isInline

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

private _isInline(\HTMLPurifier_Token $token): bool

Parameters:

Parameter	Type	Description
$token	\HTMLPurifier_Token

---

_pLookAhead

Looks ahead in the token list and determines whether or not we need to insert a

tag.

private _pLookAhead(): bool

---

_checkNeedsP

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

private _checkNeedsP(\HTMLPurifier_Token $current): bool

Parameters:

Parameter	Type	Description
$current	\HTMLPurifier_Token

---

Inherited methods

rewindOffset

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.

public rewindOffset(bool|int $offset): mixed

Parameters:

Parameter	Type	Description
$offset	bool|int

---

getRewindOffset

Retrieves rewind offset, and then unsets it.

public getRewindOffset(): bool|int

---

prepare

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

public prepare(\HTMLPurifier_Config $config, \HTMLPurifier_Context $context): bool|string

Parameters:

Parameter	Type	Description
$config	\HTMLPurifier_Config
$context	\HTMLPurifier_Context

Return Value:

Boolean false if success, string of missing needed element/attribute if failure

---

checkNeeded

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.

public checkNeeded(\HTMLPurifier_Config $config): bool|string

Parameters:

Parameter	Type	Description
$config	\HTMLPurifier_Config

Return Value:

Boolean false if success, string of missing needed element/attribute if failure

---

allowsElement

Tests if the context node allows a certain element

public allowsElement(string $name): bool

Parameters:

Parameter	Type	Description
$name	string	Name of element to test for

Return Value:

True if element is allowed, false if it is not

---

forward

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

protected forward(int& $i, \HTMLPurifier_Token& $current): bool

Parameters:

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

---

forwardUntilEndToken

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.

protected forwardUntilEndToken(int& $i, \HTMLPurifier_Token& $current, int& $nesting): bool

Parameters:

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

---

backward

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

protected backward(int& $i, \HTMLPurifier_Token& $current): bool

Parameters:

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

---

handleText

Handler that is called when a text token is processed

public handleText(mixed& $token): mixed

Parameters:

Parameter	Type	Description
$token	mixed

---

handleElement

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

public handleElement(mixed& $token): mixed

Parameters:

Parameter	Type	Description
$token	mixed

---

handleEnd

Handler that is called when an end token is processed

public handleEnd(mixed& $token): mixed

Parameters:

Parameter	Type	Description
$token	mixed

---

notifyEnd

Notifier that is called when an end token is processed

public notifyEnd(\HTMLPurifier_Token $token): mixed

• Warning: this method is deprecated. This means that this method will likely be removed in a future version.

Parameters:

Parameter	Type	Description
$token	\HTMLPurifier_Token	Current token variable.

---

---

Automatically generated on 2025-03-18