Class for handling number conversions

This class can only handle numbers without precision

category Zend
package Zend_Measure
subpackage Zend_Measure_Number
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Measure_Abstract

 Methods

Zend_Measure_Abstract is an abstract class for the different measurement types

__construct(integer $value, string $type, string|\Zend_Locale $locale = null
inherited_from \Zend_Measure_Abstract::__construct()

Parameters

$value

integer

Value

$type

string

(Optional) A Zend_Measure_Number Type

$locale

string\Zend_Locale

(Optional) A Zend_Locale

Exceptions

\Zend_Measure_Exception When language is unknown
\Zend_Measure_Exception When type is unknown

Zend_Measure_Abstract is an abstract class for the different measurement types

__construct(mixed $value, integer $type = null, \Zend_Locale $locale = null
Inherited

Parameters

$value

mixed

Value as string, integer, real or float

$type

integer

OPTIONAL a measure type f.e. Zend_Measure_Length::METER

$locale

\Zend_Locale

OPTIONAL a Zend_Locale Type

Exceptions

\Zend_Measure_Exception

Returns a string representation

__toString() : string
Inherited

Returns

string

Adds an unit to another one

add(\Zend_Measure_Abstract $object) : \Zend_Measure_Abstract
Inherited

Parameters

$object

\Zend_Measure_Abstract

object of same unit type

Returns

\Zend_Measure_Abstract

Compares two units

compare(\Zend_Measure_Abstract $object) : boolean
Inherited

Parameters

$object

\Zend_Measure_Abstract

object of same unit type

Returns

boolean

Alias function for setType returning the converted unit Default is 0 as this class only handles numbers without precision

convertTo(string $type, integer $round = 0, string|\Zend_Locale $locale = null) : string
inherited_from \Zend_Measure_Abstract::convertTo()

Parameters

$type

string

Type to convert to

$round

integer

(Optional) Precision to add, will always be 0

$locale

Returns

string

Alias function for setType returning the converted unit

convertTo(string $type, integer $round = 2, string|\Zend_Locale $locale = null) : string
Inherited

Parameters

$type

string

Constant Type

$round

integer

(Optional) Rounds the value to a given precision

$locale

string\Zend_Locale

(Optional) Locale to set for the number

Returns

string

Compare if the value and type is equal

equals(\Zend_Measure_Abstract $object) : boolean
Inherited

Parameters

$object

\Zend_Measure_Abstract

object to compare

Returns

boolean

Returns the conversion list

getConversionList() : array
Inherited

Returns

array

Returns the actual set locale

getLocale() : string
Inherited

Returns

string

Returns the original type

getType() : \type
Inherited

Returns

\type

Returns the internal value

getValue(integer $round = -1, string|\Zend_Locale $locale = null) : integer | string
Inherited

Parameters

$round

integer

(Optional) Rounds the value to an given precision, Default is -1 which returns without rounding

$locale

string\Zend_Locale

(Optional) Locale for number representation

Returns

integerstring

Sets a new locale for the value representation

setLocale(string|\Zend_Locale $locale = null, boolean $check = false) : \Zend_Measure_Abstract
Inherited

Parameters

$locale

string\Zend_Locale

(Optional) New locale to set

$check

boolean

False, check but don't set; True, set the new locale

Returns

\Zend_Measure_Abstract

Set a new type, and convert the value

setType(string $type) : void
inherited_from \Zend_Measure_Abstract::setType()

Parameters

$type

string

New type to set

Exceptions

\Zend_Measure_Exception When a unknown type is given

Set a new type, and convert the value

setType(string $type) : \Zend_Measure_Abstract
Inherited

Parameters

$type

string

New type to set

Exceptions

\Zend_Measure_Exception

Returns

\Zend_Measure_Abstract

Set a new value

setValue(integer $value, string $type = null, string|\Zend_Locale $locale = null
inherited_from \Zend_Measure_Abstract::setValue()

Parameters

$value

integer

Value

$type

string

(Optional) A Zend_Measure_Number Type

$locale

string\Zend_Locale

(Optional) A Zend_Locale Type

Exceptions

\Zend_Measure_Exception

Set a new value

setValue(integer|string $value, string $type = null, string|\Zend_Locale $locale = null) : \Zend_Measure_Abstract
Inherited

Parameters

$value

integerstring

Value as string, integer, real or float

$type

string

OPTIONAL A measure type f.e. Zend_Measure_Length::METER

$locale

string\Zend_Locale

OPTIONAL Locale for parsing numbers

Exceptions

\Zend_Measure_Exception

Returns

\Zend_Measure_Abstract

Substracts an unit from another one

sub(\Zend_Measure_Abstract $object) : \Zend_Measure_Abstract
Inherited

Parameters

$object

\Zend_Measure_Abstract

object of same unit type

Returns

\Zend_Measure_Abstract

Returns a string representation

toString(integer $round = -1, string|\Zend_Locale $locale = null) : string
Inherited

Parameters

$round

integer

(Optional) Runds the value to an given exception

$locale

string\Zend_Locale

(Optional) Locale to set for the number

Returns

string

Convert input to type value string

_fromDecimal(integer $value, string $type) : string

Parameters

$value

integer

Input string

$type

string

Type to convert to

Exceptions

\Zend_Measure_Exception When more than 200 digits are calculated

Returns

string

Convert input to decimal value string

_toDecimal(integer $input, string $type) : string

Parameters

$input

integer

Input string

$type

string

Type from which to convert to decimal

Returns

string

 Properties

 

Locale identifier

$_locale : string

Default

null
 

Original type for this unit

$_type : string

Default

 

Calculations for all number units

$_units : array

Default

array('BINARY' => array(2, '⑵'), 'TERNARY' => array(3, '⑶'), 'QUATERNARY' => array(4, '⑷'), 'QUINARY' => array(5, '⑸'), 'SENARY' => array(6, '⑹'), 'SEPTENARY' => array(7, '⑺'), 'OCTAL' => array(8, '⑻'), 'NONARY' => array(9, '⑼'), 'DECIMAL' => array(10, '⑽'), 'DUODECIMAL' => array(12, '⑿'), 'HEXADECIMAL' => array(16, '⒃'), 'ROMAN' => array(99, ''), 'STANDARD' => 'DECIMAL')
inherited_from \Zend_Measure_Abstract::_units
 

Unit types for this measurement

$_units 

Default

array()
 

Plain value in standard unit

$_value : string

Default

 

Definition of all roman signs

$_roman : array

Default

array('I' => 1, 'A' => 4, 'V' => 5, 'B' => 9, 'X' => 10, 'E' => 40, 'L' => 50, 'F' => 90, 'C' => 100, 'G' => 400, 'D' => 500, 'H' => 900, 'M' => 1000, 'J' => 4000, 'P' => 5000, 'K' => 9000, 'Q' => 10000, 'N' => 40000, 'R' => 50000, 'W' => 90000, 'S' => 100000, 'Y' => 400000, 'T' => 500000, 'Z' => 900000, 'U' => 1000000)
Static
 

Convertion table for roman signs

$_romanconvert : array

Default

array('/_V/' => '/P/', '/_X/' => '/Q/', '/_L/' => '/R/', '/_C/' => '/S/', '/_D/' => '/T/', '/_M/' => '/U/', '/IV/' => '/A/', '/IX/' => '/B/', '/XL/' => '/E/', '/XC/' => '/F/', '/CD/' => '/G/', '/CM/' => '/H/', '/M_V/' => '/J/', '/MQ/' => '/K/', '/QR/' => '/N/', '/QS/' => '/W/', '/ST/' => '/Y/', '/SU/' => '/Z/')
Static

 Constants

 

BINARY

BINARY = 'BINARY' 
 

DECIMAL

DECIMAL = 'DECIMAL' 
 

DUODECIMAL

DUODECIMAL = 'DUODECIMAL' 
 

HEXADECIMAL

HEXADECIMAL = 'HEXADECIMAL' 
 

NONARY

NONARY = 'NONARY' 
 

OCTAL

OCTAL = 'OCTAL' 
 

QUATERNARY

QUATERNARY = 'QUATERNARY' 
 

QUINARY

QUINARY = 'QUINARY' 
 

ROMAN

ROMAN = 'ROMAN' 
 

SENARY

SENARY = 'SENARY' 
 

SEPTENARY

SEPTENARY = 'SEPTENARY' 
 

STANDARD

STANDARD = 'DECIMAL' 
 

TERNARY

TERNARY = 'TERNARY'