123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863 |
- <?php
- /**
- * Methods to generate XML.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * http://www.gnu.org/copyleft/gpl.html
- *
- * @file
- */
- use MediaWiki\MediaWikiServices;
- /**
- * Module of static functions for generating XML
- */
- class Xml {
- /**
- * 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.
- *
- * @param string $element Element name
- * @param array|null $attribs Name=>value pairs. Values will be escaped.
- * @param string $contents Null to make an open tag only; '' for a contentless closed tag (default)
- * @param bool $allowShortTag Whether '' in $contents will result in a contentless closed tag
- * @return string
- */
- public static function element( $element, $attribs = null, $contents = '',
- $allowShortTag = true
- ) {
- $out = '<' . $element;
- if ( !is_null( $attribs ) ) {
- $out .= self::expandAttributes( $attribs );
- }
- if ( is_null( $contents ) ) {
- $out .= '>';
- } else {
- if ( $allowShortTag && $contents === '' ) {
- $out .= ' />';
- } else {
- $out .= '>' . htmlspecialchars( $contents, ENT_NOQUOTES ) . "</$element>";
- }
- }
- return $out;
- }
- /**
- * Given an array of ('attributename' => 'value'), it generates the code
- * to set the XML attributes : attributename="value".
- * The values are passed to Sanitizer::encodeAttribute.
- * Returns null or empty string if no attributes given.
- * @param array|null $attribs Array of attributes for an XML element
- * @throws MWException
- * @return null|string
- */
- public static function expandAttributes( $attribs ) {
- $out = '';
- if ( is_null( $attribs ) ) {
- return null;
- } elseif ( is_array( $attribs ) ) {
- foreach ( $attribs as $name => $val ) {
- $out .= " {$name}=\"" . Sanitizer::encodeAttribute( $val ) . '"';
- }
- return $out;
- } else {
- throw new MWException( 'Expected attribute array, got something else in ' . __METHOD__ );
- }
- }
- /**
- * Format an XML element as with self::element(), but run text through the content language's
- * normalize() validator first to ensure that no invalid UTF-8 is passed.
- *
- * @param string $element
- * @param array $attribs Name=>value pairs. Values will be escaped.
- * @param string $contents Null to make an open tag only; '' for a contentless closed tag (default)
- * @return string
- */
- public static function elementClean( $element, $attribs = [], $contents = '' ) {
- if ( $attribs ) {
- $attribs = array_map( [ 'UtfNormal\Validator', 'cleanUp' ], $attribs );
- }
- if ( $contents ) {
- $contents =
- MediaWikiServices::getInstance()->getContentLanguage()->normalize( $contents );
- }
- return self::element( $element, $attribs, $contents );
- }
- /**
- * This opens an XML element
- *
- * @param string $element Name of the element
- * @param array|null $attribs Array of attributes, see Xml::expandAttributes()
- * @return string
- */
- public static function openElement( $element, $attribs = null ) {
- return '<' . $element . self::expandAttributes( $attribs ) . '>';
- }
- /**
- * Shortcut to close an XML element
- * @param string $element Element name
- * @return string
- */
- public static function closeElement( $element ) {
- return "</$element>";
- }
- /**
- * Same as Xml::element(), but does not escape contents. Handy when the
- * content you have is already valid xml.
- *
- * @param string $element Element name
- * @param array|null $attribs Array of attributes
- * @param string $contents Content of the element
- * @return string
- */
- public static function tags( $element, $attribs, $contents ) {
- return self::openElement( $element, $attribs ) . $contents . "</$element>";
- }
- /**
- * Create a date selector
- *
- * @param string $selected The month which should be selected, default ''.
- * @param string|null $allmonths Value of a special item denoting all month.
- * Null to not include (default).
- * @param string $id Element identifier
- * @return string Html string containing the month selector
- */
- public static function monthSelector( $selected = '', $allmonths = null, $id = 'month' ) {
- global $wgLang;
- $options = [];
- $data = new XmlSelect( 'month', $id, $selected );
- if ( is_null( $selected ) ) {
- $selected = '';
- }
- if ( !is_null( $allmonths ) ) {
- $options[wfMessage( 'monthsall' )->text()] = $allmonths;
- }
- for ( $i = 1; $i < 13; $i++ ) {
- $options[$wgLang->getMonthName( $i )] = $i;
- }
- $data->addOptions( $options );
- $data->setAttribute( 'class', 'mw-month-selector' );
- return $data->getHTML();
- }
- /**
- * @param int|string $year Use '' or 0 to start with no year preselected.
- * @param int|string $month A month in the 1..12 range. Use '', 0 or -1 to start with no month
- * preselected.
- * @return string Formatted HTML
- */
- public static function dateMenu( $year, $month ) {
- # Offset overrides year/month selection
- if ( $month && $month !== -1 ) {
- $encMonth = intval( $month );
- } else {
- $encMonth = '';
- }
- if ( $year ) {
- $encYear = intval( $year );
- } elseif ( $encMonth ) {
- $timestamp = MWTimestamp::getInstance();
- $thisMonth = intval( $timestamp->format( 'n' ) );
- $thisYear = intval( $timestamp->format( 'Y' ) );
- if ( intval( $encMonth ) > $thisMonth ) {
- $thisYear--;
- }
- $encYear = $thisYear;
- } else {
- $encYear = '';
- }
- $inputAttribs = [ 'id' => 'year', 'maxlength' => 4, 'size' => 7 ];
- return self::label( wfMessage( 'year' )->text(), 'year' ) . ' ' .
- Html::input( 'year', $encYear, 'number', $inputAttribs ) . ' ' .
- self::label( wfMessage( 'month' )->text(), 'month' ) . ' ' .
- self::monthSelector( $encMonth, -1 );
- }
- /**
- * Construct a language selector appropriate for use in a form or preferences
- *
- * @param string $selected The language code of the selected language
- * @param bool $customisedOnly If true only languages which have some content are listed
- * @param string|null $inLanguage The ISO code of the language to display the select list in
- * @param array $overrideAttrs Override the attributes of the select tag (since 1.20)
- * @param Message|null $msg Label message key (since 1.20)
- * @return array Array containing 2 items: label HTML and select list HTML
- */
- public static function languageSelector( $selected, $customisedOnly = true,
- $inLanguage = null, $overrideAttrs = [], Message $msg = null
- ) {
- global $wgLanguageCode;
- $include = $customisedOnly ? 'mwfile' : 'mw';
- $languages = Language::fetchLanguageNames( $inLanguage, $include );
- // Make sure the site language is in the list;
- // a custom language code might not have a defined name...
- if ( !array_key_exists( $wgLanguageCode, $languages ) ) {
- $languages[$wgLanguageCode] = $wgLanguageCode;
- // Sort the array again
- ksort( $languages );
- }
- /**
- * If a bogus value is set, default to the content language.
- * Otherwise, no default is selected and the user ends up
- * with Afrikaans since it's first in the list.
- */
- $selected = isset( $languages[$selected] ) ? $selected : $wgLanguageCode;
- $options = "\n";
- foreach ( $languages as $code => $name ) {
- $options .= self::option( "$code - $name", $code, $code == $selected ) . "\n";
- }
- $attrs = [ 'id' => 'wpUserLanguage', 'name' => 'wpUserLanguage' ];
- $attrs = array_merge( $attrs, $overrideAttrs );
- if ( $msg === null ) {
- $msg = wfMessage( 'yourlanguage' );
- }
- return [
- self::label( $msg->text(), $attrs['id'] ),
- self::tags( 'select', $attrs, $options )
- ];
- }
- /**
- * Shortcut to make a span element
- * @param string $text Content of the element, will be escaped
- * @param string $class Class name of the span element
- * @param array $attribs Other attributes
- * @return string
- */
- public static function span( $text, $class, $attribs = [] ) {
- return self::element( 'span', [ 'class' => $class ] + $attribs, $text );
- }
- /**
- * Shortcut to make a specific element with a class attribute
- * @param string $text Content of the element, will be escaped
- * @param string $class Class name of the span element
- * @param string $tag Element name
- * @param array $attribs Other attributes
- * @return string
- */
- public static function wrapClass( $text, $class, $tag = 'span', $attribs = [] ) {
- return self::tags( $tag, [ 'class' => $class ] + $attribs, $text );
- }
- /**
- * Convenience function to build an HTML text input field
- * @param string $name Value of the name attribute
- * @param int $size Value of the size attribute
- * @param mixed $value Value of the value attribute
- * @param array $attribs Other attributes
- * @return string HTML
- */
- public static function input( $name, $size = false, $value = false, $attribs = [] ) {
- $attributes = [ 'name' => $name ];
- if ( $size ) {
- $attributes['size'] = $size;
- }
- if ( $value !== false ) { // maybe 0
- $attributes['value'] = $value;
- }
- return self::element( 'input',
- Html::getTextInputAttributes( $attributes + $attribs ) );
- }
- /**
- * Convenience function to build an HTML password input field
- * @param string $name Value of the name attribute
- * @param int $size Value of the size attribute
- * @param mixed $value Value of the value attribute
- * @param array $attribs Other attributes
- * @return string HTML
- */
- public static function password( $name, $size = false, $value = false,
- $attribs = []
- ) {
- return self::input( $name, $size, $value,
- array_merge( $attribs, [ 'type' => 'password' ] ) );
- }
- /**
- * Internal function for use in checkboxes and radio buttons and such.
- *
- * @param string $name
- * @param bool $present
- *
- * @return array
- */
- public static function attrib( $name, $present = true ) {
- return $present ? [ $name => $name ] : [];
- }
- /**
- * Convenience function to build an HTML checkbox
- * @param string $name Value of the name attribute
- * @param bool $checked Whether the checkbox is checked or not
- * @param array $attribs Array other attributes
- * @return string HTML
- */
- public static function check( $name, $checked = false, $attribs = [] ) {
- return self::element( 'input', array_merge(
- [
- 'name' => $name,
- 'type' => 'checkbox',
- 'value' => 1 ],
- self::attrib( 'checked', $checked ),
- $attribs ) );
- }
- /**
- * Convenience function to build an HTML radio button
- * @param string $name Value of the name attribute
- * @param string $value Value of the value attribute
- * @param bool $checked Whether the checkbox is checked or not
- * @param array $attribs Other attributes
- * @return string HTML
- */
- public static function radio( $name, $value, $checked = false, $attribs = [] ) {
- return self::element( 'input', [
- 'name' => $name,
- 'type' => 'radio',
- 'value' => $value ] + self::attrib( 'checked', $checked ) + $attribs );
- }
- /**
- * Convenience function to build an HTML form label
- * @param string $label Text of the label
- * @param string $id
- * @param array $attribs An attribute array. This will usually be
- * the same array as is passed to the corresponding input element,
- * so this function will cherry-pick appropriate attributes to
- * apply to the label as well; only class and title are applied.
- * @return string HTML
- */
- public static function label( $label, $id, $attribs = [] ) {
- $a = [ 'for' => $id ];
- foreach ( [ 'class', 'title' ] as $attr ) {
- if ( isset( $attribs[$attr] ) ) {
- $a[$attr] = $attribs[$attr];
- }
- }
- return self::element( 'label', $a, $label );
- }
- /**
- * Convenience function to build an HTML text input field with a label
- * @param string $label Text of the label
- * @param string $name Value of the name attribute
- * @param string $id Id of the input
- * @param int|bool $size Value of the size attribute
- * @param string|bool $value Value of the value attribute
- * @param array $attribs Other attributes
- * @return string HTML
- */
- public static function inputLabel( $label, $name, $id, $size = false,
- $value = false, $attribs = []
- ) {
- list( $label, $input ) = self::inputLabelSep( $label, $name, $id, $size, $value, $attribs );
- return $label . "\u{00A0}" . $input;
- }
- /**
- * Same as Xml::inputLabel() but return input and label in an array
- *
- * @param string $label
- * @param string $name
- * @param string $id
- * @param int|bool $size
- * @param string|bool $value
- * @param array $attribs
- *
- * @return array
- */
- public static function inputLabelSep( $label, $name, $id, $size = false,
- $value = false, $attribs = []
- ) {
- return [
- self::label( $label, $id, $attribs ),
- self::input( $name, $size, $value, [ 'id' => $id ] + $attribs )
- ];
- }
- /**
- * Convenience function to build an HTML checkbox with a label
- *
- * @param string $label
- * @param string $name
- * @param string $id
- * @param bool $checked
- * @param array $attribs
- *
- * @return string HTML
- */
- public static function checkLabel( $label, $name, $id, $checked = false, $attribs = [] ) {
- global $wgUseMediaWikiUIEverywhere;
- $chkLabel = self::check( $name, $checked, [ 'id' => $id ] + $attribs ) .
- "\u{00A0}" .
- self::label( $label, $id, $attribs );
- if ( $wgUseMediaWikiUIEverywhere ) {
- $chkLabel = self::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
- $chkLabel . self::closeElement( 'div' );
- }
- return $chkLabel;
- }
- /**
- * Convenience function to build an HTML radio button with a label
- *
- * @param string $label
- * @param string $name
- * @param string $value
- * @param string $id
- * @param bool $checked
- * @param array $attribs
- *
- * @return string HTML
- */
- public static function radioLabel( $label, $name, $value, $id,
- $checked = false, $attribs = []
- ) {
- return self::radio( $name, $value, $checked, [ 'id' => $id ] + $attribs ) .
- "\u{00A0}" .
- self::label( $label, $id, $attribs );
- }
- /**
- * Convenience function to build an HTML submit button
- * When $wgUseMediaWikiUIEverywhere is true it will default to a progressive button
- * @param string $value Label text for the button (unescaped)
- * @param array $attribs Optional custom attributes
- * @return string HTML
- */
- public static function submitButton( $value, $attribs = [] ) {
- global $wgUseMediaWikiUIEverywhere;
- $baseAttrs = [
- 'type' => 'submit',
- 'value' => $value,
- ];
- // Done conditionally for time being as it is possible
- // some submit forms
- // might need to be mw-ui-destructive (e.g. delete a page)
- if ( $wgUseMediaWikiUIEverywhere ) {
- $baseAttrs['class'] = 'mw-ui-button mw-ui-progressive';
- }
- // Any custom attributes will take precendence of anything in baseAttrs e.g. override the class
- $attribs = $attribs + $baseAttrs;
- return Html::element( 'input', $attribs );
- }
- /**
- * Convenience function to build an HTML drop-down list item.
- * @param string $text Text for this item. Will be HTML escaped
- * @param string|null $value Form submission value; if empty, use text
- * @param bool $selected If true, will be the default selected item
- * @param array $attribs Optional additional HTML attributes
- * @return string HTML
- */
- public static function option( $text, $value = null, $selected = false,
- $attribs = [] ) {
- if ( !is_null( $value ) ) {
- $attribs['value'] = $value;
- }
- if ( $selected ) {
- $attribs['selected'] = 'selected';
- }
- return Html::element( 'option', $attribs, $text );
- }
- /**
- * Build a drop-down box from a textual list. This is a wrapper
- * for Xml::listDropDownOptions() plus the XmlSelect class.
- *
- * @param string $name Name and id for the drop-down
- * @param string $list Correctly formatted text (newline delimited) to be
- * used to generate the options.
- * @param string $other Text for the "Other reasons" option
- * @param string $selected Option which should be pre-selected
- * @param string $class CSS classes for the drop-down
- * @param int|null $tabindex Value of the tabindex attribute
- * @return string
- */
- public static function listDropDown( $name = '', $list = '', $other = '',
- $selected = '', $class = '', $tabindex = null
- ) {
- $options = self::listDropDownOptions( $list, [ 'other' => $other ] );
- $xmlSelect = new XmlSelect( $name, $name, $selected );
- $xmlSelect->addOptions( $options );
- if ( $class ) {
- $xmlSelect->setAttribute( 'class', $class );
- }
- if ( $tabindex ) {
- $xmlSelect->setAttribute( 'tabindex', $tabindex );
- }
- return $xmlSelect->getHTML();
- }
- /**
- * Build options for a drop-down box from a textual list.
- *
- * The result of this function can be passed to XmlSelect::addOptions()
- * (to render a plain `<select>` dropdown box) or to Xml::listDropDownOptionsOoui()
- * and then OOUI\DropdownInputWidget() (to render a pretty one).
- *
- * @param string $list Correctly formatted text (newline delimited) to be
- * used to generate the options.
- * @param array $params Extra parameters:
- * - string $params['other'] If set, add an option with this as text and a value of 'other'
- * @return array Array keys are textual labels, values are internal values
- */
- public static function listDropDownOptions( $list, $params = [] ) {
- $options = [];
- if ( isset( $params['other'] ) ) {
- $options[ $params['other'] ] = 'other';
- }
- $optgroup = false;
- foreach ( explode( "\n", $list ) as $option ) {
- $value = trim( $option );
- if ( $value == '' ) {
- continue;
- } elseif ( substr( $value, 0, 1 ) == '*' && substr( $value, 1, 1 ) != '*' ) {
- # A new group is starting...
- $value = trim( substr( $value, 1 ) );
- $optgroup = $value;
- } elseif ( substr( $value, 0, 2 ) == '**' ) {
- # groupmember
- $opt = trim( substr( $value, 2 ) );
- if ( $optgroup === false ) {
- $options[$opt] = $opt;
- } else {
- $options[$optgroup][$opt] = $opt;
- }
- } else {
- # groupless reason list
- $optgroup = false;
- $options[$option] = $option;
- }
- }
- return $options;
- }
- /**
- * Convert options for a drop-down box into a format accepted by OOUI\DropdownInputWidget etc.
- *
- * TODO Find a better home for this function.
- *
- * @param array $options Options, as returned e.g. by Xml::listDropDownOptions()
- * @return array
- */
- public static function listDropDownOptionsOoui( $options ) {
- $optionsOoui = [];
- foreach ( $options as $text => $value ) {
- if ( is_array( $value ) ) {
- $optionsOoui[] = [ 'optgroup' => (string)$text ];
- foreach ( $value as $text2 => $value2 ) {
- $optionsOoui[] = [ 'data' => (string)$value2, 'label' => (string)$text2 ];
- }
- } else {
- $optionsOoui[] = [ 'data' => (string)$value, 'label' => (string)$text ];
- }
- }
- return $optionsOoui;
- }
- /**
- * Shortcut for creating fieldsets.
- *
- * @param string|bool $legend Legend of the fieldset. If evaluates to false,
- * legend is not added.
- * @param string $content Pre-escaped content for the fieldset. If false,
- * only open fieldset is returned.
- * @param array $attribs Any attributes to fieldset-element.
- *
- * @return string
- */
- public static function fieldset( $legend = false, $content = false, $attribs = [] ) {
- $s = self::openElement( 'fieldset', $attribs ) . "\n";
- if ( $legend ) {
- $s .= self::element( 'legend', null, $legend ) . "\n";
- }
- if ( $content !== false ) {
- $s .= $content . "\n";
- $s .= self::closeElement( 'fieldset' ) . "\n";
- }
- return $s;
- }
- /**
- * Shortcut for creating textareas.
- *
- * @param string $name The 'name' for the textarea
- * @param string $content Content for the textarea
- * @param int $cols The number of columns for the textarea
- * @param int $rows The number of rows for the textarea
- * @param array $attribs Any other attributes for the textarea
- *
- * @return string
- */
- public static function textarea( $name, $content, $cols = 40, $rows = 5, $attribs = [] ) {
- return self::element( 'textarea',
- Html::getTextInputAttributes(
- [
- 'name' => $name,
- 'id' => $name,
- 'cols' => $cols,
- 'rows' => $rows
- ] + $attribs
- ),
- $content, false );
- }
- /**
- * 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.
- *
- * @param mixed $value The value being encoded. Can be any type except a resource.
- * @param bool $pretty If true, add non-significant whitespace to improve readability.
- * @return string|bool String if successful; false upon failure
- */
- public static function encodeJsVar( $value, $pretty = false ) {
- if ( $value instanceof XmlJsCode ) {
- return $value->value;
- }
- return FormatJson::encode( $value, $pretty, FormatJson::UTF8_OK );
- }
- /**
- * Create a call to a JavaScript function. The supplied arguments will be
- * encoded using Xml::encodeJsVar().
- *
- * @since 1.17
- * @param string $name The name of the function to call, or a JavaScript expression
- * which evaluates to a function object which is called.
- * @param array $args The arguments to pass to the function.
- * @param bool $pretty If true, add non-significant whitespace to improve readability.
- * @return string|bool String if successful; false upon failure
- */
- public static function encodeJsCall( $name, $args, $pretty = false ) {
- foreach ( $args as &$arg ) {
- $arg = self::encodeJsVar( $arg, $pretty );
- if ( $arg === false ) {
- return false;
- }
- }
- return "$name(" . ( $pretty
- ? ( ' ' . implode( ', ', $args ) . ' ' )
- : implode( ',', $args )
- ) . ");";
- }
- /**
- * 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.
- *
- * @param string $text String to test.
- * @return bool
- *
- * @todo Error position reporting return
- */
- private static function isWellFormed( $text ) {
- $parser = xml_parser_create( "UTF-8" );
- # case folding violates XML standard, turn it off
- xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
- if ( !xml_parse( $parser, $text, true ) ) {
- // $err = xml_error_string( xml_get_error_code( $parser ) );
- // $position = xml_get_current_byte_index( $parser );
- // $fragment = $this->extractFragment( $html, $position );
- // $this->mXmlError = "$err at byte $position:\n$fragment";
- xml_parser_free( $parser );
- return false;
- }
- xml_parser_free( $parser );
- return true;
- }
- /**
- * 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.
- *
- * @param string $text
- * @return bool
- */
- public static function isWellFormedXmlFragment( $text ) {
- $html =
- Sanitizer::hackDocType() .
- '<html>' .
- $text .
- '</html>';
- return self::isWellFormed( $html );
- }
- /**
- * Replace " > and < with their respective HTML entities ( ",
- * >, <)
- *
- * @param string $in Text that might contain HTML tags.
- * @return string Escaped string
- */
- public static function escapeTagsOnly( $in ) {
- return str_replace(
- [ '"', '>', '<' ],
- [ '"', '>', '<' ],
- $in );
- }
- /**
- * Generate a form (without the opening form element).
- * Output optionally includes a submit button.
- * @param array $fields Associative array, key is the name of a message that
- * contains a description for the field, value is an HTML string
- * containing the appropriate input.
- * @param string|null $submitLabel The name of a message containing a label for
- * the submit button.
- * @param array $submitAttribs The attributes to add to the submit button
- * @return string HTML form.
- */
- public static function buildForm( $fields, $submitLabel = null, $submitAttribs = [] ) {
- $form = '';
- $form .= "<table><tbody>";
- foreach ( $fields as $labelmsg => $input ) {
- $id = "mw-$labelmsg";
- $form .= self::openElement( 'tr', [ 'id' => $id ] );
- // TODO use a <label> here for accessibility purposes - will need
- // to either not use a table to build the form, or find the ID of
- // the input somehow.
- $form .= self::tags( 'td', [ 'class' => 'mw-label' ], wfMessage( $labelmsg )->parse() );
- $form .= self::openElement( 'td', [ 'class' => 'mw-input' ] )
- . $input . self::closeElement( 'td' );
- $form .= self::closeElement( 'tr' );
- }
- if ( $submitLabel ) {
- $form .= self::openElement( 'tr' );
- $form .= self::tags( 'td', [], '' );
- $form .= self::openElement( 'td', [ 'class' => 'mw-submit' ] )
- . self::submitButton( wfMessage( $submitLabel )->text(), $submitAttribs )
- . self::closeElement( 'td' );
- $form .= self::closeElement( 'tr' );
- }
- $form .= "</tbody></table>";
- return $form;
- }
- /**
- * Build a table of data
- * @param array $rows An array of arrays of strings, each to be a row in a table
- * @param array $attribs An array of attributes to apply to the table tag [optional]
- * @param array|null $headers An array of strings to use as table headers [optional]
- * @return string
- */
- public static function buildTable( $rows, $attribs = [], $headers = null ) {
- $s = self::openElement( 'table', $attribs );
- if ( is_array( $headers ) ) {
- $s .= self::openElement( 'thead', $attribs );
- foreach ( $headers as $id => $header ) {
- $attribs = [];
- if ( is_string( $id ) ) {
- $attribs['id'] = $id;
- }
- $s .= self::element( 'th', $attribs, $header );
- }
- $s .= self::closeElement( 'thead' );
- }
- foreach ( $rows as $id => $row ) {
- $attribs = [];
- if ( is_string( $id ) ) {
- $attribs['id'] = $id;
- }
- $s .= self::buildTableRow( $attribs, $row );
- }
- $s .= self::closeElement( 'table' );
- return $s;
- }
- /**
- * Build a row for a table
- * @param array $attribs An array of attributes to apply to the tr tag
- * @param array $cells An array of strings to put in <td>
- * @return string
- */
- public static function buildTableRow( $attribs, $cells ) {
- $s = self::openElement( 'tr', $attribs );
- foreach ( $cells as $id => $cell ) {
- $attribs = [];
- if ( is_string( $id ) ) {
- $attribs['id'] = $id;
- }
- $s .= self::element( 'td', $attribs, $cell );
- }
- $s .= self::closeElement( 'tr' );
- return $s;
- }
- }
|