API Documentation

Measure/Energy.php

Zend Framework

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Measure  
version
$Id: Energy.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Measure_Energy

Class for handling energy conversions

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

Constants

Constant  STANDARD = 'JOULE'
Constant  ATTOJOULE = 'ATTOJOULE'
Constant  BOARD_OF_TRADE_UNIT = 'BOARD_OF_TRADE_UNIT'
Constant  BTU = 'BTU'
Constant  BTU_THERMOCHEMICAL = 'BTU_TERMOCHEMICAL'
Constant  CALORIE = 'CALORIE'
Constant  CALORIE_15C = 'CALORIE_15C'
Constant  CALORIE_NUTRITIONAL = 'CALORIE_NUTRITIONAL'
Constant  CALORIE_THERMOCHEMICAL = 'CALORIE_THERMOCHEMICAL'
Constant  CELSIUS_HEAT_UNIT = 'CELSIUS_HEAT_UNIT'
Constant  CENTIJOULE = 'CENTIJOULE'
Constant  CHEVAL_VAPEUR_HEURE = 'CHEVAL_VAPEUR_HEURE'
Constant  DECIJOULE = 'DECIJOULE'
Constant  DEKAJOULE = 'DEKAJOULE'
Constant  DEKAWATT_HOUR = 'DEKAWATT_HOUR'
Constant  DEKATHERM = 'DEKATHERM'
Constant  ELECTRONVOLT = 'ELECTRONVOLT'
Constant  ERG = 'ERG'
Constant  EXAJOULE = 'EXAJOULE'
Constant  EXAWATT_HOUR = 'EXAWATT_HOUR'
Constant  FEMTOJOULE = 'FEMTOJOULE'
Constant  FOOT_POUND = 'FOOT_POUND'
Constant  FOOT_POUNDAL = 'FOOT_POUNDAL'
Constant  GALLON_UK_AUTOMOTIVE = 'GALLON_UK_AUTOMOTIVE'
Constant  GALLON_US_AUTOMOTIVE = 'GALLON_US_AUTOMOTIVE'
Constant  GALLON_UK_AVIATION = 'GALLON_UK_AVIATION'
Constant  GALLON_US_AVIATION = 'GALLON_US_AVIATION'
Constant  GALLON_UK_DIESEL = 'GALLON_UK_DIESEL'
Constant  GALLON_US_DIESEL = 'GALLON_US_DIESEL'
Constant  GALLON_UK_DISTILATE = 'GALLON_UK_DISTILATE'
Constant  GALLON_US_DISTILATE = 'GALLON_US_DISTILATE'
Constant  GALLON_UK_KEROSINE_JET = 'GALLON_UK_KEROSINE_JET'
Constant  GALLON_US_KEROSINE_JET = 'GALLON_US_KEROSINE_JET'
Constant  GALLON_UK_LPG = 'GALLON_UK_LPG'
Constant  GALLON_US_LPG = 'GALLON_US_LPG'
Constant  GALLON_UK_NAPHTA = 'GALLON_UK_NAPHTA'
Constant  GALLON_US_NAPHTA = 'GALLON_US_NAPHTA'
Constant  GALLON_UK_KEROSENE = 'GALLON_UK_KEROSINE'
Constant  GALLON_US_KEROSENE = 'GALLON_US_KEROSINE'
Constant  GALLON_UK_RESIDUAL = 'GALLON_UK_RESIDUAL'
Constant  GALLON_US_RESIDUAL = 'GALLON_US_RESIDUAL'
Constant  GIGAELECTRONVOLT = 'GIGAELECTRONVOLT'
Constant  GIGACALORIE = 'GIGACALORIE'
Constant  GIGACALORIE_15C = 'GIGACALORIE_15C'
Constant  GIGAJOULE = 'GIGAJOULE'
Constant  GIGAWATT_HOUR = 'GIGAWATT_HOUR'
Constant  GRAM_CALORIE = 'GRAM_CALORIE'
Constant  HARTREE = 'HARTREE'
Constant  HECTOJOULE = 'HECTOJOULE'
Constant  HECTOWATT_HOUR = 'HECTOWATT_HOUR'
Constant  HORSEPOWER_HOUR = 'HORSEPOWER_HOUR'
Constant  HUNDRED_CUBIC_FOOT_GAS = 'HUNDRED_CUBIC_FOOT_GAS'
Constant  INCH_OUNCE = 'INCH_OUNCE'
Constant  INCH_POUND = 'INCH_POUND'
Constant  JOULE = 'JOULE'
Constant  KILOCALORIE_15C = 'KILOCALORIE_15C'
Constant  KILOCALORIE = 'KILOCALORIE'
Constant  KILOCALORIE_THERMOCHEMICAL = 'KILOCALORIE_THERMOCHEMICAL'
Constant  KILOELECTRONVOLT = 'KILOELECTRONVOLT'
Constant  KILOGRAM_CALORIE = 'KILOGRAM_CALORIE'
Constant  KILOGRAM_FORCE_METER = 'KILOGRAM_FORCE_METER'
Constant  KILOJOULE = 'KILOJOULE'
Constant  KILOPOND_METER = 'KILOPOND_METER'
Constant  KILOTON = 'KILOTON'
Constant  KILOWATT_HOUR = 'KILOWATT_HOUR'
Constant  LITER_ATMOSPHERE = 'LITER_ATMOSPHERE'
Constant  MEGAELECTRONVOLT = 'MEGAELECTRONVOLT'
Constant  MEGACALORIE = 'MEGACALORIE'
Constant  MEGACALORIE_15C = 'MEGACALORIE_15C'
Constant  MEGAJOULE = 'MEGAJOULE'
Constant  MEGALERG = 'MEGALERG'
Constant  MEGATON = 'MEGATON'
Constant  MEGAWATTHOUR = 'MEGAWATTHOUR'
Constant  METER_KILOGRAM_FORCE = 'METER_KILOGRAM_FORCE'
Constant  MICROJOULE = 'MICROJOULE'
Constant  MILLIJOULE = 'MILLIJOULE'
Constant  MYRIAWATT_HOUR = 'MYRIAWATT_HOUR'
Constant  NANOJOULE = 'NANOJOULE'
Constant  NEWTON_METER = 'NEWTON_METER'
Constant  PETAJOULE = 'PETAJOULE'
Constant  PETAWATTHOUR = 'PETAWATTHOUR'
Constant  PFERDESTAERKENSTUNDE = 'PFERDESTAERKENSTUNDE'
Constant  PICOJOULE = 'PICOJOULE'
Constant  Q_UNIT = 'Q_UNIT'
Constant  QUAD = 'QUAD'
Constant  TERAELECTRONVOLT = 'TERAELECTRONVOLT'
Constant  TERAJOULE = 'TERAJOULE'
Constant  TERAWATTHOUR = 'TERAWATTHOUR'
Constant  THERM = 'THERM'
Constant  THERM_US = 'THERM_US'
Constant  THERMIE = 'THERMIE'
Constant  TON = 'TON'
Constant  TONNE_COAL = 'TONNE_COAL'
Constant  TONNE_OIL = 'TONNE_OIL'
Constant  WATTHOUR = 'WATTHOUR'
Constant  WATTSECOND = 'WATTSECOND'
Constant  YOCTOJOULE = 'YOCTOJOULE'
Constant  YOTTAJOULE = 'YOTTAJOULE'
Constant  YOTTAWATTHOUR = 'YOTTAWATTHOUR'
Constant  ZEPTOJOULE = 'ZEPTOJOULE'
Constant  ZETTAJOULE = 'ZETTAJOULE'
Constant  ZETTAWATTHOUR = 'ZETTAWATTHOUR'

Properties

Propertyprotectedarray  $_units= 'array'

Calculations for all energy units

Default valuearrayDetails
Type
array

Methods

methodpublic__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()
Parameters
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
Throws
Exception Description
\Zend_Measure_Exception
methodpublic__toString( ) : string

Returns a string representation

Inherited from: \Zend_Measure_Abstract::__toString()
Returns
Type Description
string
methodpublicadd( \Zend_Measure_Abstract $object ) : \Zend_Measure_Abstract

Adds an unit to another one

Inherited from: \Zend_Measure_Abstract::add()
Parameters
Name Type Description
$object \Zend_Measure_Abstract object of same unit type
Returns
Type Description
\Zend_Measure_Abstract
methodpubliccompare( \Zend_Measure_Abstract $object ) : boolean

Compares two units

Inherited from: \Zend_Measure_Abstract::compare()
Parameters
Name Type Description
$object \Zend_Measure_Abstract object of same unit type
Returns
Type Description
boolean
methodpublicconvertTo( 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()
Parameters
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

Returns
Type Description
string
methodpublicequals( \Zend_Measure_Abstract $object ) : boolean

Compare if the value and type is equal

Inherited from: \Zend_Measure_Abstract::equals()
Parameters
Name Type Description
$object \Zend_Measure_Abstract object to compare
Returns
Type Description
boolean
methodpublicgetConversionList( ) : array

Returns the conversion list

Inherited from: \Zend_Measure_Abstract::getConversionList()
Returns
Type Description
array
methodpublicgetLocale( ) : string

Returns the actual set locale

Inherited from: \Zend_Measure_Abstract::getLocale()
Returns
Type Description
string
methodpublicgetType( ) : \type

Returns the original type

Inherited from: \Zend_Measure_Abstract::getType()
Returns
Type Description
\type
methodpublicgetValue( integer $round, string|\Zend_Locale $locale = null ) : integer|string

Returns the internal value

Inherited from: \Zend_Measure_Abstract::getValue()
Parameters
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

Returns
Type Description
integerstring
methodpublicsetLocale( 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()
Parameters
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

Returns
Type Description
\Zend_Measure_Abstract
methodpublicsetType( string $type ) : \Zend_Measure_Abstract

Set a new type, and convert the value

Inherited from: \Zend_Measure_Abstract::setType()
Parameters
Name Type Description
$type string New type to set
Returns
Type Description
\Zend_Measure_Abstract
Throws
Exception Description
\Zend_Measure_Exception
methodpublicsetValue( integer|string $value, string $type = null, string|\Zend_Locale $locale = null ) : \Zend_Measure_Abstract

Set a new value

Inherited from: \Zend_Measure_Abstract::setValue()
Parameters
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
Returns
Type Description
\Zend_Measure_Abstract
Throws
Exception Description
\Zend_Measure_Exception
methodpublicsub( \Zend_Measure_Abstract $object ) : \Zend_Measure_Abstract

Substracts an unit from another one

Inherited from: \Zend_Measure_Abstract::sub()
Parameters
Name Type Description
$object \Zend_Measure_Abstract object of same unit type
Returns
Type Description
\Zend_Measure_Abstract
methodpublictoString( integer $round, string|\Zend_Locale $locale = null ) : string

Returns a string representation

Inherited from: \Zend_Measure_Abstract::toString()
Parameters
Name Type Description
$round integer

(Optional) Runds the value to an given exception

$locale string|\Zend_Locale

(Optional) Locale to set for the number

Returns
Type Description
string
Documentation was generated by DocBlox 0.13.3.