Measure/Current.php
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Measure
- Version
- $Id: Current.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Measure_Current
- Parent(s)
- \Zend_Measure_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
Properties


string $_locale = null
null
Details- Type
- string
- Inherited_from
- \Zend_Measure_Abstract::$$_locale


array $_units = 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')
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')
Details- Type
- array
Methods


__construct(mixed $value, int $type = null, \Zend_Locale $locale = null) : void
Zend_Measure_Abstract is an abstract class for the different measurement types
Inherited from: \Zend_Measure_Abstract::__construct()Name | Type | Description |
---|---|---|
$value | mixed | Value as string, integer, real or float |
$type | int | OPTIONAL a measure type f.e. Zend_Measure_Length::METER |
$locale | \Zend_Locale | OPTIONAL a Zend_Locale Type |
Exception | Description |
---|---|
\Zend_Measure_Exception |


add(\Zend_Measure_Abstract $object) : \Zend_Measure_Abstract
Name | Type | Description |
---|---|---|
$object | \Zend_Measure_Abstract | object of same unit type |
Type | Description |
---|---|
\Zend_Measure_Abstract |


compare(\Zend_Measure_Abstract $object) : boolean
Name | Type | Description |
---|---|---|
$object | \Zend_Measure_Abstract | object of same unit type |
Type | Description |
---|---|
boolean |


convertTo(string $type, integer $round = 2, string | \Zend_Locale $locale = null) : string
Alias function for setType returning the converted unit
Inherited from: \Zend_Measure_Abstract::convertTo()Name | Type | Description |
---|---|---|
$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 |
Type | Description |
---|---|
string |


equals(\Zend_Measure_Abstract $object) : boolean
Name | Type | Description |
---|---|---|
$object | \Zend_Measure_Abstract | object to compare |
Type | Description |
---|---|
boolean |


getValue(integer $round = -1, string | \Zend_Locale $locale = null) : integer | string
Name | Type | Description |
---|---|---|
$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 |
Type | Description |
---|---|
integer | string |


setLocale(string | \Zend_Locale $locale = null, boolean $check = false) : \Zend_Measure_Abstract
Sets a new locale for the value representation
Inherited from: \Zend_Measure_Abstract::setLocale()Name | Type | Description |
---|---|---|
$locale | string | \Zend_Locale | (Optional) New locale to set |
$check | boolean | False, check but don't set; True, set the new locale |
Type | Description |
---|---|
\Zend_Measure_Abstract |


setType(string $type) : \Zend_Measure_Abstract
Name | Type | Description |
---|---|---|
$type | string | New type to set |
Type | Description |
---|---|
\Zend_Measure_Abstract |
Exception | Description |
---|---|
\Zend_Measure_Exception |


setValue(integer | string $value, string $type = null, string | \Zend_Locale $locale = null) : \Zend_Measure_Abstract
Name | Type | Description |
---|---|---|
$value | integer | string | 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 |
Type | Description |
---|---|
\Zend_Measure_Abstract |
Exception | Description |
---|---|
\Zend_Measure_Exception |


sub(\Zend_Measure_Abstract $object) : \Zend_Measure_Abstract
Name | Type | Description |
---|---|---|
$object | \Zend_Measure_Abstract | object of same unit type |
Type | Description |
---|---|
\Zend_Measure_Abstract |


toString(integer $round = -1, string | \Zend_Locale $locale = null) : string
Name | Type | Description |
---|---|---|
$round | integer | (Optional) Runds the value to an given exception |
$locale | string | \Zend_Locale | (Optional) Locale to set for the number |
Type | Description |
---|---|
string |