ILIAS  release_4-4 Revision
HTMLPurifier_Injector_PurifierLinkify Class Reference

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
 rewind ($index)
 Rewind to a spot to re-perform processing. More...
 
 getRewind ()
 Retrieves rewind, 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'
 
 $docURL
 
 $needed = array('a' => array('href'))
 
- 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...
 
 current (&$i, &$current)
 Initializes the iterator at the current position. More...
 
- Protected Attributes inherited from HTMLPurifier_Injector
 $htmlDefinition
 Instance of HTMLPurifier_HTMLDefinition. More...
 
 $currentNesting
 Reference to CurrentNesting variable in Context. More...
 
 $inputTokens
 Reference to InputTokens variable in Context. More...
 
 $inputIndex
 Reference to InputIndex variable in Context. More...
 
 $rewind = false
 Index of inputTokens to rewind to. 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)

Definition at line 19 of file PurifierLinkify.php.

References HTMLPurifier_Injector\allowsElement().

19  {
20  if (!$this->allowsElement('a')) return;
21  if (strpos($token->data, '%') === false) return;
22 
23  $bits = preg_split('#%([a-z0-9]+\.[a-z0-9]+)#Si', $token->data, -1, PREG_SPLIT_DELIM_CAPTURE);
24  $token = array();
25 
26  // $i = index
27  // $c = count
28  // $l = is link
29  for ($i = 0, $c = count($bits), $l = false; $i < $c; $i++, $l = !$l) {
30  if (!$l) {
31  if ($bits[$i] === '') continue;
32  $token[] = new HTMLPurifier_Token_Text($bits[$i]);
33  } else {
34  $token[] = new HTMLPurifier_Token_Start('a',
35  array('href' => str_replace('%s', $bits[$i], $this->docURL)));
36  $token[] = new HTMLPurifier_Token_Text('%' . $bits[$i]);
37  $token[] = new HTMLPurifier_Token_End('a');
38  }
39  }
40 
41  }
allowsElement($name)
Tests if the context node allows a certain element.
Definition: Injector.php:129
Concrete end token class.
Definition: End.php:10
Concrete start token class.
Definition: Start.php:6
Concrete text token class.
Definition: Text.php:12
+ Here is the call graph for this function:

◆ prepare()

HTMLPurifier_Injector_PurifierLinkify::prepare (   $config,
  $context 
)

Definition at line 14 of file PurifierLinkify.php.

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

Field Documentation

◆ $docURL

HTMLPurifier_Injector_PurifierLinkify::$docURL

Definition at line 11 of file PurifierLinkify.php.

◆ $name

HTMLPurifier_Injector_PurifierLinkify::$name = 'PurifierLinkify'

Definition at line 10 of file PurifierLinkify.php.

◆ $needed

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

Definition at line 12 of file PurifierLinkify.php.


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