API - XOOPS 2.5.11 Beta 2
By monxoops.fr
HTMLPurifier_AttrDef Class Reference
Inheritance diagram for HTMLPurifier_AttrDef:

Public Member Functions

 validate ($string, $config, $context)
 parseCDATA ($string)
 make ($string)

Data Fields

 $minimized = false
 $required = false

Protected Member Functions

 mungeRgb ($string)
 expandCSSEscape ($string)

Detailed Description

Base class for all validating attribute definitions.

This family of classes forms the core for not only HTML attribute validation, but also any sort of string that needs to be validated or cleaned (which means CSS properties and composite definitions are defined here too). Besides defining (through code) what precisely makes the string valid, subclasses are also responsible for cleaning the code if possible.

Member Function Documentation

◆ expandCSSEscape()

expandCSSEscape (   $string)

Parses a possibly escaped CSS string and returns the "pure" version of it.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ make()

make (   $string)

Factory method for creating this class from a string.

string$stringString construction info
HTMLPurifier_AttrDef Created AttrDef object corresponding to $string

Reimplemented in HTMLPurifier_AttrDef_Clone, HTMLPurifier_AttrDef_Enum, HTMLPurifier_AttrDef_HTML_Bool, HTMLPurifier_AttrDef_HTML_Pixels, and HTMLPurifier_AttrDef_URI.

◆ mungeRgb()

mungeRgb (   $string)

Removes spaces from rgb(0, 0, 0) so that shorthand CSS properties work properly. THIS IS A HACK!

string$stringa CSS colour definition
Here is the caller graph for this function:

◆ parseCDATA()

parseCDATA (   $string)

Convenience method that parses a string as if it were CDATA.

This method process a string in the manner specified at http://www.w3.org/TR/html4/types.html#h-6.2 by removing leading and trailing whitespace, ignoring line feeds, and replacing carriage returns and tabs with spaces. While most useful for HTML attributes specified as CDATA, it can also be applied to most CSS values.

This method is not entirely standards compliant, as trim() removes more types of whitespace than specified in the spec. In practice, this is rarely a problem, as those extra characters usually have already been removed by HTMLPurifier_Encoder.
This processing is inconsistent with XML's whitespace handling as specified by section 3.3.3 and referenced XHTML 1.0 section 4.7. However, note that we are NOT necessarily parsing XML, thus, this behavior may still be correct. We assume that newlines have been normalized.
Here is the caller graph for this function:

◆ validate()

validate (   $string,

Validates and cleans passed string according to a definition.

string$stringString to be validated and cleaned.
HTMLPurifier_Config$configMandatory HTMLPurifier_Config object.
HTMLPurifier_Context$contextMandatory HTMLPurifier_Context object.

Reimplemented in HTMLPurifier_AttrDef_URI_IPv4, HTMLPurifier_AttrDef_URI_IPv6, HTMLPurifier_AttrDef_CSS_Color, HTMLPurifier_AttrDef_CSS, HTMLPurifier_AttrDef_HTML_ID, HTMLPurifier_AttrDef_Integer, HTMLPurifier_AttrDef_CSS_AlphaValue, HTMLPurifier_AttrDef_CSS_Number, HTMLPurifier_AttrDef_CSS_Background, HTMLPurifier_AttrDef_CSS_BackgroundPosition, HTMLPurifier_AttrDef_CSS_Border, HTMLPurifier_AttrDef_CSS_Composite, HTMLPurifier_AttrDef_CSS_DenyElementDecorator, HTMLPurifier_AttrDef_CSS_Font, HTMLPurifier_AttrDef_CSS_FontFamily, HTMLPurifier_AttrDef_CSS_Ident, HTMLPurifier_AttrDef_CSS_ImportantDecorator, HTMLPurifier_AttrDef_CSS_Length, HTMLPurifier_AttrDef_CSS_ListStyle, HTMLPurifier_AttrDef_CSS_Multiple, HTMLPurifier_AttrDef_CSS_Percentage, HTMLPurifier_AttrDef_CSS_TextDecoration, HTMLPurifier_AttrDef_Enum, HTMLPurifier_AttrDef_HTML_Bool, HTMLPurifier_AttrDef_HTML_Color, HTMLPurifier_AttrDef_HTML_FrameTarget, HTMLPurifier_AttrDef_HTML_Length, HTMLPurifier_AttrDef_HTML_LinkTypes, HTMLPurifier_AttrDef_HTML_MultiLength, HTMLPurifier_AttrDef_HTML_Nmtokens, HTMLPurifier_AttrDef_HTML_Pixels, HTMLPurifier_AttrDef_Lang, HTMLPurifier_AttrDef_Text, HTMLPurifier_AttrDef_URI_Email_SimpleCheck, HTMLPurifier_AttrDef_URI_Host, HTMLPurifier_AttrDef_URI, HTMLPurifier_AttrDef_CSS_URI, HTMLPurifier_AttrDef_Clone, and HTMLPurifier_AttrDef_CSS_Filter.

Field Documentation

◆ $minimized

$minimized = false

Tells us whether or not an HTML attribute is minimized. Has no meaning in other contexts. @type bool

◆ $required

$required = false

Tells us whether or not an HTML attribute is required. Has no meaning in other contexts @type bool

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