MediaWiki  1.23.12
Xml Class Reference

Module of static functions for generating XML. More...

Static Public Member Functions

static attrib ( $name, $present=true)
 Internal function for use in checkboxes and radio buttons and such. More...
 
static buildForm ( $fields, $submitLabel=null, $submitAttribs=array())
 Generate a form (without the opening form element). More...
 
static buildTable ( $rows, $attribs=array(), $headers=null)
 Build a table of data. More...
 
static buildTableRow ( $attribs, $cells)
 Build a row for a table. More...
 
static check ( $name, $checked=false, $attribs=array())
 Convenience function to build an HTML checkbox. More...
 
static checkLabel ( $label, $name, $id, $checked=false, $attribs=array())
 Convenience function to build an HTML checkbox with a label. More...
 
static closeElement ( $element)
 Shortcut to close an XML element. More...
 
static dateMenu ( $year, $month)
 
static element ( $element, $attribs=null, $contents='', $allowShortTag=true)
 Format an XML element with given attributes and, optionally, text content. More...
 
static elementClean ( $element, $attribs=array(), $contents='')
 Format an XML element as with self::element(), but run text through the $wgContLang->normalize() validator first to ensure that no invalid UTF-8 is passed. More...
 
static encodeJsCall ( $name, $args, $pretty=false)
 Create a call to a JavaScript function. More...
 
static encodeJsVar ( $value, $pretty=false)
 Encode a variable of arbitrary type to JavaScript. More...
 
static escapeJsString ( $string)
 Returns an escaped string suitable for inclusion in a string literal for JavaScript source code. More...
 
static escapeTagsOnly ( $in)
 Replace " > and < with their respective HTML entities ( ", >, <) More...
 
static expandAttributes ( $attribs)
 Given an array of ('attributename' => 'value'), it generates the code to set the XML attributes : attributename="value". More...
 
static fieldset ( $legend=false, $content=false, $attribs=array())
 Shortcut for creating fieldsets. More...
 
static input ( $name, $size=false, $value=false, $attribs=array())
 Convenience function to build an HTML text input field. More...
 
static inputLabel ( $label, $name, $id, $size=false, $value=false, $attribs=array())
 Convenience function to build an HTML text input field with a label. More...
 
static inputLabelSep ( $label, $name, $id, $size=false, $value=false, $attribs=array())
 Same as Xml::inputLabel() but return input and label in an array. More...
 
static isWellFormedXmlFragment ( $text)
 Check if a string is a well-formed XML fragment. More...
 
static label ( $label, $id, $attribs=array())
 Convenience function to build an HTML form label. More...
 
static languageSelector ( $selected, $customisedOnly=true, $inLanguage=null, $overrideAttrs=array(), Message $msg=null)
 Construct a language selector appropriate for use in a form or preferences. More...
 
static listDropDown ( $name='', $list='', $other='', $selected='', $class='', $tabindex=null)
 Build a drop-down box from a textual list. More...
 
static monthSelector ( $selected='', $allmonths=null, $id='month')
 Create a date selector. More...
 
static namespaceSelector ( $selected='', $all=null, $element_name='namespace', $label=null)
 Build a drop-down box for selecting a namespace. More...
 
static openElement ( $element, $attribs=null)
 This opens an XML element. More...
 
static option ( $text, $value=null, $selected=false, $attribs=array())
 Convenience function to build an HTML drop-down list item. More...
 
static password ( $name, $size=false, $value=false, $attribs=array())
 Convenience function to build an HTML password input field. More...
 
static radio ( $name, $value, $checked=false, $attribs=array())
 Convenience function to build an HTML radio button. More...
 
static radioLabel ( $label, $name, $value, $id, $checked=false, $attribs=array())
 Convenience function to build an HTML radio button with a label. More...
 
static span ( $text, $class, $attribs=array())
 Shortcut to make a span element. More...
 
static submitButton ( $value, $attribs=array())
 Convenience function to build an HTML submit button. More...
 
static tags ( $element, $attribs=null, $contents)
 Same as Xml::element(), but does not escape contents. More...
 
static textarea ( $name, $content, $cols=40, $rows=5, $attribs=array())
 Shortcut for creating textareas. More...
 
static wrapClass ( $text, $class, $tag='span', $attribs=array())
 Shortcut to make a specific element with a class attribute. More...
 

Static Private Member Functions

static isWellFormed ( $text)
 Check if a string is well-formed XML. More...
 

Detailed Description

Module of static functions for generating XML.

Definition at line 26 of file Xml.php.

Member Function Documentation

◆ attrib()

static Xml::attrib (   $name,
  $present = true 
)
static

Internal function for use in checkboxes and radio buttons and such.

Parameters
$namestring
$presentbool
Returns
array

Definition at line 328 of file Xml.php.

References $name, and array().

◆ buildForm()

static Xml::buildForm (   $fields,
  $submitLabel = null,
  $submitAttribs = array() 
)
static

Generate a form (without the opening form element).

Output optionally includes a submit button.

Parameters
array$fieldsAssociative array, key is the name of a message that contains a description for the field, value is an HTML string containing the appropriate input.
string$submitLabelThe name of a message containing a label for the submit button.
array$submitAttribsThe attributes to add to the submit button
Returns
string HTML form.

Definition at line 750 of file Xml.php.

Referenced by ImageListPager\getForm().

◆ buildTable()

static Xml::buildTable (   $rows,
  $attribs = array(),
  $headers = null 
)
static

Build a table of data.

Parameters
array$rowsAn array of arrays of strings, each to be a row in a table
array$attribsAn array of attributes to apply to the table tag [optional]
array$headersAn array of strings to use as table headers [optional]
Returns
string

Definition at line 786 of file Xml.php.

◆ buildTableRow()

static Xml::buildTableRow (   $attribs,
  $cells 
)
static

Build a row for a table.

Parameters
array$attribsAn array of attributes to apply to the tr tag
array$cellsAn array of strings to put in
Returns
string

Definition at line 825 of file Xml.php.

◆ check()

static Xml::check (   $name,
  $checked = false,
  $attribs = array() 
)
static

Convenience function to build an HTML checkbox.

Parameters
string$namevalue of the name attribute
bool$checkedWhether the checkbox is checked or not
array$attribsother attributes
Returns
string HTML

Definition at line 339 of file Xml.php.

References $attribs, $name, array(), and element().

Referenced by checkLabel(), SpecialUndelete\formatFileRow(), HTMLMultiSelectField\formatOptions(), SpecialUndelete\formatRevisionRow(), WebInstaller\getCheckBox(), SpecialRecentChangesLinked\getExtraOptions(), HTMLCheckField\getInputHTML(), HTMLCheckMatrix\getInputHTML(), LogEventsList\getShowHideLinks(), HistoryPager\historyLine(), and MovePageForm\showForm().

◆ checkLabel()

◆ closeElement()

static Xml::closeElement (   $element)
static

Shortcut to close an XML element.

Parameters
string$elementelement name
Returns
string

Definition at line 118 of file Xml.php.

Referenced by AllmessagesTablePager\buildForm(), ProtectionForm\buildForm(), ProtectionForm\buildSelector(), Article\confirmDelete(), SpecialRecentChanges\doHeader(), SpecialWatchlist\doHeader(), SpecialStatistics\execute(), SpecialExport\execute(), SpecialListGroupRights\execute(), MIMEsearchPage\execute(), QueryPage\execute(), fieldset(), SpecialNewpages\form(), SpecialStatistics\formatRowHeader(), SpecialSearch\formHeader(), SpecialStatistics\getEditStats(), SpecialVersion\getExtensionCredits(), SpecialStatistics\getMostViewedPages(), ActiveUsersPager\getPageHeader(), UsersPager\getPageHeader(), SpecialStatistics\getPageStats(), MysqlInstaller\getSettingsForm(), SpecialStatistics\getUserStats(), SpecialStatistics\getViewsStats(), UserrightsPage\groupCheckboxes(), listDropDown(), SpecialWhatLinksHere\listEnd(), SpecialExpandTemplates\makeForm(), ChangesListSpecialPage\makeLegend(), monthSelector(), SpecialAllpages\namespaceForm(), SpecialPrefixindex\namespacePrefixForm(), ImagePage\openShowImage(), SpecialListGroupRights\outputNamespaceProtectionInfo(), SpecialSearch\powerSearchBox(), SpecialWatchlist\setTopText(), SpecialAllpages\showChunk(), UserrightsPage\showEditUserGroupsForm(), MovePageForm\showForm(), SpecialChangeEmail\showForm(), SpecialImport\showForm(), FileDeleteForm\showForm(), SpecialRevisionDelete\showForm(), SpecialMergeHistory\showHistory(), SpecialUndelete\showHistory(), SpecialWhatLinksHere\showIndirectLinks(), SpecialMergeHistory\showMergeForm(), SpecialProtectedpages\showOptions(), SpecialPrefixindex\showPrefixChunk(), SpecialSearch\showResults(), SpecialUndelete\showRevision(), SpecialUndelete\showSearchForm(), SpecialAllpages\showToplevel(), SpecialVersion\softwareInformation(), XmlTest\testCloseElement(), SpecialEmailUser\userForm(), ImagePage\view(), and SpecialWhatLinksHere\whatlinkshereForm().

◆ dateMenu()

static Xml::dateMenu (   $year,
  $month 
)
static
Parameters
$yearInteger
$monthInteger
Returns
string Formatted HTML

Definition at line 188 of file Xml.php.

References $timestamp, array(), MWTimestamp\getInstance(), Html\input(), label(), monthSelector(), text, and wfMessage().

Referenced by HistoryAction\onView(), LogEventsList\showOptions(), and XmlTest\testDateMenu().

◆ element()

static Xml::element (   $element,
  $attribs = null,
  $contents = '',
  $allowShortTag = true 
)
static

Format an XML element with given attributes and, optionally, text content.

Element and attribute names are assumed to be ready for literal inclusion. Strings are assumed to not contain XML-illegal characters; special characters (<, >, &) are escaped but illegals are not touched.

Parameters
string$elementelement name
array$attribsName=>value pairs. Values will be escaped.
string$contentsNULL to make an open tag only; '' for a contentless closed tag (default)
bool$allowShortTagwhether '' in $contents will result in a contentless closed tag
Returns
string

Definition at line 39 of file Xml.php.

References $attribs, $out, and expandAttributes().

Referenced by ProtectionForm\buildForm(), ChangeTags\buildTagFilterSelector(), XmlDumpWriter\caseSetting(), check(), TextPassDumper\clearOpenElement(), Article\confirmDelete(), Preferences\datetimePreferences(), Article\delete(), HistoryPager\diffButtons(), Article\doDelete(), SpecialTags\doTagRow(), elementClean(), escapeJsString(), SpecialExport\execute(), SpecialListGroupRights\execute(), MIMEsearchPage\execute(), fieldset(), SpecialStatistics\formatRow(), ImageListPager\formatValue(), SpecialSearch\formHeader(), XmlDumpWriter\generator(), SpecialVersion\getExtensionCredits(), SpecialVersion\getMediaWikiCredits(), Skin\getNewtalks(), UserrightsPage\groupCheckboxes(), XmlDumpWriter\homelink(), input(), ChangesList\insertDateHeader(), label(), ChangesListSpecialPage\makeLegend(), OutputPage\makeResourceLoaderLink(), SpecialSearch\makeSearchLink(), SpecialAllpages\namespaceForm(), SpecialPrefixindex\namespacePrefixForm(), XmlDumpWriter\namespaces(), XmlDumpWriter\openPage(), XmlDumpWriter\openStream(), Licenses\outputOption(), SpecialSearch\powerSearchBox(), radio(), EnhancedChangesList\recentChangesLine(), UserrightsPage\showEditUserGroupsForm(), MovePageForm\showForm(), FileDeleteForm\showForm(), SpecialUndelete\showHistory(), ProtectionForm\showLogExtract(), MovePageForm\showLogFragment(), UserrightsPage\showLogFragment(), SpecialMergeHistory\showMergeForm(), SpecialProtectedpages\showOptions(), SpecialProtectedtitles\showOptions(), SpecialSearch\showResults(), SpecialUndelete\showRevision(), XmlDumpWriter\sitename(), SpecialVersion\softwareInformation(), span(), XmlTest\testElementAttributes(), XmlTest\testElementEmpty(), XmlTest\testElementEscaping(), XmlTest\testElementOpen(), textarea(), ThumbnailImage\toHtml(), Preferences\validateSignature(), ImagePage\view(), XmlDumpWriter\writeContributor(), XmlDumpWriter\writeLogItem(), XmlDumpWriter\writeRevision(), XmlDumpWriter\writeTimestamp(), and XmlDumpWriter\writeUpload().

◆ elementClean()

static Xml::elementClean (   $element,
  $attribs = array(),
  $contents = '' 
)
static

Format an XML element as with self::element(), but run text through the $wgContLang->normalize() validator first to ensure that no invalid UTF-8 is passed.

Parameters
$elementString:
array$attribsName=>value pairs. Values will be escaped.
string$contentsNULL to make an open tag only; '' for a contentless closed tag (default)
Returns
string

Definition at line 89 of file Xml.php.

References $attribs, $wgContLang, array(), element(), global, wfProfileIn(), and wfProfileOut().

Referenced by XmlDumpWriter\openPage(), XmlDumpWriter\writeContributor(), XmlDumpWriter\writeLogItem(), XmlDumpWriter\writeRevision(), and XmlDumpWriter\writeUpload().

◆ encodeJsCall()

static Xml::encodeJsCall (   $name,
  $args,
  $pretty = false 
)
static

Create a call to a JavaScript function.

The supplied arguments will be encoded using Xml::encodeJsVar().

Since
1.17
Parameters
string$nameThe name of the function to call, or a JavaScript expression which evaluates to a function object which is called.
array$argsThe arguments to pass to the function.
bool$prettyIf true, add non-significant whitespace to improve readability.
Returns
string|bool: String if successful; false upon failure

Definition at line 665 of file Xml.php.

Referenced by ProtectionForm\buildCleanupScript(), SpecialJavaScriptTest\exportQUnit(), OutputPage\getHeadScripts(), ResourceLoaderUserTokensModule\getScript(), ResourceLoaderUserOptionsModule\getScript(), ResourceLoaderLanguageDataModule\getScript(), ResourceLoaderStartUpModule\getScript(), OutputPage\getScriptsForBottomQueue(), ResourceLoader\makeConfigSetScript(), ResourceLoader\makeCustomLoaderScript(), ResourceLoader\makeLoaderImplementScript(), ResourceLoader\makeLoaderRegisterScript(), ResourceLoader\makeLoaderSourcesScript(), ResourceLoader\makeLoaderStateScript(), ResourceLoader\makeMessageSetScript(), OutputPage\makeResourceLoaderLink(), and SpecialJavaScriptTest\viewQUnit().

◆ encodeJsVar()

static Xml::encodeJsVar (   $value,
  $pretty = false 
)
static

Encode a variable of arbitrary type to JavaScript.

If the value is an XmlJsCode object, pass through the object's value verbatim.

Note
Only use this function for generating JavaScript code. If generating output for a proper JSON parser, just call FormatJson::encode() directly.
Parameters
mixed$valueThe value being encoded. Can be any type except a resource.
bool$prettyIf true, add non-significant whitespace to improve readability.
Returns
string|bool: String if successful; false upon failure

Definition at line 647 of file Xml.php.

Referenced by XmlTest\testEncodeJsVarArray(), XmlTest\testEncodeJsVarBoolean(), XmlTest\testEncodeJsVarFloat(), XmlTest\testEncodeJsVarFloatString(), XmlTest\testEncodeJsVarInt(), XmlTest\testEncodeJsVarIntString(), XmlTest\testEncodeJsVarNull(), XmlTest\testEncodeJsVarObject(), and ResourceLoaderModule\validateScriptFile().

◆ escapeJsString()

static Xml::escapeJsString (   $string)
static

Returns an escaped string suitable for inclusion in a string literal for JavaScript source code.

Illegal control characters are assumed not to be present.

Deprecated:
since 1.21; use Xml::encodeJsVar() or Xml::encodeJsCall() instead
Parameters
string$stringto escape
Returns
String

Definition at line 609 of file Xml.php.

References array(), element(), https, of, section, and so().

Referenced by XmlTest\testEscapeJsStringSpecialChars().

◆ escapeTagsOnly()

static Xml::escapeTagsOnly (   $in)
static

Replace " > and < with their respective HTML entities ( ", >, <)

Parameters
string$intext that might contain HTML tags.
Returns
string Escaped string

Definition at line 735 of file Xml.php.

Referenced by CoreTagHooks\nowiki(), CoreTagHooks\pre(), and XmlTest\testEscapeTagsOnly().

◆ expandAttributes()

static Xml::expandAttributes (   $attribs)
static

Given an array of ('attributename' => 'value'), it generates the code to set the XML attributes : attributename="value".

The values are passed to Sanitizer::encodeAttribute. Return null if no attributes given.

Parameters
array$attribsof attributes for an XML element
Exceptions
MWException
Returns
null|string

Definition at line 65 of file Xml.php.

References $attribs, $name, $out, as, and Sanitizer\encodeAttribute().

Referenced by element(), VectorTemplate\execute(), openElement(), XmlTest\testExpandAttributes(), XmlTest\testExpandAttributesException(), and Linker\tooltip().

◆ fieldset()

static Xml::fieldset (   $legend = false,
  $content = false,
  $attribs = array() 
)
static

◆ input()

◆ inputLabel()

static Xml::inputLabel (   $label,
  $name,
  $id,
  $size = false,
  $value = false,
  $attribs = array() 
)
static

Convenience function to build an HTML text input field with a label.

Parameters
string$labeltext of the label
string$namevalue of the name attribute
string$idid of the input
int | Bool$sizevalue of the size attribute
string | Bool$valuevalue of the value attribute
array$attribsother attributes
Returns
string HTML

Definition at line 398 of file Xml.php.

References $attribs, $name, $size, $value, inputLabelSep(), and list.

Referenced by SpecialExport\execute(), LinkSearchPage\execute(), FileDuplicateSearchPage\execute(), MIMEsearchPage\execute(), LogEventsList\getExtraInputs(), WithoutInterwikiPage\getPageHeader(), ActiveUsersPager\getPageHeader(), CategoryPager\getStartForm(), LogEventsList\getTitleInput(), LogEventsList\getUserInput(), SpecialBookSources\makeForm(), SpecialExpandTemplates\makeForm(), UserrightsPage\switchForm(), SpecialEmailUser\userForm(), and SpecialWhatLinksHere\whatlinkshereForm().

◆ inputLabelSep()

static Xml::inputLabelSep (   $label,
  $name,
  $id,
  $size = false,
  $value = false,
  $attribs = array() 
)
static

Same as Xml::inputLabel() but return input and label in an array.

Parameters
$labelString
$nameString
$idString
$sizeInt|Bool
$valueString|Bool
$attribsarray
Returns
array

Definition at line 415 of file Xml.php.

References $attribs, $name, $size, $value, array(), and label().

Referenced by SpecialRecentChanges\categoryFilterForm(), and inputLabel().

◆ isWellFormed()

static Xml::isWellFormed (   $text)
staticprivate

Check if a string is well-formed XML.

Must include the surrounding tag. This function is a DoS vector if an attacker can define entities in $text.

Parameters
string$textstring to test.
Returns
bool
Todo:
Error position reporting return

Definition at line 690 of file Xml.php.

◆ isWellFormedXmlFragment()

static Xml::isWellFormedXmlFragment (   $text)
static

Check if a string is a well-formed XML fragment.

Wraps fragment in an <html> bit and doctype, so it can be a fragment and can use HTML named entities.

Parameters
$textString:
Returns
bool

Definition at line 718 of file Xml.php.

◆ label()

◆ languageSelector()

static Xml::languageSelector (   $selected,
  $customisedOnly = true,
  $inLanguage = null,
  $overrideAttrs = array(),
Message  $msg = null 
)
static

Construct a language selector appropriate for use in a form or preferences.

Parameters
string$selectedThe language code of the selected language
boolean$customisedOnlyIf true only languages which have some content are listed
string$inLanguageThe ISO code of the language to display the select list in (optional)
array$overrideAttrsOverride the attributes of the select tag (since 1.20)
Message | null$msgLabel message key (since 1.20)
Returns
array containing 2 items: label HTML and select list HTML

Definition at line 225 of file Xml.php.

References $languages, $name, $options, array(), as, Language\fetchLanguageNames(), global, label(), option(), tags(), and wfMessage().

Referenced by AllmessagesTablePager\buildForm(), and XmlTest\testLanguageSelector().

◆ listDropDown()

static Xml::listDropDown (   $name = '',
  $list = '',
  $other = '',
  $selected = '',
  $class = '',
  $tabindex = null 
)
static

Build a drop-down box from a textual list.

Parameters
$nameMixed: Name and id for the drop-down
$listMixed: Correctly formatted text (newline delimited) to be used to generate the options
$otherMixed: Text for the "Other reasons" option
$selectedMixed: Option which should be pre-selected
$classMixed: CSS classes for the drop-down
$tabindexMixed: Value of the tabindex attribute
Returns
string

Definition at line 497 of file Xml.php.

References $attribs, $name, $options, $tabindex, $value, array(), as, closeElement(), openElement(), and option().

Referenced by ProtectionForm\buildForm(), Article\confirmDelete(), FileDeleteForm\showForm(), and SpecialRevisionDelete\showForm().

◆ monthSelector()

static Xml::monthSelector (   $selected = '',
  $allmonths = null,
  $id = 'month' 
)
static

Create a date selector.

Parameters
$selectedMixed: the month which should be selected, default ''
string$allmonthsvalue of a special item denoting all month. Null to not include (default)
string$idElement identifier
Returns
String: Html string containing the month selector

Definition at line 166 of file Xml.php.

References $options, $wgLang, array(), closeElement(), global, openElement(), option(), text, and wfMessage().

Referenced by dateMenu().

◆ namespaceSelector()

static Xml::namespaceSelector (   $selected = '',
  $all = null,
  $element_name = 'namespace',
  $label = null 
)
static

Build a drop-down box for selecting a namespace.

Parameters
$selectedMixed: Namespace which should be pre-selected
$allMixed: Value of an item denoting all namespaces, or null to omit
$element_nameString: value of the "name" attribute of the select tag
string$labeloptional label to add to the field
Returns
string
Deprecated:
since 1.19

Definition at line 145 of file Xml.php.

References array(), Html\namespaceSelector(), and wfDeprecated().

◆ openElement()

static Xml::openElement (   $element,
  $attribs = null 
)
static

This opens an XML element.

Parameters
string$elementname of the element
array$attribsof attributes, see Xml::expandAttributes()
Returns
string

Definition at line 109 of file Xml.php.

References $attribs, and expandAttributes().

Referenced by AllmessagesTablePager\buildForm(), ProtectionForm\buildForm(), ProtectionForm\buildSelector(), Article\confirmDelete(), SpecialRecentChanges\doHeader(), SpecialStatistics\execute(), SpecialExport\execute(), SpecialListGroupRights\execute(), MIMEsearchPage\execute(), QueryPage\execute(), fieldset(), SpecialNewpages\form(), AllmessagesTablePager\formatRow(), SpecialStatistics\formatRowHeader(), SpecialSearch\formHeader(), SpecialStatistics\getEditStats(), SpecialVersion\getExtensionCredits(), SpecialStatistics\getMostViewedPages(), ActiveUsersPager\getPageHeader(), UsersPager\getPageHeader(), SpecialStatistics\getPageStats(), MysqlInstaller\getSettingsForm(), AllmessagesTablePager\getStartBody(), SpecialStatistics\getUserStats(), SpecialStatistics\getViewsStats(), UserrightsPage\groupCheckboxes(), listDropDown(), SpecialWhatLinksHere\listItem(), SpecialWhatLinksHere\listStart(), SpecialExpandTemplates\makeForm(), ChangesListSpecialPage\makeLegend(), monthSelector(), SpecialAllpages\namespaceForm(), SpecialPrefixindex\namespacePrefixForm(), ImagePage\openShowImage(), SpecialListGroupRights\outputNamespaceProtectionInfo(), SpecialSearch\powerSearchBox(), CoreTagHooks\pre(), SpecialWatchlist\setTopText(), SpecialAllpages\showChunk(), UserrightsPage\showEditUserGroupsForm(), SpecialUndelete\showFileConfirmationForm(), MovePageForm\showForm(), SpecialChangeEmail\showForm(), SpecialImport\showForm(), FileDeleteForm\showForm(), SpecialRevisionDelete\showForm(), SpecialMergeHistory\showHistory(), SpecialUndelete\showHistory(), LogEventsList\showLogExtract(), SpecialMergeHistory\showMergeForm(), SpecialProtectedpages\showOptions(), SpecialPrefixindex\showPrefixChunk(), SpecialSearch\showResults(), SpecialUndelete\showRevision(), SpecialUndelete\showSearchForm(), SpecialAllpages\showToplevel(), SpecialVersion\softwareInformation(), tags(), XmlTest\testOpenElement(), TraditionalImageGallery\toHTML(), SpecialRevisionDelete\tryShowFile(), SpecialEmailUser\userForm(), ImagePage\view(), and SpecialWhatLinksHere\whatlinkshereForm().

◆ option()

static Xml::option (   $text,
  $value = null,
  $selected = false,
  $attribs = array() 
)
static

Convenience function to build an HTML drop-down list item.

Parameters
string$texttext for this item. Will be HTML escaped
string$valueform submission value; if empty, use text
$selectedboolean: if true, will be the default selected item
array$attribsoptional additional HTML attributes
Returns
string HTML

Definition at line 475 of file Xml.php.

References $attribs, $value, and Html\element().

Referenced by ProtectionForm\buildForm(), ProtectionForm\buildSelector(), ImagePage\doRenderLangOpt(), SpecialProtectedtitles\getLevelMenu(), SpecialProtectedpages\getLevelMenu(), UsersPager\getPageHeader(), SpecialProtectedpages\getTypeMenu(), languageSelector(), listDropDown(), monthSelector(), ImagePage\openShowImage(), and SpecialImport\showForm().

◆ password()

static Xml::password (   $name,
  $size = false,
  $value = false,
  $attribs = array() 
)
static

Convenience function to build an HTML password input field.

Parameters
string$namevalue of the name attribute
int$sizevalue of the size attribute
$valuemixed value of the value attribute
array$attribsother attributes
Returns
string HTML

Definition at line 316 of file Xml.php.

References $attribs, $name, $size, $value, array(), and input().

◆ radio()

static Xml::radio (   $name,
  $value,
  $checked = false,
  $attribs = array() 
)
static

Convenience function to build an HTML radio button.

Parameters
string$namevalue of the name attribute
string$valuevalue of the value attribute
bool$checkedWhether the checkbox is checked or not
array$attribsother attributes
Returns
string HTML

Definition at line 357 of file Xml.php.

References $attribs, $name, $value, array(), and element().

Referenced by SpecialRevisionDelete\buildCheckBoxes(), HTMLRadioField\formatOptions(), SpecialMergeHistory\formatRevisionRow(), WebInstaller\getRadioSet(), and radioLabel().

◆ radioLabel()

static Xml::radioLabel (   $label,
  $name,
  $value,
  $id,
  $checked = false,
  $attribs = array() 
)
static

Convenience function to build an HTML radio button with a label.

Parameters
$label
$name
$value
$id
$checkedbool
$attribsarray
Returns
string HTML

Definition at line 451 of file Xml.php.

References $attribs, $name, $value, array(), label(), and radio().

Referenced by AllmessagesTablePager\buildForm(), and SpecialProtectedpages\getSizeLimit().

◆ span()

static Xml::span (   $text,
  $class,
  $attribs = array() 
)
static

Shortcut to make a span element.

Parameters
string$textcontent of the element, will be escaped
string$classclass name of the span element
array$attribsother attributes
Returns
string

Definition at line 270 of file Xml.php.

References $attribs, array(), and element().

◆ submitButton()

static Xml::submitButton (   $value,
  $attribs = array() 
)
static

Convenience function to build an HTML submit button.

Parameters
string$valuelabel text for the button
array$attribsoptional custom attributes
Returns
string HTML

Definition at line 463 of file Xml.php.

References $attribs, $value, array(), and Html\element().

Referenced by AllmessagesTablePager\buildForm(), ProtectionForm\buildForm(), Article\confirmDelete(), SpecialWatchlist\doHeader(), ImagePage\doRenderLangOpt(), SpecialExport\execute(), LinkSearchPage\execute(), FileDuplicateSearchPage\execute(), MIMEsearchPage\execute(), SpecialNewpages\form(), HTMLForm\getButtons(), WithoutInterwikiPage\getPageHeader(), ActiveUsersPager\getPageHeader(), UsersPager\getPageHeader(), CategoryPager\getStartForm(), SpecialBookSources\makeForm(), SpecialExpandTemplates\makeForm(), SpecialAllpages\namespaceForm(), SpecialPrefixindex\namespacePrefixForm(), HistoryAction\onView(), ImagePage\openShowImage(), SpecialWatchlist\setTopText(), SpecialSearch\shortDialog(), UserrightsPage\showEditUserGroupsForm(), SpecialUndelete\showFileConfirmationForm(), MovePageForm\showForm(), SpecialChangeEmail\showForm(), SpecialImport\showForm(), FileDeleteForm\showForm(), SpecialRevisionDelete\showForm(), SpecialMergeHistory\showHistory(), SpecialUndelete\showHistory(), SpecialMergeHistory\showMergeForm(), LogEventsList\showOptions(), SpecialProtectedpages\showOptions(), SpecialProtectedtitles\showOptions(), EmailConfirmation\showRequestForm(), SpecialUndelete\showSearchForm(), HistoryPager\submitButton(), UserrightsPage\switchForm(), SpecialRevisionDelete\tryShowFile(), SpecialEmailUser\userForm(), and SpecialWhatLinksHere\whatlinkshereForm().

◆ tags()

static Xml::tags (   $element,
  $attribs = null,
  $contents 
)
static

Same as Xml::element(), but does not escape contents.

Handy when the content you have is already valid xml.

Parameters
string$elementelement name
array$attribsof attributes
string$contentscontent of the element
Returns
string

Definition at line 131 of file Xml.php.

References $attribs, and openElement().

Referenced by SpecialRevisionDelete\buildCheckBoxes(), ProtectionForm\buildForm(), ChangeTags\buildTagFilterSelector(), ImportReporter\close(), Article\confirmDelete(), SpecialRecentChanges\doHeader(), SpecialTags\doTagRow(), SpecialTags\execute(), SpecialUndelete\formatRevisionRow(), AllmessagesTablePager\formatRow(), SpecialStatistics\formatRowHeader(), ChangeTags\formatSummaryRow(), SpecialSearch\formHeader(), PreferencesForm\getButtons(), SpecialStatistics\getEditStats(), SpecialProtectedtitles\getLevelMenu(), SpecialProtectedpages\getLevelMenu(), SpecialStatistics\getMostViewedPages(), SpecialStatistics\getPageStats(), WebInstaller\getRadioSet(), CategoryPager\getStartForm(), SpecialProtectedpages\getTypeMenu(), SpecialStatistics\getUserStats(), SpecialStatistics\getViewsStats(), UserrightsPage\groupCheckboxes(), HistoryPager\historyLine(), WebInstaller\label(), languageSelector(), MediaTransformOutput\linkWrap(), SpecialWhatLinksHere\listItem(), ChangesListSpecialPage\makeLegend(), ImagePage\openShowImage(), SpecialSearch\powerSearchBox(), Linker\revDeleteLink(), Linker\revDeleteLinkDisabled(), UserrightsPage\showEditUserGroupsForm(), MovePageForm\showForm(), SpecialRevisionDelete\showForm(), LogEventsList\showOptions(), wrapClass(), PreferencesForm\wrapForm(), and TableDiffFormatter\wrapLine().

◆ textarea()

static Xml::textarea (   $name,
  $content,
  $cols = 40,
  $rows = 5,
  $attribs = array() 
)
static

Shortcut for creating textareas.

Parameters
string$nameThe 'name' for the textarea
string$contentContent for the textarea
int$colsThe number of columns for the textarea
int$rowsThe number of rows for the textarea
array$attribsAny other attributes for the textarea
Returns
string

Definition at line 589 of file Xml.php.

References $attribs, $name, array(), and element().

Referenced by WebInstaller\getTextArea(), SpecialExpandTemplates\makeForm(), SpecialExpandTemplates\makeOutput(), XmlTest\testTextareaAttribs(), and XmlTest\testTextareaNoContent().

◆ wrapClass()

static Xml::wrapClass (   $text,
  $class,
  $tag = 'span',
  $attribs = array() 
)
static

Shortcut to make a specific element with a class attribute.

Parameters
string$textcontent of the element, will be escaped
string$classclass name of the span element
string$tagelement name
array$attribsother attributes
Returns
string

Definition at line 282 of file Xml.php.

References $attribs, array(), and tags().

Referenced by SpecialWhatLinksHere\listItem().


The documentation for this class was generated from the following file: