DateFormatter.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
 
class DateFormatter {
    private $regexes;
 
    private $rules = [];
 
    private $xMonths = [];
 
    private $monthNames = [];
 
    private $preferenceIDs;
 
    private $targetFormats;
 
    const ALL = -1;
 
    const NONE = 0;
 
    const MDY = 1;
 
    const DMY = 2;
 
    const YMD = 3;
 
    const ISO = 4;
 
    const LASTPREF = 4;
 
    const YDM = 5;
 
    const DM = 6;
 
    const MD = 7;
 
    const LAST = 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",
        ];
 
        // Target date formats
        $this->targetFormats = [
            self::DMY => 'j F Y',
            self::YDM => 'Y, j F',
            self::MDY => 'F j, Y',
            self::YMD => 'Y F j',
            self::DM => 'j F',
            self::MD => 'F j',
            self::ISO => 'y-m-d',
        ];
 
        // Rules
        //           pref       source      target
        $this->rules[self::DMY][self::MD] = self::DM;
        $this->rules[self::ALL][self::MD] = self::MD;
        $this->rules[self::MDY][self::DM] = self::MD;
        $this->rules[self::ALL][self::DM] = self::DM;
        $this->rules[self::NONE][self::ISO] = self::ISO;
 
        $this->preferenceIDs = [
            'default' => self::NONE,
            'dmy' => self::DMY,
            'mdy' => self::MDY,
            'ymd' => self::YMD,
            'ISO 8601' => self::ISO,
        ];
    }
 
    public static function getInstance( Language $lang = null ) {
        $lang = $lang ?? MediaWikiServices::getInstance()->getContentLanguage();
        return MediaWikiServices::getInstance()->getDateFormatterFactory()->get( $lang );
    }
 
    public function reformat( $preference, $text, $options = [] ) {
        if ( isset( $this->preferenceIDs[$preference] ) ) {
            $preference = $this->preferenceIDs[$preference];
        } else {
            $preference = self::NONE;
        }
        for ( $source = 1; $source <= self::LAST; $source++ ) {
            if ( isset( $this->rules[$preference][$source] ) ) {
                # Specific rules
                $target = $this->rules[$preference][$source];
            } elseif ( isset( $this->rules[self::ALL][$source] ) ) {
                # General rules
                $target = $this->rules[self::ALL][$source];
            } elseif ( $preference ) {
                # User preference
                $target = $preference;
            } else {
                # Default
                $target = $source;
            }
            $regex = $this->regexes[$source];
 
            $text = preg_replace_callback( $regex,
                function ( $match ) use ( $target ) {
                    $format = $this->targetFormats[$target];
 
                    $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 === false ) {
                            // Fail
                            return $match[0];
                        } else {
                            $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];
                                } else {
                                    $text .= $this->monthNames[$m];
                                }
                                break;
                            case 'Y': // ordinary (optional BC) year
                                $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 whitelisted.
                    $text = Html::rawElement( 'span',
                        [ 'class' => 'mw-formatted-date', 'title' => $isoDate ], $text );
 
                    return $text;
                }, $text
            );
        }
        return $text;
    }
 
    private function makeIsoMonth( $monthName ) {
        $isoMonth = $this->xMonths[mb_strtolower( $monthName )] ?? false;
        if ( $isoMonth === false ) {
            return false;
        }
        return sprintf( '%02d', $isoMonth );
    }
 
    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;
    }
}