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)
	Prepares the injector by giving it the config and context objects: this allows references to important variables to be made within the injector.
	handleText (&$token)
	Handler that is called when a text 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.
	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.
	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.
	notifyEnd ($token)
	Notifier that is called when an end token is processed.

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.
	$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 converts configuration directive syntax Namespace.Directive to links.

Definition at line 7 of file PurifierLinkify.php.

Member Function Documentation

HTMLPurifier_Injector_PurifierLinkify::handleText

(

&

$token

)

Handler that is called when a text token is processed.

Reimplemented from HTMLPurifier_Injector.

Definition at line 19 of file PurifierLinkify.php.

References HTMLPurifier_Injector\allowsElement().

                                        {
        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:

HTMLPurifier_Injector_PurifierLinkify::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.

This function also checks if the HTML environment will work with the Injector (see checkNeeded()).

Parameters

$config	Instance of HTMLPurifier_Config
$context	Instance of HTMLPurifier_Context

Returns

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

Reimplemented from HTMLPurifier_Injector.

Definition at line 14 of file PurifierLinkify.php.

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

Field Documentation

HTMLPurifier_Injector_PurifierLinkify::$docURL

Definition at line 11 of file PurifierLinkify.php.

HTMLPurifier_Injector_PurifierLinkify::$name = 'PurifierLinkify'

Definition at line 10 of file PurifierLinkify.php.

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:

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