HTMLPurifier_Injector_RemoveEmpty Class Reference

Inheritance diagram for HTMLPurifier_Injector_RemoveEmpty:

Collaboration diagram for HTMLPurifier_Injector_RemoveEmpty:

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.
	handleElement (&$token)
	Handler that is called when a start or empty 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.
	handleText (&$token)
	Handler that is called when a text 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
	$config
	$attrValidator
	$removeNbsp
	$removeNbspExceptions
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.

Private Attributes
	$context

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

Definition at line 3 of file RemoveEmpty.php.

Member Function Documentation

HTMLPurifier_Injector_RemoveEmpty::handleElement

(

&

$token

)

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

Reimplemented from HTMLPurifier_Injector.

Definition at line 17 of file RemoveEmpty.php.

References HTMLPurifier_Injector\rewind().

                                           {
        if (!$token instanceof HTMLPurifier_Token_Start) return;
        $next = false;
        for ($i = $this->inputIndex + 1, $c = count($this->inputTokens); $i < $c; $i++) {
            $next = $this->inputTokens[$i];
            if ($next instanceof HTMLPurifier_Token_Text) {
                if ($next->is_whitespace) continue;
                if ($this->removeNbsp && !isset($this->removeNbspExceptions[$token->name])) {
                    $plain = str_replace("\xC2\xA0", "", $next->data);
                    $isWsOrNbsp = $plain === '' || ctype_space($plain);
                    if ($isWsOrNbsp) continue;
                }
            }
            break;
        }
        if (!$next || ($next instanceof HTMLPurifier_Token_End && $next->name == $token->name)) {
            if ($token->name == 'colgroup') return;
            $this->attrValidator->validateToken($token, $this->config, $this->context);
            $token->armor['ValidateAttributes'] = true;
            if (isset($token->attr['id']) || isset($token->attr['name'])) return;
            $token = $i - $this->inputIndex + 1;
            for ($b = $this->inputIndex - 1; $b > 0; $b--) {
                $prev = $this->inputTokens[$b];
                if ($prev instanceof HTMLPurifier_Token_Text && $prev->is_whitespace) continue;
                break;
            }
            // This is safe because we removed the token that triggered this.
            $this->rewind($b - 1);
            return;
        }
    }

Here is the call graph for this function:

HTMLPurifier_Injector_RemoveEmpty::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 8 of file RemoveEmpty.php.

References $config, and $context.

                                               {
        parent::prepare($config, $context);
        $this->config = $config;
        $this->context = $context;
        $this->removeNbsp = $config->get('AutoFormat.RemoveEmpty.RemoveNbsp');
        $this->removeNbspExceptions = $config->get('AutoFormat.RemoveEmpty.RemoveNbsp.Exceptions');
        $this->attrValidator = new HTMLPurifier_AttrValidator();
    }

Field Documentation

HTMLPurifier_Injector_RemoveEmpty::$attrValidator

Definition at line 6 of file RemoveEmpty.php.

HTMLPurifier_Injector_RemoveEmpty::$config

Definition at line 6 of file RemoveEmpty.php.

Referenced by prepare().

HTMLPurifier_Injector_RemoveEmpty::$context

private

Definition at line 6 of file RemoveEmpty.php.

Referenced by prepare().

HTMLPurifier_Injector_RemoveEmpty::$removeNbsp

Definition at line 6 of file RemoveEmpty.php.

HTMLPurifier_Injector_RemoveEmpty::$removeNbspExceptions

Definition at line 6 of file RemoveEmpty.php.

---

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

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