Revised design of Special:Userlogin

[lhc/web/wiklou.git] / includes / Licenses.php

diff --git a/includes/Licenses.php b/includes/Licenses.php
index 33325d2..e8aee0b 100644 (file)
--- a/includes/Licenses.php
+++ b/includes/Licenses.php
@@ -1,14 +1,32 @@
 <?php
 /**
- * A License class for use on Special:Upload
+ * License selector for use on Special:Upload.
  *
- * @ingroup SpecialPage
+ * 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
+ * @ingroup SpecialPage
  * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
  * @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason
  * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
  */
 
+/**
+ * A License class for use on Special:Upload
+ */
 class Licenses extends HTMLFormField {
        /**
         * @var string
@@ -28,17 +46,19 @@ class Licenses extends HTMLFormField {
 
        /**
         * Constructor
+        *
+        * @param $params array
         */
        public function __construct( $params ) {
                parent::__construct( $params );
-               
-               $this->msg = empty( $params['licenses'] ) ? wfMsgForContent( 'licenses' ) : $params['licenses'];
+
+               $this->msg = empty( $params['licenses'] ) ? wfMessage( 'licenses' )->inContentLanguage()->plain() : $params['licenses'];
                $this->selected = null;
 
                $this->makeLicenses();
        }
 
-       /**#@+
+       /**
         * @private
         */
        protected function makeLicenses() {
@@ -46,9 +66,9 @@ class Licenses extends HTMLFormField {
                $lines = explode( "\n", $this->msg );
 
                foreach ( $lines as $line ) {
-                       if ( strpos( $line, '*' ) !== 0 )
+                       if ( strpos( $line, '*' ) !== 0 ) {
                                continue;
-                       else {
+                       } else {
                                list( $level, $line ) = $this->trimStars( $line );
 
                                if ( strpos( $line, '|' ) !== false ) {
@@ -60,7 +80,7 @@ class Licenses extends HTMLFormField {
                                        }
                                        if ( $level == count( $levels ) ) {
                                                $levels[$level - 1] = $line;
-                                       } else if ( $level > count( $levels ) ) {
+                                       } elseif ( $level > count( $levels ) ) {
                                                $levels[] = $line;
                                        }
                                }
@@ -68,24 +88,39 @@ class Licenses extends HTMLFormField {
                }
        }
 
+       /**
+        * @param $str
+        * @return array
+        */
        protected function trimStars( $str ) {
                $numStars = strspn( $str, '*' );
                return array( $numStars, ltrim( substr( $str, $numStars ), ' ' ) );
        }
 
+       /**
+        * @param $list
+        * @param $path
+        * @param $item
+        */
        protected function stackItem( &$list, $path, $item ) {
                $position =& $list;
-               if ( $path )
-                       foreach( $path as $key )
+               if ( $path ) {
+                       foreach( $path as $key ) {
                                $position =& $position[$key];
+                       }
+               }
                $position[] = $item;
        }
 
+       /**
+        * @param $tagset
+        * @param $depth int
+        */
        protected function makeHtml( $tagset, $depth = 0 ) {
-               foreach ( $tagset as $key => $val )
+               foreach ( $tagset as $key => $val ) {
                        if ( is_array( $val ) ) {
                                $this->html .= $this->outputOption(
-                                       $this->msg( $key ), '',
+                                       $key, '',
                                        array(
                                                'disabled' => 'disabled',
                                                'style' => 'color: GrayText', // for MSIE
@@ -95,26 +130,33 @@ class Licenses extends HTMLFormField {
                                $this->makeHtml( $val, $depth + 1 );
                        } else {
                                $this->html .= $this->outputOption(
-                                       $this->msg( $val->text ), $val->template,
+                                       $val->text, $val->template,
                                        array( 'title' => '{{' . $val->template . '}}' ),
                                        $depth
                                );
                        }
+               }
        }
 
-       protected function outputOption( $text, $value, $attribs = null, $depth = 0 ) {
+       /**
+        * @param $message
+        * @param $value
+        * @param $attribs null
+        * @param $depth int
+        * @return string
+        */
+       protected function outputOption( $message, $value, $attribs = null, $depth = 0 ) {
+               $msgObj = $this->msg( $message );
+               $text = $msgObj->exists() ? $msgObj->text() : $message;
                $attribs['value'] = $value;
-               if ( $value === $this->selected )
-                       $attribs['selected'] = 'selected';              
+               if ( $value === $this->selected ) {
+                       $attribs['selected'] = 'selected';
+               }
+
                $val = str_repeat( /* &nbsp */ "\xc2\xa0", $depth * 2 ) . $text;
                return str_repeat( "\t", $depth ) . Xml::element( 'option', $attribs, $val ) . "\n";
        }
 
-       protected function msg( $str ) {
-               $out = wfMsg( $str );
-               return wfEmptyMsg( $str, $out ) ? $str : $out;
-       }
-
        /**#@-*/
 
        /**
@@ -122,27 +164,32 @@ class Licenses extends HTMLFormField {
         *
         * @return array
         */
-       public function getLicenses() { return $this->licenses; }
+       public function getLicenses() {
+               return $this->licenses;
+       }
 
        /**
         * Accessor for $this->html
         *
+        * @param $value bool
+        *
         * @return string
         */
        public function getInputHTML( $value ) {
                $this->selected = $value;
-               
-               $this->html = $this->outputOption( wfMsg( 'nolicense' ), '',
+
+               $this->html = $this->outputOption( wfMessage( 'nolicense' )->text(), '',
                        (bool)$this->selected ? null : array( 'selected' => 'selected' ) );
                $this->makeHtml( $this->getLicenses() );
-               
+
                $attribs = array(
                        'name' => $this->mName,
                        'id' => $this->mID
                );
-               if ( !empty( $this->mParams['disabled'] ) )
+               if ( !empty( $this->mParams['disabled'] ) ) {
                        $attibs['disabled'] = 'disabled';
-               
+               }
+
                return Html::rawElement( 'select', $attribs, $this->html );
        }
 }
@@ -164,9 +211,9 @@ class License {
        /**
         * Constructor
         *
-        * @param $str String: license name??
+        * @param string $str license name??
         */
-       function License( $str ) {
+       function __construct( $str ) {
                list( $text, $template ) = explode( '|', strrev( $str ), 2 );
 
                $this->template = strrev( $template );