Zend Framework API Documentation » \Zend_Measure

Class for handling force conversions

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

Methods

Zend_Measure_Abstract is an abstract class for the different measurement types

__construct(mixed $value, integer $type = null, \Zend_Locale $locale = null)

Inherited

Parameters

$value

mixed

Value as string, integer, real or float

$type

integer

OPTIONAL a measure type f.e. Zend_Measure_Length::METER

$locale

\Zend_Locale

OPTIONAL a Zend_Locale Type

Exceptions

`\Zend_Measure_Exception`

Returns a string representation

__toString() : string

Inherited

Returns

string

Adds an unit to another one

add(\Zend_Measure_Abstract $object) : \Zend_Measure_Abstract

Inherited

Parameters

$object

\Zend_Measure_Abstract

object of same unit type

Returns

\Zend_Measure_Abstract

Compares two units

compare(\Zend_Measure_Abstract $object) : boolean

Inherited

Parameters

$object

\Zend_Measure_Abstract

object of same unit type

Returns

boolean

Alias function for setType returning the converted unit

convertTo(string $type, integer $round = 2, string|\Zend_Locale $locale = null) : string

Inherited

Parameters

$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

string

Compare if the value and type is equal

equals(\Zend_Measure_Abstract $object) : boolean

Inherited

Parameters

$object

\Zend_Measure_Abstract

object to compare

Returns

boolean

Returns the conversion list

getConversionList() : array

Inherited

Returns

array

Returns the actual set locale

getLocale() : string

Inherited

Returns

string

Returns the original type

getType() : \type

Inherited

Returns

\type

Returns the internal value

getValue(integer $round = -1, string|\Zend_Locale $locale = null) : integer | string

Inherited

Parameters

$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

integerstring

Sets a new locale for the value representation

setLocale(string|\Zend_Locale $locale = null, boolean $check = false) : \Zend_Measure_Abstract

Inherited

Parameters

$locale

string\Zend_Locale

(Optional) New locale to set

$check

boolean

False, check but don't set; True, set the new locale

Returns

\Zend_Measure_Abstract

Set a new type, and convert the value

setType(string $type) : \Zend_Measure_Abstract

Inherited

Parameters

$type

string

New type to set

Exceptions

`\Zend_Measure_Exception`

Returns

\Zend_Measure_Abstract

Set a new value

setValue(integer|string $value, string $type = null, string|\Zend_Locale $locale = null) : \Zend_Measure_Abstract

Inherited

Parameters

$value

integerstring

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

Exceptions

`\Zend_Measure_Exception`

Returns

\Zend_Measure_Abstract

Substracts an unit from another one

sub(\Zend_Measure_Abstract $object) : \Zend_Measure_Abstract

Inherited

Parameters

$object

\Zend_Measure_Abstract

object of same unit type

Returns

\Zend_Measure_Abstract

Returns a string representation

toString(integer $round = -1, string|\Zend_Locale $locale = null) : string

Inherited

Parameters

$round

integer

(Optional) Runds the value to an given exception

$locale

string\Zend_Locale

(Optional) Locale to set for the number

Returns

string

Properties

Locale identifier

$_locale : string

Default

null

Original type for this unit

$_type : string

Default

Calculations for all force units

$_units : array

Default

array('ATTONEWTON' => array('1.0e-18', 'aN'), 'CENTINEWTON' => array('0.01', 'cN'), 'DECIGRAM_FORCE' => array('0.000980665', 'dgf'), 'DECINEWTON' => array('0.1', 'dN'), 'DEKAGRAM_FORCE' => array('0.0980665', 'dagf'), 'DEKANEWTON' => array('10', 'daN'), 'DYNE' => array('0.00001', 'dyn'), 'EXANEWTON' => array('1.0e+18', 'EN'), 'FEMTONEWTON' => array('1.0e-15', 'fN'), 'GIGANEWTON' => array('1.0e+9', 'GN'), 'GRAM_FORCE' => array('0.00980665', 'gf'), 'HECTONEWTON' => array('100', 'hN'), 'JOULE_PER_METER' => array('1', 'J/m'), 'KILOGRAM_FORCE' => array('9.80665', 'kgf'), 'KILONEWTON' => array('1000', 'kN'), 'KILOPOND' => array('9.80665', 'kp'), 'KIP' => array('4448.2216', 'kip'), 'MEGANEWTON' => array('1000000', 'Mp'), 'MEGAPOND' => array('9806.65', 'MN'), 'MICRONEWTON' => array('0.000001', 'µN'), 'MILLINEWTON' => array('0.001', 'mN'), 'NANONEWTON' => array('0.000000001', 'nN'), 'NEWTON' => array('1', 'N'), 'OUNCE_FORCE' => array('0.27801385', 'ozf'), 'PETANEWTON' => array('1.0e+15', 'PN'), 'PICONEWTON' => array('1.0e-12', 'pN'), 'POND' => array('0.00980665', 'pond'), 'POUND_FORCE' => array('4.4482216', 'lbf'), 'POUNDAL' => array('0.13825495', 'pdl'), 'STHENE' => array('1000', 'sn'), 'TERANEWTON' => array('1.0e+12', 'TN'), 'TON_FORCE_LONG' => array('9964.016384', 'tnf'), 'TON_FORCE' => array('9806.65', 'tnf'), 'TON_FORCE_SHORT' => array('8896.4432', 'tnf'), 'YOCTONEWTON' => array('1.0e-24', 'yN'), 'YOTTANEWTON' => array('1.0e+24', 'YN'), 'ZEPTONEWTON' => array('1.0e-21', 'zN'), 'ZETTANEWTON' => array('1.0e+21', 'ZN'), 'STANDARD' => 'NEWTON')

inherited_from	\Zend_Measure_Abstract::_units

Unit types for this measurement

$_units

Default

array()

Plain value in standard unit

$_value : string

Default

Constants

ATTONEWTON

ATTONEWTON = 'ATTONEWTON'

CENTINEWTON

CENTINEWTON = 'CENTINEWTON'

DECIGRAM_FORCE

DECIGRAM_FORCE = 'DECIGRAM_FORCE'

DECINEWTON

DECINEWTON = 'DECINEWTON'

DEKAGRAM_FORCE

DEKAGRAM_FORCE = 'DEKAGRAM_FORCE'

DEKANEWTON

DEKANEWTON = 'DEKANEWTON'

DYNE

DYNE = 'DYNE'

EXANEWTON

EXANEWTON = 'EXANEWTON'

FEMTONEWTON

FEMTONEWTON = 'FEMTONEWTON'

GIGANEWTON

GIGANEWTON = 'GIGANEWTON'

GRAM_FORCE

GRAM_FORCE = 'GRAM_FORCE'

HECTONEWTON

HECTONEWTON = 'HECTONEWTON'

JOULE_PER_METER

JOULE_PER_METER = 'JOULE_PER_METER'

KILOGRAM_FORCE

KILOGRAM_FORCE = 'KILOGRAM_FORCE'

KILONEWTON

KILONEWTON = 'KILONEWTON'

KILOPOND

KILOPOND = 'KILOPOND'

KIP

KIP = 'KIP'

MEGANEWTON

MEGANEWTON = 'MEGANEWTON'

MEGAPOND

MEGAPOND = 'MEGAPOND'

MICRONEWTON

MICRONEWTON = 'MICRONEWTON'

MILLINEWTON

MILLINEWTON = 'MILLINEWTON'

NANONEWTON

NANONEWTON = 'NANONEWTON'

NEWTON

NEWTON = 'NEWTON'

OUNCE_FORCE

OUNCE_FORCE = 'OUNCE_FORCE'

PETANEWTON

PETANEWTON = 'PETANEWTON'

PICONEWTON

PICONEWTON = 'PICONEWTON'

POND

POND = 'POND'

POUNDAL

POUNDAL = 'POUNDAL'

POUND_FORCE

POUND_FORCE = 'POUND_FORCE'

STANDARD

STANDARD = 'NEWTON'

STHENE

STHENE = 'STHENE'

TERANEWTON

TERANEWTON = 'TERANEWTON'

TON_FORCE

TON_FORCE = 'TON_FORCE'

TON_FORCE_LONG

TON_FORCE_LONG = 'TON_FORCE_LONG'

TON_FORCE_SHORT

TON_FORCE_SHORT = 'TON_FORCE_SHORT'

YOCTONEWTON

YOCTONEWTON = 'YOCTONEWTON'

YOTTANEWTON

YOTTANEWTON = 'YOTTANEWTON'

ZEPTONEWTON

ZEPTONEWTON = 'ZEPTONEWTON'

ZETTANEWTON

ZETTANEWTON = 'ZETTANEWTON'