MediaWiki REL1_28
Licenses.php
Go to the documentation of this file.
1<?php
30class Licenses extends HTMLFormField {
32 protected $msg;
33
35 protected $licenses = [];
36
38 protected $html;
44 public function __construct( $params ) {
45 parent::__construct( $params );
46
47 $this->msg = empty( $params['licenses'] )
48 ? wfMessage( 'licenses' )->inContentLanguage()->plain()
49 : $params['licenses'];
50 $this->selected = null;
51
52 $this->makeLicenses();
53 }
54
58 protected function makeLicenses() {
59 $levels = [];
60 $lines = explode( "\n", $this->msg );
61
62 foreach ( $lines as $line ) {
63 if ( strpos( $line, '*' ) !== 0 ) {
64 continue;
65 } else {
66 list( $level, $line ) = $this->trimStars( $line );
67
68 if ( strpos( $line, '|' ) !== false ) {
69 $obj = new License( $line );
70 $this->stackItem( $this->licenses, $levels, $obj );
71 } else {
72 if ( $level < count( $levels ) ) {
73 $levels = array_slice( $levels, 0, $level );
74 }
75 if ( $level == count( $levels ) ) {
76 $levels[$level - 1] = $line;
77 } elseif ( $level > count( $levels ) ) {
78 $levels[] = $line;
79 }
80 }
81 }
82 }
83 }
84
89 protected function trimStars( $str ) {
90 $numStars = strspn( $str, '*' );
91 return [ $numStars, ltrim( substr( $str, $numStars ), ' ' ) ];
92 }
93
99 protected function stackItem( &$list, $path, $item ) {
100 $position =& $list;
101 if ( $path ) {
102 foreach ( $path as $key ) {
103 $position =& $position[$key];
104 }
105 }
106 $position[] = $item;
107 }
108
113 protected function makeHtml( $tagset, $depth = 0 ) {
114 foreach ( $tagset as $key => $val ) {
115 if ( is_array( $val ) ) {
116 $this->html .= $this->outputOption(
117 $key, '',
118 [
119 'disabled' => 'disabled',
120 'style' => 'color: GrayText', // for MSIE
121 ],
122 $depth
123 );
124 $this->makeHtml( $val, $depth + 1 );
125 } else {
126 $this->html .= $this->outputOption(
127 $val->text, $val->template,
128 [ 'title' => '{{' . $val->template . '}}' ],
129 $depth
130 );
131 }
132 }
133 }
134
142 protected function outputOption( $message, $value, $attribs = null, $depth = 0 ) {
143 $msgObj = $this->msg( $message );
144 $text = $msgObj->exists() ? $msgObj->text() : $message;
145 $attribs['value'] = $value;
146 if ( $value === $this->selected ) {
147 $attribs['selected'] = 'selected';
148 }
149
150 $val = str_repeat( /* &nbsp */ "\xc2\xa0", $depth * 2 ) . $text;
151 return str_repeat( "\t", $depth ) . Xml::element( 'option', $attribs, $val ) . "\n";
152 }
153
161 public function getLicenses() {
162 return $this->licenses;
163 }
164
172 public function getInputHTML( $value ) {
173 $this->selected = $value;
174
175 $this->html = $this->outputOption( wfMessage( 'nolicense' )->text(), '',
176 (bool)$this->selected ? null : [ 'selected' => 'selected' ] );
177 $this->makeHtml( $this->getLicenses() );
178
179 $attribs = [
180 'name' => $this->mName,
181 'id' => $this->mID
182 ];
183 if ( !empty( $this->mParams['disabled'] ) ) {
184 $attibs['disabled'] = 'disabled';
185 }
186
187 return Html::rawElement( 'select', $attribs, $this->html );
188 }
189}
190
194class License {
196 public $template;
197
199 public $text;
200
204 function __construct( $str ) {
205 list( $text, $template ) = explode( '|', strrev( $str ), 2 );
206
207 $this->template = strrev( $template );
208 $this->text = strrev( $text );
209 }
210}
$line
Definition cdb.php:59
The parent class to generate form fields.
msg()
Get a translated interface message.
A License class for use on Special:Upload (represents a single type of license).
Definition Licenses.php:194
string $template
Definition Licenses.php:196
__construct( $str)
Definition Licenses.php:204
string $text
Definition Licenses.php:199
A License class for use on Special:Upload.
Definition Licenses.php:30
string $html
Definition Licenses.php:38
__construct( $params)
#-
Definition Licenses.php:44
makeHtml( $tagset, $depth=0)
Definition Licenses.php:113
string $msg
Definition Licenses.php:32
outputOption( $message, $value, $attribs=null, $depth=0)
Definition Licenses.php:142
getLicenses()
#-
Definition Licenses.php:161
stackItem(&$list, $path, $item)
Definition Licenses.php:99
getInputHTML( $value)
Accessor for $this->html.
Definition Licenses.php:172
makeLicenses()
Definition Licenses.php:58
array $licenses
Definition Licenses.php:35
trimStars( $str)
Definition Licenses.php:89
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition Xml.php:39
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
Definition deferred.txt:11
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
Definition design.txt:18
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
the array() calling protocol came about after MediaWiki 1.4rc1.
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 "&lt;div ...>$1&lt;/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
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
Definition hooks.txt:1958
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
$lines
Definition router.php:67
$params