HTMLPurifier_AttrDef_HTML_Nmtokens Class Reference

Validates contents based on NMTOKENS attribute type. More...

Inheritance diagram for HTMLPurifier_AttrDef_HTML_Nmtokens:

Collaboration diagram for HTMLPurifier_AttrDef_HTML_Nmtokens:

Public Member Functions
	validate ($string, $config, $context)
Public Member Functions inherited from HTMLPurifier_AttrDef
	validate ($string, $config, $context)
	Validates and cleans passed string according to a definition. More...
	parseCDATA ($string)
	Convenience method that parses a string as if it were CDATA. More...
	make ($string)
	Factory method for creating this class from a string. More...

Protected Member Functions
	split ($string, $config, $context)
	Splits a space separated list of tokens into its constituent parts. More...
	filter ($tokens, $config, $context)
	Template method for removing certain tokens based on arbitrary criteria. More...
Protected Member Functions inherited from HTMLPurifier_AttrDef
	mungeRgb ($string)
	Removes spaces from rgb(0, 0, 0) so that shorthand CSS properties work properly. More...
	expandCSSEscape ($string)
	Parses a possibly escaped CSS string and returns the "pure" version of it. More...

Additional Inherited Members
Data Fields inherited from HTMLPurifier_AttrDef
	$minimized = false
	Tells us whether or not an HTML attribute is minimized. More...
	$required = false
	Tells us whether or not an HTML attribute is required. More...

Detailed Description

Validates contents based on NMTOKENS attribute type.

Definition at line 6 of file Nmtokens.php.

Member Function Documentation

filter()

HTMLPurifier_AttrDef_HTML_Nmtokens::filter (   $tokens,   $config,   $context  )

protected

Template method for removing certain tokens based on arbitrary criteria.

Note

If we wanted to be really functional, we'd do an array_filter with a callback. But... we're not.

Parameters

array	$tokens
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns

array

Definition at line 64 of file Nmtokens.php.

Referenced by validate().

    {
        return $tokens;
    }

Here is the caller graph for this function:

split()

HTMLPurifier_AttrDef_HTML_Nmtokens::split (   $string,   $config,   $context  )

protected

Splits a space separated list of tokens into its constituent parts.

Parameters

string	$string
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns

array

Definition at line 39 of file Nmtokens.php.

Referenced by validate().

    {
        // OPTIMIZABLE!
        // do the preg_match, capture all subpatterns for reformulation

        // we don't support U+00A1 and up codepoints or
        // escaping because I don't know how to do that with regexps
        // and plus it would complicate optimization efforts (you never
        // see that anyway).
        $pattern = '/(?:(?<=\s)|\A)' . // look behind for space or string start
            '((?:--|-?[A-Za-z_])[A-Za-z_\-0-9]*)' .
            '(?:(?=\s)|\z)/'; // look ahead for space or string end
        preg_match_all($pattern, $string, $matches);
        return $matches[1];
    }

Here is the caller graph for this function:

validate()

HTMLPurifier_AttrDef_HTML_Nmtokens::validate	(		$string,
			$config,
			$context
	)

Parameters

string	$string
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns

bool|string

Definition at line 15 of file Nmtokens.php.

References $config, $context, filter(), and split().

    {
        $string = trim($string);

        // early abort: '' and '0' (strings that convert to false) are invalid
        if (!$string) {
            return false;
        }

        $tokens = $this->split($string, $config, $context);
        $tokens = $this->filter($tokens, $config, $context);
        if (empty($tokens)) {
            return false;
        }
        return implode(' ', $tokens);
    }

Here is the call graph for this function:

---

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

• libs/composer/vendor/ezyang/htmlpurifier/library/HTMLPurifier/AttrDef/HTML/Nmtokens.php