Class for handling current conversions

category Zend
package Zend_Measure
subpackage Zend_Measure_Current
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(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

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) : \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|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

 Properties

 

Locale identifier

$_locale : string

Default

null
 

Original type for this unit

$_type : string

Default

 

Calculations for all current units

$_units : array

Default

array('ABAMPERE' => array('10', 'abampere'), 'AMPERE' => array('1', 'A'), 'BIOT' => array('10', 'Bi'), 'CENTIAMPERE' => array('0.01', 'cA'), 'COULOMB_PER_SECOND' => array('1', 'C/s'), 'DECIAMPERE' => array('0.1', 'dA'), 'DEKAAMPERE' => array('10', 'daA'), 'ELECTROMAGNATIC_UNIT' => array('10', 'current emu'), 'ELECTROSTATIC_UNIT' => array('3.335641e-10', 'current esu'), 'FRANCLIN_PER_SECOND' => array('3.335641e-10', 'Fr/s'), 'GAUSSIAN' => array('3.335641e-10', 'G current'), 'GIGAAMPERE' => array('1.0e+9', 'GA'), 'GILBERT' => array('0.79577472', 'Gi'), 'HECTOAMPERE' => array('100', 'hA'), 'KILOAMPERE' => array('1000', 'kA'), 'MEGAAMPERE' => array('1000000', 'MA'), 'MICROAMPERE' => array('0.000001', 'µA'), 'MILLIAMPERE' => array('0.001', 'mA'), 'NANOAMPERE' => array('1.0e-9', 'nA'), 'PICOAMPERE' => array('1.0e-12', 'pA'), 'SIEMENS_VOLT' => array('1', 'SV'), 'STATAMPERE' => array('3.335641e-10', 'statampere'), 'TERAAMPERE' => array('1.0e+12', 'TA'), 'VOLT_PER_OHM' => array('1', 'V/Ohm'), 'WATT_PER_VOLT' => array('1', 'W/V'), 'WEBER_PER_HENRY' => array('1', 'Wb/H'), 'STANDARD' => 'AMPERE')
inherited_from \Zend_Measure_Abstract::_units
 

Unit types for this measurement

$_units 

Default

array()
 

Plain value in standard unit

$_value : string

Default

 Constants

 

ABAMPERE

ABAMPERE = 'ABAMPERE' 
 

AMPERE

AMPERE = 'AMPERE' 
 

BIOT

BIOT = 'BIOT' 
 

CENTIAMPERE

CENTIAMPERE = 'CENTIAMPERE' 
 

COULOMB_PER_SECOND

COULOMB_PER_SECOND = 'COULOMB_PER_SECOND' 
 

DECIAMPERE

DECIAMPERE = 'DECIAMPERE' 
 

DEKAAMPERE

DEKAAMPERE = 'DEKAAMPERE' 
 

ELECTROMAGNETIC_UNIT

ELECTROMAGNETIC_UNIT = 'ELECTROMAGNATIC_UNIT' 
 

ELECTROSTATIC_UNIT

ELECTROSTATIC_UNIT = 'ELECTROSTATIC_UNIT' 
 

FRANCLIN_PER_SECOND

FRANCLIN_PER_SECOND = 'FRANCLIN_PER_SECOND' 
 

GAUSSIAN

GAUSSIAN = 'GAUSSIAN' 
 

GIGAAMPERE

GIGAAMPERE = 'GIGAAMPERE' 
 

GILBERT

GILBERT = 'GILBERT' 
 

HECTOAMPERE

HECTOAMPERE = 'HECTOAMPERE' 
 

KILOAMPERE

KILOAMPERE = 'KILOAMPERE' 
 

MEGAAMPERE

MEGAAMPERE = 'MEGAAMPERE' 
 

MICROAMPERE

MICROAMPERE = 'MICROAMPERE' 
 

MILLIAMPERE

MILLIAMPERE = 'MILLIAMPERE' 
 

NANOAMPERE

NANOAMPERE = 'NANOAMPERE' 
 

PICOAMPERE

PICOAMPERE = 'PICOAMPERE' 
 

SIEMENS_VOLT

SIEMENS_VOLT = 'SIEMENS_VOLT' 
 

STANDARD

STANDARD = 'AMPERE' 
 

STATAMPERE

STATAMPERE = 'STATAMPERE' 
 

TERAAMPERE

TERAAMPERE = 'TERAAMPERE' 
 

VOLT_PER_OHM

VOLT_PER_OHM = 'VOLT_PER_OHM' 
 

WATT_PER_VOLT

WATT_PER_VOLT = 'WATT_PER_VOLT' 
 

WEBER_PER_HENRY

WEBER_PER_HENRY = 'WEBER_PER_HENRY'