MediaWiki REL1_34
BaseTemplate.php
Go to the documentation of this file.
1<?php
21use Wikimedia\WrappedString;
22use Wikimedia\WrappedStringList;
23
29abstract class BaseTemplate extends QuickTemplate {
30
38 public function getMsg( $name, ...$params ) {
39 return $this->getSkin()->msg( $name, ...$params );
40 }
41
42 function msg( $str ) {
43 echo $this->getMsg( $str )->escaped();
44 }
45
49 function msgWiki( $str ) {
50 wfDeprecated( __METHOD__, '1.33' ); // Hard-deprecated in 1.34
51 echo $this->getMsg( $str )->parseAsBlock();
52 }
53
61 function getToolbox() {
62 $toolbox = [];
63 if ( isset( $this->data['nav_urls']['whatlinkshere'] )
64 && $this->data['nav_urls']['whatlinkshere']
65 ) {
66 $toolbox['whatlinkshere'] = $this->data['nav_urls']['whatlinkshere'];
67 $toolbox['whatlinkshere']['id'] = 't-whatlinkshere';
68 }
69 if ( isset( $this->data['nav_urls']['recentchangeslinked'] )
70 && $this->data['nav_urls']['recentchangeslinked']
71 ) {
72 $toolbox['recentchangeslinked'] = $this->data['nav_urls']['recentchangeslinked'];
73 $toolbox['recentchangeslinked']['msg'] = 'recentchangeslinked-toolbox';
74 $toolbox['recentchangeslinked']['id'] = 't-recentchangeslinked';
75 $toolbox['recentchangeslinked']['rel'] = 'nofollow';
76 }
77 if ( isset( $this->data['feeds'] ) && $this->data['feeds'] ) {
78 $toolbox['feeds']['id'] = 'feedlinks';
79 $toolbox['feeds']['links'] = [];
80 foreach ( $this->data['feeds'] as $key => $feed ) {
81 $toolbox['feeds']['links'][$key] = $feed;
82 $toolbox['feeds']['links'][$key]['id'] = "feed-$key";
83 $toolbox['feeds']['links'][$key]['rel'] = 'alternate';
84 $toolbox['feeds']['links'][$key]['type'] = "application/{$key}+xml";
85 $toolbox['feeds']['links'][$key]['class'] = 'feedlink';
86 }
87 }
88 foreach ( [ 'contributions', 'log', 'blockip', 'emailuser', 'mute',
89 'userrights', 'upload', 'specialpages' ] as $special
90 ) {
91 if ( isset( $this->data['nav_urls'][$special] ) && $this->data['nav_urls'][$special] ) {
92 $toolbox[$special] = $this->data['nav_urls'][$special];
93 $toolbox[$special]['id'] = "t-$special";
94 }
95 }
96 if ( isset( $this->data['nav_urls']['print'] ) && $this->data['nav_urls']['print'] ) {
97 $toolbox['print'] = $this->data['nav_urls']['print'];
98 $toolbox['print']['id'] = 't-print';
99 $toolbox['print']['rel'] = 'alternate';
100 $toolbox['print']['msg'] = 'printableversion';
101 }
102 if ( isset( $this->data['nav_urls']['permalink'] ) && $this->data['nav_urls']['permalink'] ) {
103 $toolbox['permalink'] = $this->data['nav_urls']['permalink'];
104 $toolbox['permalink']['id'] = 't-permalink';
105 }
106 if ( isset( $this->data['nav_urls']['info'] ) && $this->data['nav_urls']['info'] ) {
107 $toolbox['info'] = $this->data['nav_urls']['info'];
108 $toolbox['info']['id'] = 't-info';
109 }
110
111 // Avoid PHP 7.1 warning from passing $this by reference
112 $template = $this;
113 Hooks::run( 'BaseTemplateToolbox', [ &$template, &$toolbox ] );
114 return $toolbox;
115 }
116
127 function getPersonalTools() {
128 $personal_tools = [];
129 foreach ( $this->get( 'personal_urls' ) as $key => $plink ) {
130 # The class on a personal_urls item is meant to go on the <a> instead
131 # of the <li> so we have to use a single item "links" array instead
132 # of using most of the personal_url's keys directly.
133 $ptool = [
134 'links' => [
135 [ 'single-id' => "pt-$key" ],
136 ],
137 'id' => "pt-$key",
138 ];
139 if ( isset( $plink['active'] ) ) {
140 $ptool['active'] = $plink['active'];
141 }
142 foreach ( [
143 'href',
144 'class',
145 'text',
146 'dir',
147 'data',
148 'exists',
149 'data-mw'
150 ] as $k ) {
151 if ( isset( $plink[$k] ) ) {
152 $ptool['links'][0][$k] = $plink[$k];
153 }
154 }
155 $personal_tools[$key] = $ptool;
156 }
157 return $personal_tools;
158 }
159
160 function getSidebar( $options = [] ) {
161 // Force the rendering of the following portals
162 $sidebar = $this->data['sidebar'];
163 if ( !isset( $sidebar['SEARCH'] ) ) {
164 $sidebar['SEARCH'] = true;
165 }
166 if ( !isset( $sidebar['TOOLBOX'] ) ) {
167 $sidebar['TOOLBOX'] = true;
168 }
169 if ( !isset( $sidebar['LANGUAGES'] ) ) {
170 $sidebar['LANGUAGES'] = true;
171 }
172
173 if ( !isset( $options['search'] ) || $options['search'] !== true ) {
174 unset( $sidebar['SEARCH'] );
175 }
176 if ( isset( $options['toolbox'] ) && $options['toolbox'] === false ) {
177 unset( $sidebar['TOOLBOX'] );
178 }
179 if ( isset( $options['languages'] ) && $options['languages'] === false ) {
180 unset( $sidebar['LANGUAGES'] );
181 }
182
183 $boxes = [];
184 foreach ( $sidebar as $boxName => $content ) {
185 if ( $content === false ) {
186 continue;
187 }
188 switch ( $boxName ) {
189 case 'SEARCH':
190 // Search is a special case, skins should custom implement this
191 $boxes[$boxName] = [
192 'id' => 'p-search',
193 'header' => $this->getMsg( 'search' )->text(),
194 'generated' => false,
195 'content' => true,
196 ];
197 break;
198 case 'TOOLBOX':
199 $msgObj = $this->getMsg( 'toolbox' );
200 $boxes[$boxName] = [
201 'id' => 'p-tb',
202 'header' => $msgObj->exists() ? $msgObj->text() : 'toolbox',
203 'generated' => false,
204 'content' => $this->getToolbox(),
205 ];
206 break;
207 case 'LANGUAGES':
208 if ( $this->data['language_urls'] !== false ) {
209 $msgObj = $this->getMsg( 'otherlanguages' );
210 $boxes[$boxName] = [
211 'id' => 'p-lang',
212 'header' => $msgObj->exists() ? $msgObj->text() : 'otherlanguages',
213 'generated' => false,
214 'content' => $this->data['language_urls'] ?: [],
215 ];
216 }
217 break;
218 default:
219 $msgObj = $this->getMsg( $boxName );
220 $boxes[$boxName] = [
221 'id' => "p-$boxName",
222 'header' => $msgObj->exists() ? $msgObj->text() : $boxName,
223 'generated' => true,
224 'content' => $content,
225 ];
226 break;
227 }
228 }
229
230 // HACK: Compatibility with extensions still using SkinTemplateToolboxEnd
231 $hookContents = null;
232 if ( isset( $boxes['TOOLBOX'] ) ) {
233 ob_start();
234 // We pass an extra 'true' at the end so extensions using BaseTemplateToolbox
235 // can abort and avoid outputting double toolbox links
236 // Avoid PHP 7.1 warning from passing $this by reference
237 $template = $this;
238 Hooks::run( 'SkinTemplateToolboxEnd', [ &$template, true ] );
239 $hookContents = ob_get_contents();
240 ob_end_clean();
241 if ( !trim( $hookContents ) ) {
242 $hookContents = null;
243 }
244 }
245 // END hack
246
247 if ( isset( $options['htmlOnly'] ) && $options['htmlOnly'] === true ) {
248 foreach ( $boxes as $boxName => $box ) {
249 if ( is_array( $box['content'] ) ) {
250 $content = '<ul>';
251 foreach ( $box['content'] as $key => $val ) {
252 $content .= "\n " . $this->makeListItem( $key, $val );
253 }
254 // HACK, shove the toolbox end onto the toolbox if we're rendering itself
255 if ( $hookContents ) {
256 $content .= "\n $hookContents";
257 }
258 // END hack
259 $content .= "\n</ul>\n";
260 $boxes[$boxName]['content'] = $content;
261 }
262 }
263 } elseif ( $hookContents ) {
264 $boxes['TOOLBOXEND'] = [
265 'id' => 'p-toolboxend',
266 'header' => $boxes['TOOLBOX']['header'],
267 'generated' => false,
268 'content' => "<ul>{$hookContents}</ul>",
269 ];
270 // HACK: Make sure that TOOLBOXEND is sorted next to TOOLBOX
271 $boxes2 = [];
272 foreach ( $boxes as $key => $box ) {
273 if ( $key === 'TOOLBOXEND' ) {
274 continue;
275 }
276 $boxes2[$key] = $box;
277 if ( $key === 'TOOLBOX' ) {
278 $boxes2['TOOLBOXEND'] = $boxes['TOOLBOXEND'];
279 }
280 }
281 $boxes = $boxes2;
282 // END hack
283 }
284
285 return $boxes;
286 }
287
291 protected function renderAfterPortlet( $name ) {
292 echo $this->getAfterPortlet( $name );
293 }
294
303 protected function getAfterPortlet( $name ) {
304 $html = '';
305 $content = '';
306 Hooks::run( 'BaseTemplateAfterPortlet', [ $this, $name, &$content ] );
307
308 if ( $content !== '' ) {
309 $html = Html::rawElement(
310 'div',
311 [ 'class' => [ 'after-portlet', 'after-portlet-' . $name ] ],
313 );
314 }
315
316 return $html;
317 }
318
371 function makeLink( $key, $item, $options = [] ) {
372 $text = $item['text'] ?? wfMessage( $item['msg'] ?? $key )->text();
373
374 $html = htmlspecialchars( $text );
375
376 if ( isset( $options['text-wrapper'] ) ) {
377 $wrapper = $options['text-wrapper'];
378 if ( isset( $wrapper['tag'] ) ) {
379 $wrapper = [ $wrapper ];
380 }
381 while ( count( $wrapper ) > 0 ) {
382 $element = array_pop( $wrapper );
383 $html = Html::rawElement( $element['tag'], $element['attributes'] ?? null, $html );
384 }
385 }
386
387 if ( isset( $item['href'] ) || isset( $options['link-fallback'] ) ) {
388 $attrs = $item;
389 foreach ( [ 'single-id', 'text', 'msg', 'tooltiponly', 'context', 'primary',
390 'tooltip-params', 'exists' ] as $k ) {
391 unset( $attrs[$k] );
392 }
393
394 if ( isset( $attrs['data'] ) ) {
395 foreach ( $attrs['data'] as $key => $value ) {
396 $attrs[ 'data-' . $key ] = $value;
397 }
398 unset( $attrs[ 'data' ] );
399 }
400
401 if ( isset( $item['id'] ) && !isset( $item['single-id'] ) ) {
402 $item['single-id'] = $item['id'];
403 }
404
405 $tooltipParams = [];
406 if ( isset( $item['tooltip-params'] ) ) {
407 $tooltipParams = $item['tooltip-params'];
408 }
409
410 if ( isset( $item['single-id'] ) ) {
411 $tooltipOption = isset( $item['exists'] ) && $item['exists'] === false ? 'nonexisting' : null;
412
413 if ( isset( $item['tooltiponly'] ) && $item['tooltiponly'] ) {
414 $title = Linker::titleAttrib( $item['single-id'], $tooltipOption, $tooltipParams );
415 if ( $title !== false ) {
416 $attrs['title'] = $title;
417 }
418 } else {
420 $item['single-id'],
421 $tooltipParams,
422 $tooltipOption
423 );
424 if ( isset( $tip['title'] ) && $tip['title'] !== false ) {
425 $attrs['title'] = $tip['title'];
426 }
427 if ( isset( $tip['accesskey'] ) && $tip['accesskey'] !== false ) {
428 $attrs['accesskey'] = $tip['accesskey'];
429 }
430 }
431 }
432 if ( isset( $options['link-class'] ) ) {
433 if ( isset( $attrs['class'] ) ) {
434 $attrs['class'] .= " {$options['link-class']}";
435 } else {
436 $attrs['class'] = $options['link-class'];
437 }
438 }
439 $html = Html::rawElement( isset( $attrs['href'] )
440 ? 'a'
441 : $options['link-fallback'], $attrs, $html );
442 }
443
444 return $html;
445 }
446
478 function makeListItem( $key, $item, $options = [] ) {
479 // In case this is still set from SkinTemplate, we don't want it to appear in
480 // the HTML output (normally removed in SkinTemplate::buildContentActionUrls())
481 unset( $item['redundant'] );
482
483 if ( isset( $item['links'] ) ) {
484 $links = [];
485 foreach ( $item['links'] as $linkKey => $link ) {
486 $links[] = $this->makeLink( $linkKey, $link, $options );
487 }
488 $html = implode( ' ', $links );
489 } else {
490 $link = $item;
491 // These keys are used by makeListItem and shouldn't be passed on to the link
492 foreach ( [ 'id', 'class', 'active', 'tag', 'itemtitle' ] as $k ) {
493 unset( $link[$k] );
494 }
495 if ( isset( $item['id'] ) && !isset( $item['single-id'] ) ) {
496 // The id goes on the <li> not on the <a> for single links
497 // but makeSidebarLink still needs to know what id to use when
498 // generating tooltips and accesskeys.
499 $link['single-id'] = $item['id'];
500 }
501 if ( isset( $link['link-class'] ) ) {
502 // link-class should be set on the <a> itself,
503 // so pass it in as 'class'
504 $link['class'] = $link['link-class'];
505 unset( $link['link-class'] );
506 }
507 $html = $this->makeLink( $key, $link, $options );
508 }
509
510 $attrs = [];
511 foreach ( [ 'id', 'class' ] as $attr ) {
512 if ( isset( $item[$attr] ) ) {
513 $attrs[$attr] = $item[$attr];
514 }
515 }
516 if ( isset( $item['active'] ) && $item['active'] ) {
517 if ( !isset( $attrs['class'] ) ) {
518 $attrs['class'] = '';
519 }
520 $attrs['class'] .= ' active';
521 $attrs['class'] = trim( $attrs['class'] );
522 }
523 if ( isset( $item['itemtitle'] ) ) {
524 $attrs['title'] = $item['itemtitle'];
525 }
526 return Html::rawElement( $options['tag'] ?? 'li', $attrs, $html );
527 }
528
529 function makeSearchInput( $attrs = [] ) {
530 $realAttrs = [
531 'type' => 'search',
532 'name' => 'search',
533 'placeholder' => wfMessage( 'searchsuggest-search' )->text(),
534 ];
535 $realAttrs = array_merge( $realAttrs, Linker::tooltipAndAccesskeyAttribs( 'search' ), $attrs );
536 return Html::element( 'input', $realAttrs );
537 }
538
539 function makeSearchButton( $mode, $attrs = [] ) {
540 switch ( $mode ) {
541 case 'go':
542 case 'fulltext':
543 $realAttrs = [
544 'type' => 'submit',
545 'name' => $mode,
546 'value' => wfMessage( $mode == 'go' ? 'searcharticle' : 'searchbutton' )->text(),
547 ];
548 $realAttrs = array_merge(
549 $realAttrs,
550 Linker::tooltipAndAccesskeyAttribs( "search-$mode" ),
551 $attrs
552 );
553 return Html::element( 'input', $realAttrs );
554 case 'image':
555 $buttonAttrs = [
556 'type' => 'submit',
557 'name' => 'button',
558 ];
559 $buttonAttrs = array_merge(
560 $buttonAttrs,
561 Linker::tooltipAndAccesskeyAttribs( 'search-fulltext' ),
562 $attrs
563 );
564 unset( $buttonAttrs['src'] );
565 unset( $buttonAttrs['alt'] );
566 unset( $buttonAttrs['width'] );
567 unset( $buttonAttrs['height'] );
568 $imgAttrs = [
569 'src' => $attrs['src'],
570 'alt' => $attrs['alt'] ?? wfMessage( 'searchbutton' )->text(),
571 'width' => $attrs['width'] ?? null,
572 'height' => $attrs['height'] ?? null,
573 ];
574 return Html::rawElement( 'button', $buttonAttrs, Html::element( 'img', $imgAttrs ) );
575 default:
576 throw new MWException( 'Unknown mode passed to BaseTemplate::makeSearchButton' );
577 }
578 }
579
589 function getFooterLinks( $option = null ) {
590 $footerlinks = $this->get( 'footerlinks' );
591
592 // Reduce footer links down to only those which are being used
593 $validFooterLinks = [];
594 foreach ( $footerlinks as $category => $links ) {
595 $validFooterLinks[$category] = [];
596 foreach ( $links as $link ) {
597 if ( isset( $this->data[$link] ) && $this->data[$link] ) {
598 $validFooterLinks[$category][] = $link;
599 }
600 }
601 if ( count( $validFooterLinks[$category] ) <= 0 ) {
602 unset( $validFooterLinks[$category] );
603 }
604 }
605
606 if ( $option == 'flat' ) {
607 // fold footerlinks into a single array using a bit of trickery
608 $validFooterLinks = array_merge( ...array_values( $validFooterLinks ) );
609 }
610
611 return $validFooterLinks;
612 }
613
626 function getFooterIcons( $option = null ) {
627 // Generate additional footer icons
628 $footericons = $this->get( 'footericons' );
629
630 if ( $option == 'icononly' ) {
631 // Unset any icons which don't have an image
632 foreach ( $footericons as &$footerIconsBlock ) {
633 foreach ( $footerIconsBlock as $footerIconKey => $footerIcon ) {
634 if ( !is_string( $footerIcon ) && !isset( $footerIcon['src'] ) ) {
635 unset( $footerIconsBlock[$footerIconKey] );
636 }
637 }
638 }
639 // Redo removal of any empty blocks
640 foreach ( $footericons as $footerIconsKey => &$footerIconsBlock ) {
641 if ( count( $footerIconsBlock ) <= 0 ) {
642 unset( $footericons[$footerIconsKey] );
643 }
644 }
645 } elseif ( $option == 'nocopyright' ) {
646 unset( $footericons['copyright']['copyright'] );
647 if ( count( $footericons['copyright'] ) <= 0 ) {
648 unset( $footericons['copyright'] );
649 }
650 }
651
652 return $footericons;
653 }
654
664 protected function getFooter( $iconStyle = 'icononly', $linkStyle = 'flat' ) {
665 $validFooterIcons = $this->getFooterIcons( $iconStyle );
666 $validFooterLinks = $this->getFooterLinks( $linkStyle );
667
668 $html = '';
669
670 if ( count( $validFooterIcons ) + count( $validFooterLinks ) > 0 ) {
671 $html .= Html::openElement( 'div', [
672 'id' => 'footer-bottom',
673 'role' => 'contentinfo',
674 'lang' => $this->get( 'userlang' ),
675 'dir' => $this->get( 'dir' )
676 ] );
677 $footerEnd = Html::closeElement( 'div' );
678 } else {
679 $footerEnd = '';
680 }
681 foreach ( $validFooterIcons as $blockName => $footerIcons ) {
682 $html .= Html::openElement( 'div', [
683 'id' => Sanitizer::escapeIdForAttribute( "f-{$blockName}ico" ),
684 'class' => 'footer-icons'
685 ] );
686 foreach ( $footerIcons as $icon ) {
687 $html .= $this->getSkin()->makeFooterIcon( $icon );
688 }
689 $html .= Html::closeElement( 'div' );
690 }
691 if ( count( $validFooterLinks ) > 0 ) {
692 $html .= Html::openElement( 'ul', [ 'id' => 'f-list', 'class' => 'footer-places' ] );
693 foreach ( $validFooterLinks as $aLink ) {
694 $html .= Html::rawElement(
695 'li',
696 [ 'id' => Sanitizer::escapeIdForAttribute( $aLink ) ],
697 $this->get( $aLink )
698 );
699 }
700 $html .= Html::closeElement( 'ul' );
701 }
702
703 $html .= $this->getClear() . $footerEnd;
704
705 return $html;
706 }
707
714 protected function getClear() {
715 return Html::element( 'div', [ 'class' => 'visualClear' ] );
716 }
717
733 public function getIndicators() {
734 $out = "<div class=\"mw-indicators mw-body-content\">\n";
735 foreach ( $this->data['indicators'] as $id => $content ) {
736 $out .= Html::rawElement(
737 'div',
738 [
739 'id' => Sanitizer::escapeIdForAttribute( "mw-indicator-$id" ),
740 'class' => 'mw-indicator',
741 ],
743 ) . "\n";
744 }
745 $out .= "</div>\n";
746 return $out;
747 }
748
752 function printTrail() {
753 echo $this->getTrail();
754 }
755
764 public function getTrail() {
765 return WrappedString::join( "\n", [
766 // @phan-suppress-next-line PhanTypeMismatchArgument
767 MWDebug::getDebugHTML( $this->getSkin()->getContext() ),
768 $this->get( 'bottomscripts' ),
769 $this->get( 'reporttime' )
770 ] );
771 }
772}
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
getContext()
New base template for a skin's template extended from QuickTemplate this class features helper method...
getFooterLinks( $option=null)
Returns an array of footerlinks trimmed down to only those footer links that are valid.
makeSearchButton( $mode, $attrs=[])
renderAfterPortlet( $name)
getToolbox()
Create an array of common toolbox items from the data in the quicktemplate stored by SkinTemplate.
getTrail()
Get the basic end-page trail including bottomscripts, reporttime, and debug stuff.
printTrail()
Output getTrail.
makeLink( $key, $item, $options=[])
Makes a link, usually used by makeListItem to generate a link for an item in a list used in navigatio...
getSidebar( $options=[])
getPersonalTools()
Create an array of personal tools items from the data in the quicktemplate stored by SkinTemplate.
getFooterIcons( $option=null)
Returns an array of footer icons filtered down by options relevant to how the skin wishes to display ...
makeListItem( $key, $item, $options=[])
Generates a list item for a navigation, portlet, portal, sidebar... list.
getMsg( $name,... $params)
Get a Message object with its context set.
getIndicators()
Get the suggested HTML for page status indicators: icons (or short text snippets) usually displayed i...
makeSearchInput( $attrs=[])
getFooter( $iconStyle='icononly', $linkStyle='flat')
Renderer for getFooterIcons and getFooterLinks.
getClear()
Get a div with the core visualClear class, for clearing floats.
getAfterPortlet( $name)
Allows extensions to hook into known portlets and add stuff to them.
static titleAttrib( $name, $options=null, array $msgParams=[])
Given the id of an interface element, constructs the appropriate title attribute from the system mess...
Definition Linker.php:2026
static tooltipAndAccesskeyAttribs( $name, array $msgParams=[], $options=null)
Returns the attributes for the tooltip and access key.
Definition Linker.php:2195
MediaWiki exception.
Generic wrapper for template functions, with interface compatible with what we use of PHPTAL 0....
getSkin()
Get the Skin object related to this object.
$content
Definition router.php:78