MediaWiki  1.30.0
DateFormatter.php
Go to the documentation of this file.
1 <?php
30  private $mSource, $mTarget;
31  private $monthNames = '';
32 
33  private $regexes;
35 
36  private $lang, $mLinked;
37 
39  private $keys;
40 
42  private $targets;
43 
44  const ALL = -1;
45  const NONE = 0;
46  const MDY = 1;
47  const DMY = 2;
48  const YMD = 3;
49  const ISO1 = 4;
50  const LASTPREF = 4;
51  const ISO2 = 5;
52  const YDM = 6;
53  const DM = 7;
54  const MD = 8;
55  const LAST = 8;
56 
60  public function __construct( Language $lang ) {
61  $this->lang = $lang;
62 
63  $this->monthNames = $this->getMonthRegex();
64  for ( $i = 1; $i <= 12; $i++ ) {
65  $this->xMonths[$this->lang->lc( $this->lang->getMonthName( $i ) )] = $i;
66  $this->xMonths[$this->lang->lc( $this->lang->getMonthAbbreviation( $i ) )] = $i;
67  }
68 
69  $this->regexTrail = '(?![a-z])/iu';
70 
71  # Partial regular expressions
72  $this->prxDM = '\[\[(\d{1,2})[ _](' . $this->monthNames . ')\]\]';
73  $this->prxMD = '\[\[(' . $this->monthNames . ')[ _](\d{1,2})\]\]';
74  $this->prxY = '\[\[(\d{1,4}([ _]BC|))\]\]';
75  $this->prxISO1 = '\[\[(-?\d{4})]]-\[\[(\d{2})-(\d{2})\]\]';
76  $this->prxISO2 = '\[\[(-?\d{4})-(\d{2})-(\d{2})\]\]';
77 
78  # Real regular expressions
79  $this->regexes[self::DMY] = "/{$this->prxDM}(?: *, *| +){$this->prxY}{$this->regexTrail}";
80  $this->regexes[self::YDM] = "/{$this->prxY}(?: *, *| +){$this->prxDM}{$this->regexTrail}";
81  $this->regexes[self::MDY] = "/{$this->prxMD}(?: *, *| +){$this->prxY}{$this->regexTrail}";
82  $this->regexes[self::YMD] = "/{$this->prxY}(?: *, *| +){$this->prxMD}{$this->regexTrail}";
83  $this->regexes[self::DM] = "/{$this->prxDM}{$this->regexTrail}";
84  $this->regexes[self::MD] = "/{$this->prxMD}{$this->regexTrail}";
85  $this->regexes[self::ISO1] = "/{$this->prxISO1}{$this->regexTrail}";
86  $this->regexes[self::ISO2] = "/{$this->prxISO2}{$this->regexTrail}";
87 
88  # Extraction keys
89  # See the comments in replace() for the meaning of the letters
90  $this->keys[self::DMY] = 'jFY';
91  $this->keys[self::YDM] = 'Y jF';
92  $this->keys[self::MDY] = 'FjY';
93  $this->keys[self::YMD] = 'Y Fj';
94  $this->keys[self::DM] = 'jF';
95  $this->keys[self::MD] = 'Fj';
96  $this->keys[self::ISO1] = 'ymd'; # y means ISO year
97  $this->keys[self::ISO2] = 'ymd';
98 
99  # Target date formats
100  $this->targets[self::DMY] = '[[F j|j F]] [[Y]]';
101  $this->targets[self::YDM] = '[[Y]], [[F j|j F]]';
102  $this->targets[self::MDY] = '[[F j]], [[Y]]';
103  $this->targets[self::YMD] = '[[Y]] [[F j]]';
104  $this->targets[self::DM] = '[[F j|j F]]';
105  $this->targets[self::MD] = '[[F j]]';
106  $this->targets[self::ISO1] = '[[Y|y]]-[[F j|m-d]]';
107  $this->targets[self::ISO2] = '[[y-m-d]]';
108 
109  # Rules
110  # pref source target
111  $this->rules[self::DMY][self::MD] = self::DM;
112  $this->rules[self::ALL][self::MD] = self::MD;
113  $this->rules[self::MDY][self::DM] = self::MD;
114  $this->rules[self::ALL][self::DM] = self::DM;
115  $this->rules[self::NONE][self::ISO2] = self::ISO1;
116 
117  $this->preferences = [
118  'default' => self::NONE,
119  'dmy' => self::DMY,
120  'mdy' => self::MDY,
121  'ymd' => self::YMD,
122  'ISO 8601' => self::ISO1,
123  ];
124  }
125 
133  public static function getInstance( $lang = null ) {
135 
138 
139  static $dateFormatter = false;
140  if ( !$dateFormatter ) {
141  $dateFormatter = $cache->getWithSetCallback(
142  $cache->makeKey( 'dateformatter', $lang->getCode() ),
143  $cache::TTL_HOUR,
144  function () use ( $lang ) {
145  return new DateFormatter( $lang );
146  }
147  );
148  }
149 
150  return $dateFormatter;
151  }
152 
160  public function reformat( $preference, $text, $options = [ 'linked' ] ) {
161  $linked = in_array( 'linked', $options );
162  $match_whole = in_array( 'match-whole', $options );
163 
164  if ( isset( $this->preferences[$preference] ) ) {
165  $preference = $this->preferences[$preference];
166  } else {
167  $preference = self::NONE;
168  }
169  for ( $i = 1; $i <= self::LAST; $i++ ) {
170  $this->mSource = $i;
171  if ( isset( $this->rules[$preference][$i] ) ) {
172  # Specific rules
173  $this->mTarget = $this->rules[$preference][$i];
174  } elseif ( isset( $this->rules[self::ALL][$i] ) ) {
175  # General rules
176  $this->mTarget = $this->rules[self::ALL][$i];
177  } elseif ( $preference ) {
178  # User preference
179  $this->mTarget = $preference;
180  } else {
181  # Default
182  $this->mTarget = $i;
183  }
184  $regex = $this->regexes[$i];
185 
186  // Horrible hack
187  if ( !$linked ) {
188  $regex = str_replace( [ '\[\[', '\]\]' ], '', $regex );
189  }
190 
191  if ( $match_whole ) {
192  // Let's hope this works
193  $regex = preg_replace( '!^/!', '/^', $regex );
194  $regex = str_replace( $this->regexTrail,
195  '$' . $this->regexTrail, $regex );
196  }
197 
198  // Another horrible hack
199  $this->mLinked = $linked;
200  $text = preg_replace_callback( $regex, [ $this, 'replace' ], $text );
201  unset( $this->mLinked );
202  }
203  return $text;
204  }
205 
212  private function replace( $matches ) {
213  # Extract information from $matches
214  $linked = true;
215  if ( isset( $this->mLinked ) ) {
216  $linked = $this->mLinked;
217  }
218 
219  $bits = [];
220  $key = $this->keys[$this->mSource];
221  $keyLength = strlen( $key );
222  for ( $p = 0; $p < $keyLength; $p++ ) {
223  if ( $key[$p] != ' ' ) {
224  $bits[$key[$p]] = $matches[$p + 1];
225  }
226  }
227 
228  return $this->formatDate( $bits, $matches[0], $linked );
229  }
230 
238  private function formatDate( $bits, $orig, $link = true ) {
239  $format = $this->targets[$this->mTarget];
240 
241  if ( !$link ) {
242  // strip piped links
243  $format = preg_replace( '/\[\[[^|]+\|([^\]]+)\]\]/', '$1', $format );
244  // strip remaining links
245  $format = str_replace( [ '[[', ']]' ], '', $format );
246  }
247 
248  # Construct new date
249  $text = '';
250  $fail = false;
251 
252  // Pre-generate y/Y stuff because we need the year for the <span> title.
253  if ( !isset( $bits['y'] ) && isset( $bits['Y'] ) ) {
254  $bits['y'] = $this->makeIsoYear( $bits['Y'] );
255  }
256  if ( !isset( $bits['Y'] ) && isset( $bits['y'] ) ) {
257  $bits['Y'] = $this->makeNormalYear( $bits['y'] );
258  }
259 
260  if ( !isset( $bits['m'] ) ) {
261  $m = $this->makeIsoMonth( $bits['F'] );
262  if ( !$m || $m == '00' ) {
263  $fail = true;
264  } else {
265  $bits['m'] = $m;
266  }
267  }
268 
269  if ( !isset( $bits['d'] ) ) {
270  $bits['d'] = sprintf( '%02d', $bits['j'] );
271  }
272 
273  $formatLength = strlen( $format );
274  for ( $p = 0; $p < $formatLength; $p++ ) {
275  $char = $format[$p];
276  switch ( $char ) {
277  case 'd': # ISO day of month
278  $text .= $bits['d'];
279  break;
280  case 'm': # ISO month
281  $text .= $bits['m'];
282  break;
283  case 'y': # ISO year
284  $text .= $bits['y'];
285  break;
286  case 'j': # ordinary day of month
287  if ( !isset( $bits['j'] ) ) {
288  $text .= intval( $bits['d'] );
289  } else {
290  $text .= $bits['j'];
291  }
292  break;
293  case 'F': # long month
294  if ( !isset( $bits['F'] ) ) {
295  $m = intval( $bits['m'] );
296  if ( $m > 12 || $m < 1 ) {
297  $fail = true;
298  } else {
299  $text .= $this->lang->getMonthName( $m );
300  }
301  } else {
302  $text .= ucfirst( $bits['F'] );
303  }
304  break;
305  case 'Y': # ordinary (optional BC) year
306  $text .= $bits['Y'];
307  break;
308  default:
309  $text .= $char;
310  }
311  }
312  if ( $fail ) {
313  // This occurs when parsing a date with day or month outside the bounds
314  // of possibilities.
315  $text = $orig;
316  }
317 
318  $isoBits = [];
319  if ( isset( $bits['y'] ) ) {
320  $isoBits[] = $bits['y'];
321  }
322  $isoBits[] = $bits['m'];
323  $isoBits[] = $bits['d'];
324  $isoDate = implode( '-', $isoBits );
325 
326  // Output is not strictly HTML (it's wikitext), but <span> is whitelisted.
327  $text = Html::rawElement( 'span',
328  [ 'class' => 'mw-formatted-date', 'title' => $isoDate ], $text );
329 
330  return $text;
331  }
332 
337  private function getMonthRegex() {
338  $names = [];
339  for ( $i = 1; $i <= 12; $i++ ) {
340  $names[] = $this->lang->getMonthName( $i );
341  $names[] = $this->lang->getMonthAbbreviation( $i );
342  }
343  return implode( '|', $names );
344  }
345 
351  private function makeIsoMonth( $monthName ) {
352  $n = $this->xMonths[$this->lang->lc( $monthName )];
353  return sprintf( '%02d', $n );
354  }
355 
361  private function makeIsoYear( $year ) {
362  # Assumes the year is in a nice format, as enforced by the regex
363  if ( substr( $year, -2 ) == 'BC' ) {
364  $num = intval( substr( $year, 0, -3 ) ) - 1;
365  # PHP bug note: sprintf( "%04d", -1 ) fails poorly
366  $text = sprintf( '-%04d', $num );
367 
368  } else {
369  $text = sprintf( '%04d', $year );
370  }
371  return $text;
372  }
373 
380  private function makeNormalYear( $iso ) {
381  if ( $iso[0] == '-' ) {
382  $text = ( intval( substr( $iso, 1 ) ) + 1 ) . ' BC';
383  } else {
384  $text = intval( $iso );
385  }
386  return $text;
387  }
388 }
DateFormatter\$regexes
$regexes
Definition: DateFormatter.php:33
DateFormatter\formatDate
formatDate( $bits, $orig, $link=true)
Definition: DateFormatter.php:238
DateFormatter\replace
replace( $matches)
Regexp replacement callback.
Definition: DateFormatter.php:212
DateFormatter\$mLinked
$mLinked
Definition: DateFormatter.php:36
DateFormatter\reformat
reformat( $preference, $text, $options=[ 'linked'])
Definition: DateFormatter.php:160
DateFormatter\getInstance
static getInstance( $lang=null)
Get a DateFormatter object.
Definition: DateFormatter.php:133
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
DateFormatter\LASTPREF
const LASTPREF
Definition: DateFormatter.php:50
DateFormatter\$xMonths
$xMonths
Definition: DateFormatter.php:34
DateFormatter\$targets
string[] $targets
Definition: DateFormatter.php:42
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
means
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control means(i) the power
DateFormatter\makeIsoMonth
makeIsoMonth( $monthName)
Makes an ISO month, e.g.
Definition: DateFormatter.php:351
DateFormatter\YMD
const YMD
Definition: DateFormatter.php:48
DateFormatter\$lang
$lang
Definition: DateFormatter.php:36
$matches
$matches
Definition: NoLocalSettings.php:24
DateFormatter\$monthNames
$monthNames
Definition: DateFormatter.php:31
DateFormatter\NONE
const NONE
Definition: DateFormatter.php:45
wfGetLangObj
wfGetLangObj( $langcode=false)
Return a Language object from $langcode.
Definition: GlobalFunctions.php:1368
DateFormatter\MD
const MD
Definition: DateFormatter.php:54
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
DateFormatter\$keys
string[] $keys
Definition: DateFormatter.php:39
DateFormatter\$preferences
$preferences
Definition: DateFormatter.php:34
DateFormatter\$rules
$rules
Definition: DateFormatter.php:34
DateFormatter\DM
const DM
Definition: DateFormatter.php:53
DateFormatter\__construct
__construct(Language $lang)
Definition: DateFormatter.php:60
DateFormatter\DMY
const DMY
Definition: DateFormatter.php:47
DateFormatter\MDY
const MDY
Definition: DateFormatter.php:46
DateFormatter\YDM
const YDM
Definition: DateFormatter.php:52
DateFormatter\getMonthRegex
getMonthRegex()
Return a regex that can be used to find month names in string.
Definition: DateFormatter.php:337
$cache
$cache
Definition: mcc.php:33
$options
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1965
DateFormatter\makeIsoYear
makeIsoYear( $year)
Make an ISO year from a year name, for instance: '-1199' from '1200 BC'.
Definition: DateFormatter.php:361
DateFormatter\$mSource
$mSource
Definition: DateFormatter.php:30
DateFormatter\ISO1
const ISO1
Definition: DateFormatter.php:49
$wgMainCacheType
CACHE_MEMCACHED $wgMainCacheType
Definition: memcached.txt:63
Html\rawElement
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
$link
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:2981
of
globals txt Globals are evil The original MediaWiki code relied on globals for processing context far too often MediaWiki development since then has been a story of slowly moving context out of global variables and into objects Storing processing context in object member variables allows those objects to be reused in a much more flexible way Consider the elegance of
Definition: globals.txt:10
DateFormatter\LAST
const LAST
Definition: DateFormatter.php:55
DateFormatter\makeNormalYear
makeNormalYear( $iso)
Make a year one from an ISO year, for instance: '400 BC' from '-0399'.
Definition: DateFormatter.php:380
DateFormatter\ISO2
const ISO2
Definition: DateFormatter.php:51
Language
Internationalisation code.
Definition: Language.php:35
DateFormatter
Date formatter, recognises dates in plain text and formats them according to user preferences.
Definition: DateFormatter.php:29
DateFormatter\ALL
const ALL
Definition: DateFormatter.php:44
ObjectCache\getLocalServerInstance
static getLocalServerInstance( $fallback=CACHE_NONE)
Factory function for CACHE_ACCEL (referenced from DefaultSettings.php)
Definition: ObjectCache.php:288
DateFormatter\$mTarget
$mTarget
Definition: DateFormatter.php:30
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:56