Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
HTMLPurifier_Injector_PurifierLinkify Class Reference
Inheritance diagram for HTMLPurifier_Injector_PurifierLinkify:
HTMLPurifier_Injector

Public Member Functions

 allowsElement ($name)
 Tests if the context node allows a certain element.
 
 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.
 
 getRewindOffset ()
 Retrieves rewind offset, and then unsets it.
 
 handleElement (&$token)
 Handler that is called when a start or empty token is processed.
 
 handleEnd (&$token)
 Handler that is called when an end token is processed.
 
 handleText (&$token)
 
 notifyEnd ($token)
 Notifier that is called when an end token is processed.
 
 prepare ($config, $context)
 
 rewindOffset ($offset)
 Rewind to a spot to re-perform processing.
 

Public Attributes

 $docURL
 @type string
 
 $name = 'PurifierLinkify'
 @type string
 
 $needed = array('a' => array('href'))
 @type array
 

Protected Member Functions

 backward (&$i, &$current)
 Iterator function, starts with the previous token and continues until you reach the beginning of input tokens.
 
 forward (&$i, &$current)
 Iterator function, which starts with the next token and continues until you reach the end of the input tokens.
 
 forwardUntilEndToken (&$i, &$current, &$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.
 

Protected Attributes

 $currentNesting
 Reference to CurrentNesting variable in Context.
 
 $currentToken
 Reference to current token.
 
 $htmlDefinition
 @type HTMLPurifier_HTMLDefinition
 
 $inputZipper
 Reference to InputZipper variable in Context.
 
 $rewindOffset = false
 Number of elements to rewind backwards (relative).
 

Member Function Documentation

◆ allowsElement()

HTMLPurifier_Injector::allowsElement ( $name)
inherited

Tests if the context node allows a certain element.

Parameters
string$nameName of element to test for
Return values
boolTrue if element is allowed, false if it is not

◆ backward()

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

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$iCurrent integer index variable for inputTokens
HTMLPurifier_Token$currentCurrent token variable. Do NOT use $token, as that variable is also a reference
Return values
bool

◆ checkNeeded()

HTMLPurifier_Injector::checkNeeded ( $config)
inherited

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
Return values
bool|stringBoolean false if success, string of missing needed element/attribute if failure

◆ forward()

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

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$iCurrent integer index variable for inputTokens
HTMLPurifier_Token$currentCurrent token variable. Do NOT use $token, as that variable is also a reference
Return values
bool

◆ forwardUntilEndToken()

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

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$iCurrent integer index variable for inputTokens
HTMLPurifier_Token$currentCurrent token variable. Do NOT use $token, as that variable is also a reference
int$nesting
Return values
bool

◆ getRewindOffset()

HTMLPurifier_Injector::getRewindOffset ( )
inherited

Retrieves rewind offset, and then unsets it.

Return values
bool|int

◆ handleElement()

HTMLPurifier_Injector::handleElement ( & $token)
inherited

◆ handleEnd()

HTMLPurifier_Injector::handleEnd ( & $token)
inherited

Handler that is called when an end token is processed.

Reimplemented in HTMLPurifier_Injector_DisplayLinkURI, HTMLPurifier_Injector_RemoveSpansWithoutAttributes, and HTMLPurifier_Injector_SafeObject.

◆ handleText()

HTMLPurifier_Injector_PurifierLinkify::handleText ( & $token)
Parameters
HTMLPurifier_Token$token

Reimplemented from HTMLPurifier_Injector.

◆ notifyEnd()

HTMLPurifier_Injector::notifyEnd ( $token)
inherited

Notifier that is called when an end token is processed.

Parameters
HTMLPurifier_Token$tokenCurrent token variable.
Note
This differs from handlers in that the token is read-only
Deprecated

◆ prepare()

HTMLPurifier_Injector_PurifierLinkify::prepare ( $config,
$context )
Parameters
HTMLPurifier_Config$config
HTMLPurifier_Context$context
Return values
string

Reimplemented from HTMLPurifier_Injector.

◆ rewindOffset()

HTMLPurifier_Injector::rewindOffset ( $offset)
inherited

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.

Member Data Documentation

◆ $currentNesting

HTMLPurifier_Injector::$currentNesting
protectedinherited

Reference to CurrentNesting variable in Context.

This is an array list of tokens that we are currently "inside" @type array

◆ $currentToken

HTMLPurifier_Injector::$currentToken
protectedinherited

Reference to current token.

@type HTMLPurifier_Token

◆ $inputZipper

HTMLPurifier_Injector::$inputZipper
protectedinherited

Reference to InputZipper variable in Context.

@type HTMLPurifier_Zipper

◆ $rewindOffset

HTMLPurifier_Injector::$rewindOffset = false
protectedinherited

Number of elements to rewind backwards (relative).

@type bool|int


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