HTMLPurifier_AttrDef_Integer Class Reference

Inheritance diagram for HTMLPurifier_AttrDef_Integer:

Public Member Functions
	__construct ($negative=true, $zero=true, $positive=true)
	make ($string)
	Factory method for creating this class from a string.
	parseCDATA ($string)
	Convenience method that parses a string as if it were CDATA.
	validate ($integer, $config, $context)

Public Attributes
	$minimized = false
	Tells us whether or not an HTML attribute is minimized.
	$required = false
	Tells us whether or not an HTML attribute is required.

Protected Member Functions
	expandCSSEscape ($string)
	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.

Protected Attributes
	$negative = true
	Whether or not negative values are allowed.
	$positive = true
	Whether or not positive values are allowed.
	$zero = true
	Whether or not zero is allowed.

Constructor & Destructor Documentation

__construct()

HTMLPurifier_AttrDef_Integer::__construct	(		$negative = true,
			$zero = true,
			$positive = true )

Parameters

$negative	Bool indicating whether or not negative values are allowed
$zero	Bool indicating whether or not zero is allowed
$positive	Bool indicating whether or not positive values are allowed

Member Function Documentation

make()

HTMLPurifier_AttrDef::make ( $string )

inherited

Factory method for creating this class from a string.

Parameters

string

$string

String construction info

Return values

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()

HTMLPurifier_AttrDef::mungeRgb ( $string )

protectedinherited

Removes spaces from rgb(0, 0, 0) so that shorthand CSS properties work properly.

THIS IS A HACK!

Parameters

string

$string

a CSS colour definition

Return values

string

parseCDATA()

HTMLPurifier_AttrDef::parseCDATA ( $string )

inherited

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.

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.

validate()

HTMLPurifier_AttrDef_Integer::validate	(		$integer,
			$config,
			$context )

Parameters

string	$integer
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Return values

bool|string

Reimplemented from HTMLPurifier_AttrDef.

Member Data Documentation

$minimized

HTMLPurifier_AttrDef::$minimized = false

inherited

Tells us whether or not an HTML attribute is minimized.

Has no meaning in other contexts. @type bool

$negative

HTMLPurifier_AttrDef_Integer::$negative = true

protected

Whether or not negative values are allowed.

@type bool

$positive

HTMLPurifier_AttrDef_Integer::$positive = true

protected

Whether or not positive values are allowed.

@type bool

$required

HTMLPurifier_AttrDef::$required = false

inherited

Tells us whether or not an HTML attribute is required.

Has no meaning in other contexts @type bool

$zero

HTMLPurifier_AttrDef_Integer::$zero = true

protected

Whether or not zero is allowed.

@type bool

---

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

• lib/htmlpurifier/HTMLPurifier/AttrDef/Integer.php