Merge "Define $wgAlwaysUseTidy to false where needed in unit tests"

[lhc/web/wiklou.git] / maintenance / userOptions.inc

diff --git a/maintenance/userOptions.inc b/maintenance/userOptions.inc
index deb12bc..2a06657 100644 (file)
--- a/maintenance/userOptions.inc
+++ b/maintenance/userOptions.inc
@@ -1,5 +1,22 @@
 <?php
 /**
+ * Helper class for userOptions.php script.
+ *
+ * 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 Maintenance
  */
@@ -8,7 +25,7 @@
 $options = array( 'list', 'nowarn', 'quiet', 'usage', 'dry' );
 $optionsWithArgs = array( 'old', 'new' );
 
-require_once( dirname( __FILE__ ) . '/commandLine.inc' );
+require_once( __DIR__ . '/commandLine.inc' );
 
 /**
  * @ingroup Maintenance
@@ -33,7 +50,14 @@ class userOptions {
        }
 
 
-       /** This is used to check options. Only needed on construction */
+       /**
+        * This is used to check options. Only needed on construction
+        *
+        * @param $opts array
+        * @param $args array
+        *
+        * @return bool
+        */
        private function checkOpts( $opts, $args ) {
                // The three possible ways to run the script:
                $list   = isset( $opts['list'] );
@@ -46,7 +70,14 @@ class userOptions {
                return $isValid;
        }
 
-       /** load script options in the object */
+       /**
+        * load script options in the object
+        *
+        * @param $opts array
+        * @param $args array
+        *
+        * @return bool
+        */
        private function initializeOpts( $opts, $args ) {
 
                $this->mQuick = isset( $opts['nowarn'] );
@@ -77,8 +108,8 @@ class userOptions {
                        return false;
                }
 
-               $this-> { $this->mMode } ( );
-
+               $this->{ $this->mMode } ( );
+               return true;
        }
 
        #
@@ -189,8 +220,10 @@ class userOptions {
                }
        }
 
-
-       /** Return an array of option names */
+       /**
+        * Return an array of option names
+        * @return array
+        */
        public static function getDefaultOptionsNames() {
                $def = User::getDefaultOptions();
                $ret = array();
@@ -200,7 +233,6 @@ class userOptions {
                return $ret;
        }
 
-
        #
        # Helper methods
        #
@@ -233,7 +265,10 @@ USAGE;
        exit( 0 );
        }
 
-       /** The warning message and countdown */
+       /**
+        * The warning message and countdown
+        * @return bool
+        */
        public function warn() {
 
                if ( $this->mQuick ) {