MediaWiki\Utils\MWTimestamp Class Reference

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

Inherits ConvertibleTimestamp.

Collaboration diagram for MediaWiki\Utils\MWTimestamp:

Public Member Functions
	getRelativeTimestamp (?MWTimestamp $relativeTo=null, ?UserIdentity $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 (UserIdentity $user)
	Adjust the timestamp depending on the given user's preferences.

Static Public Member Functions
static	fromMW (string $ts_mw, ?DateTimeZone $zone=null)
	Convert a TS::MW format string, with optional time zone, to a MWTimestamp.
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.

Stability: newable

Since

1.20

Definition at line 36 of file MWTimestamp.php.

Member Function Documentation

fromMW()

static MediaWiki\Utils\MWTimestamp::fromMW ( string $ts_mw, ?DateTimeZone $zone = null )

static

Convert a TS::MW format string, with optional time zone, to a MWTimestamp.

This is more efficient that using the general constructor, which has a long list of string formats that it attempts to match against.

Definition at line 54 of file MWTimestamp.php.

getInstance()

static MediaWiki\Utils\MWTimestamp::getInstance ( $ts = false )

static

Get a timestamp instance in GMT.

Parameters

bool | string

$ts

Timestamp to set, or false for current time

Definition at line 42 of file MWTimestamp.php.

getLocalInstance()

static MediaWiki\Utils\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 153 of file MWTimestamp.php.

getRelativeTimestamp()

MediaWiki\Utils\MWTimestamp::getRelativeTimestamp	(	?MWTimestamp	$relativeTo = null,
		?UserIdentity	$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)
UserIdentity | 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 97 of file MWTimestamp.php.

References wfMessage().

getTimezoneMessage()

MediaWiki\Utils\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 135 of file MWTimestamp.php.

References wfMessage().

offsetForUser()

MediaWiki\Utils\MWTimestamp::offsetForUser

(

UserIdentity

$user

)

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

Since

1.22

Parameters

UserIdentity

$user

User to take preferences from

Returns

DateInterval Offset that was applied to the timestamp

Definition at line 69 of file MWTimestamp.php.

Referenced by MediaWiki\Language\Language\getHumanTimestamp().

---

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

• includes/Utils/MWTimestamp.php