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

\Zend_Measure_Density
jump to top

Package: Zend\Measure\Zend\Measure\Density

Class for handling density 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_CUBIC_METER'
Constant  ALUMINIUM = 'ALUMINIUM'
Constant  COPPER = 'COPPER'
Constant  GOLD = 'GOLD'
Constant  GRAIN_PER_CUBIC_FOOT = 'GRAIN_PER_CUBIC_FOOT'
Constant  GRAIN_PER_CUBIC_INCH = 'GRAIN_PER_CUBIC_INCH'
Constant  GRAIN_PER_CUBIC_YARD = 'GRAIN_PER_CUBIC_YARD'
Constant  GRAIN_PER_GALLON = 'GRAIN_PER_GALLON'
Constant  GRAIN_PER_GALLON_US = 'GRAIN_PER_GALLON_US'
Constant  GRAM_PER_CUBIC_CENTIMETER = 'GRAM_PER_CUBIC_CENTIMETER'
Constant  GRAM_PER_CUBIC_DECIMETER = 'GRAM_PER_CUBIC_DECIMETER'
Constant  GRAM_PER_CUBIC_METER = 'GRAM_PER_CUBIC_METER'
Constant  GRAM_PER_LITER = 'GRAM_PER_LITER'
Constant  GRAM_PER_MILLILITER = 'GRAM_PER_MILLILITER'
Constant  IRON = 'IRON'
Constant  KILOGRAM_PER_CUBIC_CENTIMETER = 'KILOGRAM_PER_CUBIC_CENTIMETER'
Constant  KILOGRAM_PER_CUBIC_DECIMETER = 'KILOGRAM_PER_CUBIC_DECIMETER'
Constant  KILOGRAM_PER_CUBIC_METER = 'KILOGRAM_PER_CUBIC_METER'
Constant  KILOGRAM_PER_CUBIC_MILLIMETER = 'KILOGRAM_PER_CUBIC_MILLIMETER'
Constant  KILOGRAM_PER_LITER = 'KILOGRAM_PER_LITER'
Constant  KILOGRAM_PER_MILLILITER = 'KILOGRAM_PER_MILLILITER'
Constant  LEAD = 'LEAD'
Constant  MEGAGRAM_PER_CUBIC_CENTIMETER = 'MEGAGRAM_PER_CUBIC_CENTIMETER'
Constant  MEGAGRAM_PER_CUBIC_DECIMETER = 'MEGAGRAM_PER_CUBIC_DECIMETER'
Constant  MEGAGRAM_PER_CUBIC_METER = 'MEGAGRAM_PER_CUBIC_METER'
Constant  MEGAGRAM_PER_LITER = 'MEGAGRAM_PER_LITER'
Constant  MEGAGRAM_PER_MILLILITER = 'MEGAGRAM_PER_MILLILITER'
Constant  MICROGRAM_PER_CUBIC_CENTIMETER = 'MICROGRAM_PER_CUBIC_CENTIMETER'
Constant  MICROGRAM_PER_CUBIC_DECIMETER = 'MICROGRAM_PER_CUBIC_DECIMETER'
Constant  MICROGRAM_PER_CUBIC_METER = 'MICROGRAM_PER_CUBIC_METER'
Constant  MICROGRAM_PER_LITER = 'MICROGRAM_PER_LITER'
Constant  MICROGRAM_PER_MILLILITER = 'MICROGRAM_PER_MILLILITER'
Constant  MILLIGRAM_PER_CUBIC_CENTIMETER = 'MILLIGRAM_PER_CUBIC_CENTIMETER'
Constant  MILLIGRAM_PER_CUBIC_DECIMETER = 'MILLIGRAM_PER_CUBIC_DECIMETER'
Constant  MILLIGRAM_PER_CUBIC_METER = 'MILLIGRAM_PER_CUBIC_METER'
Constant  MILLIGRAM_PER_LITER = 'MILLIGRAM_PER_LITER'
Constant  MILLIGRAM_PER_MILLILITER = 'MILLIGRAM_PER_MILLILITER'
Constant  OUNCE_PER_CUBIC_FOOT = 'OUNCE_PER_CUBIC_FOOT'
Constant  OUNCR_PER_CUBIC_FOOT_TROY = 'OUNCE_PER_CUBIC_FOOT_TROY'
Constant  OUNCE_PER_CUBIC_INCH = 'OUNCE_PER_CUBIC_INCH'
Constant  OUNCE_PER_CUBIC_INCH_TROY = 'OUNCE_PER_CUBIC_INCH_TROY'
Constant  OUNCE_PER_CUBIC_YARD = 'OUNCE_PER_CUBIC_YARD'
Constant  OUNCE_PER_CUBIC_YARD_TROY = 'OUNCE_PER_CUBIC_YARD_TROY'
Constant  OUNCE_PER_GALLON = 'OUNCE_PER_GALLON'
Constant  OUNCE_PER_GALLON_US = 'OUNCE_PER_GALLON_US'
Constant  OUNCE_PER_GALLON_TROY = 'OUNCE_PER_GALLON_TROY'
Constant  OUNCE_PER_GALLON_US_TROY = 'OUNCE_PER_GALLON_US_TROY'
Constant  POUND_PER_CIRCULAR_MIL_FOOT = 'POUND_PER_CIRCULAR_MIL_FOOT'
Constant  POUND_PER_CUBIC_FOOT = 'POUND_PER_CUBIC_FOOT'
Constant  POUND_PER_CUBIC_INCH = 'POUND_PER_CUBIC_INCH'
Constant  POUND_PER_CUBIC_YARD = 'POUND_PER_CUBIC_YARD'
Constant  POUND_PER_GALLON = 'POUND_PER_GALLON'
Constant  POUND_PER_KILOGALLON = 'POUND_PER_KILOGALLON'
Constant  POUND_PER_MEGAGALLON = 'POUND_PER_MEGAGALLON'
Constant  POUND_PER_GALLON_US = 'POUND_PER_GALLON_US'
Constant  POUND_PER_KILOGALLON_US = 'POUND_PER_KILOGALLON_US'
Constant  POUND_PER_MEGAGALLON_US = 'POUND_PER_MEGAGALLON_US'
Constant  SILVER = 'SILVER'
Constant  SLUG_PER_CUBIC_FOOT = 'SLUG_PER_CUBIC_FOOT'
Constant  SLUG_PER_CUBIC_INCH = 'SLUG_PER_CUBIC_INCH'
Constant  SLUG_PER_CUBIC_YARD = 'SLUG_PER_CUBIC_YARD'
Constant  SLUG_PER_GALLON = 'SLUG_PER_GALLON'
Constant  SLUG_PER_GALLON_US = 'SLUG_PER_GALLON_US'
Constant  TON_PER_CUBIC_FOOT_LONG = 'TON_PER_CUBIC_FOOT_LONG'
Constant  TON_PER_CUBIC_FOOT = 'TON_PER_CUBIC_FOOT'
Constant  TON_PER_CUBIC_INCH_LONG = 'TON_PER_CUBIC_INCH_LONG'
Constant  TON_PER_CUBIC_INCH = 'TON_PER_CUBIC_INCH'
Constant  TON_PER_CUBIC_YARD_LONG = 'TON_PER_CUBIC_YARD_LONG'
Constant  TON_PER_CUBIC_YARD = 'TON_PER_CUBIC_YARD'
Constant  TON_PER_GALLON_LONG = 'TON_PER_GALLON_LONG'
Constant  TON_PER_GALLON_US_LONG = 'TON_PER_GALLON_US_LONG'
Constant  TON_PER_GALLON = 'TON_PER_GALLON'
Constant  TON_PER_GALLON_US = 'TON_PER_GALLON_US'
Constant  TONNE_PER_CUBIC_CENTIMETER = 'TONNE_PER_CUBIC_CENTIMETER'
Constant  TONNE_PER_CUBIC_DECIMETER = 'TONNE_PER_CUBIC_DECIMETER'
Constant  TONNE_PER_CUBIC_METER = 'TONNE_PER_CUBIC_METER'
Constant  TONNE_PER_LITER = 'TONNE_PER_LITER'
Constant  TONNE_PER_MILLILITER = 'TONNE_PER_MILLILITER'
Constant  WATER = 'WATER'

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('ALUMINIUM' => array('2643', 'aluminium'), 'COPPER' => array('8906', 'copper'), 'GOLD' => array('19300', 'gold'), 'GRAIN_PER_CUBIC_FOOT' => array('0.0022883519', 'gr/ft³'), 'GRAIN_PER_CUBIC_INCH' => array('3.9542721', 'gr/in³'), 'GRAIN_PER_CUBIC_YARD' => array('0.000084753774', 'gr/yd³'), 'GRAIN_PER_GALLON' => array('0.014253768', 'gr/gal'), 'GRAIN_PER_GALLON_US' => array('0.017118061', 'gr/gal'), 'GRAM_PER_CUBIC_CENTIMETER' => array('1000', 'g/cm³'), 'GRAM_PER_CUBIC_DECIMETER' => array('1', 'g/dm³'), 'GRAM_PER_CUBIC_METER' => array('0.001', 'g/m³'), 'GRAM_PER_LITER' => array('1', 'g/l'), 'GRAM_PER_MILLILITER' => array('1000', 'g/ml'), 'IRON' => array('7658', 'iron'), 'KILOGRAM_PER_CUBIC_CENTIMETER' => array('1000000', 'kg/cm³'), 'KILOGRAM_PER_CUBIC_DECIMETER' => array('1000', 'kg/dm³'), 'KILOGRAM_PER_CUBIC_METER' => array('1', 'kg/m³'), 'KILOGRAM_PER_CUBIC_MILLIMETER' => array('1000000000', 'kg/l'), 'KILOGRAM_PER_LITER' => array('1000', 'kg/ml'), 'KILOGRAM_PER_MILLILITER' => array('1000000', 'kg/ml'), 'LEAD' => array('11370', 'lead'), 'MEGAGRAM_PER_CUBIC_CENTIMETER' => array('1.0e+9', 'Mg/cm³'), 'MEGAGRAM_PER_CUBIC_DECIMETER' => array('1000000', 'Mg/dm³'), 'MEGAGRAM_PER_CUBIC_METER' => array('1000', 'Mg/m³'), 'MEGAGRAM_PER_LITER' => array('1000000', 'Mg/l'), 'MEGAGRAM_PER_MILLILITER' => array('1.0e+9', 'Mg/ml'), 'MICROGRAM_PER_CUBIC_CENTIMETER' => array('0.001', 'µg/cm³'), 'MICROGRAM_PER_CUBIC_DECIMETER' => array('1.0e-6', 'µg/dm³'), 'MICROGRAM_PER_CUBIC_METER' => array('1.0e-9', 'µg/m³'), 'MICROGRAM_PER_LITER' => array('1.0e-6', 'µg/l'), 'MICROGRAM_PER_MILLILITER' => array('0.001', 'µg/ml'), 'MILLIGRAM_PER_CUBIC_CENTIMETER' => array('1', 'mg/cm³'), 'MILLIGRAM_PER_CUBIC_DECIMETER' => array('0.001', 'mg/dm³'), 'MILLIGRAM_PER_CUBIC_METER' => array('0.000001', 'mg/m³'), 'MILLIGRAM_PER_LITER' => array('0.001', 'mg/l'), 'MILLIGRAM_PER_MILLILITER' => array('1', 'mg/ml'), 'OUNCE_PER_CUBIC_FOOT' => array('1.001154', 'oz/ft³'), 'OUNCE_PER_CUBIC_FOOT_TROY' => array('1.0984089', 'oz/ft³'), 'OUNCE_PER_CUBIC_INCH' => array('1729.994', 'oz/in³'), 'OUNCE_PER_CUBIC_INCH_TROY' => array('1898.0506', 'oz/in³'), 'OUNCE_PER_CUBIC_YARD' => array('0.037079776', 'oz/yd³'), 'OUNCE_PER_CUBIC_YARD_TROY' => array('0.040681812', 'oz/yd³'), 'OUNCE_PER_GALLON' => array('6.2360233', 'oz/gal'), 'OUNCE_PER_GALLON_US' => array('7.4891517', 'oz/gal'), 'OUNCE_PER_GALLON_TROY' => array('6.8418084', 'oz/gal'), 'OUNCE_PER_GALLON_US_TROY' => array('8.2166693', 'oz/gal'), 'POUND_PER_CIRCULAR_MIL_FOOT' => array('2.9369291', 'lb/cmil ft'), 'POUND_PER_CUBIC_FOOT' => array('16.018463', 'lb/in³'), 'POUND_PER_CUBIC_INCH' => array('27679.905', 'lb/in³'), 'POUND_PER_CUBIC_YARD' => array('0.59327642', 'lb/yd³'), 'POUND_PER_GALLON' => array('99.776373', 'lb/gal'), 'POUND_PER_KILOGALLON' => array('0.099776373', 'lb/kgal'), 'POUND_PER_MEGAGALLON' => array('0.000099776373', 'lb/Mgal'), 'POUND_PER_GALLON_US' => array('119.82643', 'lb/gal'), 'POUND_PER_KILOGALLON_US' => array('0.11982643', 'lb/kgal'), 'POUND_PER_MEGAGALLON_US' => array('0.00011982643', 'lb/Mgal'), 'SILVER' => array('10510', 'silver'), 'SLUG_PER_CUBIC_FOOT' => array('515.37882', 'slug/ft³'), 'SLUG_PER_CUBIC_INCH' => array('890574.6', 'slug/in³'), 'SLUG_PER_CUBIC_YARD' => array('19.088104', 'slug/yd³'), 'SLUG_PER_GALLON' => array('3210.2099', 'slug/gal'), 'SLUG_PER_GALLON_US' => array('3855.3013', 'slug/gal'), 'TON_PER_CUBIC_FOOT_LONG' => array('35881.358', 't/ft³'), 'TON_PER_CUBIC_FOOT' => array('32036.927', 't/ft³'), 'TON_PER_CUBIC_INCH_LONG' => array('6.2202987e+7', 't/in³'), 'TON_PER_CUBIC_INCH' => array('5.5359809e+7', 't/in³'), 'TON_PER_CUBIC_YARD_LONG' => array('1328.9392', 't/yd³'), 'TON_PER_CUBIC_YARD' => array('1186.5528', 't/yd³'), 'TON_PER_GALLON_LONG' => array('223499.07', 't/gal'), 'TON_PER_GALLON_US_LONG' => array('268411.2', 't/gal'), 'TON_PER_GALLON' => array('199522.75', 't/gal'), 'TON_PER_GALLON_US' => array('239652.85', 't/gal'), 'TONNE_PER_CUBIC_CENTIMETER' => array('1.0e+9', 't/cm³'), 'TONNE_PER_CUBIC_DECIMETER' => array('1000000', 't/dm³'), 'TONNE_PER_CUBIC_METER' => array('1000', 't/m³'), 'TONNE_PER_LITER' => array('1000000', 't/l'), 'TONNE_PER_MILLILITER' => array('1.0e+9', 't/ml'), 'WATER' => array('1000', 'water'), 'STANDARD' => 'KILOGRAM_PER_CUBIC_METER')

Calculations for all density units

Default valuearray('ALUMINIUM' => array('2643', 'aluminium'), 'COPPER' => array('8906', 'copper'), 'GOLD' => array('19300', 'gold'), 'GRAIN_PER_CUBIC_FOOT' => array('0.0022883519', 'gr/ft³'), 'GRAIN_PER_CUBIC_INCH' => array('3.9542721', 'gr/in³'), 'GRAIN_PER_CUBIC_YARD' => array('0.000084753774', 'gr/yd³'), 'GRAIN_PER_GALLON' => array('0.014253768', 'gr/gal'), 'GRAIN_PER_GALLON_US' => array('0.017118061', 'gr/gal'), 'GRAM_PER_CUBIC_CENTIMETER' => array('1000', 'g/cm³'), 'GRAM_PER_CUBIC_DECIMETER' => array('1', 'g/dm³'), 'GRAM_PER_CUBIC_METER' => array('0.001', 'g/m³'), 'GRAM_PER_LITER' => array('1', 'g/l'), 'GRAM_PER_MILLILITER' => array('1000', 'g/ml'), 'IRON' => array('7658', 'iron'), 'KILOGRAM_PER_CUBIC_CENTIMETER' => array('1000000', 'kg/cm³'), 'KILOGRAM_PER_CUBIC_DECIMETER' => array('1000', 'kg/dm³'), 'KILOGRAM_PER_CUBIC_METER' => array('1', 'kg/m³'), 'KILOGRAM_PER_CUBIC_MILLIMETER' => array('1000000000', 'kg/l'), 'KILOGRAM_PER_LITER' => array('1000', 'kg/ml'), 'KILOGRAM_PER_MILLILITER' => array('1000000', 'kg/ml'), 'LEAD' => array('11370', 'lead'), 'MEGAGRAM_PER_CUBIC_CENTIMETER' => array('1.0e+9', 'Mg/cm³'), 'MEGAGRAM_PER_CUBIC_DECIMETER' => array('1000000', 'Mg/dm³'), 'MEGAGRAM_PER_CUBIC_METER' => array('1000', 'Mg/m³'), 'MEGAGRAM_PER_LITER' => array('1000000', 'Mg/l'), 'MEGAGRAM_PER_MILLILITER' => array('1.0e+9', 'Mg/ml'), 'MICROGRAM_PER_CUBIC_CENTIMETER' => array('0.001', 'µg/cm³'), 'MICROGRAM_PER_CUBIC_DECIMETER' => array('1.0e-6', 'µg/dm³'), 'MICROGRAM_PER_CUBIC_METER' => array('1.0e-9', 'µg/m³'), 'MICROGRAM_PER_LITER' => array('1.0e-6', 'µg/l'), 'MICROGRAM_PER_MILLILITER' => array('0.001', 'µg/ml'), 'MILLIGRAM_PER_CUBIC_CENTIMETER' => array('1', 'mg/cm³'), 'MILLIGRAM_PER_CUBIC_DECIMETER' => array('0.001', 'mg/dm³'), 'MILLIGRAM_PER_CUBIC_METER' => array('0.000001', 'mg/m³'), 'MILLIGRAM_PER_LITER' => array('0.001', 'mg/l'), 'MILLIGRAM_PER_MILLILITER' => array('1', 'mg/ml'), 'OUNCE_PER_CUBIC_FOOT' => array('1.001154', 'oz/ft³'), 'OUNCE_PER_CUBIC_FOOT_TROY' => array('1.0984089', 'oz/ft³'), 'OUNCE_PER_CUBIC_INCH' => array('1729.994', 'oz/in³'), 'OUNCE_PER_CUBIC_INCH_TROY' => array('1898.0506', 'oz/in³'), 'OUNCE_PER_CUBIC_YARD' => array('0.037079776', 'oz/yd³'), 'OUNCE_PER_CUBIC_YARD_TROY' => array('0.040681812', 'oz/yd³'), 'OUNCE_PER_GALLON' => array('6.2360233', 'oz/gal'), 'OUNCE_PER_GALLON_US' => array('7.4891517', 'oz/gal'), 'OUNCE_PER_GALLON_TROY' => array('6.8418084', 'oz/gal'), 'OUNCE_PER_GALLON_US_TROY' => array('8.2166693', 'oz/gal'), 'POUND_PER_CIRCULAR_MIL_FOOT' => array('2.9369291', 'lb/cmil ft'), 'POUND_PER_CUBIC_FOOT' => array('16.018463', 'lb/in³'), 'POUND_PER_CUBIC_INCH' => array('27679.905', 'lb/in³'), 'POUND_PER_CUBIC_YARD' => array('0.59327642', 'lb/yd³'), 'POUND_PER_GALLON' => array('99.776373', 'lb/gal'), 'POUND_PER_KILOGALLON' => array('0.099776373', 'lb/kgal'), 'POUND_PER_MEGAGALLON' => array('0.000099776373', 'lb/Mgal'), 'POUND_PER_GALLON_US' => array('119.82643', 'lb/gal'), 'POUND_PER_KILOGALLON_US' => array('0.11982643', 'lb/kgal'), 'POUND_PER_MEGAGALLON_US' => array('0.00011982643', 'lb/Mgal'), 'SILVER' => array('10510', 'silver'), 'SLUG_PER_CUBIC_FOOT' => array('515.37882', 'slug/ft³'), 'SLUG_PER_CUBIC_INCH' => array('890574.6', 'slug/in³'), 'SLUG_PER_CUBIC_YARD' => array('19.088104', 'slug/yd³'), 'SLUG_PER_GALLON' => array('3210.2099', 'slug/gal'), 'SLUG_PER_GALLON_US' => array('3855.3013', 'slug/gal'), 'TON_PER_CUBIC_FOOT_LONG' => array('35881.358', 't/ft³'), 'TON_PER_CUBIC_FOOT' => array('32036.927', 't/ft³'), 'TON_PER_CUBIC_INCH_LONG' => array('6.2202987e+7', 't/in³'), 'TON_PER_CUBIC_INCH' => array('5.5359809e+7', 't/in³'), 'TON_PER_CUBIC_YARD_LONG' => array('1328.9392', 't/yd³'), 'TON_PER_CUBIC_YARD' => array('1186.5528', 't/yd³'), 'TON_PER_GALLON_LONG' => array('223499.07', 't/gal'), 'TON_PER_GALLON_US_LONG' => array('268411.2', 't/gal'), 'TON_PER_GALLON' => array('199522.75', 't/gal'), 'TON_PER_GALLON_US' => array('239652.85', 't/gal'), 'TONNE_PER_CUBIC_CENTIMETER' => array('1.0e+9', 't/cm³'), 'TONNE_PER_CUBIC_DECIMETER' => array('1000000', 't/dm³'), 'TONNE_PER_CUBIC_METER' => array('1000', 't/m³'), 'TONNE_PER_LITER' => array('1000000', 't/l'), 'TONNE_PER_MILLILITER' => array('1.0e+9', 't/ml'), 'WATER' => array('1000', 'water'), 'STANDARD' => 'KILOGRAM_PER_CUBIC_METER')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.