HTMLPurifier_Length Class Reference

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

Static Public Member Functions
static	make ($s)

Protected Member Functions
	validate ()

Protected Attributes
	$isValid
	$n
	$unit

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 7 of file Length.php.

Constructor & Destructor Documentation

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

Parameters

number	$n	Magnitude
string	$u	Unit

Definition at line 37 of file Length.php.

References $n, and n.

Member Function Documentation

HTMLPurifier_Length::compareTo

(

$l

)

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

Warning

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

Definition at line 103 of file Length.php.

References n.

HTMLPurifier_Length::getN

(

)

Retrieves string numeric magnitude.

Definition at line 83 of file Length.php.

References $n.

HTMLPurifier_Length::getUnit

(

)

Retrieves string unit.

Definition at line 88 of file Length.php.

References $unit.

HTMLPurifier_Length::isValid

(

)

Returns true if this length unit is valid.

Definition at line 93 of file Length.php.

References $isValid, and validate().

Referenced by toString().

Here is the call graph for this function:

Here is the caller graph for this function:

static HTMLPurifier_Length::make (   $s )

static

Parameters

string

$s

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

Warning

Does not perform validation.

Definition at line 46 of file Length.php.

References $n, and $unit.

Referenced by HTMLPurifier_AttrDef_CSS_Length\__construct(), and HTMLPurifier_AttrDef_CSS_Length\validate().

Here is the caller graph for this function:

HTMLPurifier_Length::toString

(

)

Returns string representation of number.

Definition at line 75 of file Length.php.

References $unit, isValid(), and n.

Here is the call graph for this function:

HTMLPurifier_Length::validate ( )

protected

Validates the number and unit.

Definition at line 58 of file Length.php.

References $allowedUnits, $result, and n.

Referenced by isValid().

Here is the caller graph for this function:

Member Data Documentation

HTMLPurifier_Length::$allowedUnits

staticprotected

Initial value:

= array(
        'em' => true, 'ex' => true, 'px' => true, 'in' => true,
        'cm' => true, 'mm' => true, 'pt' => true, 'pc' => true
    )

Lookup array of units recognized by CSS 2.1

Definition at line 28 of file Length.php.

Referenced by validate().

HTMLPurifier_Length::$isValid

protected

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

Definition at line 23 of file Length.php.

Referenced by isValid().

HTMLPurifier_Length::$n

protected

String numeric magnitude.

Definition at line 13 of file Length.php.

Referenced by __construct(), getN(), and make().

HTMLPurifier_Length::$unit

protected

String unit. False is permitted if $n = 0.

Definition at line 18 of file Length.php.

Referenced by getUnit(), make(), and toString().

---

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

• L:/0xoops/xoops-2.5.6/htdocs/xoops_lib/modules/protector/library/HTMLPurifier/Length.php