6 class XmlTest
extends MediaWikiTestCase
{
8 protected function setUp() {
11 $langObj = Language
::factory( 'en' );
12 $langObj->setNamespaces( [
24 9 => 'MediaWiki_talk',
26 11 => 'Template_talk',
31 $this->setMwGlobals( [
33 'wgUseMediaWikiUIEverywhere' => false,
37 protected function tearDown() {
38 Language
::factory( 'en' )->resetNamespaces();
43 * @covers Xml::expandAttributes
45 public function testExpandAttributes() {
46 $this->assertNull( Xml
::expandAttributes( null ),
47 'Converting a null list of attributes'
49 $this->assertEquals( '', Xml
::expandAttributes( [] ),
50 'Converting an empty list of attributes'
55 * @covers Xml::expandAttributes
57 public function testExpandAttributesException() {
58 $this->setExpectedException( MWException
::class );
59 Xml
::expandAttributes( 'string' );
63 * @covers Xml::element
65 public function testElementOpen() {
68 Xml
::element( 'element', null, null ),
69 'Opening element with no attributes'
74 * @covers Xml::element
76 public function testElementEmpty() {
79 Xml
::element( 'element', null, '' ),
80 'Terminated empty element'
87 public function testElementInputCanHaveAValueOfZero() {
89 '<input name="name" value="0" />',
90 Xml
::input( 'name', false, 0 ),
91 'Input with a value of 0 (T25797)'
96 * @covers Xml::element
98 public function testElementEscaping() {
100 '<element>"hello <there> your\'s & you"</element>',
101 Xml
::element( 'element', null, '"hello <there> your\'s & you"' ),
102 'Element with no attributes and content that needs escaping'
107 * @covers Xml::escapeTagsOnly
109 public function testEscapeTagsOnly() {
110 $this->assertEquals( '"><', Xml
::escapeTagsOnly( '"><' ),
111 'replace " > and < with their HTML entitites'
116 * @covers Xml::element
118 public function testElementAttributes() {
120 '<element key="value" <>="<>">',
121 Xml
::element( 'element', [ 'key' => 'value', '<>' => '<>' ], null ),
122 'Element attributes, keys are not escaped'
127 * @covers Xml::openElement
129 public function testOpenElement() {
132 Xml
::openElement( 'element', [ 'k' => 'v' ] ),
133 'openElement() shortcut'
138 * @covers Xml::closeElement
140 public function testCloseElement() {
141 $this->assertEquals( '</element>', Xml
::closeElement( 'element' ), 'closeElement() shortcut' );
144 public function provideMonthSelector() {
147 $header = '<select name="month" id="month" class="mw-month-selector">';
148 $header2 = '<select name="month" id="monthSelector" class="mw-month-selector">';
150 for ( $i = 1; $i < 13; $i++
) {
151 $monthName = $wgLang->getMonthName( $i );
152 $monthsString .= "<option value=\"{$i}\">{$monthName}</option>";
154 $monthsString .= "\n";
157 $monthsString2 = str_replace(
158 '<option value="12">December</option>',
159 '<option value="12" selected="">December</option>',
164 $allMonths = "<option value=\"AllMonths\">all</option>\n";
166 [ $header . $monthsString . $end, '', null, 'month' ],
167 [ $header . $monthsString2 . $end, 12, null, 'month' ],
168 [ $header2 . $monthsString . $end, '', null, 'monthSelector' ],
169 [ $header . $allMonths . $monthsString . $end, '', 'AllMonths', 'month' ],
175 * @covers Xml::monthSelector
176 * @dataProvider provideMonthSelector
178 public function testMonthSelector( $expected, $selected, $allmonths, $id ) {
181 Xml
::monthSelector( $selected, $allmonths, $id )
188 public function testSpan() {
190 '<span class="foo" id="testSpan">element</span>',
191 Xml
::span( 'element', 'foo', [ 'id' => 'testSpan' ] )
196 * @covers Xml::dateMenu
198 public function testDateMenu() {
199 $curYear = intval( gmdate( 'Y' ) );
200 $prevYear = $curYear - 1;
202 $curMonth = intval( gmdate( 'n' ) );
204 $nextMonth = $curMonth +
1;
205 if ( $nextMonth == 13 ) {
210 '<label for="year">From year (and earlier):</label> ' .
211 '<input id="year" maxlength="4" size="7" type="number" value="2011" name="year"/> ' .
212 '<label for="month">From month (and earlier):</label> ' .
213 '<select name="month" id="month" class="mw-month-selector">' .
214 '<option value="-1">all</option>' . "\n" .
215 '<option value="1">January</option>' . "\n" .
216 '<option value="2" selected="">February</option>' . "\n" .
217 '<option value="3">March</option>' . "\n" .
218 '<option value="4">April</option>' . "\n" .
219 '<option value="5">May</option>' . "\n" .
220 '<option value="6">June</option>' . "\n" .
221 '<option value="7">July</option>' . "\n" .
222 '<option value="8">August</option>' . "\n" .
223 '<option value="9">September</option>' . "\n" .
224 '<option value="10">October</option>' . "\n" .
225 '<option value="11">November</option>' . "\n" .
226 '<option value="12">December</option></select>',
227 Xml
::dateMenu( 2011, 02 ),
228 "Date menu for february 2011"
231 '<label for="year">From year (and earlier):</label> ' .
232 '<input id="year" maxlength="4" size="7" type="number" value="2011" name="year"/> ' .
233 '<label for="month">From month (and earlier):</label> ' .
234 '<select name="month" id="month" class="mw-month-selector">' .
235 '<option value="-1">all</option>' . "\n" .
236 '<option value="1">January</option>' . "\n" .
237 '<option value="2">February</option>' . "\n" .
238 '<option value="3">March</option>' . "\n" .
239 '<option value="4">April</option>' . "\n" .
240 '<option value="5">May</option>' . "\n" .
241 '<option value="6">June</option>' . "\n" .
242 '<option value="7">July</option>' . "\n" .
243 '<option value="8">August</option>' . "\n" .
244 '<option value="9">September</option>' . "\n" .
245 '<option value="10">October</option>' . "\n" .
246 '<option value="11">November</option>' . "\n" .
247 '<option value="12">December</option></select>',
248 Xml
::dateMenu( 2011, -1 ),
249 "Date menu with negative month for 'All'"
252 Xml
::dateMenu( $curYear, $curMonth ),
253 Xml
::dateMenu( '', $curMonth ),
254 "Date menu year is the current one when not specified"
257 $wantedYear = $nextMonth == 1 ?
$curYear : $prevYear;
259 Xml
::dateMenu( $wantedYear, $nextMonth ),
260 Xml
::dateMenu( '', $nextMonth ),
261 "Date menu next month is 11 months ago"
265 '<label for="year">From year (and earlier):</label> ' .
266 '<input id="year" maxlength="4" size="7" type="number" name="year"/> ' .
267 '<label for="month">From month (and earlier):</label> ' .
268 '<select name="month" id="month" class="mw-month-selector">' .
269 '<option value="-1">all</option>' . "\n" .
270 '<option value="1">January</option>' . "\n" .
271 '<option value="2">February</option>' . "\n" .
272 '<option value="3">March</option>' . "\n" .
273 '<option value="4">April</option>' . "\n" .
274 '<option value="5">May</option>' . "\n" .
275 '<option value="6">June</option>' . "\n" .
276 '<option value="7">July</option>' . "\n" .
277 '<option value="8">August</option>' . "\n" .
278 '<option value="9">September</option>' . "\n" .
279 '<option value="10">October</option>' . "\n" .
280 '<option value="11">November</option>' . "\n" .
281 '<option value="12">December</option></select>',
282 Xml
::dateMenu( '', '' ),
283 "Date menu with neither year or month"
288 * @covers Xml::textarea
290 public function testTextareaNoContent() {
292 '<textarea name="name" id="name" cols="40" rows="5"></textarea>',
293 Xml
::textarea( 'name', '' ),
294 'textarea() with not content'
299 * @covers Xml::textarea
301 public function testTextareaAttribs() {
303 '<textarea name="name" id="name" cols="20" rows="10"><txt></textarea>',
304 Xml
::textarea( 'name', '<txt>', 20, 10 ),
305 'textarea() with custom attribs'
312 public function testLabelCreation() {
314 '<label for="id">name</label>',
315 Xml
::label( 'name', 'id' ),
316 'label() with no attribs'
323 public function testLabelAttributeCanOnlyBeClassOrTitle() {
325 '<label for="id">name</label>',
326 Xml
::label( 'name', 'id', [ 'generated' => true ] ),
327 'label() can not be given a generated attribute'
330 '<label for="id" class="nice">name</label>',
331 Xml
::label( 'name', 'id', [ 'class' => 'nice' ] ),
332 'label() can get a class attribute'
335 '<label for="id" title="nice tooltip">name</label>',
336 Xml
::label( 'name', 'id', [ 'title' => 'nice tooltip' ] ),
337 'label() can get a title attribute'
340 '<label for="id" class="nice" title="nice tooltip">name</label>',
341 Xml
::label( 'name', 'id', [
344 'title' => 'nice tooltip',
345 'anotherattr' => 'value',
348 'label() skip all attributes but "class" and "title"'
353 * @covers Xml::languageSelector
355 public function testLanguageSelector() {
356 $select = Xml
::languageSelector( 'en', true, null,
357 [ 'id' => 'testlang' ], wfMessage( 'yourlanguage' ) );
359 '<label for="testlang">Language:</label>',
365 * @covers Xml::encodeJsVar
367 public function testEncodeJsVarBoolean() {
370 Xml
::encodeJsVar( true ),
371 'encodeJsVar() with boolean'
376 * @covers Xml::encodeJsVar
378 public function testEncodeJsVarNull() {
381 Xml
::encodeJsVar( null ),
382 'encodeJsVar() with null'
387 * @covers Xml::encodeJsVar
389 public function testEncodeJsVarArray() {
392 Xml
::encodeJsVar( [ 'a', 1 ] ),
393 'encodeJsVar() with array'
397 Xml
::encodeJsVar( [ 'a' => 'a', 'b' => 1 ] ),
398 'encodeJsVar() with associative array'
403 * @covers Xml::encodeJsVar
405 public function testEncodeJsVarObject() {
408 Xml
::encodeJsVar( (object)[ 'a' => 'a', 'b' => 1 ] ),
409 'encodeJsVar() with object'
414 * @covers Xml::encodeJsVar
416 public function testEncodeJsVarInt() {
419 Xml
::encodeJsVar( 123456 ),
420 'encodeJsVar() with int'
425 * @covers Xml::encodeJsVar
427 public function testEncodeJsVarFloat() {
430 Xml
::encodeJsVar( 1.23456 ),
431 'encodeJsVar() with float'
436 * @covers Xml::encodeJsVar
438 public function testEncodeJsVarIntString() {
441 Xml
::encodeJsVar( '123456' ),
442 'encodeJsVar() with int-like string'
447 * @covers Xml::encodeJsVar
449 public function testEncodeJsVarFloatString() {
452 Xml
::encodeJsVar( '1.23456' ),
453 'encodeJsVar() with float-like string'
458 * @covers Xml::listDropDown
460 public function testListDropDown() {
462 '<select name="test-name" id="test-name" class="test-css" tabindex="2">' .
463 '<option value="other">other reasons</option>' . "\n" .
464 '<optgroup label="Foo">' .
465 '<option value="Foo 1">Foo 1</option>' . "\n" .
466 '<option value="Example" selected="">Example</option>' . "\n" .
467 '</optgroup>' . "\n" .
468 '<optgroup label="Bar">' .
469 '<option value="Bar 1">Bar 1</option>' . "\n" .
476 "* Foo\n** Foo 1\n** Example\n* Bar\n** Bar 1",
490 * @covers Xml::listDropDownOptions
492 public function testListDropDownOptions() {
495 'other reasons' => 'other',
498 'Example' => 'Example',
504 Xml
::listDropDownOptions(
505 "* Foo\n** Foo 1\n** Example\n* Bar\n** Bar 1",
506 [ 'other' => 'other reasons' ]
512 * @covers Xml::listDropDownOptionsOoui
514 public function testListDropDownOptionsOoui() {
517 [ 'data' => 'other', 'label' => 'other reasons' ],
518 [ 'optgroup' => 'Foo' ],
519 [ 'data' => 'Foo 1', 'label' => 'Foo 1' ],
520 [ 'data' => 'Example', 'label' => 'Example' ],
521 [ 'optgroup' => 'Bar' ],
522 [ 'data' => 'Bar 1', 'label' => 'Bar 1' ],
524 Xml
::listDropDownOptionsOoui( [
525 'other reasons' => 'other',
528 'Example' => 'Example',
538 * @covers Xml::fieldset
540 public function testFieldset() {
548 Xml
::fieldset( false ),
549 'Opening tag (false means no legend)'
554 'Opening tag (empty string also means no legend)'
557 "<fieldset>\n<legend>Foo</legend>\n",
558 Xml
::fieldset( 'Foo' ),
559 'Opening tag with legend'
562 "<fieldset>\n<legend>Foo</legend>\nBar\n</fieldset>\n",
563 Xml
::fieldset( 'Foo', 'Bar' ),
564 'Entire element with legend'
567 "<fieldset>\n<legend>Foo</legend>\n",
568 Xml
::fieldset( 'Foo', false ),
569 'Opening tag with legend (false means no content and no closing tag)'
572 "<fieldset>\n<legend>Foo</legend>\n\n</fieldset>\n",
573 Xml
::fieldset( 'Foo', '' ),
574 'Entire element with legend but no content (empty string generates a closing tag)'
577 "<fieldset class=\"bar\">\n<legend>Foo</legend>\nBar\n</fieldset>\n",
578 Xml
::fieldset( 'Foo', 'Bar', [ 'class' => 'bar' ] ),
579 'Opening tag with legend and attributes'
582 "<fieldset class=\"bar\">\n<legend>Foo</legend>\n",
583 Xml
::fieldset( 'Foo', false, [ 'class' => 'bar' ] ),
584 'Entire element with legend and attributes'
589 * @covers Xml::buildTable
591 public function testBuildTable() {
592 $firstRow = [ 'foo', 'bar' ];
593 $secondRow = [ 'Berlin', 'Tehran' ];
594 $headers = [ 'header1', 'header2' ];
595 $expected = '<table id="testTable"><thead id="testTable"><th>header1</th>' .
596 '<th>header2</th></thead><tr><td>foo</td><td>bar</td></tr><tr><td>Berlin</td>' .
597 '<td>Tehran</td></tr></table>';
601 [ $firstRow, $secondRow ],
602 [ 'id' => 'testTable' ],
609 * @covers Xml::buildTableRow
611 public function testBuildTableRow() {
613 '<tr id="testRow"><td>foo</td><td>bar</td></tr>',
614 Xml
::buildTableRow( [ 'id' => 'testRow' ], [ 'foo', 'bar' ] )