Class for handling time conversions

category Zend
package Zend_Measure
subpackage Zend_Measure_Time
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 time units

$_units : array

Default

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')
inherited_from \Zend_Measure_Abstract::_units
 

Unit types for this measurement

$_units 

Default

array()
 

Plain value in standard unit

$_value : string

Default

 Constants

 

ANOMALISTIC_YEAR

ANOMALISTIC_YEAR = 'ANOMALISTIC_YEAR' 
 

ATTOSECOND

ATTOSECOND = 'ATTOSECOND' 
 

CENTURY

CENTURY = 'CENTURY' 
 

DAY

DAY = 'DAY' 
 

DECADE

DECADE = 'DECADE' 
 

DRACONIC_YEAR

DRACONIC_YEAR = 'DRACONTIC_YEAR' 
 

EXASECOND

EXASECOND = 'EXASECOND' 
 

FEMTOSECOND

FEMTOSECOND = 'FEMTOSECOND' 
 

FORTNIGHT

FORTNIGHT = 'FORTNIGHT' 
 

GAUSSIAN_YEAR

GAUSSIAN_YEAR = 'GAUSSIAN_YEAR' 
 

GIGASECOND

GIGASECOND = 'GIGASECOND' 
 

GREGORIAN_YEAR

GREGORIAN_YEAR = 'GREGORIAN_YEAR' 
 

HOUR

HOUR = 'HOUR' 
 

JULIAN_YEAR

JULIAN_YEAR = 'JULIAN_YEAR' 
 

KILOSECOND

KILOSECOND = 'KILOSECOND' 
 

LEAPYEAR

LEAPYEAR = 'LEAPYEAR' 
 

MEGASECOND

MEGASECOND = 'MEGASECOND' 
 

MICROSECOND

MICROSECOND = 'MICROSECOND' 
 

MILLENIUM

MILLENIUM = 'MILLENIUM' 
 

MILLISECOND

MILLISECOND = 'MILLISECOND' 
 

MINUTE

MINUTE = 'MINUTE' 
 

MONTH

MONTH = 'MONTH' 
 

NANOSECOND

NANOSECOND = 'NANOSECOND' 
 

PETASECOND

PETASECOND = 'PETASECOND' 
 

PICOSECOND

PICOSECOND = 'PICOSECOND' 
 

QUARTER

QUARTER = 'QUARTER' 
 

SECOND

SECOND = 'SECOND' 
 

SHAKE

SHAKE = 'SHAKE' 
 

SIDEREAL_YEAR

SIDEREAL_YEAR = 'SYNODIC_MONTH' 
 

STANDARD

STANDARD = 'SECOND' 
 

TERASECOND

TERASECOND = 'TERASECOND' 
 

TROPICAL_YEAR

TROPICAL_YEAR = 'TROPIC_YEAR' 
 

WEEK

WEEK = 'WEEK' 
 

YEAR

YEAR = 'YEAR'