1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
<?php
/**
* Class for generating HTML <select> elements.
*
* 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
*/
namespace MediaWiki\Xml;
use MediaWiki\Html\Html;
/**
* Class for generating HTML <select> or <datalist> elements.
*/
class XmlSelect {
/** @var array[] */
protected $options = [];
/** @var string|array|false */
protected $default = false;
/** @var string|array */
protected $tagName = 'select';
/** @var (string|int)[] */
protected $attributes = [];
public function __construct( $name = false, $id = false, $default = false ) {
if ( $name ) {
$this->setAttribute( 'name', $name );
}
if ( $id ) {
$this->setAttribute( 'id', $id );
}
if ( $default !== false ) {
$this->default = $default;
}
}
/**
* @param string|array $default
*/
public function setDefault( $default ) {
$this->default = $default;
}
/**
* @param string|array $tagName
*/
public function setTagName( $tagName ) {
$this->tagName = $tagName;
}
/**
* @param string $name
* @param string|int $value
*/
public function setAttribute( $name, $value ) {
$this->attributes[$name] = $value;
}
/**
* @param string $name
* @return string|int|null
*/
public function getAttribute( $name ) {
return $this->attributes[$name] ?? null;
}
/**
* @param string $label
* @param string|int|float|false $value If not given, assumed equal to $label
*/
public function addOption( $label, $value = false ) {
$value = $value !== false ? $value : $label;
$this->options[] = [ $label => $value ];
}
/**
* This accepts an array of form
* label => value
* label => ( label => value, label => value )
*
* @param array $options
*/
public function addOptions( $options ) {
$this->options[] = $options;
}
/**
* This accepts an array of form:
* label => value
* label => ( label => value, label => value )
*
* @param array $options
* @param string|array|false $default
* @return string
*/
public static function formatOptions( $options, $default = false ) {
$data = '';
foreach ( $options as $label => $value ) {
if ( is_array( $value ) ) {
$contents = self::formatOptions( $value, $default );
$data .= Html::rawElement( 'optgroup', [ 'label' => $label ], $contents ) . "\n";
} else {
// If $default is an array, then the <select> probably has the multiple attribute,
// so we should check if each $value is in $default, rather than checking if
// $value is equal to $default.
$selected = is_array( $default ) ? in_array( $value, $default ) : $value === $default;
$data .= Xml::option( $label, $value, $selected ) . "\n";
}
}
return $data;
}
/**
* @return string
*/
public function getHTML() {
$contents = '';
foreach ( $this->options as $options ) {
$contents .= self::formatOptions( $options, $this->default );
}
return Html::rawElement( $this->tagName, $this->attributes, rtrim( $contents ) );
}
/**
* Parse labels and values out of a comma- and colon-separated list of options, such as is used for
* expiry and duration lists. Documentation of the format is on translatewiki.net.
* @since 1.35
* @link https://translatewiki.net/wiki/Template:Doc-mediawiki-options-list
* @param string $msg The message to parse.
* @return string[] The options array, where keys are option labels (i.e. translations)
* and values are option values (i.e. untranslated).
*/
public static function parseOptionsMessage( string $msg ): array {
$options = [];
foreach ( explode( ',', $msg ) as $option ) {
// Normalize options that only have one part.
if ( strpos( $option, ':' ) === false ) {
$option = "$option:$option";
}
// Extract the two parts.
[ $label, $value ] = explode( ':', $option );
$options[ trim( $label ) ] = trim( $value );
}
return $options;
}
}
/** @deprecated class alias since 1.43 */
class_alias( XmlSelect::class, 'XmlSelect' );
|
