MediaWiki REL1_37
Licenses.php
Go to the documentation of this file.
1<?php
27
31class Licenses extends HTMLFormField {
33 protected $msg;
34
36 protected $lines = [];
37
39 protected $html;
40
42 protected $selected;
48 public function __construct( $params ) {
49 parent::__construct( $params );
50
51 $this->msg = static::getMessageFromParams( $params );
52 $this->selected = null;
53
54 $this->makeLines();
55 }
56
61 protected static function getMessageFromParams( $params ) {
62 if ( !empty( $params['licenses'] ) ) {
63 return $params['licenses'];
64 }
65
66 // If the licenses page is in $wgForceUIMsgAsContentMsg (which is the case
67 // on Commons), translations will be in the database, in subpages of this
68 // message (e.g. MediaWiki:Licenses/<lang>)
69 // If there is no such translation, the result will be '-' (the empty default
70 // in the i18n files), so we'll need to force it to look up the actual licenses
71 // in the default site language (= get the translation from MediaWiki:Licenses)
72 // Also see https://phabricator.wikimedia.org/T3495
73 $defaultMsg = wfMessage( 'licenses' )->inContentLanguage();
74 if ( !$defaultMsg->exists() || $defaultMsg->plain() === '-' ) {
75 $defaultMsg = wfMessage( 'licenses' )->inLanguage(
76 MediaWikiServices::getInstance()->getContentLanguage() );
77 }
78
79 return $defaultMsg->plain();
80 }
81
86 protected function buildLine( $line ) {
87 return new License( $line );
88 }
89
93 protected function makeLines() {
94 $levels = [];
95 $lines = explode( "\n", $this->msg );
96
97 foreach ( $lines as $line ) {
98 if ( strpos( $line, '*' ) !== 0 ) {
99 continue;
100 }
101 list( $level, $line ) = $this->trimStars( $line );
102
103 if ( strpos( $line, '|' ) !== false ) {
104 $obj = $this->buildLine( $line );
105 $this->stackItem( $this->lines, $levels, $obj );
106 } else {
107 if ( $level < count( $levels ) ) {
108 $levels = array_slice( $levels, 0, $level );
109 }
110 if ( $level == count( $levels ) ) {
111 $levels[$level - 1] = $line;
112 } elseif ( $level > count( $levels ) ) {
113 $levels[] = $line;
114 }
115 }
116 }
117 }
118
123 protected function trimStars( $str ) {
124 $numStars = strspn( $str, '*' );
125 return [ $numStars, ltrim( substr( $str, $numStars ), ' ' ) ];
126 }
127
133 protected function stackItem( &$list, $path, $item ) {
134 $position =& $list;
135 if ( $path ) {
136 foreach ( $path as $key ) {
137 $position =& $position[$key];
138 }
139 }
140 $position[] = $item;
141 }
142
148 protected function makeHtml( $tagset, $depth = 0 ) {
149 $html = '';
150
151 foreach ( $tagset as $key => $val ) {
152 if ( is_array( $val ) ) {
153 $html .= $this->outputOption(
154 $key, '',
155 [
156 'disabled' => 'disabled',
157 'style' => 'color: GrayText', // for MSIE
158 ],
159 $depth
160 );
161 $html .= $this->makeHtml( $val, $depth + 1 );
162 } else {
163 $html .= $this->outputOption(
164 $val->text, $val->template,
165 [ 'title' => '{{' . $val->template . '}}' ],
166 $depth
167 );
168 }
169 }
170
171 return $html;
172 }
173
181 protected function outputOption( $message, $value, $attribs = null, $depth = 0 ) {
182 $msgObj = $this->msg( $message );
183 $text = $msgObj->exists() ? $msgObj->text() : $message;
184 $attribs['value'] = $value;
185 if ( $value === $this->selected ) {
186 $attribs['selected'] = 'selected';
187 }
188
189 $val = str_repeat( /* &nbsp */ "\u{00A0}", $depth * 2 ) . $text;
190 return str_repeat( "\t", $depth ) . Xml::element( 'option', $attribs, $val ) . "\n";
191 }
192
200 public function getLines() {
201 return $this->lines;
202 }
203
211 public function getLicenses() {
212 return $this->getLines();
213 }
214
218 public function getInputHTML( $value ) {
219 $this->selected = $value;
220
221 // add a default "no license selected" option
222 $default = $this->buildLine( '|nolicense' );
223 array_unshift( $this->lines, $default );
224
225 $html = $this->makeHtml( $this->getLines() );
226
227 $attribs = [
228 'name' => $this->mName,
229 'id' => $this->mID
230 ];
231 if ( !empty( $this->mParams['disabled'] ) ) {
232 $attribs['disabled'] = 'disabled';
233 }
234
235 $html = Html::rawElement( 'select', $attribs, $html );
236
237 // remove default "no license selected" from lines again
238 array_shift( $this->lines );
239
240 return $html;
241 }
242}
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
The parent class to generate form fields.
msg( $key,... $params)
Get a translated interface message.
A License class for use on Special:Upload (represents a single type of license).
Definition License.php:30
A License class for use on Special:Upload.
Definition Licenses.php:31
makeLines()
Definition Licenses.php:93
string $html
Definition Licenses.php:39
__construct( $params)
#-
Definition Licenses.php:48
string null $selected
Definition Licenses.php:42
buildLine( $line)
Definition Licenses.php:86
makeHtml( $tagset, $depth=0)
Definition Licenses.php:148
string $msg
Definition Licenses.php:33
static getMessageFromParams( $params)
Definition Licenses.php:61
outputOption( $message, $value, $attribs=null, $depth=0)
Definition Licenses.php:181
getLicenses()
Accessor for $this->lines.
Definition Licenses.php:211
array $lines
Definition Licenses.php:36
getLines()
#-
Definition Licenses.php:200
stackItem(&$list, $path, $item)
Definition Licenses.php:133
getInputHTML( $value)
This function must be implemented to return the HTML to generate the input object itself....
Definition Licenses.php:218
trimStars( $str)
Definition Licenses.php:123
MediaWikiServices is the service locator for the application scope of MediaWiki.
$line
Definition mcc.php:119