\CodeIgniter\I18nTimeDifference

Class TimeDifference

Summary

Methods
Properties
Constants
__construct()
getYears()
getMonths()
getWeeks()
getDays()
getHours()
getMinutes()
getSeconds()
humanize()
__get()
__isset()
No public properties found
No constants found
No protected methods found
$currentTime
$testTime
$eras
$years
$months
$weeks
$days
$hours
$minutes
$seconds
$difference
N/A
No private methods found
No private properties found
N/A

Properties

$currentTime

$currentTime : integer

The timestamp of the "current" time.

Type

integer

$testTime

$testTime : integer

The timestamp to compare the current time to.

Type

integer

$eras

$eras : float

Eras.

Type

float

$years

$years : float

Years.

Type

float

$months

$months : float

Months.

Type

float

$weeks

$weeks : integer

Weeks.

Type

integer

$days

$days : integer

Days.

Type

integer

$hours

$hours : integer

Hours.

Type

integer

$minutes

$minutes : integer

Minutes.

Type

integer

$seconds

$seconds : integer

Seconds.

Type

integer

$difference

$difference : integer

Difference in seconds.

Type

integer

Methods

__construct()

__construct(\DateTime  $currentTime, \DateTime  $testTime) 

Note: both parameters are required to be in the same timezone. No timezone shifting is done internally.

Parameters

\DateTime $currentTime
\DateTime $testTime

getYears()

getYears(boolean  $raw = false) : float|integer

Returns the number of years of difference between the two.

Parameters

boolean $raw

Returns

float|integer

getMonths()

getMonths(boolean  $raw = false) : float|integer

Returns the number of months difference between the two dates.

Parameters

boolean $raw

Returns

float|integer

getWeeks()

getWeeks(boolean  $raw = false) : float|integer

Returns the number of weeks difference between the two dates.

Parameters

boolean $raw

Returns

float|integer

getDays()

getDays(boolean  $raw = false) : float|integer

Returns the number of days difference between the two dates.

Parameters

boolean $raw

Returns

float|integer

getHours()

getHours(boolean  $raw = false) : float|integer

Returns the number of hours difference between the two dates.

Parameters

boolean $raw

Returns

float|integer

getMinutes()

getMinutes(boolean  $raw = false) : float|integer

Returns the number of minutes difference between the two dates.

Parameters

boolean $raw

Returns

float|integer

getSeconds()

getSeconds(boolean  $raw = false) : integer

Returns the number of seconds difference between the two dates.

Parameters

boolean $raw

Returns

integer

humanize()

humanize(string|null  $locale = null) : string

Convert the time to human readable format

Parameters

string|null $locale

Returns

string

__get()

__get(  $name) : mixed

Allow property-like access to our calculated values.

Parameters

$name

Returns

mixed

__isset()

__isset(  $name) : boolean

Allow property-like checking for our calculated values.

Parameters

$name

Returns

boolean