Measure/Time.php
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-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Measure
- Version
- $Id: Time.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Measure_Time
- 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
Properties


string $_locale = null
null
Details- Type
- string
- Inherited_from
- \Zend_Measure_Abstract::$$_locale


array $_units = array('ANOMALISTIC_YEAR' => array('31558432', 'anomalistic year'), 'ATTOSECOND' => array('1.0e-18', 'as'), 'CENTURY' => array('3153600000', 'century'), 'DAY' => array('86400', 'day'), 'DECADE' => array('315360000', 'decade'), 'DRACONIC_YEAR' => array('29947974', 'draconic year'), 'EXASECOND' => array('1.0e+18', 'Es'), 'FEMTOSECOND' => array('1.0e-15', 'fs'), 'FORTNIGHT' => array('1209600', 'fortnight'), 'GAUSSIAN_YEAR' => array('31558196', 'gaussian year'), 'GIGASECOND' => array('1.0e+9', 'Gs'), 'GREAT_YEAR' => array(array('*' => '31536000', '*' => '25700'), 'great year'), 'GREGORIAN_YEAR' => array('31536000', 'year'), 'HOUR' => array('3600', 'h'), 'JULIAN_YEAR' => array('31557600', 'a'), 'KILOSECOND' => array('1000', 'ks'), 'LEAPYEAR' => array('31622400', 'year'), 'MEGASECOND' => array('1000000', 'Ms'), 'MICROSECOND' => array('0.000001', 'µs'), 'MILLENIUM' => array('31536000000', 'millenium'), 'MILLISECOND' => array('0.001', 'ms'), 'MINUTE' => array('60', 'min'), 'MONTH' => array('2628600', 'month'), 'NANOSECOND' => array('1.0e-9', 'ns'), 'PETASECOND' => array('1.0e+15', 'Ps'), 'PICOSECOND' => array('1.0e-12', 'ps'), 'QUARTER' => array('7884000', 'quarter'), 'SECOND' => array('1', 's'), 'SHAKE' => array('1.0e-9', 'shake'), 'SIDEREAL_YEAR' => array('31558149.7676', 'sidereal year'), 'TERASECOND' => array('1.0e+12', 'Ts'), 'TROPICAL_YEAR' => array('31556925', 'tropical year'), 'WEEK' => array('604800', 'week'), 'YEAR' => array('31536000', 'year'), 'STANDARD' => 'SECOND')
array('ANOMALISTIC_YEAR' => array('31558432', 'anomalistic year'), 'ATTOSECOND' => array('1.0e-18', 'as'), 'CENTURY' => array('3153600000', 'century'), 'DAY' => array('86400', 'day'), 'DECADE' => array('315360000', 'decade'), 'DRACONIC_YEAR' => array('29947974', 'draconic year'), 'EXASECOND' => array('1.0e+18', 'Es'), 'FEMTOSECOND' => array('1.0e-15', 'fs'), 'FORTNIGHT' => array('1209600', 'fortnight'), 'GAUSSIAN_YEAR' => array('31558196', 'gaussian year'), 'GIGASECOND' => array('1.0e+9', 'Gs'), 'GREAT_YEAR' => array(array('*' => '31536000', '*' => '25700'), 'great year'), 'GREGORIAN_YEAR' => array('31536000', 'year'), 'HOUR' => array('3600', 'h'), 'JULIAN_YEAR' => array('31557600', 'a'), 'KILOSECOND' => array('1000', 'ks'), 'LEAPYEAR' => array('31622400', 'year'), 'MEGASECOND' => array('1000000', 'Ms'), 'MICROSECOND' => array('0.000001', 'µs'), 'MILLENIUM' => array('31536000000', 'millenium'), 'MILLISECOND' => array('0.001', 'ms'), 'MINUTE' => array('60', 'min'), 'MONTH' => array('2628600', 'month'), 'NANOSECOND' => array('1.0e-9', 'ns'), 'PETASECOND' => array('1.0e+15', 'Ps'), 'PICOSECOND' => array('1.0e-12', 'ps'), 'QUARTER' => array('7884000', 'quarter'), 'SECOND' => array('1', 's'), 'SHAKE' => array('1.0e-9', 'shake'), 'SIDEREAL_YEAR' => array('31558149.7676', 'sidereal year'), 'TERASECOND' => array('1.0e+12', 'Ts'), 'TROPICAL_YEAR' => array('31556925', 'tropical year'), 'WEEK' => array('604800', 'week'), 'YEAR' => array('31536000', 'year'), 'STANDARD' => 'SECOND')
Details- Type
- array
Methods


__construct(mixed $value, int $type = null, \Zend_Locale $locale = null) : void
Zend_Measure_Abstract is an abstract class for the different measurement types
Inherited from: \Zend_Measure_Abstract::__construct()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
Name | Type | Description |
---|---|---|
$object | \Zend_Measure_Abstract | object of same unit type |
Type | Description |
---|---|
\Zend_Measure_Abstract |


compare(\Zend_Measure_Abstract $object) : boolean
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
Inherited from: \Zend_Measure_Abstract::convertTo()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
Name | Type | Description |
---|---|---|
$object | \Zend_Measure_Abstract | object to compare |
Type | Description |
---|---|
boolean |


getValue(integer $round = -1, string | \Zend_Locale $locale = null) : integer | string
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
Inherited from: \Zend_Measure_Abstract::setLocale()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
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
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
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
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 |