MWTimestamp Class Reference

Library for creating and parsing MW-style timestamps. More...

Inheritance diagram for MWTimestamp:

Collaboration diagram for MWTimestamp:

Public Member Functions
	getHumanTimestamp (MWTimestamp $relativeTo=null, User $user=null, Language $lang=null)
	Get the timestamp in a human-friendly relative format, e.g., "3 days ago".
	getRelativeTimestamp (MWTimestamp $relativeTo=null, User $user=null, Language $lang=null, array $chosenIntervals=[])
	Generate a purely relative timestamp, i.e., represent the time elapsed between the given base timestamp and this object.
	getTimezoneMessage ()
	Get the localized timezone message, if available.
	offsetForUser (User $user)
	Adjust the timestamp depending on the given user's preferences.

Static Public Member Functions
static	getInstance ( $ts=false)
	Get a timestamp instance in GMT.
static	getLocalInstance ( $ts=false)
	Get a timestamp instance in the server local timezone ($wgLocaltimezone)

Detailed Description

Library for creating and parsing MW-style timestamps.

Based on the JS library that does the same thing.

Since

1.20

Definition at line 32 of file MWTimestamp.php.

Member Function Documentation

getHumanTimestamp()

MWTimestamp::getHumanTimestamp	(	MWTimestamp	$relativeTo = null,
		User	$user = null,
		Language	$lang = null
	)

Get the timestamp in a human-friendly relative format, e.g., "3 days ago".

Determine the difference between the timestamp and the current time, and generate a readable timestamp by returning "<N> <units> ago", where the largest possible unit is used.

Since

1.20

1.22 Uses Language::getHumanTimestamp to produce the timestamp

Deprecated:

since 1.26 Use Language::getHumanTimestamp directly

Parameters

MWTimestamp | null	$relativeTo	The base timestamp to compare to (defaults to now)
User | null	$user	User the timestamp is being generated for (or null to use main context's user)
Language | null	$lang	Language to use to make the human timestamp (or null to use main context's language)

Returns

string Formatted timestamp

Definition at line 61 of file MWTimestamp.php.

References $lang, and $user.

getInstance()

static MWTimestamp::getInstance (   $ts = false )

static

Get a timestamp instance in GMT.

Parameters

bool | string

$ts

Timestamp to set, or false for current time

Returns

MWTimestamp The instance

Definition at line 39 of file MWTimestamp.php.

getLocalInstance()

static MWTimestamp::getLocalInstance (   $ts = false )

static

Get a timestamp instance in the server local timezone ($wgLocaltimezone)

Since

1.22

Parameters

bool | string

$ts

Timestamp to set, or false for current time

Returns

MWTimestamp The local instance

Definition at line 204 of file MWTimestamp.php.

References $wgLocaltimezone.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\getTimezoneOptions().

getRelativeTimestamp()

MWTimestamp::getRelativeTimestamp	(	MWTimestamp	$relativeTo = null,
		User	$user = null,
		Language	$lang = null,
		array	$chosenIntervals = []
	)

Generate a purely relative timestamp, i.e., represent the time elapsed between the given base timestamp and this object.

Parameters

MWTimestamp | null	$relativeTo	Relative base timestamp (defaults to now)
User | null	$user	Use to use offset for
Language | null	$lang	Language to use
array	$chosenIntervals	Intervals to use to represent it

Returns

string Relative timestamp

Definition at line 147 of file MWTimestamp.php.

References $lang, $user, diff, and wfMessage().

getTimezoneMessage()

MWTimestamp::getTimezoneMessage

(

)

Get the localized timezone message, if available.

Premade translations are not shipped as format() may return whatever the system uses, localized or not, so translation must be done through wiki.

Since

1.27

Returns

Message The localized timezone message

Definition at line 186 of file MWTimestamp.php.

References format, and wfMessage().

offsetForUser()

MWTimestamp::offsetForUser

(

User

$user

)

Adjust the timestamp depending on the given user's preferences.

Since

1.22

Parameters

User

$user

User to take preferences from

Returns

DateInterval Offset that was applied to the timestamp

Definition at line 79 of file MWTimestamp.php.

References $e, $user, and $wgLocalTZoffset.

---

The documentation for this class was generated from the following file:

• includes/MWTimestamp.php