HTMLPurifier_Injector_RemoveEmpty Class Reference

Inheritance diagram for HTMLPurifier_Injector_RemoveEmpty:

Collaboration diagram for HTMLPurifier_Injector_RemoveEmpty:

Public Member Functions
	prepare ($config, $context)
	handleElement (&$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...

Private Attributes
	$context
	HTMLPurifier_Context More...
	$config
	HTMLPurifier_Config More...
	$attrValidator
	HTMLPurifier_AttrValidator More...
	$removeNbsp
	bool More...
	$removeNbspExceptions
	bool More...
	$_exclude = array('colgroup' => 1, 'th' => 1, 'td' => 1, 'iframe' => 1)
	array TODO: make me configurable More...

Additional Inherited Members
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...
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

Definition at line 3 of file RemoveEmpty.php.

Member Function Documentation

handleElement()

HTMLPurifier_Injector_RemoveEmpty::handleElement

(

&

$token

)

Parameters

HTMLPurifier_Token

$token

Definition at line 54 of file RemoveEmpty.php.

References HTMLPurifier_Injector\rewindOffset().

    {
        if (!$token instanceof HTMLPurifier_Token_Start) {
            return;
        }
        $next = false;
        $deleted = 1; // the current tag
        for ($i = count($this->inputZipper->back) - 1; $i >= 0; $i--, $deleted++) {
            $next = $this->inputZipper->back[$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 (isset($this->_exclude[$token->name])) {
                return;
            }
            $this->attrValidator->validateToken($token, $this->config, $this->context);
            $token->armor['ValidateAttributes'] = true;
            if (isset($token->attr['id']) || isset($token->attr['name'])) {
                return;
            }
            $token = $deleted + 1;
            for ($b = 0, $c = count($this->inputZipper->front); $b < $c; $b++) {
                $prev = $this->inputZipper->front[$b];
                if ($prev instanceof HTMLPurifier_Token_Text && $prev->is_whitespace) {
                    continue;
                }
                break;
            }
            // This is safe because we removed the token that triggered this.
            $this->rewindOffset($b+$deleted);
            return;
        }
    }

Here is the call graph for this function:

prepare()

HTMLPurifier_Injector_RemoveEmpty::prepare	(		$config,
			$context
	)

Parameters

HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns

void

Definition at line 41 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

$_exclude

HTMLPurifier_Injector_RemoveEmpty::$_exclude = array('colgroup' => 1, 'th' => 1, 'td' => 1, 'iframe' => 1)

private

array TODO: make me configurable

Definition at line 34 of file RemoveEmpty.php.

$attrValidator

HTMLPurifier_Injector_RemoveEmpty::$attrValidator

private

HTMLPurifier_AttrValidator

Definition at line 18 of file RemoveEmpty.php.

$config

HTMLPurifier_Injector_RemoveEmpty::$config

private

HTMLPurifier_Config

Definition at line 13 of file RemoveEmpty.php.

Referenced by prepare().

$context

HTMLPurifier_Injector_RemoveEmpty::$context

private

HTMLPurifier_Context

Definition at line 8 of file RemoveEmpty.php.

Referenced by prepare().

$removeNbsp

HTMLPurifier_Injector_RemoveEmpty::$removeNbsp

private

bool

Definition at line 23 of file RemoveEmpty.php.

$removeNbspExceptions

HTMLPurifier_Injector_RemoveEmpty::$removeNbspExceptions

private

bool

Definition at line 28 of file RemoveEmpty.php.

---

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

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