Zend Framework API Documentation » \Zend_Measure_Flow

Class for handling flow mass conversions

category	Zend
package	Zend_Measure
subpackage	Zend_Measure_Flow_Mass
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 flow mass units

$_units : array

Default

array('CENTIGRAM_PER_DAY' => array(array('' => '0.00001', '/' => '86400'), 'cg/day'), 'CENTIGRAM_PER_HOUR' => array(array('' => '0.00001', '/' => '3600'), 'cg/h'), 'CENTIGRAM_PER_MINUTE' => array(array('' => '0.00001', '/' => '60'), 'cg/m'), 'CENTIGRAM_PER_SECOND' => array('0.00001', 'cg/s'), 'GRAM_PER_DAY' => array(array('' => '0.001', '/' => '86400'), 'g/day'), 'GRAM_PER_HOUR' => array(array('' => '0.001', '/' => '3600'), 'g/h'), 'GRAM_PER_MINUTE' => array(array('' => '0.001', '/' => '60'), 'g/m'), 'GRAM_PER_SECOND' => array('0.001', 'g/s'), 'KILOGRAM_PER_DAY' => array(array('' => '1', '/' => '86400'), 'kg/day'), 'KILOGRAM_PER_HOUR' => array(array('' => '1', '/' => '3600'), 'kg/h'), 'KILOGRAM_PER_MINUTE' => array(array('' => '1', '/' => '60'), 'kg/m'), 'KILOGRAM_PER_SECOND' => array('1', 'kg/s'), 'MILLIGRAM_PER_DAY' => array(array('' => '0.000001', '/' => '86400'), 'mg/day'), 'MILLIGRAM_PER_HOUR' => array(array('' => '0.000001', '/' => '3600'), 'mg/h'), 'MILLIGRAM_PER_MINUTE' => array(array('' => '0.000001', '/' => '60'), 'mg/m'), 'MILLIGRAM_PER_SECOND' => array('0.000001', 'mg/s'), 'OUNCE_PER_DAY' => array(array('' => '0.0283495', '/' => '86400'), 'oz/day'), 'OUNCE_PER_HOUR' => array(array('' => '0.0283495', '/' => '3600'), 'oz/h'), 'OUNCE_PER_MINUTE' => array(array('' => '0.0283495', '/' => '60'), 'oz/m'), 'OUNCE_PER_SECOND' => array('0.0283495', 'oz/s'), 'POUND_PER_DAY' => array(array('' => '0.453592', '/' => '86400'), 'lb/day'), 'POUND_PER_HOUR' => array(array('' => '0.453592', '/' => '3600'), 'lb/h'), 'POUND_PER_MINUTE' => array(array('' => '0.453592', '/' => '60'), 'lb/m'), 'POUND_PER_SECOND' => array('0.453592', 'lb/s'), 'TON_LONG_PER_DAY' => array(array('' => '1016.04608', '/' => '86400'), 't/day'), 'TON_LONG_PER_HOUR' => array(array('' => '1016.04608', '/' => '3600'), 't/h'), 'TON_LONG_PER_MINUTE' => array(array('' => '1016.04608', '/' => '60'), 't/m'), 'TON_LONG_PER_SECOND' => array('1016.04608', 't/s'), 'TON_PER_DAY' => array(array('' => '1000', '/' => '86400'), 't/day'), 'TON_PER_HOUR' => array(array('' => '1000', '/' => '3600'), 't/h'), 'TON_PER_MINUTE' => array(array('' => '1000', '/' => '60'), 't/m'), 'TON_PER_SECOND' => array('1000', 't/s'), 'TON_SHORT_PER_DAY' => array(array('' => '907.184', '/' => '86400'), 't/day'), 'TON_SHORT_PER_HOUR' => array(array('' => '907.184', '/' => '3600'), 't/h'), 'TON_SHORT_PER_MINUTE' => array(array('' => '907.184', '/' => '60'), 't/m'), 'TON_SHORT_PER_SECOND' => array('907.184', 't/s'), 'STANDARD' => 'KILOGRAM_PER_SECOND')

inherited_from	\Zend_Measure_Abstract::_units

Unit types for this measurement

$_units

Default

array()

Plain value in standard unit

$_value : string

Default

Constants

CENTIGRAM_PER_DAY

CENTIGRAM_PER_DAY = 'CENTIGRAM_PER_DAY'

CENTIGRAM_PER_HOUR

CENTIGRAM_PER_HOUR = 'CENTIGRAM_PER_HOUR'

CENTIGRAM_PER_MINUTE

CENTIGRAM_PER_MINUTE = 'CENTIGRAM_PER_MINUTE'

CENTIGRAM_PER_SECOND

CENTIGRAM_PER_SECOND = 'CENTIGRAM_PER_SECOND'

GRAM_PER_DAY

GRAM_PER_DAY = 'GRAM_PER_DAY'

GRAM_PER_HOUR

GRAM_PER_HOUR = 'GRAM_PER_HOUR'

GRAM_PER_MINUTE

GRAM_PER_MINUTE = 'GRAM_PER_MINUTE'

GRAM_PER_SECOND

GRAM_PER_SECOND = 'GRAM_PER_SECOND'

KILOGRAM_PER_DAY

KILOGRAM_PER_DAY = 'KILOGRAM_PER_DAY'

KILOGRAM_PER_HOUR

KILOGRAM_PER_HOUR = 'KILOGRAM_PER_HOUR'

KILOGRAM_PER_MINUTE

KILOGRAM_PER_MINUTE = 'KILOGRAM_PER_MINUTE'

KILOGRAM_PER_SECOND

KILOGRAM_PER_SECOND = 'KILOGRAM_PER_SECOND'

MILLIGRAM_PER_DAY

MILLIGRAM_PER_DAY = 'MILLIGRAM_PER_DAY'

MILLIGRAM_PER_HOUR

MILLIGRAM_PER_HOUR = 'MILLIGRAM_PER_HOUR'

MILLIGRAM_PER_MINUTE

MILLIGRAM_PER_MINUTE = 'MILLIGRAM_PER_MINUTE'

MILLIGRAM_PER_SECOND

MILLIGRAM_PER_SECOND = 'MILLIGRAM_PER_SECOND'

OUNCE_PER_DAY

OUNCE_PER_DAY = 'OUNCE_PER_DAY'

OUNCE_PER_HOUR

OUNCE_PER_HOUR = 'OUNCE_PER_HOUR'

OUNCE_PER_MINUTE

OUNCE_PER_MINUTE = 'OUNCE_PER_MINUTE'

OUNCE_PER_SECOND

OUNCE_PER_SECOND = 'OUNCE_PER_SECOND'

POUND_PER_DAY

POUND_PER_DAY = 'POUND_PER_DAY'

POUND_PER_HOUR

POUND_PER_HOUR = 'POUND_PER_HOUR'

POUND_PER_MINUTE

POUND_PER_MINUTE = 'POUND_PER_MINUTE'

POUND_PER_SECOND

POUND_PER_SECOND = 'POUND_PER_SECOND'

STANDARD

STANDARD = 'KILOGRAM_PER_SECOND'

TON_LONG_PER_DAY

TON_LONG_PER_DAY = 'TON_LONG_PER_DAY'

TON_LONG_PER_HOUR

TON_LONG_PER_HOUR = 'TON_LONG_PER_HOUR'

TON_LONG_PER_MINUTE

TON_LONG_PER_MINUTE = 'TON_LONG_PER_MINUTE'

TON_LONG_PER_SECOND

TON_LONG_PER_SECOND = 'TON_LONG_PER_SECOND'

TON_PER_DAY

TON_PER_DAY = 'TON_PER_DAY'

TON_PER_HOUR

TON_PER_HOUR = 'TON_PER_HOUR'

TON_PER_MINUTE

TON_PER_MINUTE = 'TON_PER_MINUTE'

TON_PER_SECOND

TON_PER_SECOND = 'TON_PER_SECOND'

TON_SHORT_PER_DAY

TON_SHORT_PER_DAY = 'TON_SHORT_PER_DAY'

TON_SHORT_PER_HOUR

TON_SHORT_PER_HOUR = 'TON_SHORT_PER_HOUR'

TON_SHORT_PER_MINUTE

TON_SHORT_PER_MINUTE = 'TON_SHORT_PER_MINUTE'

TON_SHORT_PER_SECOND

TON_SHORT_PER_SECOND = 'TON_SHORT_PER_SECOND'