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 license@zend.com so we can send you a copy immediately.
Abstract class for all measurements

__construct(
mixed $value, int $type
=
null, \Zend_Locale $locale
=
null
)
:
void
Zend_Measure_Abstract is an abstract class for the different measurement types
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 |
Exception | Description |
---|---|
\Zend_Measure_Exception |

add(
\Zend_Measure_Abstract $object
)
:
\Zend_Measure_Abstract
Adds an unit to another one
Name | Type | Description |
---|---|---|
$object | \Zend_Measure_Abstract | object of same unit type |
Type | Description |
---|---|
\Zend_Measure_Abstract |

compare(
\Zend_Measure_Abstract $object
)
:
boolean
Compares two units
Name | Type | Description |
---|---|---|
$object | \Zend_Measure_Abstract | object of same unit type |
Type | Description |
---|---|
boolean |

convertTo(
string $type, integer $round
=
2, string|\Zend_Locale $locale
=
null
)
:
string
Alias function for setType returning the converted unit
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 |
Type | Description |
---|---|
string |

equals(
\Zend_Measure_Abstract $object
)
:
boolean
Compare if the value and type is equal
Name | Type | Description |
---|---|---|
$object | \Zend_Measure_Abstract | object to compare |
Type | Description |
---|---|
boolean |

getValue(
integer $round
=
-1, string|\Zend_Locale $locale
=
null
)
:
integer|string
Returns the internal value
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 |
Type | Description |
---|---|
integer|string |

setLocale(
string|\Zend_Locale $locale
=
null, boolean $check
=
false
)
:
\Zend_Measure_Abstract
Sets a new locale for the value representation
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 |
Type | Description |
---|---|
\Zend_Measure_Abstract |

setType(
string $type
)
:
\Zend_Measure_Abstract
Set a new type, and convert the value
Name | Type | Description |
---|---|---|
$type | string | New type to set |
Type | Description |
---|---|
\Zend_Measure_Abstract |
Exception | Description |
---|---|
\Zend_Measure_Exception |

setValue(
integer|string $value, string $type
=
null, string|\Zend_Locale $locale
=
null
)
:
\Zend_Measure_Abstract
Set a new value
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 |
Type | Description |
---|---|
\Zend_Measure_Abstract |
Exception | Description |
---|---|
\Zend_Measure_Exception |

sub(
\Zend_Measure_Abstract $object
)
:
\Zend_Measure_Abstract
Substracts an unit from another one
Name | Type | Description |
---|---|---|
$object | \Zend_Measure_Abstract | object of same unit type |
Type | Description |
---|---|
\Zend_Measure_Abstract |

toString(
integer $round
=
-1, string|\Zend_Locale $locale
=
null
)
:
string
Returns a string representation
Name | Type | Description |
---|---|---|
$round | integer | (Optional) Runds the value to an given exception |
$locale | string|\Zend_Locale | (Optional) Locale to set for the number |
Type | Description |
---|---|
string |