API * Better log events info * Added RAW debugging format
[mediawiki.git] / includes / Licenses.php
blobaaa44052bf9c555da8f538e05063b7a2a56cf38d
1 <?php
2 /**
3 * A License class for use on Special:Upload
5 * @package MediaWiki
6 * @subpackage SpecialPage
8 * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
9 * @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason
10 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
13 class Licenses {
14 /**#@+
15 * @private
17 /**
18 * @var string
20 var $msg;
22 /**
23 * @var array
25 var $licenses = array();
27 /**
28 * @var string
30 var $html;
31 /**#@-*/
33 /**
34 * Constrictor
36 * @param $str String: the string to build the licenses member from, will use
37 * wfMsgForContent( 'licenses' ) if null (default: null)
39 function Licenses( $str = null ) {
40 // PHP sucks, this should be possible in the constructor
41 $this->msg = is_null( $str ) ? wfMsgForContent( 'licenses' ) : $str;
42 $this->html = '';
44 $this->makeLicenses();
45 $tmp = $this->getLicenses();
46 $this->makeHtml( $tmp );
49 /**#@+
50 * @private
52 function makeLicenses() {
53 $levels = array();
54 $lines = explode( "\n", $this->msg );
56 foreach ( $lines as $line ) {
57 if ( strpos( $line, '*' ) !== 0 )
58 continue;
59 else {
60 list( $level, $line ) = $this->trimStars( $line );
62 if ( strpos( $line, '|' ) !== false ) {
63 $obj = new License( $line );
64 $this->stackItem( $this->licenses, $levels, $obj );
65 } else {
66 if ( $level < count( $levels ) )
67 $levels = array_slice( $levels, 0, $level );
68 if ( $level == count( $levels ) )
69 $levels[$level - 1] = $line;
70 else if ( $level > count( $levels ) )
71 $levels[] = $line;
77 function trimStars( $str ) {
78 $i = $count = 0;
80 wfSuppressWarnings();
81 while ($str[$i++] == '*')
82 ++$count;
83 wfRestoreWarnings();
85 return array( $count, ltrim( $str, '* ' ) );
88 function stackItem( &$list, $path, $item ) {
89 $position =& $list;
90 if ( $path )
91 foreach( $path as $key )
92 $position =& $position[$key];
93 $position[] = $item;
96 function makeHtml( &$tagset, $depth = 0 ) {
97 foreach ( $tagset as $key => $val )
98 if ( is_array( $val ) ) {
99 $this->html .= $this->outputOption(
100 $this->msg( $key ),
101 array(
102 'value' => '',
103 'disabled' => 'disabled',
104 'style' => 'color: GrayText', // for MSIE
106 $depth
108 $this->makeHtml( $val, $depth + 1 );
109 } else {
110 $this->html .= $this->outputOption(
111 $this->msg( $val->text ),
112 array(
113 'value' => $val->template,
114 'title' => '{{' . $val->template . '}}'
116 $depth
121 function outputOption( $val, $attribs = null, $depth ) {
122 $val = str_repeat( /* &nbsp */ "\xc2\xa0", $depth * 2 ) . $val;
123 return str_repeat( "\t", $depth ) . wfElement( 'option', $attribs, $val ) . "\n";
126 function msg( $str ) {
127 $out = wfMsg( $str );
128 return wfEmptyMsg( $str, $out ) ? $str : $out;
131 /**#@-*/
134 * Accessor for $this->licenses
136 * @return array
138 function getLicenses() { return $this->licenses; }
141 * Accessor for $this->html
143 * @return string
145 function getHtml() { return $this->html; }
148 class License {
150 * @var string
152 var $template;
155 * @var string
157 var $text;
160 * Constructor
162 * @param $str String: license name??
164 function License( $str ) {
165 list( $text, $template ) = explode( '|', strrev( $str ), 2 );
167 $this->template = strrev( $template );
168 $this->text = strrev( $text );