Another fix.
[lhc/web/wiklou.git] / includes / HTMLForm.php
index 12147d5..1a2f581 100644 (file)
@@ -1,14 +1,12 @@
 <?php
 /**
  * This file contain a class to easily build HTML forms as well as custom
- * functions used by SpecialUserrights.php and SpecialGroups.php
- * @package MediaWiki
+ * functions used by SpecialUserrights.php
  */
 
 /**
  * Class to build various forms
  *
- * @package MediaWiki
  * @author jeluf, hashar
  */
 class HTMLForm {
@@ -20,9 +18,9 @@ class HTMLForm {
        }
 
        /**
-        * @access private
-        * @param string $name Name of the fieldset.
-        * @param string $content HTML content to put in.
+        * @private
+        * @param $name String: name of the fieldset.
+        * @param $content String: HTML content to put in.
         * @return string HTML fieldset
         */
        function fieldset( $name, $content ) {
@@ -31,9 +29,9 @@ class HTMLForm {
        }
 
        /**
-        * @access private
-        * @param string $varname Name of the checkbox.
-        * @param boolean $checked Set true to check the box (default False).
+        * @private
+        * @param $varname String: name of the checkbox.
+        * @param $checked Boolean: set true to check the box (default False).
         */
        function checkbox( $varname, $checked=false ) {
                if ( $this->mRequest->wasPosted() && !is_null( $this->mRequest->getVal( $varname ) ) ) {
@@ -45,11 +43,11 @@ class HTMLForm {
                        "</label></div>\n";
        }
 
-       /** 
-        * @access private
-        * @param string $varname Name of the textbox.
-        * @param string $value Optional value (default empty)
-        * @param integer $size Optional size of the textbox (default 20)
+       /**
+        * @private
+        * @param $varname String: name of the textbox.
+        * @param $value String: optional value (default empty)
+        * @param $size Integer: optional size of the textbox (default 20)
         */
        function textbox( $varname, $value='', $size=20 ) {
                if ( $this->mRequest->wasPosted() ) {
@@ -60,10 +58,10 @@ class HTMLForm {
                        "<input type='text' name=\"{$varname}\" value=\"{$value}\" size=\"{$size}\" /></label></div>\n";
        }
 
-       /** 
-        * @access private
-        * @param string $varname Name of the radiobox.
-        * @param array $fields Various fields.
+       /**
+        * @private
+        * @param $varname String: name of the radiobox.
+        * @param $fields Array: Various fields.
         */
        function radiobox( $varname, $fields ) {
                foreach ( $fields as $value => $checked ) {
@@ -71,35 +69,35 @@ class HTMLForm {
                                ( $checked ? ' checked="checked"' : '' ) . " />" . wfMsg( $this->mName.'-'.$varname.'-'.$value ) .
                                "</label></div>\n";
                }
-               return $this->fieldset( $this->mName.'-'.$varname, $s );
+               return $this->fieldset( $varname, $s );
        }
-       
-       /** 
-        * @access private
-        * @param string $varname Name of the textareabox.
-        * @param string $value Optional value (default empty)
-        * @param integer $size Optional size of the textarea (default 20)
+
+       /**
+        * @private
+        * @param $varname String: name of the textareabox.
+        * @param $value String: optional value (default empty)
+        * @param $size Integer: optional size of the textarea (default 20)
         */
        function textareabox ( $varname, $value='', $size=20 ) {
                if ( $this->mRequest->wasPosted() ) {
                        $value = $this->mRequest->getText( $varname, $value );
-               }       
+               }
                $value = htmlspecialchars( $value );
                return '<div><label>'.wfMsg( $this->mName.'-'.$varname ).
                       "<textarea name=\"{$varname}\" rows=\"5\" cols=\"{$size}\">$value</textarea></label></div>\n";
        }
 
-       /** 
-        * @access private
-        * @param string $varname Name of the arraybox.
-        * @param integer $size Optional size of the textarea (default 20)
+       /**
+        * @private
+        * @param $varname String: name of the arraybox.
+        * @param $size Integer: Optional size of the textarea (default 20)
         */
        function arraybox( $varname , $size=20 ) {
                $s = '';
                if ( $this->mRequest->wasPosted() ) {
                        $arr = $this->mRequest->getArray( $varname );
                        if ( is_array( $arr ) ) {
-                               foreach ( $_POST[$varname] as $index=>$element ) {
+                               foreach ( $_POST[$varname] as $element ) {
                                        $s .= htmlspecialchars( $element )."\n";
                                }
                        }
@@ -109,20 +107,23 @@ class HTMLForm {
        }
 } // end class
 
-
-// functions used by SpecialUserrights.php and SpecialGroups.php
-
 /** Build a select with all defined groups
- * @param string $selectname Name of this element. Name of form is automaticly prefixed.
- * @param array $selected Array of element selected when posted. Only multiples will show them.
- * @param boolean $multiple A multiple elements select.
- * @param integer $size Number of elements to be shown ignored for non-multiple (default 6).
- * @param boolean $reverse If true, multiple select will hide selected elements (default false).
+ *
+ * used by SpecialUserrights.php
+ * @todo move it to there, and don't forget to copy it for SpecialMakesysop.php
+ *
+ * @param $selectname String: name of this element. Name of form is automaticly prefixed.
+ * @param $selectmsg String: FIXME
+ * @param $selected Array: array of element selected when posted. Only multiples will show them.
+ * @param $multiple Boolean: A multiple elements select.
+ * @param $size Integer: number of elements to be shown ignored for non-multiple (default 6).
+ * @param $reverse Boolean: if true, multiple select will hide selected elements (default false).
+ * @todo Document $selectmsg
 */
 function HTMLSelectGroups($selectname, $selectmsg, $selected=array(), $multiple=false, $size=6, $reverse=false) {
        $groups = User::getAllGroups();
        $out = htmlspecialchars( wfMsg( $selectmsg ) );
-       
+
        if( $multiple ) {
                $attribs = array(
                        'name'    => $selectname . '[]',
@@ -132,7 +133,7 @@ function HTMLSelectGroups($selectname, $selectmsg, $selected=array(), $multiple=
                $attribs = array( 'name' => $selectname );
        }
        $out .= wfElement( 'select', $attribs, null );
-       
+
        foreach( $groups as $group ) {
                $attribs = array( 'value' => $group );
                if( $multiple ) {
@@ -152,24 +153,4 @@ function HTMLSelectGroups($selectname, $selectmsg, $selected=array(), $multiple=
        return $out;
 }
 
-/** Build a select with all existent rights
- * @param array $selected Names(?) of user rights that should be selected.
- * @return string HTML select.
- */
-function HTMLSelectRights($selected='') {
-       global $wgAvailableRights;
-       $out = '<select name="editgroup-getrights[]" multiple="multiple">';
-       $groupRights = explode(',',$selected);
-       
-       foreach($wgAvailableRights as $right) {
-       
-               // check box when right exist
-               if(in_array($right, $groupRights)) { $selected = 'selected="selected" '; }
-               else { $selected = ''; }
-                                       
-               $out .= '<option value="'.$right.'" '.$selected.'>'.$right."</option>\n";
-       }
-       $out .= "</select>\n";
-       return $out;
-}
 ?>