MediaWiki  master
MediaWiki\User\UserTimeCorrection Class Reference

Utility class to parse the TimeCorrection string value. More...

Public Member Functions

 __construct (string $timeCorrection, DateTime $relativeToDate=null, int $systemOffset=0)
 
 __toString ()
 
 getCorrectionType ()
 Get time offset for a user. More...
 
 getTimeOffset ()
 Get corresponding time offset for this correction Note: When correcting dates/times, apply only the offset OR the time zone, not both. More...
 
 getTimeOffsetInterval ()
 Get corresponding time offset for this correction Note: When correcting dates/times, apply only the offset OR the time zone, not both. More...
 
 getTimeZone ()
 The time zone if known Note: When correcting dates/times, apply only the offset OR the time zone, not both. More...
 
 isValid ()
 Was the original correction specification valid. More...
 
 toString ()
 Note: The string value of this object might not be equal to the original value. More...
 

Detailed Description

Utility class to parse the TimeCorrection string value.

These values are used to specify the time offset for a user and are stored in the database as a user preference and returned by the preferences APIs

The class will correct invalid input and adjusts timezone offsets to applicable dates, taking into account DST etc.

Since
1.37

Definition at line 42 of file UserTimeCorrection.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\User\UserTimeCorrection::__construct ( string  $timeCorrection,
DateTime  $relativeToDate = null,
int  $systemOffset = 0 
)
Parameters
string$timeCorrectionOriginal time correction string
DateTime | null$relativeToDateThe date used to calculate the time zone offset of. This defaults to the current date and time.
int$systemOffsetOffset for self::SYSTEM in minutes

Definition at line 77 of file UserTimeCorrection.php.

Member Function Documentation

◆ __toString()

MediaWiki\User\UserTimeCorrection::__toString ( )

Definition at line 255 of file UserTimeCorrection.php.

◆ getCorrectionType()

MediaWiki\User\UserTimeCorrection::getCorrectionType ( )

Get time offset for a user.

Returns
string Offset that was applied to the user

Definition at line 92 of file UserTimeCorrection.php.

◆ getTimeOffset()

MediaWiki\User\UserTimeCorrection::getTimeOffset ( )

Get corresponding time offset for this correction Note: When correcting dates/times, apply only the offset OR the time zone, not both.

Returns
int Offset in minutes

Definition at line 101 of file UserTimeCorrection.php.

◆ getTimeOffsetInterval()

MediaWiki\User\UserTimeCorrection::getTimeOffsetInterval ( )

Get corresponding time offset for this correction Note: When correcting dates/times, apply only the offset OR the time zone, not both.

Returns
DateInterval Offset in minutes as a DateInterval

Definition at line 110 of file UserTimeCorrection.php.

◆ getTimeZone()

MediaWiki\User\UserTimeCorrection::getTimeZone ( )

The time zone if known Note: When correcting dates/times, apply only the offset OR the time zone, not both.

Returns
DateTimeZone|null

Definition at line 124 of file UserTimeCorrection.php.

◆ isValid()

MediaWiki\User\UserTimeCorrection::isValid ( )

Was the original correction specification valid.

Returns
bool

Definition at line 132 of file UserTimeCorrection.php.

◆ toString()

MediaWiki\User\UserTimeCorrection::toString ( )

Note: The string value of this object might not be equal to the original value.

Returns
string a timecorrection string representing this value

Definition at line 241 of file UserTimeCorrection.php.


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