Zend Framework API Documentation » \Zend_Measure

Class for handling acceleration conversions

category	Zend
package	Zend_Measure
subpackage	Zend_Measure_Acceleration
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 acceleration units

$_units : array

Default

array('CENTIGAL' => array('0.0001', 'cgal'), 'CENTIMETER_PER_SQUARE_SECOND' => array('0.01', 'cm/s²'), 'DECIGAL' => array('0.001', 'dgal'), 'DECIMETER_PER_SQUARE_SECOND' => array('0.1', 'dm/s²'), 'DEKAMETER_PER_SQUARE_SECOND' => array('10', 'dam/s²'), 'FOOT_PER_SQUARE_SECOND' => array('0.3048', 'ft/s²'), 'G' => array('9.80665', 'g'), 'GAL' => array('0.01', 'gal'), 'GALILEO' => array('0.01', 'gal'), 'GRAV' => array('9.80665', 'g'), 'HECTOMETER_PER_SQUARE_SECOND' => array('100', 'h/s²'), 'INCH_PER_SQUARE_SECOND' => array('0.0254', 'in/s²'), 'KILOMETER_PER_HOUR_SECOND' => array(array('' => '5', '/' => '18'), 'km/h²'), 'KILOMETER_PER_SQUARE_SECOND' => array('1000', 'km/s²'), 'METER_PER_SQUARE_SECOND' => array('1', 'm/s²'), 'MILE_PER_HOUR_MINUTE' => array(array('' => '22', '/' => '15', '*' => '0.3048', '/' => '60'), 'mph/m'), 'MILE_PER_HOUR_SECOND' => array(array('' => '22', '/' => '15', '*' => '0.3048'), 'mph/s'), 'MILE_PER_SQUARE_SECOND' => array('1609.344', 'mi/s²'), 'MILLIGAL' => array('0.00001', 'mgal'), 'MILLIMETER_PER_SQUARE_SECOND' => array('0.001', 'mm/s²'), 'STANDARD' => 'METER_PER_SQUARE_SECOND')

inherited_from	\Zend_Measure_Abstract::_units

Unit types for this measurement

$_units

Default

array()

Plain value in standard unit

$_value : string

Default

Constants

CENTIGAL

CENTIGAL = 'CENTIGAL'

CENTIMETER_PER_SQUARE_SECOND

CENTIMETER_PER_SQUARE_SECOND = 'CENTIMETER_PER_SQUARE_SECOND'

DECIGAL

DECIGAL = 'DECIGAL'

DECIMETER_PER_SQUARE_SECOND

DECIMETER_PER_SQUARE_SECOND = 'DECIMETER_PER_SQUARE_SECOND'

DEKAMETER_PER_SQUARE_SECOND

DEKAMETER_PER_SQUARE_SECOND = 'DEKAMETER_PER_SQUARE_SECOND'

FOOT_PER_SQUARE_SECOND

FOOT_PER_SQUARE_SECOND = 'FOOT_PER_SQUARE_SECOND'

G

G = 'G'

GAL

GAL = 'GAL'

GALILEO

GALILEO = 'GALILEO'

GRAV

GRAV = 'GRAV'

HECTOMETER_PER_SQUARE_SECOND

HECTOMETER_PER_SQUARE_SECOND = 'HECTOMETER_PER_SQUARE_SECOND'

INCH_PER_SQUARE_SECOND

INCH_PER_SQUARE_SECOND = 'INCH_PER_SQUARE_SECOND'

KILOMETER_PER_HOUR_SECOND

KILOMETER_PER_HOUR_SECOND = 'KILOMETER_PER_HOUR_SECOND'

KILOMETER_PER_SQUARE_SECOND

KILOMETER_PER_SQUARE_SECOND = 'KILOMETER_PER_SQUARE_SECOND'

METER_PER_SQUARE_SECOND

METER_PER_SQUARE_SECOND = 'METER_PER_SQUARE_SECOND'

MILE_PER_HOUR_MINUTE

MILE_PER_HOUR_MINUTE = 'MILE_PER_HOUR_MINUTE'

MILE_PER_HOUR_SECOND

MILE_PER_HOUR_SECOND = 'MILE_PER_HOUR_SECOND'

MILE_PER_SQUARE_SECOND

MILE_PER_SQUARE_SECOND = 'MILE_PER_SQUARE_SECOND'

MILLIGAL

MILLIGAL = 'MILLIGAL'

MILLIMETER_PER_SQUARE_SECOND

MILLIMETER_PER_SQUARE_SECOND = 'MILLIMETER_PER_SQUARE_SECOND'

STANDARD

STANDARD = 'METER_PER_SQUARE_SECOND'