HTMLPurifier_Injector_DisplayLinkURI Class Reference

Injector that displays the URL of an anchor instead of linking to it, in addition to showing the text of the link. More...

Inheritance diagram for HTMLPurifier_Injector_DisplayLinkURI:

Collaboration diagram for HTMLPurifier_Injector_DisplayLinkURI:

Public Member Functions
	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.
Public Member Functions inherited from HTMLPurifier_Injector
	rewind ($index)
	Rewind to a spot to re-perform processing.
	getRewind ()
	Retrieves rewind, and then unsets it.
	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.
	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.
	allowsElement ($name)
	Tests if the context node allows a certain element.
	handleText (&$token)
	Handler that is called when a text token is processed.
	notifyEnd ($token)
	Notifier that is called when an end token is processed.

Data Fields
	$name = 'DisplayLinkURI'
	$needed = array('a')
Data Fields inherited from HTMLPurifier_Injector
	$name
	Advisory name of injector, this is for friendly error messages.
	$needed = array()
	Array of elements and attributes this injector creates and therefore need to be allowed by the definition.

Additional Inherited Members
Protected Member Functions inherited from HTMLPurifier_Injector
	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.
	backward (&$i, &$current)
	Iterator function, starts with the previous token and continues until you reach the beginning of input tokens.
	current (&$i, &$current)
	Initializes the iterator at the current position.
Protected Attributes inherited from HTMLPurifier_Injector
	$htmlDefinition
	Instance of HTMLPurifier_HTMLDefinition.
	$currentNesting
	Reference to CurrentNesting variable in Context.
	$inputTokens
	Reference to InputTokens variable in Context.
	$inputIndex
	Reference to InputIndex variable in Context.
	$rewind = false
	Index of inputTokens to rewind to.

Detailed Description

Injector that displays the URL of an anchor instead of linking to it, in addition to showing the text of the link.

Definition at line 6 of file DisplayLinkURI.php.

Member Function Documentation

HTMLPurifier_Injector_DisplayLinkURI::handleElement

(

&

$token

)

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

Reimplemented from HTMLPurifier_Injector.

Definition at line 12 of file DisplayLinkURI.php.

                                           {
    }

HTMLPurifier_Injector_DisplayLinkURI::handleEnd

(

&

$token

)

Handler that is called when an end token is processed.

Reimplemented from HTMLPurifier_Injector.

Definition at line 15 of file DisplayLinkURI.php.

                                       {
        if (isset($token->start->attr['href'])){
            $url = $token->start->attr['href'];
            unset($token->start->attr['href']);
            $token = array($token, new HTMLPurifier_Token_Text(" ($url)"));
        } else {
            // nothing to display
        }
    }

Field Documentation

HTMLPurifier_Injector_DisplayLinkURI::$name = 'DisplayLinkURI'

Definition at line 9 of file DisplayLinkURI.php.

HTMLPurifier_Injector_DisplayLinkURI::$needed = array('a')

Definition at line 10 of file DisplayLinkURI.php.

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/Injector/DisplayLinkURI.php