MediaWiki  REL1_31
Licenses.php
Go to the documentation of this file.
1 <?php
29 class Licenses extends HTMLFormField {
31  protected $msg;
32 
34  protected $lines = [];
35 
37  protected $html;
38 
40  protected $selected;
46  public function __construct( $params ) {
47  parent::__construct( $params );
48 
49  $this->msg = static::getMessageFromParams( $params );
50  $this->selected = null;
51 
52  $this->makeLines();
53  }
54 
59  protected static function getMessageFromParams( $params ) {
60  return empty( $params['licenses'] )
61  ? wfMessage( 'licenses' )->inContentLanguage()->plain()
62  : $params['licenses'];
63  }
64 
69  protected function buildLine( $line ) {
70  return new License( $line );
71  }
72 
76  protected function makeLines() {
77  $levels = [];
78  $lines = explode( "\n", $this->msg );
79 
80  foreach ( $lines as $line ) {
81  if ( strpos( $line, '*' ) !== 0 ) {
82  continue;
83  } else {
84  list( $level, $line ) = $this->trimStars( $line );
85 
86  if ( strpos( $line, '|' ) !== false ) {
87  $obj = $this->buildLine( $line );
88  $this->stackItem( $this->lines, $levels, $obj );
89  } else {
90  if ( $level < count( $levels ) ) {
91  $levels = array_slice( $levels, 0, $level );
92  }
93  if ( $level == count( $levels ) ) {
94  $levels[$level - 1] = $line;
95  } elseif ( $level > count( $levels ) ) {
96  $levels[] = $line;
97  }
98  }
99  }
100  }
101  }
102 
107  protected function trimStars( $str ) {
108  $numStars = strspn( $str, '*' );
109  return [ $numStars, ltrim( substr( $str, $numStars ), ' ' ) ];
110  }
111 
117  protected function stackItem( &$list, $path, $item ) {
118  $position =& $list;
119  if ( $path ) {
120  foreach ( $path as $key ) {
121  $position =& $position[$key];
122  }
123  }
124  $position[] = $item;
125  }
126 
132  protected function makeHtml( $tagset, $depth = 0 ) {
133  $html = '';
134 
135  foreach ( $tagset as $key => $val ) {
136  if ( is_array( $val ) ) {
137  $html .= $this->outputOption(
138  $key, '',
139  [
140  'disabled' => 'disabled',
141  'style' => 'color: GrayText', // for MSIE
142  ],
143  $depth
144  );
145  $html .= $this->makeHtml( $val, $depth + 1 );
146  } else {
147  $html .= $this->outputOption(
148  $val->text, $val->template,
149  [ 'title' => '{{' . $val->template . '}}' ],
150  $depth
151  );
152  }
153  }
154 
155  return $html;
156  }
157 
165  protected function outputOption( $message, $value, $attribs = null, $depth = 0 ) {
166  $msgObj = $this->msg( $message );
167  $text = $msgObj->exists() ? $msgObj->text() : $message;
168  $attribs['value'] = $value;
169  if ( $value === $this->selected ) {
170  $attribs['selected'] = 'selected';
171  }
172 
173  $val = str_repeat( /* &nbsp */ "\xc2\xa0", $depth * 2 ) . $text;
174  return str_repeat( "\t", $depth ) . Xml::element( 'option', $attribs, $val ) . "\n";
175  }
176 
184  public function getLines() {
185  return $this->lines;
186  }
187 
195  public function getLicenses() {
196  return $this->getLines();
197  }
198 
202  public function getInputHTML( $value ) {
203  $this->selected = $value;
204 
205  // add a default "no license selected" option
206  $default = $this->buildLine( '|nolicense' );
207  array_unshift( $this->lines, $default );
208 
209  $html = $this->makeHtml( $this->getLines() );
210 
211  $attribs = [
212  'name' => $this->mName,
213  'id' => $this->mID
214  ];
215  if ( !empty( $this->mParams['disabled'] ) ) {
216  $attribs['disabled'] = 'disabled';
217  }
218 
219  $html = Html::rawElement( 'select', $attribs, $html );
220 
221  // remove default "no license selected" from lines again
222  array_shift( $this->lines );
223 
224  return $html;
225  }
226 }
Licenses\trimStars
trimStars( $str)
Definition: Licenses.php:107
wfMessage
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
array
the array() calling protocol came about after MediaWiki 1.4rc1.
Licenses\getLines
getLines()
#-
Definition: Licenses.php:184
Licenses\$selected
string null $selected
Definition: Licenses.php:40
License
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the License
Definition: APACHE-LICENSE-2.0.txt:37
Licenses\stackItem
stackItem(&$list, $path, $item)
Definition: Licenses.php:117
Licenses\makeLines
makeLines()
Definition: Licenses.php:76
$params
$params
Definition: styleTest.css.php:40
Licenses\$html
string $html
Definition: Licenses.php:37
Licenses\getInputHTML
getInputHTML( $value)
{This function must be implemented to return the HTML to generate the input object itself....
Definition: Licenses.php:202
Licenses
A License class for use on Special:Upload.
Definition: Licenses.php:29
php
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
Licenses\$msg
string $msg
Definition: Licenses.php:31
Licenses\getLicenses
getLicenses()
Accessor for $this->lines.
Definition: Licenses.php:195
HTMLFormField\$mName
$mName
Definition: HTMLFormField.php:12
Licenses\makeHtml
makeHtml( $tagset, $depth=0)
Definition: Licenses.php:132
HTMLFormField
The parent class to generate form fields.
Definition: HTMLFormField.php:7
Xml\element
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:39
Licenses\$lines
array $lines
Definition: Licenses.php:34
Licenses\outputOption
outputOption( $message, $value, $attribs=null, $depth=0)
Definition: Licenses.php:165
list
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
HTMLFormField\$mID
$mID
Definition: HTMLFormField.php:15
$line
$line
Definition: cdb.php:59
$attribs
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:2014
$value
$value
Definition: styleTest.css.php:45
HTMLFormField\msg
msg()
Get a translated interface message.
Definition: HTMLFormField.php:77
Licenses\buildLine
buildLine( $line)
Definition: Licenses.php:69
Licenses\__construct
__construct( $params)
#-
Definition: Licenses.php:46
$path
$path
Definition: NoLocalSettings.php:25
as
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
Definition: distributors.txt:22
Html\rawElement
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
Licenses\getMessageFromParams
static getMessageFromParams( $params)
Definition: Licenses.php:59