Measure/Energy.php

Show: inherited
Table of Contents

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 [email protected] 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
jump to top

Package: Zend\Measure\Zend\Measure\Energy

Class for handling energy conversions

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

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

Propertyprotectedstring $_locale = null
inherited

Locale identifier

Inherited from: \Zend_Measure_Abstract::$$_locale
Default valuenullDetails
Type
string
Inherited_from
\Zend_Measure_Abstract::$$_locale  
Propertyprotectedstring $_type =
inherited

Original type for this unit

Inherited from: \Zend_Measure_Abstract::$$_type
Details
Type
string
Inherited_from
\Zend_Measure_Abstract::$$_type  
Propertyprotectedarray $_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')

Calculations for all energy units

Default valuearray('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
Propertyprotectedstring $_value =
inherited

Plain value in standard unit

Inherited from: \Zend_Measure_Abstract::$$_value
Details
Type
string
Inherited_from
\Zend_Measure_Abstract::$$_value  

Methods

methodpublic__construct(mixed $value, int $type = null, \Zend_Locale $locale = null) : void
inherited

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
inherited

Returns a string representation

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

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
inherited

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
inherited

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
inherited

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
inherited

Returns the conversion list

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

Returns the actual set locale

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

Returns the original type

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

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
integer | string
methodpublicsetLocale(string | \Zend_Locale $locale = null, boolean $check = false) : \Zend_Measure_Abstract
inherited

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
inherited

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
inherited

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
inherited

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 = -1, string | \Zend_Locale $locale = null) : string
inherited

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 phpDocumentor 2.0.0a8.