MediaWiki  master
HtmlTest.php
Go to the documentation of this file.
1 <?php
2 
3 class HtmlTest extends MediaWikiTestCase {
4  private $restoreWarnings;
5 
6  protected function setUp() {
7  parent::setUp();
8 
9  $this->setMwGlobals( [
10  'wgUseMediaWikiUIEverywhere' => false,
11  ] );
12 
13  $contLangObj = Language::factory( 'en' );
14 
15  // Hardcode namespaces during test runs,
16  // so that html output based on existing namespaces
17  // can be properly evaluated.
18  $contLangObj->setNamespaces( [
19  -2 => 'Media',
20  -1 => 'Special',
21  0 => '',
22  1 => 'Talk',
23  2 => 'User',
24  3 => 'User_talk',
25  4 => 'MyWiki',
26  5 => 'MyWiki_Talk',
27  6 => 'File',
28  7 => 'File_talk',
29  8 => 'MediaWiki',
30  9 => 'MediaWiki_talk',
31  10 => 'Template',
32  11 => 'Template_talk',
33  14 => 'Category',
34  15 => 'Category_talk',
35  100 => 'Custom',
36  101 => 'Custom_talk',
37  ] );
38  $this->setContentLang( $contLangObj );
39 
40  $userLangObj = Language::factory( 'es' );
41  $userLangObj->setNamespaces( [
42  -2 => "Medio",
43  -1 => "Especial",
44  0 => "",
45  1 => "Discusión",
46  2 => "Usuario",
47  3 => "Usuario discusión",
48  4 => "Wiki",
49  5 => "Wiki discusión",
50  6 => "Archivo",
51  7 => "Archivo discusión",
52  8 => "MediaWiki",
53  9 => "MediaWiki discusión",
54  10 => "Plantilla",
55  11 => "Plantilla discusión",
56  12 => "Ayuda",
57  13 => "Ayuda discusión",
58  14 => "Categoría",
59  15 => "Categoría discusión",
60  100 => "Personalizado",
61  101 => "Personalizado discusión",
62  ] );
63  $this->setUserLang( $userLangObj );
64 
65  $this->restoreWarnings = false;
66  }
67 
68  protected function tearDown() {
69  Language::factory( 'en' )->resetNamespaces();
70 
71  if ( $this->restoreWarnings ) {
72  $this->restoreWarnings = false;
73  Wikimedia\restoreWarnings();
74  }
75 
76  parent::tearDown();
77  }
78 
84  public function testOpenElement() {
85  Html::openElement( 'span id="x"' );
86  }
87 
94  public function testElementBasics() {
95  $this->assertEquals(
96  '<img/>',
97  Html::element( 'img', null, '' ),
98  'Self-closing tag for short-tag elements'
99  );
100 
101  $this->assertEquals(
102  '<element></element>',
103  Html::element( 'element', null, null ),
104  'Close tag for empty element (null, null)'
105  );
106 
107  $this->assertEquals(
108  '<element></element>',
109  Html::element( 'element', [], '' ),
110  'Close tag for empty element (array, string)'
111  );
112  }
113 
114  public function dataXmlMimeType() {
115  return [
116  // ( $mimetype, $isXmlMimeType )
117  # HTML is not an XML MimeType
118  [ 'text/html', false ],
119  # XML is an XML MimeType
120  [ 'text/xml', true ],
121  [ 'application/xml', true ],
122  # XHTML is an XML MimeType
123  [ 'application/xhtml+xml', true ],
124  # Make sure other +xml MimeTypes are supported
125  # SVG is another random MimeType even though we don't use it
126  [ 'image/svg+xml', true ],
127  # Complete random other MimeTypes are not XML
128  [ 'text/plain', false ],
129  ];
130  }
131 
136  public function testXmlMimeType( $mimetype, $isXmlMimeType ) {
137  $this->assertEquals( $isXmlMimeType, Html::isXmlMimeType( $mimetype ) );
138  }
139 
144  # ## EMPTY ########
145  $this->assertEmpty(
146  Html::expandAttributes( [ 'foo' => null ] ),
147  'skip keys with null value'
148  );
149  $this->assertEmpty(
150  Html::expandAttributes( [ 'foo' => false ] ),
151  'skip keys with false value'
152  );
153  $this->assertEquals(
154  ' foo=""',
155  Html::expandAttributes( [ 'foo' => '' ] ),
156  'keep keys with an empty string'
157  );
158  }
159 
164  $this->assertEquals(
165  '',
166  Html::expandAttributes( [ 'selected' => false ] ),
167  'Boolean attributes do not generates output when value is false'
168  );
169  $this->assertEquals(
170  '',
171  Html::expandAttributes( [ 'selected' => null ] ),
172  'Boolean attributes do not generates output when value is null'
173  );
174 
175  $this->assertEquals(
176  ' selected=""',
177  Html::expandAttributes( [ 'selected' => true ] ),
178  'Boolean attributes have no value when value is true'
179  );
180  $this->assertEquals(
181  ' selected=""',
182  Html::expandAttributes( [ 'selected' ] ),
183  'Boolean attributes have no value when value is true (passed as numerical array)'
184  );
185  }
186 
190  public function testExpandAttributesForNumbers() {
191  $this->assertEquals(
192  ' value="1"',
193  Html::expandAttributes( [ 'value' => 1 ] ),
194  'Integer value is cast to a string'
195  );
196  $this->assertEquals(
197  ' value="1.1"',
198  Html::expandAttributes( [ 'value' => 1.1 ] ),
199  'Float value is cast to a string'
200  );
201  }
202 
206  public function testExpandAttributesForObjects() {
207  $this->assertEquals(
208  ' value="stringValue"',
209  Html::expandAttributes( [ 'value' => new HtmlTestValue() ] ),
210  'Object value is converted to a string'
211  );
212  }
213 
219  # ## NOT EMPTY ####
220  $this->assertEquals(
221  ' empty_string=""',
222  Html::expandAttributes( [ 'empty_string' => '' ] ),
223  'Empty string is always quoted'
224  );
225  $this->assertEquals(
226  ' key="value"',
227  Html::expandAttributes( [ 'key' => 'value' ] ),
228  'Simple string value needs no quotes'
229  );
230  $this->assertEquals(
231  ' one="1"',
232  Html::expandAttributes( [ 'one' => 1 ] ),
233  'Number 1 value needs no quotes'
234  );
235  $this->assertEquals(
236  ' zero="0"',
237  Html::expandAttributes( [ 'zero' => 0 ] ),
238  'Number 0 value needs no quotes'
239  );
240  }
241 
249  # ## STRING VALUES
250  $this->assertEquals(
251  ' class="redundant spaces here"',
252  Html::expandAttributes( [ 'class' => ' redundant spaces here ' ] ),
253  'Normalization should strip redundant spaces'
254  );
255  $this->assertEquals(
256  ' class="foo bar"',
257  Html::expandAttributes( [ 'class' => 'foo bar foo bar bar' ] ),
258  'Normalization should remove duplicates in string-lists'
259  );
260  # ## "EMPTY" ARRAY VALUES
261  $this->assertEquals(
262  ' class=""',
263  Html::expandAttributes( [ 'class' => [] ] ),
264  'Value with an empty array'
265  );
266  $this->assertEquals(
267  ' class=""',
268  Html::expandAttributes( [ 'class' => [ null, '', ' ', ' ' ] ] ),
269  'Array with null, empty string and spaces'
270  );
271  # ## NON-EMPTY ARRAY VALUES
272  $this->assertEquals(
273  ' class="foo bar"',
274  Html::expandAttributes( [ 'class' => [
275  'foo',
276  'bar',
277  'foo',
278  'bar',
279  'bar',
280  ] ] ),
281  'Normalization should remove duplicates in the array'
282  );
283  $this->assertEquals(
284  ' class="foo bar"',
285  Html::expandAttributes( [ 'class' => [
286  'foo bar',
287  'bar foo',
288  'foo',
289  'bar bar',
290  ] ] ),
291  'Normalization should remove duplicates in string-lists in the array'
292  );
293  }
294 
301  $this->assertEquals(
302  ' class="booltrue one"',
303  Html::expandAttributes( [ 'class' => [
304  'booltrue' => true,
305  'one' => 1,
306 
307  # Method use isset() internally, make sure we do discard
308  # attributes values which have been assigned well known values
309  'emptystring' => '',
310  'boolfalse' => false,
311  'zero' => 0,
312  'null' => null,
313  ] ] )
314  );
315  }
316 
326  $this->assertEquals(
327  ' class=""',
328  Html::expandAttributes( [ 'class' => [
329  'GREEN',
330  'GREEN' => false,
331  'GREEN',
332  ] ] )
333  );
334  }
335 
341  // Real-life test case found in the Popups extension (see Gerrit cf0fd64),
342  // when used with an outdated BetaFeatures extension (see Gerrit deda1e7)
344  'src' => [
345  'ltr' => 'ltr.svg',
346  'rtl' => 'rtl.svg'
347  ]
348  ] );
349  }
350 
355  public function testNamespaceSelector() {
356  $this->assertEquals(
357  '<select id="namespace" name="namespace">' . "\n" .
358  '<option value="0">(Principal)</option>' . "\n" .
359  '<option value="1">Talk</option>' . "\n" .
360  '<option value="2">User</option>' . "\n" .
361  '<option value="3">User talk</option>' . "\n" .
362  '<option value="4">MyWiki</option>' . "\n" .
363  '<option value="5">MyWiki Talk</option>' . "\n" .
364  '<option value="6">File</option>' . "\n" .
365  '<option value="7">File talk</option>' . "\n" .
366  '<option value="8">MediaWiki</option>' . "\n" .
367  '<option value="9">MediaWiki talk</option>' . "\n" .
368  '<option value="10">Template</option>' . "\n" .
369  '<option value="11">Template talk</option>' . "\n" .
370  '<option value="14">Category</option>' . "\n" .
371  '<option value="15">Category talk</option>' . "\n" .
372  '<option value="100">Custom</option>' . "\n" .
373  '<option value="101">Custom talk</option>' . "\n" .
374  '</select>',
376  'Basic namespace selector without custom options'
377  );
378 
379  $this->assertEquals(
380  '<label for="mw-test-namespace">Select a namespace:</label>' . "\u{00A0}" .
381  '<select id="mw-test-namespace" name="wpNamespace">' . "\n" .
382  '<option value="all">todos</option>' . "\n" .
383  '<option value="0">(Principal)</option>' . "\n" .
384  '<option value="1">Talk</option>' . "\n" .
385  '<option value="2" selected="">User</option>' . "\n" .
386  '<option value="3">User talk</option>' . "\n" .
387  '<option value="4">MyWiki</option>' . "\n" .
388  '<option value="5">MyWiki Talk</option>' . "\n" .
389  '<option value="6">File</option>' . "\n" .
390  '<option value="7">File talk</option>' . "\n" .
391  '<option value="8">MediaWiki</option>' . "\n" .
392  '<option value="9">MediaWiki talk</option>' . "\n" .
393  '<option value="10">Template</option>' . "\n" .
394  '<option value="11">Template talk</option>' . "\n" .
395  '<option value="14">Category</option>' . "\n" .
396  '<option value="15">Category talk</option>' . "\n" .
397  '<option value="100">Custom</option>' . "\n" .
398  '<option value="101">Custom talk</option>' . "\n" .
399  '</select>',
401  [ 'selected' => '2', 'all' => 'all', 'label' => 'Select a namespace:' ],
402  [ 'name' => 'wpNamespace', 'id' => 'mw-test-namespace' ]
403  ),
404  'Basic namespace selector with custom values'
405  );
406 
407  $this->assertEquals(
408  '<label for="namespace">Select a namespace:</label>' . "\u{00A0}" .
409  '<select id="namespace" name="namespace">' . "\n" .
410  '<option value="0">(Principal)</option>' . "\n" .
411  '<option value="1">Talk</option>' . "\n" .
412  '<option value="2">User</option>' . "\n" .
413  '<option value="3">User talk</option>' . "\n" .
414  '<option value="4">MyWiki</option>' . "\n" .
415  '<option value="5">MyWiki Talk</option>' . "\n" .
416  '<option value="6">File</option>' . "\n" .
417  '<option value="7">File talk</option>' . "\n" .
418  '<option value="8">MediaWiki</option>' . "\n" .
419  '<option value="9">MediaWiki talk</option>' . "\n" .
420  '<option value="10">Template</option>' . "\n" .
421  '<option value="11">Template talk</option>' . "\n" .
422  '<option value="14">Category</option>' . "\n" .
423  '<option value="15">Category talk</option>' . "\n" .
424  '<option value="100">Custom</option>' . "\n" .
425  '<option value="101">Custom talk</option>' . "\n" .
426  '</select>',
428  [ 'label' => 'Select a namespace:' ]
429  ),
430  'Basic namespace selector with a custom label but no id attribtue for the <select>'
431  );
432 
433  $this->assertEquals(
434  '<select id="namespace" name="namespace">' . "\n" .
435  '<option value="0">(Principal)</option>' . "\n" .
436  '<option value="1">Discusión</option>' . "\n" .
437  '<option value="2">Usuario</option>' . "\n" .
438  '<option value="3">Usuario discusión</option>' . "\n" .
439  '<option value="4">Wiki</option>' . "\n" .
440  '<option value="5">Wiki discusión</option>' . "\n" .
441  '<option value="6">Archivo</option>' . "\n" .
442  '<option value="7">Archivo discusión</option>' . "\n" .
443  '<option value="8">MediaWiki</option>' . "\n" .
444  '<option value="9">MediaWiki discusión</option>' . "\n" .
445  '<option value="10">Plantilla</option>' . "\n" .
446  '<option value="11">Plantilla discusión</option>' . "\n" .
447  '<option value="12">Ayuda</option>' . "\n" .
448  '<option value="13">Ayuda discusión</option>' . "\n" .
449  '<option value="14">Categoría</option>' . "\n" .
450  '<option value="15">Categoría discusión</option>' . "\n" .
451  '<option value="100">Personalizado</option>' . "\n" .
452  '<option value="101">Personalizado discusión</option>' . "\n" .
453  '</select>',
455  [ 'in-user-lang' => true ]
456  ),
457  'Basic namespace selector in user language'
458  );
459  }
460 
464  public function testCanFilterOutNamespaces() {
465  $this->assertEquals(
466  '<select id="namespace" name="namespace">' . "\n" .
467  '<option value="2">User</option>' . "\n" .
468  '<option value="4">MyWiki</option>' . "\n" .
469  '<option value="5">MyWiki Talk</option>' . "\n" .
470  '<option value="6">File</option>' . "\n" .
471  '<option value="7">File talk</option>' . "\n" .
472  '<option value="8">MediaWiki</option>' . "\n" .
473  '<option value="9">MediaWiki talk</option>' . "\n" .
474  '<option value="10">Template</option>' . "\n" .
475  '<option value="11">Template talk</option>' . "\n" .
476  '<option value="14">Category</option>' . "\n" .
477  '<option value="15">Category talk</option>' . "\n" .
478  '</select>',
480  [ 'exclude' => [ 0, 1, 3, 100, 101 ] ]
481  ),
482  'Namespace selector namespace filtering.'
483  );
484  }
485 
489  public function testCanDisableANamespaces() {
490  $this->assertEquals(
491  '<select id="namespace" name="namespace">' . "\n" .
492  '<option disabled="" value="0">(Principal)</option>' . "\n" .
493  '<option disabled="" value="1">Talk</option>' . "\n" .
494  '<option disabled="" value="2">User</option>' . "\n" .
495  '<option disabled="" value="3">User talk</option>' . "\n" .
496  '<option disabled="" value="4">MyWiki</option>' . "\n" .
497  '<option value="5">MyWiki Talk</option>' . "\n" .
498  '<option value="6">File</option>' . "\n" .
499  '<option value="7">File talk</option>' . "\n" .
500  '<option value="8">MediaWiki</option>' . "\n" .
501  '<option value="9">MediaWiki talk</option>' . "\n" .
502  '<option value="10">Template</option>' . "\n" .
503  '<option value="11">Template talk</option>' . "\n" .
504  '<option value="14">Category</option>' . "\n" .
505  '<option value="15">Category talk</option>' . "\n" .
506  '<option value="100">Custom</option>' . "\n" .
507  '<option value="101">Custom talk</option>' . "\n" .
508  '</select>',
510  'disable' => [ 0, 1, 2, 3, 4 ]
511  ] ),
512  'Namespace selector namespace disabling'
513  );
514  }
515 
520  public function testHtmlElementAcceptsNewHtml5TypesInHtml5Mode( $HTML5InputType ) {
521  $this->assertEquals(
522  '<input type="' . $HTML5InputType . '"/>',
523  Html::element( 'input', [ 'type' => $HTML5InputType ] ),
524  'In HTML5, Html::element() should accept type="' . $HTML5InputType . '"'
525  );
526  }
527 
532  public function testWarningBox() {
533  $this->assertEquals(
534  Html::warningBox( 'warn' ),
535  '<div class="warningbox">warn</div>'
536  );
537  }
538 
543  public function testErrorBox() {
544  $this->assertEquals(
545  Html::errorBox( 'err' ),
546  '<div class="errorbox">err</div>'
547  );
548  $this->assertEquals(
549  Html::errorBox( 'err', 'heading' ),
550  '<div class="errorbox"><h2>heading</h2>err</div>'
551  );
552  $this->assertEquals(
553  Html::errorBox( 'err', '0' ),
554  '<div class="errorbox"><h2>0</h2>err</div>'
555  );
556  }
557 
562  public function testSuccessBox() {
563  $this->assertEquals(
564  Html::successBox( 'great' ),
565  '<div class="successbox">great</div>'
566  );
567  $this->assertEquals(
568  Html::successBox( '<script>beware no escaping!</script>' ),
569  '<div class="successbox"><script>beware no escaping!</script></div>'
570  );
571  }
572 
577  public static function provideHtml5InputTypes() {
578  $types = [
579  'datetime',
580  'datetime-local',
581  'date',
582  'month',
583  'time',
584  'week',
585  'number',
586  'range',
587  'email',
588  'url',
589  'search',
590  'tel',
591  'color',
592  ];
593  $cases = [];
594  foreach ( $types as $type ) {
595  $cases[] = [ $type ];
596  }
597 
598  return $cases;
599  }
600 
606  public function testDropDefaults( $expected, $element, $attribs, $message = '' ) {
607  $this->assertEquals( $expected, Html::element( $element, $attribs ), $message );
608  }
609 
611  # Use cases in a concise format:
612  # <expected>, <element name>, <array of attributes> [, <message>]
613  # Will be mapped to Html::element()
614  $cases = [];
615 
616  # ## Generic cases, match $attribDefault static array
617  $cases[] = [ '<area/>',
618  'area', [ 'shape' => 'rect' ]
619  ];
620 
621  $cases[] = [ '<button type="submit"></button>',
622  'button', [ 'formaction' => 'GET' ]
623  ];
624  $cases[] = [ '<button type="submit"></button>',
625  'button', [ 'formenctype' => 'application/x-www-form-urlencoded' ]
626  ];
627 
628  $cases[] = [ '<canvas></canvas>',
629  'canvas', [ 'height' => '150' ]
630  ];
631  $cases[] = [ '<canvas></canvas>',
632  'canvas', [ 'width' => '300' ]
633  ];
634  # Also check with numeric values
635  $cases[] = [ '<canvas></canvas>',
636  'canvas', [ 'height' => 150 ]
637  ];
638  $cases[] = [ '<canvas></canvas>',
639  'canvas', [ 'width' => 300 ]
640  ];
641 
642  $cases[] = [ '<form></form>',
643  'form', [ 'action' => 'GET' ]
644  ];
645  $cases[] = [ '<form></form>',
646  'form', [ 'autocomplete' => 'on' ]
647  ];
648  $cases[] = [ '<form></form>',
649  'form', [ 'enctype' => 'application/x-www-form-urlencoded' ]
650  ];
651 
652  $cases[] = [ '<input/>',
653  'input', [ 'formaction' => 'GET' ]
654  ];
655  $cases[] = [ '<input/>',
656  'input', [ 'type' => 'text' ]
657  ];
658 
659  $cases[] = [ '<keygen/>',
660  'keygen', [ 'keytype' => 'rsa' ]
661  ];
662 
663  $cases[] = [ '<link/>',
664  'link', [ 'media' => 'all' ]
665  ];
666 
667  $cases[] = [ '<menu></menu>',
668  'menu', [ 'type' => 'list' ]
669  ];
670 
671  $cases[] = [ '<script></script>',
672  'script', [ 'type' => 'text/javascript' ]
673  ];
674 
675  $cases[] = [ '<style></style>',
676  'style', [ 'media' => 'all' ]
677  ];
678  $cases[] = [ '<style></style>',
679  'style', [ 'type' => 'text/css' ]
680  ];
681 
682  $cases[] = [ '<textarea></textarea>',
683  'textarea', [ 'wrap' => 'soft' ]
684  ];
685 
686  # ## SPECIFIC CASES
687 
688  # <link type="text/css">
689  $cases[] = [ '<link/>',
690  'link', [ 'type' => 'text/css' ]
691  ];
692 
693  # <input> specific handling
694  $cases[] = [ '<input type="checkbox"/>',
695  'input', [ 'type' => 'checkbox', 'value' => 'on' ],
696  'Default value "on" is stripped of checkboxes',
697  ];
698  $cases[] = [ '<input type="radio"/>',
699  'input', [ 'type' => 'radio', 'value' => 'on' ],
700  'Default value "on" is stripped of radio buttons',
701  ];
702  $cases[] = [ '<input type="submit" value="Submit"/>',
703  'input', [ 'type' => 'submit', 'value' => 'Submit' ],
704  'Default value "Submit" is kept on submit buttons (for possible l10n issues)',
705  ];
706  $cases[] = [ '<input type="color"/>',
707  'input', [ 'type' => 'color', 'value' => '' ],
708  ];
709  $cases[] = [ '<input type="range"/>',
710  'input', [ 'type' => 'range', 'value' => '' ],
711  ];
712 
713  # <button> specific handling
714  # see remarks on https://msdn.microsoft.com/library/ms535211(v=vs.85).aspx
715  $cases[] = [ '<button type="submit"></button>',
716  'button', [ 'type' => 'submit' ],
717  'According to standard the default type is "submit". '
718  . 'Depending on compatibility mode IE might use "button", instead.',
719  ];
720 
721  # <select> specific handling
722  $cases[] = [ '<select multiple=""></select>',
723  'select', [ 'size' => '4', 'multiple' => true ],
724  ];
725  # .. with numeric value
726  $cases[] = [ '<select multiple=""></select>',
727  'select', [ 'size' => 4, 'multiple' => true ],
728  ];
729  $cases[] = [ '<select></select>',
730  'select', [ 'size' => '1', 'multiple' => false ],
731  ];
732  # .. with numeric value
733  $cases[] = [ '<select></select>',
734  'select', [ 'size' => 1, 'multiple' => false ],
735  ];
736 
737  # Passing an array as value
738  $cases[] = [ '<a class="css-class-one css-class-two"></a>',
739  'a', [ 'class' => [ 'css-class-one', 'css-class-two' ] ],
740  "dropDefaults accepts values given as an array"
741  ];
742 
743  # FIXME: doDropDefault should remove defaults given in an array
744  # Expected should be '<a></a>'
745  $cases[] = [ '<a class=""></a>',
746  'a', [ 'class' => [ '', '' ] ],
747  "dropDefaults accepts values given as an array"
748  ];
749 
750  # Craft the Html elements
751  $ret = [];
752  foreach ( $cases as $case ) {
753  $ret[] = [
754  $case[0],
755  $case[1], $case[2],
756  $case[3] ?? ''
757  ];
758  }
759 
760  return $ret;
761  }
762 
766  public function testWrapperInput() {
767  $this->assertEquals(
768  '<input type="radio" value="testval" name="testname"/>',
769  Html::input( 'testname', 'testval', 'radio' ),
770  'Input wrapper with type and value.'
771  );
772  $this->assertEquals(
773  '<input name="testname"/>',
774  Html::input( 'testname' ),
775  'Input wrapper with all default values.'
776  );
777  }
778 
782  public function testWrapperCheck() {
783  $this->assertEquals(
784  '<input type="checkbox" value="1" name="testname"/>',
785  Html::check( 'testname' ),
786  'Checkbox wrapper unchecked.'
787  );
788  $this->assertEquals(
789  '<input checked="" type="checkbox" value="1" name="testname"/>',
790  Html::check( 'testname', true ),
791  'Checkbox wrapper checked.'
792  );
793  $this->assertEquals(
794  '<input type="checkbox" value="testval" name="testname"/>',
795  Html::check( 'testname', false, [ 'value' => 'testval' ] ),
796  'Checkbox wrapper with a value override.'
797  );
798  }
799 
803  public function testWrapperRadio() {
804  $this->assertEquals(
805  '<input type="radio" value="1" name="testname"/>',
806  Html::radio( 'testname' ),
807  'Radio wrapper unchecked.'
808  );
809  $this->assertEquals(
810  '<input checked="" type="radio" value="1" name="testname"/>',
811  Html::radio( 'testname', true ),
812  'Radio wrapper checked.'
813  );
814  $this->assertEquals(
815  '<input type="radio" value="testval" name="testname"/>',
816  Html::radio( 'testname', false, [ 'value' => 'testval' ] ),
817  'Radio wrapper with a value override.'
818  );
819  }
820 
824  public function testWrapperLabel() {
825  $this->assertEquals(
826  '<label for="testid">testlabel</label>',
827  Html::label( 'testlabel', 'testid' ),
828  'Label wrapper'
829  );
830  }
831 
832  public static function provideSrcSetImages() {
833  return [
834  [ [], '', 'when there are no images, return empty string' ],
835  [
836  [ '1x' => '1x.png', '1.5x' => '1_5x.png', '2x' => '2x.png' ],
837  '1x.png 1x, 1_5x.png 1.5x, 2x.png 2x',
838  'pixel depth keys may include a trailing "x"'
839  ],
840  [
841  [ '1' => '1x.png', '1.5' => '1_5x.png', '2' => '2x.png' ],
842  '1x.png 1x, 1_5x.png 1.5x, 2x.png 2x',
843  'pixel depth keys may omit a trailing "x"'
844  ],
845  [
846  [ '1' => 'small.png', '1.5' => 'large.png', '2' => 'large.png' ],
847  'small.png 1x, large.png 1.5x',
848  'omit larger duplicates'
849  ],
850  [
851  [ '1' => 'small.png', '2' => 'large.png', '1.5' => 'large.png' ],
852  'small.png 1x, large.png 1.5x',
853  'omit larger duplicates in irregular order'
854  ],
855  ];
856  }
857 
862  public function testSrcSet( $images, $expected, $message ) {
863  $this->assertEquals( Html::srcSet( $images ), $expected, $message );
864  }
865 
866  public static function provideInlineScript() {
867  return [
868  'Empty' => [
869  '',
870  '<script></script>'
871  ],
872  'Simple' => [
873  'EXAMPLE.label("foo");',
874  '<script>EXAMPLE.label("foo");</script>'
875  ],
876  'Ampersand' => [
877  'EXAMPLE.is(a && b);',
878  '<script>EXAMPLE.is(a && b);</script>'
879  ],
880  'HTML' => [
881  'EXAMPLE.label("<a>");',
882  '<script>EXAMPLE.label("<a>");</script>'
883  ],
884  'Script closing string (lower)' => [
885  'EXAMPLE.label("</script>");',
886  '<script>/* ERROR: Invalid script */</script>',
887  true,
888  ],
889  'Script closing with non-standard attributes (mixed)' => [
890  'EXAMPLE.label("</SCriPT and STyLE>");',
891  '<script>/* ERROR: Invalid script */</script>',
892  true,
893  ],
894  'HTML-comment-open and script-open' => [
895  // In HTML, <script> contents aren't just plain CDATA until </script>,
896  // there are levels of escaping modes, and the below sequence puts an
897  // HTML parser in a state where </script> would *not* close the script.
898  // https://html.spec.whatwg.org/multipage/parsing.html#script-data-double-escape-end-state
899  'var a = "<!--<script>";',
900  '<script>/* ERROR: Invalid script */</script>',
901  true,
902  ],
903  ];
904  }
905 
910  public function testInlineScript( $code, $expected, $error = false ) {
911  if ( $error ) {
912  Wikimedia\suppressWarnings();
913  $this->restoreWarnings = true;
914  }
915  $this->assertSame( Html::inlineScript( $code ), $expected );
916  }
917 }
918 
920  function __toString() {
921  return 'stringValue';
922  }
923 }
testExpandAttributes_ArrayOnNonListValueAttribute_ThrowsException()
Html::expandAttributes MWException
Definition: HtmlTest.php:340
testWrapperCheck()
Html::check
Definition: HtmlTest.php:782
$restoreWarnings
Definition: HtmlTest.php:4
testCanDisableANamespaces()
Html::namespaceSelector
Definition: HtmlTest.php:489
static radio( $name, $checked=false, array $attribs=[])
Convenience function to produce a radio button (input element with type=radio)
Definition: Html.php:758
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:232
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
testErrorBox()
Html::errorBox Html::messageBox
Definition: HtmlTest.php:543
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:1982
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static provideHtml5InputTypes()
List of input element types values introduced by HTML5 Full list at https://www.w3.org/TR/html-markup/input.html.
Definition: HtmlTest.php:577
static openElement( $element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing &#39;/&#39;...
Definition: Html.php:252
static warningBox( $html)
Return a warning box.
Definition: Html.php:725
testElementBasics()
Html::element Html::rawElement Html::openElement Html::closeElement.
Definition: HtmlTest.php:94
tearDown()
Definition: HtmlTest.php:68
page as well
testExpandAttributesVariousExpansions()
Please note it output a string prefixed with a space! Html::expandAttributes.
Definition: HtmlTest.php:218
static inlineScript( $contents, $nonce=null)
Output an HTML script tag with the given contents.
Definition: Html.php:573
testCanFilterOutNamespaces()
Html::namespaceSelector
Definition: HtmlTest.php:464
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 just before the function returns a value If you return true
Definition: hooks.txt:1982
testSrcSet( $images, $expected, $message)
provideSrcSetImages Html::srcSet
Definition: HtmlTest.php:862
testExpandAttributesForNumbers()
Html::expandAttributes
Definition: HtmlTest.php:190
testExpandAttributesSpaceSeparatedAttributesWithBoolean()
Test feature added by r96188, let pass attributes values as a PHP array.
Definition: HtmlTest.php:300
testExpandAttributesListValueAttributes()
Html::expandAttributes has special features for HTML attributes that use space separated lists and al...
Definition: HtmlTest.php:248
testWrapperRadio()
Html::radio
Definition: HtmlTest.php:803
testExpandAttributesForObjects()
Html::expandAttributes
Definition: HtmlTest.php:206
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 just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:1982
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:216
static expandAttributes(array $attribs)
Given an associative array of element attributes, generate a string to stick after the element name i...
Definition: Html.php:481
static input( $name, $value='', $type='text', array $attribs=[])
Convenience function to produce an "<input>" element.
Definition: Html.php:668
setMwGlobals( $pairs, $value=null)
Sets a global, maintaining a stashed version of the previous global to be restored in tearDown...
testInlineScript( $code, $expected, $error=false)
provideInlineScript Html::inlineScript
Definition: HtmlTest.php:910
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:780
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
testExpandAttributesForBooleans()
Html::expandAttributes
Definition: HtmlTest.php:163
static check( $name, $checked=false, array $attribs=[])
Convenience function to produce a checkbox (input element with type=checkbox)
Definition: Html.php:689
static srcSet(array $urls)
Generate a srcset attribute value.
Definition: Html.php:1065
dataXmlMimeType()
Definition: HtmlTest.php:114
static errorBox( $html, $heading='')
Return an error box.
Definition: Html.php:736
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
static provideInlineScript()
Definition: HtmlTest.php:866
testSuccessBox()
Html::successBox Html::messageBox
Definition: HtmlTest.php:562
testNamespaceSelector()
Html::namespaceSelector Html::namespaceSelectorOptions
Definition: HtmlTest.php:355
testWrapperLabel()
Html::label
Definition: HtmlTest.php:824
static successBox( $html)
Return a success box.
Definition: Html.php:746
static provideSrcSetImages()
Definition: HtmlTest.php:832
testOpenElement()
PHPUnit_Framework_Error_Notice given element name with space Html::openElement.
Definition: HtmlTest.php:84
testExpandAttributesSkipsNullAndFalse()
Html::expandAttributes
Definition: HtmlTest.php:143
static isXmlMimeType( $mimetype)
Determines if the given MIME type is xml.
Definition: Html.php:1000
testXmlMimeType( $mimetype, $isXmlMimeType)
dataXmlMimeType Html::isXmlMimeType
Definition: HtmlTest.php:136
testWarningBox()
Html::warningBox Html::messageBox
Definition: HtmlTest.php:532
testValueIsAuthoritativeInSpaceSeparatedAttributesArrays()
How do we handle duplicate keys in HTML attributes expansion? We could pass a "class" the values: &#39;GR...
Definition: HtmlTest.php:325
setUp()
Definition: HtmlTest.php:6
testDropDefaults( $expected, $element, $attribs, $message='')
Test out Html::element drops or enforces default value Html::dropDefaults provideElementsWithAttrib...
Definition: HtmlTest.php:606
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible values
Definition: hooks.txt:175
testWrapperInput()
Html::input
Definition: HtmlTest.php:766
testHtmlElementAcceptsNewHtml5TypesInHtml5Mode( $HTML5InputType)
provideHtml5InputTypes Html::element
Definition: HtmlTest.php:520
static provideElementsWithAttributesHavingDefaultValues()
Definition: HtmlTest.php:610
static label( $label, $id, array $attribs=[])
Convenience function for generating a label for inputs.
Definition: Html.php:781
static namespaceSelector(array $params=[], array $selectAttribs=[])
Build a drop-down box for selecting a namespace.
Definition: Html.php:889