HTMLPurifier_Length Class Reference

Public Member Functions
	__construct ($n='0', $u=false)
	toString ()
	getN ()
	getUnit ()
	isValid ()
	compareTo ($l)

Static Public Member Functions
static	make ($s)

Protected Member Functions
	validate ()

Protected Attributes
	$n
	$unit
	$isValid

Static Protected Attributes
static	$allowedUnits

Detailed Description

Represents a measurable length, with a string numeric magnitude and a unit. This object is immutable.

Definition at line 7466 of file HTMLPurifier.standalone.php.

Constructor & Destructor Documentation

__construct()

HTMLPurifier_Length::__construct	(		$n = '0',
			$u = false
	)

Parameters

string	$n	Magnitude
bool | string	$u	Unit

Definition at line 7502 of file HTMLPurifier.standalone.php.

Member Function Documentation

compareTo()

HTMLPurifier_Length::compareTo

(

$l

)

Compares two lengths, and returns 1 if greater, -1 if less and 0 if equal.

Parameters

HTMLPurifier_Length

$l

Returns

int

Warning

If both values are too large or small, this calculation will not work properly

Definition at line 7605 of file HTMLPurifier.standalone.php.

getN()

HTMLPurifier_Length::getN

(

)

Retrieves string numeric magnitude.

Returns

string

Definition at line 7572 of file HTMLPurifier.standalone.php.

getUnit()

HTMLPurifier_Length::getUnit

(

)

Retrieves string unit.

Returns

string

Definition at line 7581 of file HTMLPurifier.standalone.php.

isValid()

HTMLPurifier_Length::isValid

(

)

Returns true if this length unit is valid.

Returns

bool

Definition at line 7590 of file HTMLPurifier.standalone.php.

make()

static HTMLPurifier_Length::make (   $s )

static

Parameters

string

$s

Unit string, like '2em' or '3.4in'

Returns

HTMLPurifier_Length

Warning

Does not perform validation.

Definition at line 7513 of file HTMLPurifier.standalone.php.

toString()

HTMLPurifier_Length::toString

(

)

Returns string representation of number.

Returns

string

Definition at line 7560 of file HTMLPurifier.standalone.php.

validate()

HTMLPurifier_Length::validate ( )

protected

Validates the number and unit.

Returns

bool

Definition at line 7531 of file HTMLPurifier.standalone.php.

Member Data Documentation

$allowedUnits

HTMLPurifier_Length::$allowedUnits

staticprotected

Initial value:

= array(
        'em' => true, 'ex' => true, 'px' => true, 'in' => true,
        'cm' => true, 'mm' => true, 'pt' => true, 'pc' => true,
        'ch' => true, 'rem' => true, 'vw' => true, 'vh' => true,
        'vmin' => true, 'vmax' => true
    )

Array Lookup array of units recognized by CSS 3 @type array

Definition at line 7491 of file HTMLPurifier.standalone.php.

$isValid

HTMLPurifier_Length::$isValid

protected

Whether or not this length is valid. Null if not calculated yet. @type bool

Definition at line 7485 of file HTMLPurifier.standalone.php.

$n

HTMLPurifier_Length::$n

protected

String numeric magnitude. @type string

Definition at line 7473 of file HTMLPurifier.standalone.php.

$unit

HTMLPurifier_Length::$unit

protected

String unit. False is permitted if $n = 0. @type string|bool

Definition at line 7479 of file HTMLPurifier.standalone.php.

---

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

• plugins/htmlpurifier/HTMLPurifier.standalone.php