MediaWiki  master
BaseTemplate.php
Go to the documentation of this file.
1 <?php
23 
29 abstract class BaseTemplate extends QuickTemplate {
30 
38  public function getMsg( $name /* ... */ ) {
39  return $this->getSkin()->msg( ...func_get_args() );
40  }
41 
42  function msg( $str ) {
43  echo $this->getMsg( $str )->escaped();
44  }
45 
53  function msgHtml( $str ) {
54  wfDeprecated( __METHOD__, '1.32' );
55  echo $this->getMsg( $str )->text();
56  }
57 
61  function msgWiki( $str ) {
62  // TODO: Add wfDeprecated( __METHOD__, '1.33' ) after 1.33 got released
63  echo $this->getMsg( $str )->parseAsBlock();
64  }
65 
73  function getToolbox() {
74  $toolbox = [];
75  if ( isset( $this->data['nav_urls']['whatlinkshere'] )
76  && $this->data['nav_urls']['whatlinkshere']
77  ) {
78  $toolbox['whatlinkshere'] = $this->data['nav_urls']['whatlinkshere'];
79  $toolbox['whatlinkshere']['id'] = 't-whatlinkshere';
80  }
81  if ( isset( $this->data['nav_urls']['recentchangeslinked'] )
82  && $this->data['nav_urls']['recentchangeslinked']
83  ) {
84  $toolbox['recentchangeslinked'] = $this->data['nav_urls']['recentchangeslinked'];
85  $toolbox['recentchangeslinked']['msg'] = 'recentchangeslinked-toolbox';
86  $toolbox['recentchangeslinked']['id'] = 't-recentchangeslinked';
87  $toolbox['recentchangeslinked']['rel'] = 'nofollow';
88  }
89  if ( isset( $this->data['feeds'] ) && $this->data['feeds'] ) {
90  $toolbox['feeds']['id'] = 'feedlinks';
91  $toolbox['feeds']['links'] = [];
92  foreach ( $this->data['feeds'] as $key => $feed ) {
93  $toolbox['feeds']['links'][$key] = $feed;
94  $toolbox['feeds']['links'][$key]['id'] = "feed-$key";
95  $toolbox['feeds']['links'][$key]['rel'] = 'alternate';
96  $toolbox['feeds']['links'][$key]['type'] = "application/{$key}+xml";
97  $toolbox['feeds']['links'][$key]['class'] = 'feedlink';
98  }
99  }
100  foreach ( [ 'contributions', 'log', 'blockip', 'emailuser',
101  'userrights', 'upload', 'specialpages' ] as $special
102  ) {
103  if ( isset( $this->data['nav_urls'][$special] ) && $this->data['nav_urls'][$special] ) {
104  $toolbox[$special] = $this->data['nav_urls'][$special];
105  $toolbox[$special]['id'] = "t-$special";
106  }
107  }
108  if ( isset( $this->data['nav_urls']['print'] ) && $this->data['nav_urls']['print'] ) {
109  $toolbox['print'] = $this->data['nav_urls']['print'];
110  $toolbox['print']['id'] = 't-print';
111  $toolbox['print']['rel'] = 'alternate';
112  $toolbox['print']['msg'] = 'printableversion';
113  }
114  if ( isset( $this->data['nav_urls']['permalink'] ) && $this->data['nav_urls']['permalink'] ) {
115  $toolbox['permalink'] = $this->data['nav_urls']['permalink'];
116  $toolbox['permalink']['id'] = 't-permalink';
117  }
118  if ( isset( $this->data['nav_urls']['info'] ) && $this->data['nav_urls']['info'] ) {
119  $toolbox['info'] = $this->data['nav_urls']['info'];
120  $toolbox['info']['id'] = 't-info';
121  }
122 
123  // Avoid PHP 7.1 warning from passing $this by reference
124  $template = $this;
125  Hooks::run( 'BaseTemplateToolbox', [ &$template, &$toolbox ] );
126  return $toolbox;
127  }
128 
139  function getPersonalTools() {
140  $personal_tools = [];
141  foreach ( $this->get( 'personal_urls' ) as $key => $plink ) {
142  # The class on a personal_urls item is meant to go on the <a> instead
143  # of the <li> so we have to use a single item "links" array instead
144  # of using most of the personal_url's keys directly.
145  $ptool = [
146  'links' => [
147  [ 'single-id' => "pt-$key" ],
148  ],
149  'id' => "pt-$key",
150  ];
151  if ( isset( $plink['active'] ) ) {
152  $ptool['active'] = $plink['active'];
153  }
154  foreach ( [ 'href', 'class', 'text', 'dir', 'data', 'exists' ] as $k ) {
155  if ( isset( $plink[$k] ) ) {
156  $ptool['links'][0][$k] = $plink[$k];
157  }
158  }
159  $personal_tools[$key] = $ptool;
160  }
161  return $personal_tools;
162  }
163 
164  function getSidebar( $options = [] ) {
165  // Force the rendering of the following portals
166  $sidebar = $this->data['sidebar'];
167  if ( !isset( $sidebar['SEARCH'] ) ) {
168  $sidebar['SEARCH'] = true;
169  }
170  if ( !isset( $sidebar['TOOLBOX'] ) ) {
171  $sidebar['TOOLBOX'] = true;
172  }
173  if ( !isset( $sidebar['LANGUAGES'] ) ) {
174  $sidebar['LANGUAGES'] = true;
175  }
176 
177  if ( !isset( $options['search'] ) || $options['search'] !== true ) {
178  unset( $sidebar['SEARCH'] );
179  }
180  if ( isset( $options['toolbox'] ) && $options['toolbox'] === false ) {
181  unset( $sidebar['TOOLBOX'] );
182  }
183  if ( isset( $options['languages'] ) && $options['languages'] === false ) {
184  unset( $sidebar['LANGUAGES'] );
185  }
186 
187  $boxes = [];
188  foreach ( $sidebar as $boxName => $content ) {
189  if ( $content === false ) {
190  continue;
191  }
192  switch ( $boxName ) {
193  case 'SEARCH':
194  // Search is a special case, skins should custom implement this
195  $boxes[$boxName] = [
196  'id' => 'p-search',
197  'header' => $this->getMsg( 'search' )->text(),
198  'generated' => false,
199  'content' => true,
200  ];
201  break;
202  case 'TOOLBOX':
203  $msgObj = $this->getMsg( 'toolbox' );
204  $boxes[$boxName] = [
205  'id' => 'p-tb',
206  'header' => $msgObj->exists() ? $msgObj->text() : 'toolbox',
207  'generated' => false,
208  'content' => $this->getToolbox(),
209  ];
210  break;
211  case 'LANGUAGES':
212  if ( $this->data['language_urls'] !== false ) {
213  $msgObj = $this->getMsg( 'otherlanguages' );
214  $boxes[$boxName] = [
215  'id' => 'p-lang',
216  'header' => $msgObj->exists() ? $msgObj->text() : 'otherlanguages',
217  'generated' => false,
218  'content' => $this->data['language_urls'] ?: [],
219  ];
220  }
221  break;
222  default:
223  $msgObj = $this->getMsg( $boxName );
224  $boxes[$boxName] = [
225  'id' => "p-$boxName",
226  'header' => $msgObj->exists() ? $msgObj->text() : $boxName,
227  'generated' => true,
228  'content' => $content,
229  ];
230  break;
231  }
232  }
233 
234  // HACK: Compatibility with extensions still using SkinTemplateToolboxEnd
235  $hookContents = null;
236  if ( isset( $boxes['TOOLBOX'] ) ) {
237  ob_start();
238  // We pass an extra 'true' at the end so extensions using BaseTemplateToolbox
239  // can abort and avoid outputting double toolbox links
240  // Avoid PHP 7.1 warning from passing $this by reference
241  $template = $this;
242  Hooks::run( 'SkinTemplateToolboxEnd', [ &$template, true ] );
243  $hookContents = ob_get_contents();
244  ob_end_clean();
245  if ( !trim( $hookContents ) ) {
246  $hookContents = null;
247  }
248  }
249  // END hack
250 
251  if ( isset( $options['htmlOnly'] ) && $options['htmlOnly'] === true ) {
252  foreach ( $boxes as $boxName => $box ) {
253  if ( is_array( $box['content'] ) ) {
254  $content = '<ul>';
255  foreach ( $box['content'] as $key => $val ) {
256  $content .= "\n " . $this->makeListItem( $key, $val );
257  }
258  // HACK, shove the toolbox end onto the toolbox if we're rendering itself
259  if ( $hookContents ) {
260  $content .= "\n $hookContents";
261  }
262  // END hack
263  $content .= "\n</ul>\n";
264  $boxes[$boxName]['content'] = $content;
265  }
266  }
267  } elseif ( $hookContents ) {
268  $boxes['TOOLBOXEND'] = [
269  'id' => 'p-toolboxend',
270  'header' => $boxes['TOOLBOX']['header'],
271  'generated' => false,
272  'content' => "<ul>{$hookContents}</ul>",
273  ];
274  // HACK: Make sure that TOOLBOXEND is sorted next to TOOLBOX
275  $boxes2 = [];
276  foreach ( $boxes as $key => $box ) {
277  if ( $key === 'TOOLBOXEND' ) {
278  continue;
279  }
280  $boxes2[$key] = $box;
281  if ( $key === 'TOOLBOX' ) {
282  $boxes2['TOOLBOXEND'] = $boxes['TOOLBOXEND'];
283  }
284  }
285  $boxes = $boxes2;
286  // END hack
287  }
288 
289  return $boxes;
290  }
291 
295  protected function renderAfterPortlet( $name ) {
296  echo $this->getAfterPortlet( $name );
297  }
298 
307  protected function getAfterPortlet( $name ) {
308  $html = '';
309  $content = '';
310  Hooks::run( 'BaseTemplateAfterPortlet', [ $this, $name, &$content ] );
311 
312  if ( $content !== '' ) {
314  'div',
315  [ 'class' => [ 'after-portlet', 'after-portlet-' . $name ] ],
316  $content
317  );
318  }
319 
320  return $html;
321  }
322 
375  function makeLink( $key, $item, $options = [] ) {
376  $text = $item['text'] ?? wfMessage( $item['msg'] ?? $key )->text();
377 
378  $html = htmlspecialchars( $text );
379 
380  if ( isset( $options['text-wrapper'] ) ) {
381  $wrapper = $options['text-wrapper'];
382  if ( isset( $wrapper['tag'] ) ) {
383  $wrapper = [ $wrapper ];
384  }
385  while ( count( $wrapper ) > 0 ) {
386  $element = array_pop( $wrapper );
387  $html = Html::rawElement( $element['tag'], $element['attributes'] ?? null, $html );
388  }
389  }
390 
391  if ( isset( $item['href'] ) || isset( $options['link-fallback'] ) ) {
392  $attrs = $item;
393  foreach ( [ 'single-id', 'text', 'msg', 'tooltiponly', 'context', 'primary',
394  'tooltip-params', 'exists' ] as $k ) {
395  unset( $attrs[$k] );
396  }
397 
398  if ( isset( $attrs['data'] ) ) {
399  foreach ( $attrs['data'] as $key => $value ) {
400  $attrs[ 'data-' . $key ] = $value;
401  }
402  unset( $attrs[ 'data' ] );
403  }
404 
405  if ( isset( $item['id'] ) && !isset( $item['single-id'] ) ) {
406  $item['single-id'] = $item['id'];
407  }
408 
409  $tooltipParams = [];
410  if ( isset( $item['tooltip-params'] ) ) {
411  $tooltipParams = $item['tooltip-params'];
412  }
413 
414  if ( isset( $item['single-id'] ) ) {
415  $tooltipOption = isset( $item['exists'] ) && $item['exists'] === false ? 'nonexisting' : null;
416 
417  if ( isset( $item['tooltiponly'] ) && $item['tooltiponly'] ) {
418  $title = Linker::titleAttrib( $item['single-id'], $tooltipOption, $tooltipParams );
419  if ( $title !== false ) {
420  $attrs['title'] = $title;
421  }
422  } else {
424  $item['single-id'],
425  $tooltipParams,
426  $tooltipOption
427  );
428  if ( isset( $tip['title'] ) && $tip['title'] !== false ) {
429  $attrs['title'] = $tip['title'];
430  }
431  if ( isset( $tip['accesskey'] ) && $tip['accesskey'] !== false ) {
432  $attrs['accesskey'] = $tip['accesskey'];
433  }
434  }
435  }
436  if ( isset( $options['link-class'] ) ) {
437  if ( isset( $attrs['class'] ) ) {
438  $attrs['class'] .= " {$options['link-class']}";
439  } else {
440  $attrs['class'] = $options['link-class'];
441  }
442  }
443  $html = Html::rawElement( isset( $attrs['href'] )
444  ? 'a'
445  : $options['link-fallback'], $attrs, $html );
446  }
447 
448  return $html;
449  }
450 
480  function makeListItem( $key, $item, $options = [] ) {
481  if ( isset( $item['links'] ) ) {
482  $links = [];
483  foreach ( $item['links'] as $linkKey => $link ) {
484  $links[] = $this->makeLink( $linkKey, $link, $options );
485  }
486  $html = implode( ' ', $links );
487  } else {
488  $link = $item;
489  // These keys are used by makeListItem and shouldn't be passed on to the link
490  foreach ( [ 'id', 'class', 'active', 'tag', 'itemtitle' ] as $k ) {
491  unset( $link[$k] );
492  }
493  if ( isset( $item['id'] ) && !isset( $item['single-id'] ) ) {
494  // The id goes on the <li> not on the <a> for single links
495  // but makeSidebarLink still needs to know what id to use when
496  // generating tooltips and accesskeys.
497  $link['single-id'] = $item['id'];
498  }
499  if ( isset( $link['link-class'] ) ) {
500  // link-class should be set on the <a> itself,
501  // so pass it in as 'class'
502  $link['class'] = $link['link-class'];
503  unset( $link['link-class'] );
504  }
505  $html = $this->makeLink( $key, $link, $options );
506  }
507 
508  $attrs = [];
509  foreach ( [ 'id', 'class' ] as $attr ) {
510  if ( isset( $item[$attr] ) ) {
511  $attrs[$attr] = $item[$attr];
512  }
513  }
514  if ( isset( $item['active'] ) && $item['active'] ) {
515  if ( !isset( $attrs['class'] ) ) {
516  $attrs['class'] = '';
517  }
518  $attrs['class'] .= ' active';
519  $attrs['class'] = trim( $attrs['class'] );
520  }
521  if ( isset( $item['itemtitle'] ) ) {
522  $attrs['title'] = $item['itemtitle'];
523  }
524  return Html::rawElement( $options['tag'] ?? 'li', $attrs, $html );
525  }
526 
527  function makeSearchInput( $attrs = [] ) {
528  $realAttrs = [
529  'type' => 'search',
530  'name' => 'search',
531  'placeholder' => wfMessage( 'searchsuggest-search' )->text(),
532  ];
533  $realAttrs = array_merge( $realAttrs, Linker::tooltipAndAccesskeyAttribs( 'search' ), $attrs );
534  return Html::element( 'input', $realAttrs );
535  }
536 
537  function makeSearchButton( $mode, $attrs = [] ) {
538  switch ( $mode ) {
539  case 'go':
540  case 'fulltext':
541  $realAttrs = [
542  'type' => 'submit',
543  'name' => $mode,
544  'value' => wfMessage( $mode == 'go' ? 'searcharticle' : 'searchbutton' )->text(),
545  ];
546  $realAttrs = array_merge(
547  $realAttrs,
548  Linker::tooltipAndAccesskeyAttribs( "search-$mode" ),
549  $attrs
550  );
551  return Html::element( 'input', $realAttrs );
552  case 'image':
553  $buttonAttrs = [
554  'type' => 'submit',
555  'name' => 'button',
556  ];
557  $buttonAttrs = array_merge(
558  $buttonAttrs,
559  Linker::tooltipAndAccesskeyAttribs( 'search-fulltext' ),
560  $attrs
561  );
562  unset( $buttonAttrs['src'] );
563  unset( $buttonAttrs['alt'] );
564  unset( $buttonAttrs['width'] );
565  unset( $buttonAttrs['height'] );
566  $imgAttrs = [
567  'src' => $attrs['src'],
568  'alt' => $attrs['alt'] ?? wfMessage( 'searchbutton' )->text(),
569  'width' => $attrs['width'] ?? null,
570  'height' => $attrs['height'] ?? null,
571  ];
572  return Html::rawElement( 'button', $buttonAttrs, Html::element( 'img', $imgAttrs ) );
573  default:
574  throw new MWException( 'Unknown mode passed to BaseTemplate::makeSearchButton' );
575  }
576  }
577 
587  function getFooterLinks( $option = null ) {
588  $footerlinks = $this->get( 'footerlinks' );
589 
590  // Reduce footer links down to only those which are being used
591  $validFooterLinks = [];
592  foreach ( $footerlinks as $category => $links ) {
593  $validFooterLinks[$category] = [];
594  foreach ( $links as $link ) {
595  if ( isset( $this->data[$link] ) && $this->data[$link] ) {
596  $validFooterLinks[$category][] = $link;
597  }
598  }
599  if ( count( $validFooterLinks[$category] ) <= 0 ) {
600  unset( $validFooterLinks[$category] );
601  }
602  }
603 
604  if ( $option == 'flat' ) {
605  // fold footerlinks into a single array using a bit of trickery
606  $validFooterLinks = array_merge( ...array_values( $validFooterLinks ) );
607  }
608 
609  return $validFooterLinks;
610  }
611 
624  function getFooterIcons( $option = null ) {
625  // Generate additional footer icons
626  $footericons = $this->get( 'footericons' );
627 
628  if ( $option == 'icononly' ) {
629  // Unset any icons which don't have an image
630  foreach ( $footericons as &$footerIconsBlock ) {
631  foreach ( $footerIconsBlock as $footerIconKey => $footerIcon ) {
632  if ( !is_string( $footerIcon ) && !isset( $footerIcon['src'] ) ) {
633  unset( $footerIconsBlock[$footerIconKey] );
634  }
635  }
636  }
637  // Redo removal of any empty blocks
638  foreach ( $footericons as $footerIconsKey => &$footerIconsBlock ) {
639  if ( count( $footerIconsBlock ) <= 0 ) {
640  unset( $footericons[$footerIconsKey] );
641  }
642  }
643  } elseif ( $option == 'nocopyright' ) {
644  unset( $footericons['copyright']['copyright'] );
645  if ( count( $footericons['copyright'] ) <= 0 ) {
646  unset( $footericons['copyright'] );
647  }
648  }
649 
650  return $footericons;
651  }
652 
662  protected function getFooter( $iconStyle = 'icononly', $linkStyle = 'flat' ) {
663  $validFooterIcons = $this->getFooterIcons( $iconStyle );
664  $validFooterLinks = $this->getFooterLinks( $linkStyle );
665 
666  $html = '';
667 
668  if ( count( $validFooterIcons ) + count( $validFooterLinks ) > 0 ) {
669  $html .= Html::openElement( 'div', [
670  'id' => 'footer-bottom',
671  'role' => 'contentinfo',
672  'lang' => $this->get( 'userlang' ),
673  'dir' => $this->get( 'dir' )
674  ] );
675  $footerEnd = Html::closeElement( 'div' );
676  } else {
677  $footerEnd = '';
678  }
679  foreach ( $validFooterIcons as $blockName => $footerIcons ) {
680  $html .= Html::openElement( 'div', [
681  'id' => Sanitizer::escapeIdForAttribute( "f-{$blockName}ico" ),
682  'class' => 'footer-icons'
683  ] );
684  foreach ( $footerIcons as $icon ) {
685  $html .= $this->getSkin()->makeFooterIcon( $icon );
686  }
687  $html .= Html::closeElement( 'div' );
688  }
689  if ( count( $validFooterLinks ) > 0 ) {
690  $html .= Html::openElement( 'ul', [ 'id' => 'f-list', 'class' => 'footer-places' ] );
691  foreach ( $validFooterLinks as $aLink ) {
693  'li',
694  [ 'id' => Sanitizer::escapeIdForAttribute( $aLink ) ],
695  $this->get( $aLink )
696  );
697  }
698  $html .= Html::closeElement( 'ul' );
699  }
700 
701  $html .= $this->getClear() . $footerEnd;
702 
703  return $html;
704  }
705 
712  protected function getClear() {
713  return Html::element( 'div', [ 'class' => 'visualClear' ] );
714  }
715 
731  public function getIndicators() {
732  $out = "<div class=\"mw-indicators mw-body-content\">\n";
733  foreach ( $this->data['indicators'] as $id => $content ) {
735  'div',
736  [
737  'id' => Sanitizer::escapeIdForAttribute( "mw-indicator-$id" ),
738  'class' => 'mw-indicator',
739  ],
740  $content
741  ) . "\n";
742  }
743  $out .= "</div>\n";
744  return $out;
745  }
746 
750  function printTrail() {
751  echo $this->getTrail();
752  }
753 
762  public function getTrail() {
763  return WrappedString::join( "\n", [
765  $this->get( 'bottomscripts' ),
766  $this->get( 'reporttime' )
767  ] );
768  }
769 }
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of data
Definition: hooks.txt:6
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 & $html
Definition: hooks.txt:1982
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:232
getPersonalTools()
Create an array of personal tools items from the data in the quicktemplate stored by SkinTemplate...
Generic wrapper for template functions, with interface compatible with what we use of PHPTAL 0...
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getFooter( $iconStyle='icononly', $linkStyle='flat')
Renderer for getFooterIcons and getFooterLinks.
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 rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
New base template for a skin&#39;s template extended from QuickTemplate this class features helper method...
$value
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.
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3050
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 $out
Definition: hooks.txt:780
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
makeLink( $key, $item, $options=[])
Makes a link, usually used by makeListItem to generate a link for an item in a list used in navigatio...
getSkin()
Get the Skin object related to this object.
getFooterIcons( $option=null)
Returns an array of footer icons filtered down by options relevant to how the skin wishes to display ...
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:1974
getIndicators()
Get the suggested HTML for page status indicators: icons (or short text snippets) usually displayed i...
static escapeIdForAttribute( $id, $mode=self::ID_PRIMARY)
Given a section name or other user-generated or otherwise unsafe string, escapes it to be a valid HTM...
Definition: Sanitizer.php:1287
getContext()
renderAfterPortlet( $name)
getFooterLinks( $option=null)
Returns an array of footerlinks trimmed down to only those footer links that are valid.
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:1982
static closeElement( $element)
Returns "</$element>".
Definition: Html.php:316
makeSearchInput( $attrs=[])
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
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
getSidebar( $options=[])
makeSearchButton( $mode, $attrs=[])
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
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
getMsg( $name)
Get a Message object with its context set.
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 $template
Definition: hooks.txt:780
getClear()
Get a div with the core visualClear class, for clearing floats.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
static tooltipAndAccesskeyAttribs( $name, array $msgParams=[], $options=null)
Returns the attributes for the tooltip and access key.
Definition: Linker.php:2141
$content
Definition: pageupdater.txt:72
static getDebugHTML(IContextSource $context)
Returns the HTML to add to the page for the toolbar.
Definition: MWDebug.php:421
msgWiki( $str)
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
getAfterPortlet( $name)
Allows extensions to hook into known portlets and add stuff to them.
msgHtml( $str)
printTrail()
Output getTrail.
makeListItem( $key, $item, $options=[])
Generates a list item for a navigation, portlet, portal, sidebar...