HTMLPurifier_UnitConverter Klassenreferenz

Öffentliche Methoden

 __construct ($output_precision=4, $internal_precision=10, $force_no_bcmath=false)
 
 convert ($length, $to_unit)
 
 getSigFigs ($n)
 

Datenfelder

const ENGLISH = 1
 
const METRIC = 2
 
const DIGITAL = 3
 

Geschützte Attribute

 $outputPrecision
 
 $internalPrecision
 

Statische, geschützte Attribute

static $units
 

Private Methoden

 add ($s1, $s2, $scale)
 
 mul ($s1, $s2, $scale)
 
 div ($s1, $s2, $scale)
 
 round ($n, $sigfigs)
 
 scale ($r, $scale)
 

Private Attribute

 $bcmath
 

Ausführliche Beschreibung

Class for converting between different unit-lengths as specified by CSS.

Definiert in Zeile 7 der Datei UnitConverter.php.

Beschreibung der Konstruktoren und Destruktoren

__construct (   $output_precision = 4,
  $internal_precision = 10,
  $force_no_bcmath = false 
)

Definiert in Zeile 56 der Datei UnitConverter.php.

Dokumentation der Elementfunktionen

add (   $s1,
  $s2,
  $scale 
)
private

Adds two numbers, using arbitrary precision when available.

Parameter
string$s1
string$s2
int$scale
Rückgabe
string

Definiert in Zeile 214 der Datei UnitConverter.php.

Benutzt scale().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

convert (   $length,
  $to_unit 
)

Converts a length object of one unit into another unit.

Parameter
HTMLPurifier_Length$lengthInstance of HTMLPurifier_Length to convert. You must validate() it before passing it here!
string$to_unitUnit to convert to.
Rückgabe
HTMLPurifier_Length|bool
Zu beachten
About precision: This conversion function pays very special attention to the incoming precision of values and attempts to maintain a number of significant figure. Results are fairly accurate up to nine digits. Some caveats:
  • If a number is zero-padded as a result of this significant figure tracking, the zeroes will be eliminated.
  • If a number contains less than four sigfigs ($outputPrecision) and this causes some decimals to be excluded, those decimals will be added on.

Definiert in Zeile 82 der Datei UnitConverter.php.

Benutzt $outputPrecision, div(), getSigFigs(), mul() und round().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

div (   $s1,
  $s2,
  $scale 
)
private

Divides two numbers, using arbitrary precision when available.

Parameter
string$s1
string$s2
int$scale
Rückgabe
string

Definiert in Zeile 246 der Datei UnitConverter.php.

Benutzt scale().

Wird benutzt von convert().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getSigFigs (   $n)

Returns the number of significant figures in a string number.

Parameter
string$nDecimal number
Rückgabe
int number of sigfigs

Definiert in Zeile 192 der Datei UnitConverter.php.

Wird benutzt von convert().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

mul (   $s1,
  $s2,
  $scale 
)
private

Multiples two numbers, using arbitrary precision when available.

Parameter
string$s1
string$s2
int$scale
Rückgabe
string

Definiert in Zeile 230 der Datei UnitConverter.php.

Benutzt scale().

Wird benutzt von convert().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

round (   $n,
  $sigfigs 
)
private

Rounds a number according to the number of sigfigs it should have, using arbitrary precision when available.

Parameter
float$n
int$sigfigs
Rückgabe
string

Definiert in Zeile 262 der Datei UnitConverter.php.

Benutzt scale().

Wird benutzt von convert() und scale().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

scale (   $r,
  $scale 
)
private

Scales a float to $scale digits right of decimal point, like BCMath.

Parameter
float$r
int$scale
Rückgabe
string

Definiert in Zeile 289 der Datei UnitConverter.php.

Benutzt round().

Wird benutzt von add(), div(), mul() und round().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

Dokumentation der Datenelemente

$bcmath
private

Whether or not BCMath is available. bool

Definiert in Zeile 54 der Datei UnitConverter.php.

$internalPrecision
protected

Bcmath precision for internal calculations. int

Definiert in Zeile 48 der Datei UnitConverter.php.

$outputPrecision
protected

Minimum bcmath precision for output. int

Definiert in Zeile 42 der Datei UnitConverter.php.

Wird benutzt von convert().

$units
staticprotected
Initialisierung:
= array(
self::ENGLISH => array(
'px' => 3,
'pt' => 4,
'pc' => 48,
'in' => 288,
self::METRIC => array('pt', '0.352777778', 'mm'),
),
self::METRIC => array(
'mm' => 1,
'cm' => 10,
self::ENGLISH => array('mm', '2.83464567', 'pt'),
),
)

Units information array. Units are grouped into measuring systems (English, Metric), and are assigned an integer representing the conversion factor between that unit and the smallest unit in the system. Numeric indexes are actually magical constants that encode conversion data from one system to the next, with a O(n^2) constraint on memory (this is generally not a problem, since the number of measuring systems is small.)

Definiert in Zeile 23 der Datei UnitConverter.php.

const DIGITAL = 3

Definiert in Zeile 12 der Datei UnitConverter.php.

const ENGLISH = 1

Definiert in Zeile 10 der Datei UnitConverter.php.

const METRIC = 2

Definiert in Zeile 11 der Datei UnitConverter.php.


Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:




Korrekturen, Hinweise und Ergänzungen

Bitte scheuen Sie sich nicht und melden Sie, was auf dieser Seite sachlich falsch oder irreführend ist, was ergänzt werden sollte, was fehlt usw. Dazu bitte oben aus dem Menü Seite den Eintrag Support Forum wählen. Es ist eine kostenlose Anmeldung erforderlich, um Anmerkungen zu posten. Unpassende Postings, Spam usw. werden kommentarlos entfernt.