Injector that converts configuration directive syntax Namespace.Directive to links. More...

Inheritance diagram for HTMLPurifier_Injector_PurifierLinkify:

Collaboration diagram for HTMLPurifier_Injector_PurifierLinkify:

Public Member Functions
	prepare ($config, $context)

	handleText (&$token)

Public Member Functions inherited from HTMLPurifier_Injector
	rewindOffset ($offset)
	Rewind to a spot to re-perform processing. More...

	getRewindOffset ()
	Retrieves rewind offset, and then unsets it. More...

	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. More...

	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. More...

	allowsElement ($name)
	Tests if the context node allows a certain element. More...

	handleText (&$token)
	Handler that is called when a text token is processed. More...

	handleElement (&$token)
	Handler that is called when a start or empty token is processed. More...

	handleEnd (&$token)
	Handler that is called when an end token is processed. More...

	notifyEnd ($token)
	Notifier that is called when an end token is processed. More...

Data Fields
	$name = 'PurifierLinkify'
	string More...

	$docURL
	string More...

	$needed = array('a' => array('href'))
	array More...

Data Fields inherited from HTMLPurifier_Injector
	$name
	Advisory name of injector, this is for friendly error messages. More...

	$needed = array()
	Array of elements and attributes this injector creates and therefore need to be allowed by the definition. More...

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. More...

	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. More...

	backward (&$i, &$current)
	Iterator function, starts with the previous token and continues until you reach the beginning of input tokens. More...

Protected Attributes inherited from HTMLPurifier_Injector
	$htmlDefinition
	HTMLPurifier_HTMLDefinition More...

	$currentNesting
	Reference to CurrentNesting variable in Context. More...

	$currentToken
	Reference to current token. More...

	$inputZipper
	Reference to InputZipper variable in Context. More...

	$rewindOffset = false
	Number of elements to rewind backwards (relative). More...

Detailed Description

Injector that converts configuration directive syntax Namespace.Directive to links.

Definition at line 7 of file PurifierLinkify.php.

Member Function Documentation

◆ handleText()

HTMLPurifier_Injector_PurifierLinkify::handleText ( & $token )

Parameters

HTMLPurifier_Token $token

Definition at line 38 of file PurifierLinkify.php.

References $i, $l, HTMLPurifier_Injector\allowsElement(), and array.

     {
         if (!$this->allowsElement('a')) {
             return;
         }
         if (strpos($token->data, '%') === false) {
             return;
         }
 
         $bits = preg_split('#%([a-z0-9]+\.[a-z0-9]+)#Si', $token->data, -1, PREG_SPLIT_DELIM_CAPTURE);
         $token = array();
 
         // $i = index
         // $c = count
         // $l = is link
         for ($i = 0, $c = count($bits), $l = false; $i < $c; $i++, $l = !$l) {
             if (!$l) {
                 if ($bits[$i] === '') {
                     continue;
                 }
                 $token[] = new HTMLPurifier_Token_Text($bits[$i]);
             } else {
                 $token[] = new HTMLPurifier_Token_Start(
                     'a',
                     array('href' => str_replace('%s', $bits[$i], $this->docURL))
                 );
                 $token[] = new HTMLPurifier_Token_Text('%' . $bits[$i]);
                 $token[] = new HTMLPurifier_Token_End('a');
             }
         }
     }

Here is the call graph for this function:

◆ prepare()

HTMLPurifier_Injector_PurifierLinkify::prepare	(	$config,
		$context
	)

Parameters

HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns: string

Definition at line 29 of file PurifierLinkify.php.

References $config.

     {
         $this->docURL = $config->get('AutoFormat.PurifierLinkify.DocURL');
         return parent::prepare($config, $context);
     }

Field Documentation

◆ $docURL

HTMLPurifier_Injector_PurifierLinkify::$docURL

string

Definition at line 17 of file PurifierLinkify.php.

◆ $name

HTMLPurifier_Injector_PurifierLinkify::$name = 'PurifierLinkify'

string

Definition at line 12 of file PurifierLinkify.php.

◆ $needed

HTMLPurifier_Injector_PurifierLinkify::$needed = array('a' => array('href'))

array

Definition at line 22 of file PurifierLinkify.php.

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

libs/composer/vendor/ezyang/htmlpurifier/library/HTMLPurifier/Injector/PurifierLinkify.php

Public Member Functions

Data Fields

Additional Inherited Members