42 $out =
'<' . $element;
46 if ( is_null( $contents ) ) {
49 if ( $allowShortTag && $contents ===
'' ) {
52 $out .=
'>' . htmlspecialchars( $contents ) .
"</$element>";
72 foreach (
$attribs as $name => $val ) {
73 $out .=
" {$name}=\"" . Sanitizer::encodeAttribute( $val ) .
'"';
77 throw new MWException(
'Expected attribute array, got something else in ' . __METHOD__ );
99 return self::element( $element,
$attribs, $contents );
110 return '<' . $element . self::expandAttributes(
$attribs ) .
'>';
119 return "</$element>";
132 return self::openElement( $element,
$attribs ) . $contents .
"</$element>";
144 public static function monthSelector( $selected =
'', $allmonths =
null, $id =
'month' ) {
147 $data =
new XmlSelect(
'month', $id, $selected );
148 if ( is_null( $selected ) ) {
151 if ( !is_null( $allmonths ) ) {
154 for ( $i = 1; $i < 13; $i++ ) {
158 $data->setAttribute(
'class',
'mw-month-selector' );
159 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 ];
188 return self::label(
wfMessage(
'year' )->
text(),
'year' ) .
' ' .
189 Html::input(
'year', $encYear,
'number', $inputAttribs ) .
' ' .
191 self::monthSelector( $encMonth, -1 );
205 $inLanguage =
null, $overrideAttrs = [],
Message $msg =
null
209 $include = $customisedOnly ?
'mwfile' :
'mw';
210 $languages = Language::fetchLanguageNames( $inLanguage, $include );
231 $attrs = [
'id' =>
'wpUserLanguage',
'name' =>
'wpUserLanguage' ];
232 $attrs = array_merge( $attrs, $overrideAttrs );
234 if ( $msg ===
null ) {
238 self::label( $msg->text(), $attrs[
'id'] ),
239 self::tags(
'select', $attrs,
$options )
251 return self::element(
'span', [
'class' => $class ] +
$attribs, $text );
263 return self::tags( $tag, [
'class' => $class ] +
$attribs, $text );
275 $attributes = [
'name' =>
$name ];
278 $attributes[
'size'] = $size;
282 $attributes[
'value'] =
$value;
285 return self::element(
'input',
286 Html::getTextInputAttributes( $attributes +
$attribs ) );
300 return self::input( $name, $size,
$value,
301 array_merge(
$attribs, [
'type' =>
'password' ] ) );
312 public static function attrib( $name, $present =
true ) {
313 return $present ? [ $name =>
$name ] : [];
324 return self::element(
'input', array_merge(
327 'type' =>
'checkbox',
329 self::attrib(
'checked', $checked ),
342 return self::element(
'input', [
345 'value' =>
$value ] + self::attrib(
'checked', $checked ) +
$attribs );
359 $a = [
'for' => $id ];
361 foreach ( [
'class',
'title' ] as $attr ) {
367 return self::element(
'label', $a, $label );
380 public static function inputLabel( $label, $name, $id, $size =
false,
384 return $label .
' ' .
$input;
403 self::label( $label, $id,
$attribs ),
423 self::label( $label, $id,
$attribs );
426 $chkLabel = self::openElement(
'div', [
'class' =>
'mw-ui-checkbox' ] ) .
427 $chkLabel . self::closeElement(
'div' );
447 return self::radio( $name,
$value, $checked, [
'id' => $id ] +
$attribs ) .
449 self::label( $label, $id,
$attribs );
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 );
508 public static function listDropDown( $name =
'', $list =
'', $other =
'',
509 $selected =
'', $class =
'',
$tabindex =
null
511 $options = self::listDropDownOptions( $list, [
'other' => $other ] );
513 $xmlSelect =
new XmlSelect( $name, $name, $selected );
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 ];
610 $s = self::openElement(
'fieldset',
$attribs ) .
"\n";
613 $s .= self::element(
'legend',
null, $legend ) .
"\n";
616 if ( $content !==
false ) {
617 $s .= $content .
"\n";
618 $s .= self::closeElement(
'fieldset' ) .
"\n";
636 return self::element(
'textarea',
637 Html::getTextInputAttributes(
663 return FormatJson::encode(
$value, $pretty, FormatJson::UTF8_OK );
678 foreach (
$args as &$arg ) {
679 $arg = self::encodeJsVar( $arg, $pretty );
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() .
737 return self::isWellFormed(
$html );
750 [
'"',
'>',
'<' ],
765 public static function buildForm( $fields, $submitLabel =
null, $submitAttribs = [] ) {
767 $form .=
"<table><tbody>";
769 foreach ( $fields as $labelmsg =>
$input ) {
770 $id =
"mw-$labelmsg";
771 $form .= self::openElement(
'tr', [
'id' => $id ] );
777 $form .= self::tags(
'td', [
'class' =>
'mw-label' ],
wfMessage( $labelmsg )->parse() );
778 $form .= self::openElement(
'td', [
'class' =>
'mw-input' ] )
779 .
$input . self::closeElement(
'td' );
780 $form .= self::closeElement(
'tr' );
783 if ( $submitLabel ) {
784 $form .= self::openElement(
'tr' );
785 $form .= self::tags(
'td', [],
'' );
786 $form .= self::openElement(
'td', [
'class' =>
'mw-submit' ] )
787 . self::submitButton(
wfMessage( $submitLabel )->
text(), $submitAttribs )
788 . self::closeElement(
'td' );
789 $form .= self::closeElement(
'tr' );
792 $form .=
"</tbody></table>";
807 if ( is_array( $headers ) ) {
810 foreach ( $headers as $id =>
$header ) {
813 if ( is_string( $id ) ) {
819 $s .= self::closeElement(
'thead' );
822 foreach (
$rows as $id => $row ) {
825 if ( is_string( $id ) ) {
832 $s .= self::closeElement(
'table' );
846 foreach ( $cells as $id => $cell ) {
849 if ( is_string( $id ) ) {
856 $s .= self::closeElement(
'tr' );
$wgLanguageCode
Site language code.
$wgUseMediaWikiUIEverywhere
Temporary variable that applies MediaWiki UI wherever it can be supported.
static getInstance( $ts=false)
Get a timestamp instance in GMT.
The Message class provides methods which fulfil two basic services:
A wrapper class which causes Xml::encodeJsVar() and Xml::encodeJsCall() to interpret a given string a...
Class for generating HTML <select> or <datalist> elements.
Module of static functions for generating XML.
static password( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML password input field.
static closeElement( $element)
Shortcut to close an XML element.
static textarea( $name, $content, $cols=40, $rows=5, $attribs=[])
Shortcut for creating textareas.
static inputLabelSep( $label, $name, $id, $size=false, $value=false, $attribs=[])
Same as Xml::inputLabel() but return input and label in an array.
static isWellFormed( $text)
Check if a string is well-formed XML.
static listDropDownOptions( $list, $params=[])
Build options for a drop-down box from a textual list.
static encodeJsVar( $value, $pretty=false)
Encode a variable of arbitrary type to JavaScript.
static listDropDownOptionsOoui( $options)
Convert options for a drop-down box into a format accepted by OOUI\DropdownInputWidget etc.
static isWellFormedXmlFragment( $text)
Check if a string is a well-formed XML fragment.
static check( $name, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox.
static dateMenu( $year, $month)
static buildForm( $fields, $submitLabel=null, $submitAttribs=[])
Generate a form (without the opening form element).
static attrib( $name, $present=true)
Internal function for use in checkboxes and radio buttons and such.
static label( $label, $id, $attribs=[])
Convenience function to build an HTML form label.
static openElement( $element, $attribs=null)
This opens an XML element.
static input( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field.
static wrapClass( $text, $class, $tag='span', $attribs=[])
Shortcut to make a specific element with a class attribute.
static buildTable( $rows, $attribs=[], $headers=null)
Build a table of data.
static submitButton( $value, $attribs=[])
Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will ...
static option( $text, $value=null, $selected=false, $attribs=[])
Convenience function to build an HTML drop-down list item.
static checkLabel( $label, $name, $id, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox with a label.
static inputLabel( $label, $name, $id, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field with a label.
static languageSelector( $selected, $customisedOnly=true, $inLanguage=null, $overrideAttrs=[], Message $msg=null)
Construct a language selector appropriate for use in a form or preferences.
static expandAttributes( $attribs)
Given an array of ('attributename' => 'value'), it generates the code to set the XML attributes : att...
static tags( $element, $attribs=null, $contents)
Same as Xml::element(), but does not escape contents.
static span( $text, $class, $attribs=[])
Shortcut to make a span element.
static escapeTagsOnly( $in)
Replace " > and < with their respective HTML entities ( ", >, <)
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
static radio( $name, $value, $checked=false, $attribs=[])
Convenience function to build an HTML radio button.
static buildTableRow( $attribs, $cells)
Build a row for a table.
static radioLabel( $label, $name, $value, $id, $checked=false, $attribs=[])
Convenience function to build an HTML radio button with a label.
static encodeJsCall( $name, $args, $pretty=false)
Create a call to a JavaScript function.
static listDropDown( $name='', $list='', $other='', $selected='', $class='', $tabindex=null)
Build a drop-down box from a textual list.
static monthSelector( $selected='', $allmonths=null, $id='month')
Create a date selector.
static fieldset( $legend=false, $content=false, $attribs=[])
Shortcut for creating fieldsets.
static elementClean( $element, $attribs=[], $contents='')
Format an XML element as with self::element(), but run text through the $wgContLang->normalize() vali...
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
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
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
do that in ParserLimitReportFormat instead $parser
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
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
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub 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
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 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 "<div ...>$1</div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
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
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub 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
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
Allows to change the fields on the form that will be generated $name
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
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 or overridable Default is either copyrightwarning or copyrightwarning2 overridable Default is editpage tos summary such as anonymity and the real check
if(is_array($mode)) switch( $mode) $input
switch( $options['output']) $languages