Measure/Abstract.php
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.
- category
- Zend
- copyright
- Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
- license
-
New BSD License
- package
- Zend_Measure
- version
- $Id: Abstract.php 23775 2011-03-01 17:25:24Z ralph $
Abstract class for all measurements
- category
- Zend
- copyright
- Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
- license
-
New BSD License
- package
- Zend_Measure
- subpackage
- Zend_Measure_Abstract
Properties



$_units= 'array'
Unit types for this measurement
Default valuearray
Details
- Type
Methods



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



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



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



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



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



toString(
integer $round, string|\Zend_Locale $locale
=
null
)
:
string
Returns a string representation
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