BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
MWTimestamp Class Reference
Inheritance diagram for MWTimestamp:
Collaboration diagram for MWTimestamp:

Public Member Functions

 getHumanTimestamp (MWTimestamp $relativeTo=null, User $user=null, Language $lang=null)
 
 offsetForUser (User $user)
 
 getRelativeTimestamp (MWTimestamp $relativeTo=null, User $user=null, Language $lang=null, array $chosenIntervals=[])
 
 getTimezoneMessage ()
 
- Public Member Functions inherited from Wikimedia\Timestamp\ConvertibleTimestamp
 __construct ($timestamp=false)
 
 setTimestamp ($ts=false)
 
 getTimestamp ($style=TS_UNIX)
 
 __toString ()
 
 diff (ConvertibleTimestamp $relativeTo)
 
 setTimezone ($timezone)
 
 getTimezone ()
 
 format ($format)
 

Static Public Member Functions

static getInstance ($ts=false)
 
static getLocalInstance ($ts=false)
 
- Static Public Member Functions inherited from Wikimedia\Timestamp\ConvertibleTimestamp
static convert ($style=TS_UNIX, $ts)
 
static now ($style=TS_MW)
 

Additional Inherited Members

- Public Attributes inherited from Wikimedia\Timestamp\ConvertibleTimestamp
 $timestamp
 
- Static Public Attributes inherited from Wikimedia\Timestamp\ConvertibleTimestamp
static TS_MW
 

Detailed Description

Library for creating and parsing MW-style timestamps. Based on the JS library that does the same thing.

Since
1.20

Member Function Documentation

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$relativeToThe base timestamp to compare to (defaults to now)
User | null$userUser the timestamp is being generated for (or null to use main context's user)
Language | null$langLanguage to use to make the human timestamp (or null to use main context's language)
Returns
string Formatted timestamp
static MWTimestamp::getInstance (   $ts = false)
static

Get a timestamp instance in GMT

Parameters
bool | string$tsTimestamp to set, or false for current time
Returns
MWTimestamp The instance
static MWTimestamp::getLocalInstance (   $ts = false)
static

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

Since
1.22
Parameters
bool | string$tsTimestamp to set, or false for current time
Returns
MWTimestamp The local instance
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$relativeToRelative base timestamp (defaults to now)
User$userUse to use offset for
Language$langLanguage to use
array$chosenIntervalsIntervals to use to represent it
Returns
string Relative timestamp
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
MWTimestamp::offsetForUser ( User  $user)

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

Since
1.22
Parameters
User$userUser to take preferences from
Returns
DateInterval Offset that was applied to the timestamp

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