Class Zend_Measure_Energy

Description
  • license: New BSD License
  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Measure/Energy.php (line 38)

Zend_Measure_Abstract
   |
   --Zend_Measure_Energy
Class Constant Summary
 ATTOJOULE = 'ATTOJOULE'
 BOARD_OF_TRADE_UNIT = 'BOARD_OF_TRADE_UNIT'
 BTU = 'BTU'
 BTU_THERMOCHEMICAL = 'BTU_TERMOCHEMICAL'
 CALORIE = 'CALORIE'
 CALORIE_15C = 'CALORIE_15C'
 CALORIE_NUTRITIONAL = 'CALORIE_NUTRITIONAL'
 CALORIE_THERMOCHEMICAL = 'CALORIE_THERMOCHEMICAL'
 CELSIUS_HEAT_UNIT = 'CELSIUS_HEAT_UNIT'
 CENTIJOULE = 'CENTIJOULE'
 CHEVAL_VAPEUR_HEURE = 'CHEVAL_VAPEUR_HEURE'
 DECIJOULE = 'DECIJOULE'
 DEKAJOULE = 'DEKAJOULE'
 DEKATHERM = 'DEKATHERM'
 DEKAWATT_HOUR = 'DEKAWATT_HOUR'
 ELECTRONVOLT = 'ELECTRONVOLT'
 ERG = 'ERG'
 EXAJOULE = 'EXAJOULE'
 EXAWATT_HOUR = 'EXAWATT_HOUR'
 FEMTOJOULE = 'FEMTOJOULE'
 FOOT_POUND = 'FOOT_POUND'
 FOOT_POUNDAL = 'FOOT_POUNDAL'
 GALLON_UK_AUTOMOTIVE = 'GALLON_UK_AUTOMOTIVE'
 GALLON_UK_AVIATION = 'GALLON_UK_AVIATION'
 GALLON_UK_DIESEL = 'GALLON_UK_DIESEL'
 GALLON_UK_DISTILATE = 'GALLON_UK_DISTILATE'
 GALLON_UK_KEROSENE = 'GALLON_UK_KEROSINE'
 GALLON_UK_KEROSINE_JET = 'GALLON_UK_KEROSINE_JET'
 GALLON_UK_LPG = 'GALLON_UK_LPG'
 GALLON_UK_NAPHTA = 'GALLON_UK_NAPHTA'
 GALLON_UK_RESIDUAL = 'GALLON_UK_RESIDUAL'
 GALLON_US_AUTOMOTIVE = 'GALLON_US_AUTOMOTIVE'
 GALLON_US_AVIATION = 'GALLON_US_AVIATION'
 GALLON_US_DIESEL = 'GALLON_US_DIESEL'
 GALLON_US_DISTILATE = 'GALLON_US_DISTILATE'
 GALLON_US_KEROSENE = 'GALLON_US_KEROSINE'
 GALLON_US_KEROSINE_JET = 'GALLON_US_KEROSINE_JET'
 GALLON_US_LPG = 'GALLON_US_LPG'
 GALLON_US_NAPHTA = 'GALLON_US_NAPHTA'
 GALLON_US_RESIDUAL = 'GALLON_US_RESIDUAL'
 GIGACALORIE = 'GIGACALORIE'
 GIGACALORIE_15C = 'GIGACALORIE_15C'
 GIGAELECTRONVOLT = 'GIGAELECTRONVOLT'
 GIGAJOULE = 'GIGAJOULE'
 GIGAWATT_HOUR = 'GIGAWATT_HOUR'
 GRAM_CALORIE = 'GRAM_CALORIE'
 HARTREE = 'HARTREE'
 HECTOJOULE = 'HECTOJOULE'
 HECTOWATT_HOUR = 'HECTOWATT_HOUR'
 HORSEPOWER_HOUR = 'HORSEPOWER_HOUR'
 HUNDRED_CUBIC_FOOT_GAS = 'HUNDRED_CUBIC_FOOT_GAS'
 INCH_OUNCE = 'INCH_OUNCE'
 INCH_POUND = 'INCH_POUND'
 JOULE = 'JOULE'
 KILOCALORIE = 'KILOCALORIE'
 KILOCALORIE_15C = 'KILOCALORIE_15C'
 KILOCALORIE_THERMOCHEMICAL = 'KILOCALORIE_THERMOCHEMICAL'
 KILOELECTRONVOLT = 'KILOELECTRONVOLT'
 KILOGRAM_CALORIE = 'KILOGRAM_CALORIE'
 KILOGRAM_FORCE_METER = 'KILOGRAM_FORCE_METER'
 KILOJOULE = 'KILOJOULE'
 KILOPOND_METER = 'KILOPOND_METER'
 KILOTON = 'KILOTON'
 KILOWATT_HOUR = 'KILOWATT_HOUR'
 LITER_ATMOSPHERE = 'LITER_ATMOSPHERE'
 MEGACALORIE = 'MEGACALORIE'
 MEGACALORIE_15C = 'MEGACALORIE_15C'
 MEGAELECTRONVOLT = 'MEGAELECTRONVOLT'
 MEGAJOULE = 'MEGAJOULE'
 MEGALERG = 'MEGALERG'
 MEGATON = 'MEGATON'
 MEGAWATTHOUR = 'MEGAWATTHOUR'
 METER_KILOGRAM_FORCE = 'METER_KILOGRAM_FORCE'
 MICROJOULE = 'MICROJOULE'
 MILLIJOULE = 'MILLIJOULE'
 MYRIAWATT_HOUR = 'MYRIAWATT_HOUR'
 NANOJOULE = 'NANOJOULE'
 NEWTON_METER = 'NEWTON_METER'
 PETAJOULE = 'PETAJOULE'
 PETAWATTHOUR = 'PETAWATTHOUR'
 PFERDESTAERKENSTUNDE = 'PFERDESTAERKENSTUNDE'
 PICOJOULE = 'PICOJOULE'
 QUAD = 'QUAD'
 Q_UNIT = 'Q_UNIT'
 STANDARD = 'JOULE'
 TERAELECTRONVOLT = 'TERAELECTRONVOLT'
 TERAJOULE = 'TERAJOULE'
 TERAWATTHOUR = 'TERAWATTHOUR'
 THERM = 'THERM'
 THERMIE = 'THERMIE'
 THERM_US = 'THERM_US'
 TON = 'TON'
 TONNE_COAL = 'TONNE_COAL'
 TONNE_OIL = 'TONNE_OIL'
 WATTHOUR = 'WATTHOUR'
 WATTSECOND = 'WATTSECOND'
 YOCTOJOULE = 'YOCTOJOULE'
 YOTTAJOULE = 'YOTTAJOULE'
 YOTTAWATTHOUR = 'YOTTAWATTHOUR'
 ZEPTOJOULE = 'ZEPTOJOULE'
 ZETTAJOULE = 'ZETTAJOULE'
 ZETTAWATTHOUR = 'ZETTAWATTHOUR'
Method Summary
 boolean equals (Zend_Measure_Energy $object)
 void setType ($type $type)
 void setValue (integer|string $value, [string $type = null], [string|Zend_Locale $locale = null])
 string toString ()
 Zend_Measure_Energy __construct (integer|string $value, [string $type = null], [string|Zend_Locale $locale = null])
 string __toString ()
Methods
equals (line 276)

Compare if the value and type is equal

  • access: public
boolean equals (Zend_Measure_Energy $object)

Redefinition of:
Zend_Measure_Abstract::equals()
Compare if the value and type is equal
getConversionList (line 373)

Returns the conversion list

  • access: public
array getConversionList ()

Redefinition of:
Zend_Measure_Abstract::getConversionList()
Returns the conversion list
setType (line 329)

Set a new type, and convert the value

  • access: public
  • throws: Zend_Measure_Exception
void setType ($type $type)
  • $type $type: new type to set

Redefinition of:
Zend_Measure_Abstract::setType()
Sets the original type
setValue (line 294)

Set a new value

  • access: public
  • throws: Zend_Measure_Exception
void setValue (integer|string $value, [string $type = null], [string|Zend_Locale $locale = null])
  • integer|string $value: Value as string, integer, real or float
  • string $type: OPTIONAL A Zend_Measure_Energy Type
  • string|Zend_Locale $locale: OPTIONAL Locale for parsing numbers

Redefinition of:
Zend_Measure_Abstract::setValue()
Sets the internal value
toString (line 351)

Returns a string representation

  • access: public
string toString ()

Redefinition of:
Zend_Measure_Abstract::toString()
Returns a string representation
Constructor __construct (line 264)

Zend_Measure_Energy provides an locale aware class for conversion and formatting of energy values

Zend_Measure $input can be a locale based input string or a value. $locale can be used to define that the input is made in a different language than the actual one.

  • access: public
  • throws: Zend_Measure_Exception
Zend_Measure_Energy __construct (integer|string $value, [string $type = null], [string|Zend_Locale $locale = null])
  • integer|string $value: Value as string, integer, real or float
  • string $type: OPTIONAL A Zend_Measure_Energy Type
  • string|Zend_Locale $locale: OPTIONAL Locale for parsing numbers
__toString (line 362)

Returns a string representation

  • access: public
string __toString ()

Redefinition of:
Zend_Measure_Abstract::__toString()
Returns a string representation

Inherited Methods

Inherited From Zend_Measure_Abstract

 Zend_Measure_Abstract::equals()
 Zend_Measure_Abstract::getConversionList()
 Zend_Measure_Abstract::getType()
 Zend_Measure_Abstract::getValue()
 Zend_Measure_Abstract::serialize()
 Zend_Measure_Abstract::setType()
 Zend_Measure_Abstract::setValue()
 Zend_Measure_Abstract::toString()
 Zend_Measure_Abstract::__toString()
Class Constants
ATTOJOULE = 'ATTOJOULE' (line 43)
BOARD_OF_TRADE_UNIT = 'BOARD_OF_TRADE_UNIT' (line 44)
BTU = 'BTU' (line 45)
BTU_THERMOCHEMICAL = 'BTU_TERMOCHEMICAL' (line 46)
CALORIE = 'CALORIE' (line 47)
CALORIE_15C = 'CALORIE_15C' (line 48)
CALORIE_NUTRITIONAL = 'CALORIE_NUTRITIONAL' (line 49)
CALORIE_THERMOCHEMICAL = 'CALORIE_THERMOCHEMICAL' (line 50)
CELSIUS_HEAT_UNIT = 'CELSIUS_HEAT_UNIT' (line 51)
CENTIJOULE = 'CENTIJOULE' (line 52)
CHEVAL_VAPEUR_HEURE = 'CHEVAL_VAPEUR_HEURE' (line 53)
DECIJOULE = 'DECIJOULE' (line 54)
DEKAJOULE = 'DEKAJOULE' (line 55)
DEKATHERM = 'DEKATHERM' (line 57)
DEKAWATT_HOUR = 'DEKAWATT_HOUR' (line 56)
ELECTRONVOLT = 'ELECTRONVOLT' (line 58)
ERG = 'ERG' (line 59)
EXAJOULE = 'EXAJOULE' (line 60)
EXAWATT_HOUR = 'EXAWATT_HOUR' (line 61)
FEMTOJOULE = 'FEMTOJOULE' (line 62)
FOOT_POUND = 'FOOT_POUND' (line 63)
FOOT_POUNDAL = 'FOOT_POUNDAL' (line 64)
GALLON_UK_AUTOMOTIVE = 'GALLON_UK_AUTOMOTIVE' (line 65)
GALLON_UK_AVIATION = 'GALLON_UK_AVIATION' (line 67)
GALLON_UK_DIESEL = 'GALLON_UK_DIESEL' (line 69)
GALLON_UK_DISTILATE = 'GALLON_UK_DISTILATE' (line 71)
GALLON_UK_KEROSENE = 'GALLON_UK_KEROSINE' (line 79)
GALLON_UK_KEROSINE_JET = 'GALLON_UK_KEROSINE_JET' (line 73)
GALLON_UK_LPG = 'GALLON_UK_LPG' (line 75)
GALLON_UK_NAPHTA = 'GALLON_UK_NAPHTA' (line 77)
GALLON_UK_RESIDUAL = 'GALLON_UK_RESIDUAL' (line 81)
GALLON_US_AUTOMOTIVE = 'GALLON_US_AUTOMOTIVE' (line 66)
GALLON_US_AVIATION = 'GALLON_US_AVIATION' (line 68)
GALLON_US_DIESEL = 'GALLON_US_DIESEL' (line 70)
GALLON_US_DISTILATE = 'GALLON_US_DISTILATE' (line 72)
GALLON_US_KEROSENE = 'GALLON_US_KEROSINE' (line 80)
GALLON_US_KEROSINE_JET = 'GALLON_US_KEROSINE_JET' (line 74)
GALLON_US_LPG = 'GALLON_US_LPG' (line 76)
GALLON_US_NAPHTA = 'GALLON_US_NAPHTA' (line 78)
GALLON_US_RESIDUAL = 'GALLON_US_RESIDUAL' (line 82)
GIGACALORIE = 'GIGACALORIE' (line 84)
GIGACALORIE_15C = 'GIGACALORIE_15C' (line 85)
GIGAELECTRONVOLT = 'GIGAELECTRONVOLT' (line 83)
GIGAJOULE = 'GIGAJOULE' (line 86)
GIGAWATT_HOUR = 'GIGAWATT_HOUR' (line 87)
GRAM_CALORIE = 'GRAM_CALORIE' (line 88)
HARTREE = 'HARTREE' (line 89)
HECTOJOULE = 'HECTOJOULE' (line 90)
HECTOWATT_HOUR = 'HECTOWATT_HOUR' (line 91)
HORSEPOWER_HOUR = 'HORSEPOWER_HOUR' (line 92)
HUNDRED_CUBIC_FOOT_GAS = 'HUNDRED_CUBIC_FOOT_GAS' (line 93)
INCH_OUNCE = 'INCH_OUNCE' (line 94)
INCH_POUND = 'INCH_POUND' (line 95)
JOULE = 'JOULE' (line 96)
KILOCALORIE = 'KILOCALORIE' (line 98)
KILOCALORIE_15C = 'KILOCALORIE_15C' (line 97)
KILOCALORIE_THERMOCHEMICAL = 'KILOCALORIE_THERMOCHEMICAL' (line 99)
KILOELECTRONVOLT = 'KILOELECTRONVOLT' (line 100)
KILOGRAM_CALORIE = 'KILOGRAM_CALORIE' (line 101)
KILOGRAM_FORCE_METER = 'KILOGRAM_FORCE_METER' (line 102)
KILOJOULE = 'KILOJOULE' (line 103)
KILOPOND_METER = 'KILOPOND_METER' (line 104)
KILOTON = 'KILOTON' (line 105)
KILOWATT_HOUR = 'KILOWATT_HOUR' (line 106)
LITER_ATMOSPHERE = 'LITER_ATMOSPHERE' (line 107)
MEGACALORIE = 'MEGACALORIE' (line 109)
MEGACALORIE_15C = 'MEGACALORIE_15C' (line 110)
MEGAELECTRONVOLT = 'MEGAELECTRONVOLT' (line 108)
MEGAJOULE = 'MEGAJOULE' (line 111)
MEGALERG = 'MEGALERG' (line 112)
MEGATON = 'MEGATON' (line 113)
MEGAWATTHOUR = 'MEGAWATTHOUR' (line 114)
METER_KILOGRAM_FORCE = 'METER_KILOGRAM_FORCE' (line 115)
MICROJOULE = 'MICROJOULE' (line 116)
MILLIJOULE = 'MILLIJOULE' (line 117)
MYRIAWATT_HOUR = 'MYRIAWATT_HOUR' (line 118)
NANOJOULE = 'NANOJOULE' (line 119)
NEWTON_METER = 'NEWTON_METER' (line 120)
PETAJOULE = 'PETAJOULE' (line 121)
PETAWATTHOUR = 'PETAWATTHOUR' (line 122)
PFERDESTAERKENSTUNDE = 'PFERDESTAERKENSTUNDE' (line 123)
PICOJOULE = 'PICOJOULE' (line 124)
QUAD = 'QUAD' (line 126)
Q_UNIT = 'Q_UNIT' (line 125)
STANDARD = 'JOULE' (line 41)
TERAELECTRONVOLT = 'TERAELECTRONVOLT' (line 127)
TERAJOULE = 'TERAJOULE' (line 128)
TERAWATTHOUR = 'TERAWATTHOUR' (line 129)
THERM = 'THERM' (line 130)
THERMIE = 'THERMIE' (line 132)
THERM_US = 'THERM_US' (line 131)
TON = 'TON' (line 133)
TONNE_COAL = 'TONNE_COAL' (line 134)
TONNE_OIL = 'TONNE_OIL' (line 135)
WATTHOUR = 'WATTHOUR' (line 136)
WATTSECOND = 'WATTSECOND' (line 137)
YOCTOJOULE = 'YOCTOJOULE' (line 138)
YOTTAJOULE = 'YOTTAJOULE' (line 139)
YOTTAWATTHOUR = 'YOTTAWATTHOUR' (line 140)
ZEPTOJOULE = 'ZEPTOJOULE' (line 141)
ZETTAJOULE = 'ZETTAJOULE' (line 142)
ZETTAWATTHOUR = 'ZETTAWATTHOUR' (line 143)

Documentation generated on Thu, 18 Jan 2007 09:53:05 -0800 by phpDocumentor 1.3.1