Measure/Energy.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: Energy.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Measure_Energy
- 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('ATTOJOULE' => array('1.0e-18', 'aJ'), 'BOARD_OF_TRADE_UNIT' => array('3600000', 'BOTU'), 'BTU' => array('1055.0559', 'Btu'), 'BTU_TERMOCHEMICAL' => array('1054.3503', 'Btu'), 'CALORIE' => array('4.1868', 'cal'), 'CALORIE_15C' => array('6.1858', 'cal'), 'CALORIE_NUTRITIONAL' => array('4186.8', 'cal'), 'CALORIE_THERMOCHEMICAL' => array('4.184', 'cal'), 'CELSIUS_HEAT_UNIT' => array('1899.1005', 'Chu'), 'CENTIJOULE' => array('0.01', 'cJ'), 'CHEVAL_VAPEUR_HEURE' => array('2647795.5', 'cv heure'), 'DECIJOULE' => array('0.1', 'dJ'), 'DEKAJOULE' => array('10', 'daJ'), 'DEKAWATT_HOUR' => array('36000', 'daWh'), 'DEKATHERM' => array('1.055057e+9', 'dathm'), 'ELECTRONVOLT' => array('1.6021773e-19', 'eV'), 'ERG' => array('0.0000001', 'erg'), 'EXAJOULE' => array('1.0e+18', 'EJ'), 'EXAWATT_HOUR' => array('3.6e+21', 'EWh'), 'FEMTOJOULE' => array('1.0e-15', 'fJ'), 'FOOT_POUND' => array('1.3558179', 'ft lb'), 'FOOT_POUNDAL' => array('0.04214011', 'ft poundal'), 'GALLON_UK_AUTOMOTIVE' => array('158237172', 'gal car gasoline'), 'GALLON_US_AUTOMOTIVE' => array('131760000', 'gal car gasoline'), 'GALLON_UK_AVIATION' => array('158237172', 'gal jet gasoline'), 'GALLON_US_AVIATION' => array('131760000', 'gal jet gasoline'), 'GALLON_UK_DIESEL' => array('175963194', 'gal diesel'), 'GALLON_US_DIESEL' => array('146520000', 'gal diesel'), 'GALLON_UK_DISTILATE' => array('175963194', 'gal destilate fuel'), 'GALLON_US_DISTILATE' => array('146520000', 'gal destilate fuel'), 'GALLON_UK_KEROSINE_JET' => array('170775090', 'gal jet kerosine'), 'GALLON_US_KEROSINE_JET' => array('142200000', 'gal jet kerosine'), 'GALLON_UK_LPG' => array('121005126.0865275', 'gal lpg'), 'GALLON_US_LPG' => array('100757838.45', 'gal lpg'), 'GALLON_UK_NAPHTA' => array('160831224', 'gal jet fuel'), 'GALLON_US_NAPHTA' => array('133920000', 'gal jet fuel'), 'GALLON_UK_KEROSINE' => array('170775090', 'gal kerosine'), 'GALLON_US_KEROSINE' => array('142200000', 'gal kerosine'), 'GALLON_UK_RESIDUAL' => array('189798138', 'gal residual fuel'), 'GALLON_US_RESIDUAL' => array('158040000', 'gal residual fuel'), 'GIGAELECTRONVOLT' => array('1.6021773e-10', 'GeV'), 'GIGACALORIE' => array('4186800000', 'Gcal'), 'GIGACALORIE_15C' => array('4185800000', 'Gcal'), 'GIGAJOULE' => array('1.0e+9', 'GJ'), 'GIGAWATT_HOUR' => array('3.6e+12', 'GWh'), 'GRAM_CALORIE' => array('4.1858', 'g cal'), 'HARTREE' => array('4.3597482e-18', 'Eh'), 'HECTOJOULE' => array('100', 'hJ'), 'HECTOWATT_HOUR' => array('360000', 'hWh'), 'HORSEPOWER_HOUR' => array('2684519.5', 'hph'), 'HUNDRED_CUBIC_FOOT_GAS' => array('108720000', 'hundred ft� gas'), 'INCH_OUNCE' => array('0.0070615518', 'in oc'), 'INCH_POUND' => array('0.112984825', 'in lb'), 'JOULE' => array('1', 'J'), 'KILOCALORIE_15C' => array('4185.8', 'kcal'), 'KILOCALORIE' => array('4186', '8', 'kcal'), 'KILOCALORIE_THERMOCHEMICAL' => array('4184', 'kcal'), 'KILOELECTRONVOLT' => array('1.6021773e-16', 'keV'), 'KILOGRAM_CALORIE' => array('4185.8', 'kg cal'), 'KILOGRAM_FORCE_METER' => array('9.80665', 'kgf m'), 'KILOJOULE' => array('1000', 'kJ'), 'KILOPOND_METER' => array('9.80665', 'kp m'), 'KILOTON' => array('4.184e+12', 'kt'), 'KILOWATT_HOUR' => array('3600000', 'kWh'), 'LITER_ATMOSPHERE' => array('101.325', 'l atm'), 'MEGAELECTRONVOLT' => array('1.6021773e-13', 'MeV'), 'MEGACALORIE' => array('4186800', 'Mcal'), 'MEGACALORIE_15C' => array('4185800', 'Mcal'), 'MEGAJOULE' => array('1000000', 'MJ'), 'MEGALERG' => array('0.1', 'megalerg'), 'MEGATON' => array('4.184e+15', 'Mt'), 'MEGAWATTHOUR' => array('3.6e+9', 'MWh'), 'METER_KILOGRAM_FORCE' => array('9.80665', 'm kgf'), 'MICROJOULE' => array('0.000001', '�J'), 'MILLIJOULE' => array('0.001', 'mJ'), 'MYRIAWATT_HOUR' => array('3.6e+7', 'myWh'), 'NANOJOULE' => array('1.0e-9', 'nJ'), 'NEWTON_METER' => array('1', 'Nm'), 'PETAJOULE' => array('1.0e+15', 'PJ'), 'PETAWATTHOUR' => array('3.6e+18', 'PWh'), 'PFERDESTAERKENSTUNDE' => array('2647795.5', 'ps h'), 'PICOJOULE' => array('1.0e-12', 'pJ'), 'Q_UNIT' => array('1.0550559e+21', 'Q unit'), 'QUAD' => array('1.0550559e+18', 'quad'), 'TERAELECTRONVOLT' => array('1.6021773e-7', 'TeV'), 'TERAJOULE' => array('1.0e+12', 'TJ'), 'TERAWATTHOUR' => array('3.6e+15', 'TWh'), 'THERM' => array('1.0550559e+8', 'thm'), 'THERM_US' => array('1.054804e+8', 'thm'), 'THERMIE' => array('4185800', 'th'), 'TON' => array('4.184e+9', 'T explosive'), 'TONNE_COAL' => array('2.93076e+10', 'T coal'), 'TONNE_OIL' => array('4.1868e+10', 'T oil'), 'WATTHOUR' => array('3600', 'Wh'), 'WATTSECOND' => array('1', 'Ws'), 'YOCTOJOULE' => array('1.0e-24', 'yJ'), 'YOTTAJOULE' => array('1.0e+24', 'YJ'), 'YOTTAWATTHOUR' => array('3.6e+27', 'YWh'), 'ZEPTOJOULE' => array('1.0e-21', 'zJ'), 'ZETTAJOULE' => array('1.0e+21', 'ZJ'), 'ZETTAWATTHOUR' => array('3.6e+24', 'ZWh'), 'STANDARD' => 'JOULE')
array('ATTOJOULE' => array('1.0e-18', 'aJ'), 'BOARD_OF_TRADE_UNIT' => array('3600000', 'BOTU'), 'BTU' => array('1055.0559', 'Btu'), 'BTU_TERMOCHEMICAL' => array('1054.3503', 'Btu'), 'CALORIE' => array('4.1868', 'cal'), 'CALORIE_15C' => array('6.1858', 'cal'), 'CALORIE_NUTRITIONAL' => array('4186.8', 'cal'), 'CALORIE_THERMOCHEMICAL' => array('4.184', 'cal'), 'CELSIUS_HEAT_UNIT' => array('1899.1005', 'Chu'), 'CENTIJOULE' => array('0.01', 'cJ'), 'CHEVAL_VAPEUR_HEURE' => array('2647795.5', 'cv heure'), 'DECIJOULE' => array('0.1', 'dJ'), 'DEKAJOULE' => array('10', 'daJ'), 'DEKAWATT_HOUR' => array('36000', 'daWh'), 'DEKATHERM' => array('1.055057e+9', 'dathm'), 'ELECTRONVOLT' => array('1.6021773e-19', 'eV'), 'ERG' => array('0.0000001', 'erg'), 'EXAJOULE' => array('1.0e+18', 'EJ'), 'EXAWATT_HOUR' => array('3.6e+21', 'EWh'), 'FEMTOJOULE' => array('1.0e-15', 'fJ'), 'FOOT_POUND' => array('1.3558179', 'ft lb'), 'FOOT_POUNDAL' => array('0.04214011', 'ft poundal'), 'GALLON_UK_AUTOMOTIVE' => array('158237172', 'gal car gasoline'), 'GALLON_US_AUTOMOTIVE' => array('131760000', 'gal car gasoline'), 'GALLON_UK_AVIATION' => array('158237172', 'gal jet gasoline'), 'GALLON_US_AVIATION' => array('131760000', 'gal jet gasoline'), 'GALLON_UK_DIESEL' => array('175963194', 'gal diesel'), 'GALLON_US_DIESEL' => array('146520000', 'gal diesel'), 'GALLON_UK_DISTILATE' => array('175963194', 'gal destilate fuel'), 'GALLON_US_DISTILATE' => array('146520000', 'gal destilate fuel'), 'GALLON_UK_KEROSINE_JET' => array('170775090', 'gal jet kerosine'), 'GALLON_US_KEROSINE_JET' => array('142200000', 'gal jet kerosine'), 'GALLON_UK_LPG' => array('121005126.0865275', 'gal lpg'), 'GALLON_US_LPG' => array('100757838.45', 'gal lpg'), 'GALLON_UK_NAPHTA' => array('160831224', 'gal jet fuel'), 'GALLON_US_NAPHTA' => array('133920000', 'gal jet fuel'), 'GALLON_UK_KEROSINE' => array('170775090', 'gal kerosine'), 'GALLON_US_KEROSINE' => array('142200000', 'gal kerosine'), 'GALLON_UK_RESIDUAL' => array('189798138', 'gal residual fuel'), 'GALLON_US_RESIDUAL' => array('158040000', 'gal residual fuel'), 'GIGAELECTRONVOLT' => array('1.6021773e-10', 'GeV'), 'GIGACALORIE' => array('4186800000', 'Gcal'), 'GIGACALORIE_15C' => array('4185800000', 'Gcal'), 'GIGAJOULE' => array('1.0e+9', 'GJ'), 'GIGAWATT_HOUR' => array('3.6e+12', 'GWh'), 'GRAM_CALORIE' => array('4.1858', 'g cal'), 'HARTREE' => array('4.3597482e-18', 'Eh'), 'HECTOJOULE' => array('100', 'hJ'), 'HECTOWATT_HOUR' => array('360000', 'hWh'), 'HORSEPOWER_HOUR' => array('2684519.5', 'hph'), 'HUNDRED_CUBIC_FOOT_GAS' => array('108720000', 'hundred ft� gas'), 'INCH_OUNCE' => array('0.0070615518', 'in oc'), 'INCH_POUND' => array('0.112984825', 'in lb'), 'JOULE' => array('1', 'J'), 'KILOCALORIE_15C' => array('4185.8', 'kcal'), 'KILOCALORIE' => array('4186', '8', 'kcal'), 'KILOCALORIE_THERMOCHEMICAL' => array('4184', 'kcal'), 'KILOELECTRONVOLT' => array('1.6021773e-16', 'keV'), 'KILOGRAM_CALORIE' => array('4185.8', 'kg cal'), 'KILOGRAM_FORCE_METER' => array('9.80665', 'kgf m'), 'KILOJOULE' => array('1000', 'kJ'), 'KILOPOND_METER' => array('9.80665', 'kp m'), 'KILOTON' => array('4.184e+12', 'kt'), 'KILOWATT_HOUR' => array('3600000', 'kWh'), 'LITER_ATMOSPHERE' => array('101.325', 'l atm'), 'MEGAELECTRONVOLT' => array('1.6021773e-13', 'MeV'), 'MEGACALORIE' => array('4186800', 'Mcal'), 'MEGACALORIE_15C' => array('4185800', 'Mcal'), 'MEGAJOULE' => array('1000000', 'MJ'), 'MEGALERG' => array('0.1', 'megalerg'), 'MEGATON' => array('4.184e+15', 'Mt'), 'MEGAWATTHOUR' => array('3.6e+9', 'MWh'), 'METER_KILOGRAM_FORCE' => array('9.80665', 'm kgf'), 'MICROJOULE' => array('0.000001', '�J'), 'MILLIJOULE' => array('0.001', 'mJ'), 'MYRIAWATT_HOUR' => array('3.6e+7', 'myWh'), 'NANOJOULE' => array('1.0e-9', 'nJ'), 'NEWTON_METER' => array('1', 'Nm'), 'PETAJOULE' => array('1.0e+15', 'PJ'), 'PETAWATTHOUR' => array('3.6e+18', 'PWh'), 'PFERDESTAERKENSTUNDE' => array('2647795.5', 'ps h'), 'PICOJOULE' => array('1.0e-12', 'pJ'), 'Q_UNIT' => array('1.0550559e+21', 'Q unit'), 'QUAD' => array('1.0550559e+18', 'quad'), 'TERAELECTRONVOLT' => array('1.6021773e-7', 'TeV'), 'TERAJOULE' => array('1.0e+12', 'TJ'), 'TERAWATTHOUR' => array('3.6e+15', 'TWh'), 'THERM' => array('1.0550559e+8', 'thm'), 'THERM_US' => array('1.054804e+8', 'thm'), 'THERMIE' => array('4185800', 'th'), 'TON' => array('4.184e+9', 'T explosive'), 'TONNE_COAL' => array('2.93076e+10', 'T coal'), 'TONNE_OIL' => array('4.1868e+10', 'T oil'), 'WATTHOUR' => array('3600', 'Wh'), 'WATTSECOND' => array('1', 'Ws'), 'YOCTOJOULE' => array('1.0e-24', 'yJ'), 'YOTTAJOULE' => array('1.0e+24', 'YJ'), 'YOTTAWATTHOUR' => array('3.6e+27', 'YWh'), 'ZEPTOJOULE' => array('1.0e-21', 'zJ'), 'ZETTAJOULE' => array('1.0e+21', 'ZJ'), 'ZETTAWATTHOUR' => array('3.6e+24', 'ZWh'), 'STANDARD' => 'JOULE')
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 |