MediaWiki  master
HTMLDateTimeField.php
Go to the documentation of this file.
1 <?php
2 
20  protected static $patterns = [
21  'date' => '[0-9]{4}-[01][0-9]-[0-3][0-9]',
22  'time' => '[0-2][0-9]:[0-5][0-9]:[0-5][0-9](?:\.[0-9]+)?',
23  'datetime' => '[0-9]{4}-[01][0-9]-[0-3][0-9][T ][0-2][0-9]:[0-5][0-9]:[0-5][0-9](?:\.[0-9]+)?Z?',
24  ];
25 
26  protected $mType = 'datetime';
27 
28  public function __construct( $params ) {
29  parent::__construct( $params );
30 
31  $this->mType = array_key_exists( 'type', $params )
32  ? $params['type']
33  : 'datetime';
34 
35  if ( !in_array( $this->mType, [ 'date', 'time', 'datetime' ] ) ) {
36  throw new InvalidArgumentException( "Invalid type '$this->mType'" );
37  }
38 
39  if ( $this->mPlaceholder === '' ) {
40  // Messages: htmlform-date-placeholder htmlform-time-placeholder htmlform-datetime-placeholder
41  $this->mPlaceholder = $this->msg( "htmlform-{$this->mType}-placeholder" )->text();
42  }
43 
44  $this->mClass .= ' mw-htmlform-datetime-field';
45  }
46 
47  public function getAttributes( array $list ) {
48  $parentList = array_diff( $list, [ 'min', 'max' ] );
49  $ret = parent::getAttributes( $parentList );
50 
51  if ( in_array( 'min', $list ) && isset( $this->mParams['min'] ) ) {
52  $min = $this->parseDate( $this->mParams['min'] );
53  if ( $min ) {
54  $ret['min'] = $this->formatDate( $min );
55  }
56  }
57  if ( in_array( 'max', $list ) && isset( $this->mParams['max'] ) ) {
58  $max = $this->parseDate( $this->mParams['max'] );
59  if ( $max ) {
60  $ret['max'] = $this->formatDate( $max );
61  }
62  }
63 
64  $ret['step'] = 1;
65 
66  $ret['type'] = $this->mType;
67  $ret['pattern'] = static::$patterns[$this->mType];
68 
69  return $ret;
70  }
71 
72  public function loadDataFromRequest( $request ) {
73  if ( !$request->getCheck( $this->mName ) ) {
74  return $this->getDefault();
75  }
76 
77  $value = $request->getText( $this->mName );
78  $date = $this->parseDate( $value );
79  return $date ? $this->formatDate( $date ) : $value;
80  }
81 
82  public function validate( $value, $alldata ) {
83  $p = parent::validate( $value, $alldata );
84 
85  if ( $p !== true ) {
86  return $p;
87  }
88 
89  if ( $value === '' ) {
90  // required was already checked by parent::validate
91  return true;
92  }
93 
94  $date = $this->parseDate( $value );
95  if ( !$date ) {
96  // Messages: htmlform-date-invalid htmlform-time-invalid htmlform-datetime-invalid
97  return $this->msg( "htmlform-{$this->mType}-invalid" );
98  }
99 
100  if ( isset( $this->mParams['min'] ) ) {
101  $min = $this->parseDate( $this->mParams['min'] );
102  if ( $min && $date < $min ) {
103  // Messages: htmlform-date-toolow htmlform-time-toolow htmlform-datetime-toolow
104  return $this->msg( "htmlform-{$this->mType}-toolow", $this->formatDate( $min ) );
105  }
106  }
107 
108  if ( isset( $this->mParams['max'] ) ) {
109  $max = $this->parseDate( $this->mParams['max'] );
110  if ( $max && $date > $max ) {
111  // Messages: htmlform-date-toohigh htmlform-time-toohigh htmlform-datetime-toohigh
112  return $this->msg( "htmlform-{$this->mType}-toohigh", $this->formatDate( $max ) );
113  }
114  }
115 
116  return true;
117  }
118 
119  protected function parseDate( $value ) {
120  $value = trim( $value );
121  if ( $value === '' ) {
122  return false;
123  }
124 
125  if ( $this->mType === 'date' ) {
126  $value .= ' T00:00:00+0000';
127  }
128  if ( $this->mType === 'time' ) {
129  $value = '1970-01-01 ' . $value . '+0000';
130  }
131 
132  try {
133  $date = new DateTime( $value, new DateTimeZone( 'GMT' ) );
134  return $date->getTimestamp();
135  } catch ( Exception $ex ) {
136  return false;
137  }
138  }
139 
140  protected function formatDate( $value ) {
141  switch ( $this->mType ) {
142  case 'date':
143  return gmdate( 'Y-m-d', $value );
144 
145  case 'time':
146  return gmdate( 'H:i:s', $value );
147 
148  case 'datetime':
149  return gmdate( 'Y-m-d\\TH:i:s\\Z', $value );
150  }
151  }
152 
153  public function getInputOOUI( $value ) {
154  $params = [
155  'type' => $this->mType,
156  'value' => $value,
157  'name' => $this->mName,
158  'id' => $this->mID,
159  ];
160 
161  if ( isset( $this->mParams['min'] ) ) {
162  $min = $this->parseDate( $this->mParams['min'] );
163  if ( $min ) {
164  $params['min'] = $this->formatDate( $min );
165  }
166  }
167  if ( isset( $this->mParams['max'] ) ) {
168  $max = $this->parseDate( $this->mParams['max'] );
169  if ( $max ) {
170  $params['max'] = $this->formatDate( $max );
171  }
172  }
173 
174  if ( $this->mType === 'date' ) {
175  $this->mParent->getOutput()->addModuleStyles( 'mediawiki.widgets.DateInputWidget.styles' );
177  } else {
179  }
180  }
181 
182  protected function getOOUIModules() {
183  if ( $this->mType === 'date' ) {
184  return [ 'mediawiki.widgets.DateInputWidget' ];
185  } else {
186  return [ 'mediawiki.widgets.datetime' ];
187  }
188  }
189 
190  protected function shouldInfuseOOUI() {
191  return true;
192  }
193 
194 }
loadDataFromRequest( $request)
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 noclasses & $ret
Definition: hooks.txt:1978
msg()
Get a translated interface message.
$value
$params
validate( $value, $alldata)
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
getAttributes(array $list)
<input> field.
A field that will contain a date and/or time.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2627