Measure/Flow/Mass.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: Mass.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Measure_Flow_Mass

Package: Zend\Measure\Zend\Measure\Flow\Mass

Class for handling flow mass 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 = 'KILOGRAM_PER_SECOND'
Constant  CENTIGRAM_PER_DAY = 'CENTIGRAM_PER_DAY'
Constant  CENTIGRAM_PER_HOUR = 'CENTIGRAM_PER_HOUR'
Constant  CENTIGRAM_PER_MINUTE = 'CENTIGRAM_PER_MINUTE'
Constant  CENTIGRAM_PER_SECOND = 'CENTIGRAM_PER_SECOND'
Constant  GRAM_PER_DAY = 'GRAM_PER_DAY'
Constant  GRAM_PER_HOUR = 'GRAM_PER_HOUR'
Constant  GRAM_PER_MINUTE = 'GRAM_PER_MINUTE'
Constant  GRAM_PER_SECOND = 'GRAM_PER_SECOND'
Constant  KILOGRAM_PER_DAY = 'KILOGRAM_PER_DAY'
Constant  KILOGRAM_PER_HOUR = 'KILOGRAM_PER_HOUR'
Constant  KILOGRAM_PER_MINUTE = 'KILOGRAM_PER_MINUTE'
Constant  KILOGRAM_PER_SECOND = 'KILOGRAM_PER_SECOND'
Constant  MILLIGRAM_PER_DAY = 'MILLIGRAM_PER_DAY'
Constant  MILLIGRAM_PER_HOUR = 'MILLIGRAM_PER_HOUR'
Constant  MILLIGRAM_PER_MINUTE = 'MILLIGRAM_PER_MINUTE'
Constant  MILLIGRAM_PER_SECOND = 'MILLIGRAM_PER_SECOND'
Constant  OUNCE_PER_DAY = 'OUNCE_PER_DAY'
Constant  OUNCE_PER_HOUR = 'OUNCE_PER_HOUR'
Constant  OUNCE_PER_MINUTE = 'OUNCE_PER_MINUTE'
Constant  OUNCE_PER_SECOND = 'OUNCE_PER_SECOND'
Constant  POUND_PER_DAY = 'POUND_PER_DAY'
Constant  POUND_PER_HOUR = 'POUND_PER_HOUR'
Constant  POUND_PER_MINUTE = 'POUND_PER_MINUTE'
Constant  POUND_PER_SECOND = 'POUND_PER_SECOND'
Constant  TON_LONG_PER_DAY = 'TON_LONG_PER_DAY'
Constant  TON_LONG_PER_HOUR = 'TON_LONG_PER_HOUR'
Constant  TON_LONG_PER_MINUTE = 'TON_LONG_PER_MINUTE'
Constant  TON_LONG_PER_SECOND = 'TON_LONG_PER_SECOND'
Constant  TON_PER_DAY = 'TON_PER_DAY'
Constant  TON_PER_HOUR = 'TON_PER_HOUR'
Constant  TON_PER_MINUTE = 'TON_PER_MINUTE'
Constant  TON_PER_SECOND = 'TON_PER_SECOND'
Constant  TON_SHORT_PER_DAY = 'TON_SHORT_PER_DAY'
Constant  TON_SHORT_PER_HOUR = 'TON_SHORT_PER_HOUR'
Constant  TON_SHORT_PER_MINUTE = 'TON_SHORT_PER_MINUTE'
Constant  TON_SHORT_PER_SECOND = 'TON_SHORT_PER_SECOND'

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('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')

Calculations for all flow mass units

Default valuearray('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')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.