HumHub Documentation (unofficial)

HTMLPurifier_AttrDef_Enum extends HTMLPurifier_AttrDef
in package

Validates a keyword against a list of valid values.

Tags
warning

The case-insensitive compare of this function uses PHP's built-in strtolower and ctype_lower functions, which may cause problems with international comparisons

Table of Contents

Properties

$minimized  : mixed
Tells us whether or not an HTML attribute is minimized.
$required  : mixed
Tells us whether or not an HTML attribute is required.
$valid_values  : mixed
Lookup table of valid values.
$case_sensitive  : mixed
Bool indicating whether or not enumeration is case sensitive.

Methods

__construct()  : mixed
make()  : HTMLPurifier_AttrDef_Enum
Factory method for creating this class from a string.
parseCDATA()  : mixed
Convenience method that parses a string as if it were CDATA.
validate()  : bool|string
Validates and cleans passed string according to a definition.
expandCSSEscape()  : mixed
Parses a possibly escaped CSS string and returns the "pure" version of it.
mungeRgb()  : string
Removes spaces from rgb(0, 0, 0) so that shorthand CSS properties work properly. THIS IS A HACK!

Properties

$minimized

Tells us whether or not an HTML attribute is minimized.

public mixed $minimized = \false

Has no meaning in other contexts.

Tags
type

bool

$required

Tells us whether or not an HTML attribute is required.

public mixed $required = \false

Has no meaning in other contexts

Tags
type

bool

$valid_values

Lookup table of valid values.

public mixed $valid_values = array()
Tags
type

array

todo

Make protected

$case_sensitive

Bool indicating whether or not enumeration is case sensitive.

protected mixed $case_sensitive = \false
Tags
note

In general this is always case insensitive.

Methods

__construct()

public __construct([array<string|int, mixed> $valid_values = array() ][, bool $case_sensitive = false ]) : mixed
Parameters
$valid_values : array<string|int, mixed> = array()

List of valid values

$case_sensitive : bool = false

Whether or not case sensitive

make()

Factory method for creating this class from a string.

public make(string $string) : HTMLPurifier_AttrDef_Enum
Parameters
$string : string

In form of comma-delimited list of case-insensitive valid values. Example: "foo,bar,baz". Prepend "s:" to make case sensitive

Return values
HTMLPurifier_AttrDef_Enum

parseCDATA()

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

public parseCDATA(mixed $string) : mixed

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.

Parameters
$string : mixed
Tags
note

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.

warning

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.

expandCSSEscape()

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

protected expandCSSEscape(mixed $string) : mixed
Parameters
$string : mixed

mungeRgb()

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

protected mungeRgb(string $string) : string
Parameters
$string : string

a CSS colour definition

Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results