DateFormatter.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Parser;
 
use MediaWiki\Html\Html;
use MediaWiki\Language\Language;
use MediaWiki\MediaWikiServices;
 
class DateFormatter {
    private $regexes;
 
    private const RULES = [
        self::ALL => [
            self::MD => self::MD,
            self::DM => self::DM,
        ],
        self::NONE => [
            self::ISO => self::ISO,
        ],
        self::MDY => [
            self::DM => self::MD,
        ],
        self::DMY => [
            self::MD => self::DM,
        ],
    ];
 
    private $xMonths = [];
 
    private $monthNames = [];
 
    private const PREFERENCE_IDS = [
        'default' => self::NONE,
        'dmy' => self::DMY,
        'mdy' => self::MDY,
        'ymd' => self::YMD,
        'ISO 8601' => self::ISO,
    ];
 
    private const TARGET_FORMATS = [
        self::MDY => 'F j, Y',
        self::DMY => 'j F Y',
        self::YMD => 'Y F j',
        self::ISO => 'y-m-d',
        self::YDM => 'Y, j F',
        self::DM => 'j F',
        self::MD => 'F j',
    ];
 
    private const ALL = -1;
 
    private const NONE = 0;
 
    private const MDY = 1;
 
    private const DMY = 2;
 
    private const YMD = 3;
 
    private const ISO = 4;
 
    private const YDM = 5;
 
    private const DM = 6;
 
    private const MD = 7;
 
    public function __construct( Language $lang ) {
        $monthRegexParts = [];
        for ( $i = 1; $i <= 12; $i++ ) {
            $monthName = $lang->getMonthName( $i );
            $monthAbbrev = $lang->getMonthAbbreviation( $i );
            $this->monthNames[$i] = $monthName;
            $monthRegexParts[] = preg_quote( $monthName, '/' );
            $monthRegexParts[] = preg_quote( $monthAbbrev, '/' );
            $this->xMonths[mb_strtolower( $monthName )] = $i;
            $this->xMonths[mb_strtolower( $monthAbbrev )] = $i;
        }
 
        // Partial regular expressions
        $monthNames = implode( '|', $monthRegexParts );
        $dm = "(?<day>\d{1,2})[ _](?<monthName>{$monthNames})";
        $md = "(?<monthName>{$monthNames})[ _](?<day>\d{1,2})";
        $y = '(?<year>\d{1,4}([ _]BC|))';
        $iso = '(?<isoYear>-?\d{4})-(?<isoMonth>\d{2})-(?<isoDay>\d{2})';
 
        $this->regexes = [
            self::DMY => "/^{$dm}(?: *, *| +){$y}$/iu",
            self::YDM => "/^{$y}(?: *, *| +){$dm}$/iu",
            self::MDY => "/^{$md}(?: *, *| +){$y}$/iu",
            self::YMD => "/^{$y}(?: *, *| +){$md}$/iu",
            self::DM => "/^{$dm}$/iu",
            self::MD => "/^{$md}$/iu",
            self::ISO => "/^{$iso}$/iu",
        ];
    }
 
    public static function getInstance( ?Language $lang = null ) {
        $lang ??= MediaWikiServices::getInstance()->getContentLanguage();
        return MediaWikiServices::getInstance()->getDateFormatterFactory()->get( $lang );
    }
 
    public function reformat( $preference, $text, $options = [] ) {
        $userFormatId = self::PREFERENCE_IDS[$preference] ?? self::NONE;
        foreach ( self::TARGET_FORMATS as $source => $_ ) {
            if ( isset( self::RULES[$userFormatId][$source] ) ) {
                # Specific rules
                $target = self::RULES[$userFormatId][$source];
            } elseif ( isset( self::RULES[self::ALL][$source] ) ) {
                # General rules
                $target = self::RULES[self::ALL][$source];
            } elseif ( $userFormatId ) {
                # User preference
                $target = $userFormatId;
            } else {
                # Default
                $target = $source;
            }
            $format = self::TARGET_FORMATS[$target];
            $regex = $this->regexes[$source];
 
            $text = preg_replace_callback( $regex,
                function ( $match ) use ( $format ) {
                    $text = '';
 
                    // Pre-generate y/Y stuff because we need the year for the <span> title.
                    if ( !isset( $match['isoYear'] ) && isset( $match['year'] ) ) {
                        $match['isoYear'] = $this->makeIsoYear( $match['year'] );
                    }
                    if ( !isset( $match['year'] ) && isset( $match['isoYear'] ) ) {
                        $match['year'] = $this->makeNormalYear( $match['isoYear'] );
                    }
 
                    if ( !isset( $match['isoMonth'] ) ) {
                        $m = $this->makeIsoMonth( $match['monthName'] );
                        if ( $m === null ) {
                            // Fail
                            return $match[0];
                        }
                        $match['isoMonth'] = $m;
                    }
 
                    if ( !isset( $match['isoDay'] ) ) {
                        $match['isoDay'] = sprintf( '%02d', $match['day'] );
                    }
 
                    $formatLength = strlen( $format );
                    for ( $p = 0; $p < $formatLength; $p++ ) {
                        $char = $format[$p];
                        switch ( $char ) {
                            case 'd': // ISO day of month
                                $text .= $match['isoDay'];
                                break;
                            case 'm': // ISO month
                                $text .= $match['isoMonth'];
                                break;
                            case 'y': // ISO year
                                $text .= $match['isoYear'];
                                break;
                            case 'j': // ordinary day of month
                                if ( !isset( $match['day'] ) ) {
                                    $text .= intval( $match['isoDay'] );
                                } else {
                                    $text .= $match['day'];
                                }
                                break;
                            case 'F': // long month
                                $m = intval( $match['isoMonth'] );
                                if ( $m > 12 || $m < 1 ) {
                                    // Fail
                                    return $match[0];
                                }
                                $text .= $this->monthNames[$m];
                                break;
                            case 'Y': // ordinary (optional BC) year
                                // @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset False positive
                                $text .= $match['year'];
                                break;
                            default:
                                $text .= $char;
                        }
                    }
 
                    $isoBits = [];
                    if ( isset( $match['isoYear'] ) ) {
                        $isoBits[] = $match['isoYear'];
                    }
                    $isoBits[] = $match['isoMonth'];
                    $isoBits[] = $match['isoDay'];
                    $isoDate = implode( '-', $isoBits );
 
                    // Output is not strictly HTML (it's wikitext), but <span> is allowed.
                    return Html::rawElement( 'span',
                        [ 'class' => 'mw-formatted-date', 'title' => $isoDate ], $text );
                }, $text
            );
        }
        return $text;
    }
 
    private function makeIsoMonth( $monthName ) {
        $number = $this->xMonths[mb_strtolower( $monthName )] ?? null;
        return $number !== null ? sprintf( '%02d', $number ) : null;
    }
 
    private function makeIsoYear( $year ) {
        // Assumes the year is in a nice format, as enforced by the regex
        if ( substr( $year, -2 ) == 'BC' ) {
            $num = intval( substr( $year, 0, -3 ) ) - 1;
            // PHP bug note: sprintf( "%04d", -1 ) fails poorly
            $text = sprintf( '-%04d', $num );
        } else {
            $text = sprintf( '%04d', $year );
        }
        return $text;
    }
 
    private function makeNormalYear( $iso ) {
        if ( $iso <= 0 ) {
            $text = ( intval( substr( $iso, 1 ) ) + 1 ) . ' BC';
        } else {
            $text = intval( $iso );
        }
        return $text;
    }
}
 
class_alias( DateFormatter::class, 'DateFormatter' );