Go to the documentation of this file.
44 $out =
'<' . $element;
48 if ( is_null( $contents ) ) {
50 } elseif ( $allowShortTag && $contents ===
'' ) {
53 $out .=
'>' . htmlspecialchars( $contents, ENT_NOQUOTES ) .
"</$element>";
73 $out .=
" {$name}=\"" . Sanitizer::encodeAttribute( $val ) .
'"';
77 throw new MWException(
'Expected attribute array, got something else in ' . __METHOD__ );
96 MediaWikiServices::getInstance()->getContentLanguage()->normalize( $contents );
118 return "</$element>";
143 public static function monthSelector( $selected =
'', $allmonths =
null, $id =
'month' ) {
147 if ( is_null( $selected ) ) {
150 if ( !is_null( $allmonths ) ) {
153 for ( $i = 1; $i < 13; $i++ ) {
157 $data->setAttribute(
'class',
'mw-month-selector' );
158 return $data->getHTML();
168 # Offset overrides year/month selection
169 if ( $month && $month !== -1 ) {
170 $encMonth = intval( $month );
175 $encYear = intval( $year );
176 } elseif ( $encMonth ) {
178 $thisMonth = intval( $timestamp->format(
'n' ) );
179 $thisYear = intval( $timestamp->format(
'Y' ) );
180 if ( intval( $encMonth ) > $thisMonth ) {
183 $encYear = $thisYear;
187 $inputAttribs = [
'id' =>
'year',
'maxlength' => 4,
'size' => 7 ];
189 Html::input(
'year', $encYear,
'number', $inputAttribs ) .
' ' .
205 $inLanguage =
null, $overrideAttrs = [], Message $msg =
null
209 $include = $customisedOnly ?
'mwfile' :
'mw';
231 $attrs = [
'id' =>
'wpUserLanguage',
'name' =>
'wpUserLanguage' ];
232 $attrs = array_merge( $attrs, $overrideAttrs );
234 if ( $msg ===
null ) {
239 self::tags(
'select', $attrs,
$options )
275 $attributes = [
'name' =>
$name ];
278 $attributes[
'size'] = $size;
282 $attributes[
'value'] =
$value;
286 Html::getTextInputAttributes( $attributes +
$attribs ) );
301 array_merge(
$attribs, [
'type' =>
'password' ] ) );
327 'type' =>
'checkbox',
329 self::attrib(
'checked', $checked ),
345 'value' =>
$value ] + self::attrib(
'checked', $checked ) +
$attribs );
359 $a = [
'for' => $id ];
361 foreach ( [
'class',
'title' ]
as $attr ) {
384 return $label .
"\u{00A0}" .
$input;
469 $baseAttrs[
'class'] =
'mw-ui-button mw-ui-progressive';
473 return Html::element(
'input',
$attribs );
484 public static function option( $text,
$value =
null, $selected =
false,
486 if ( !is_null(
$value ) ) {
492 return Html::element(
'option',
$attribs, $text );
509 $selected =
'', $class =
'',
$tabindex =
null
517 $xmlSelect->setAttribute(
'class', $class );
520 $xmlSelect->setAttribute(
'tabindex',
$tabindex );
523 return $xmlSelect->getHTML();
542 if ( isset(
$params[
'other'] ) ) {
547 foreach ( explode(
"\n", $list )
as $option ) {
551 } elseif ( substr(
$value, 0, 1 ) ==
'*' && substr(
$value, 1, 1 ) !=
'*' ) {
552 # A new group is starting...
555 } elseif ( substr(
$value, 0, 2 ) ==
'**' ) {
558 if ( $optgroup ===
false ) {
564 # groupless reason list
585 if ( is_array(
$value ) ) {
586 $optionsOoui[] = [
'optgroup' => (
string)$text ];
587 foreach (
$value as $text2 => $value2 ) {
588 $optionsOoui[] = [
'data' => (
string)$value2,
'label' => (
string)$text2 ];
591 $optionsOoui[] = [
'data' => (
string)
$value,
'label' => (
string)$text ];
637 Html::getTextInputAttributes(
680 if ( $arg ===
false ) {
685 return "$name(" . ( $pretty
686 ? (
' ' . implode(
', ',
$args ) .
' ' )
687 : implode(
',',
$args )
703 $parser = xml_parser_create(
"UTF-8" );
705 # case folding violates XML standard, turn it off
706 xml_parser_set_option(
$parser, XML_OPTION_CASE_FOLDING,
false );
708 if ( !xml_parse(
$parser, $text,
true ) ) {
732 Sanitizer::hackDocType() .
750 [
'"',
'>',
'<' ],
765 public static function buildForm( $fields, $submitLabel =
null, $submitAttribs = [] ) {
767 $form .=
"<table><tbody>";
769 foreach ( $fields
as $labelmsg =>
$input ) {
770 $id =
"mw-$labelmsg";
783 if ( $submitLabel ) {
792 $form .=
"</tbody></table>";
807 if ( is_array( $headers ) ) {
813 if ( is_string( $id ) ) {
822 foreach (
$rows as $id => $row ) {
825 if ( is_string( $id ) ) {
846 foreach ( $cells
as $id => $cell ) {
849 if ( is_string( $id ) ) {
static isWellFormed( $text)
Check if a string is well-formed XML.
static buildTableRow( $attribs, $cells)
Build a row for a table.
static expandAttributes( $attribs)
Given an array of ('attributename' => 'value'), it generates the code to set the XML attributes : att...
static listDropDownOptionsOoui( $options)
Convert options for a drop-down box into a format accepted by OOUI\DropdownInputWidget etc.
static label( $label, $id, $attribs=[])
Convenience function to build an HTML form label.
switch( $options['output']) $languages
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
$wgUseMediaWikiUIEverywhere
Temporary variable that applies MediaWiki UI wherever it can be supported.
static textarea( $name, $content, $cols=40, $rows=5, $attribs=[])
Shortcut for creating textareas.
static radio( $name, $value, $checked=false, $attribs=[])
Convenience function to build an HTML radio button.
static inputLabelSep( $label, $name, $id, $size=false, $value=false, $attribs=[])
Same as Xml::inputLabel() but return input and label in an array.
static option( $text, $value=null, $selected=false, $attribs=[])
Convenience function to build an HTML drop-down list item.
static password( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML password input field.
static buildForm( $fields, $submitLabel=null, $submitAttribs=[])
Generate a form (without the opening form element).
static openElement( $element, $attribs=null)
This opens an XML element.
static encodeJsVar( $value, $pretty=false)
Encode a variable of arbitrary type to JavaScript.
static languageSelector( $selected, $customisedOnly=true, $inLanguage=null, $overrideAttrs=[], Message $msg=null)
Construct a language selector appropriate for use in a form or preferences.
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
Class for generating HTML <select> or <datalist> elements.
static fieldset( $legend=false, $content=false, $attribs=[])
Shortcut for creating fieldsets.
A wrapper class which causes Xml::encodeJsVar() and Xml::encodeJsCall() to interpret a given string a...
static encodeJsCall( $name, $args, $pretty=false)
Create a call to a JavaScript function.
static elementClean( $element, $attribs=[], $contents='')
Format an XML element as with self::element(), but run text through the content language's normalize(...
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
static wrapClass( $text, $class, $tag='span', $attribs=[])
Shortcut to make a specific element with a class attribute.
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
if(is_array( $mode)) switch( $mode) $input
static check( $name, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox.
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
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
in this case you re responsible for computing and outputting the entire conflict i the difference between revisions and your text headers and sections and Diff & $tabindex
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
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
see documentation in includes Linker php for Linker::makeImageLink or false for current used if you return false $parser
static getInstance( $ts=false)
Get a timestamp instance in GMT.
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Allows to change the fields on the form that will be generated $name
static tags( $element, $attribs, $contents)
Same as Xml::element(), but does not escape contents.
static attrib( $name, $present=true)
Internal function for use in checkboxes and radio buttons and such.
$wgLanguageCode
Site language code.
static span( $text, $class, $attribs=[])
Shortcut to make a span element.
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
static radioLabel( $label, $name, $value, $id, $checked=false, $attribs=[])
Convenience function to build an HTML radio button with a label.
static closeElement( $element)
Shortcut to close an XML element.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction $rows
static listDropDown( $name='', $list='', $other='', $selected='', $class='', $tabindex=null)
Build a drop-down box from a textual list.
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
static isWellFormedXmlFragment( $text)
Check if a string is a well-formed XML fragment.
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
static dateMenu( $year, $month)
static input( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field.
static buildTable( $rows, $attribs=[], $headers=null)
Build a table of data.
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 MediaWikiServices
static monthSelector( $selected='', $allmonths=null, $id='month')
Create a date selector.
static fetchLanguageNames( $inLanguage=self::AS_AUTONYMS, $include='mw')
Get an array of language names, indexed by code.
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 "<
static inputLabel( $label, $name, $id, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field with a label.
Module of static functions for generating XML.
static escapeTagsOnly( $in)
Replace " > and < with their respective HTML entities ( ", >, <)
static listDropDownOptions( $list, $params=[])
Build options for a drop-down box from a textual list.
static submitButton( $value, $attribs=[])
Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will ...
static checkLabel( $label, $name, $id, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox with a label.