Abstract class for all measurements

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

 Methods

Zend_Measure_Abstract is an abstract class for the different measurement types

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

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

Returns

string

Adds an unit to another one

add(\Zend_Measure_Abstract $object) : \Zend_Measure_Abstract

Parameters

$object

\Zend_Measure_Abstract

object of same unit type

Returns

\Zend_Measure_Abstract

Compares two units

compare(\Zend_Measure_Abstract $object) : boolean

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

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

Parameters

$object

\Zend_Measure_Abstract

object to compare

Returns

boolean

Returns the conversion list

getConversionList() : array

Returns

array

Returns the actual set locale

getLocale() : string

Returns

string

Returns the original type

getType() : \type

Returns

\type

Returns the internal value

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

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

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

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

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

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

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

 

Unit types for this measurement

$_units 

Default

array()
 

Plain value in standard unit

$_value : string

Default