Merge "Add tests for WikiMap and WikiReference"
[lhc/web/wiklou.git] / maintenance / userOptions.inc
index f497f2a..99ba3b8 100644 (file)
@@ -40,7 +40,11 @@ class UserOptions {
 
        private $mMode, $mReady;
 
 
        private $mMode, $mReady;
 
-       /** Constructor. Will show usage and exit if script options are not correct */
+       /**
+        * Constructor. Will show usage and exit if script options are not correct
+        * @param array $opts
+        * @param array $args
+        */
        function __construct( $opts, $args ) {
                if ( !$this->checkOpts( $opts, $args ) ) {
                        UserOptions::showUsageAndExit();
        function __construct( $opts, $args ) {
                if ( !$this->checkOpts( $opts, $args ) ) {
                        UserOptions::showUsageAndExit();
@@ -52,8 +56,8 @@ 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
+        * @param array $opts
+        * @param array $args
         *
         * @return bool
         */
         *
         * @return bool
         */
@@ -72,8 +76,8 @@ class UserOptions {
        /**
         * load script options in the object
         *
        /**
         * load script options in the object
         *
-        * @param $opts array
-        * @param $args array
+        * @param array $opts
+        * @param array $args
         *
         * @return bool
         */
         *
         * @return bool
         */
@@ -107,7 +111,8 @@ class UserOptions {
                        return false;
                }
 
                        return false;
                }
 
-               $this->{ $this->mMode } ();
+               $this->{$this->mMode}();
+
                return true;
        }
 
                return true;
        }
 
@@ -139,7 +144,7 @@ class UserOptions {
                        array( 'user_id' ),
                        array(),
                        __METHOD__
                        array( 'user_id' ),
                        array(),
                        __METHOD__
-                       );
+               );
 
                foreach ( $result as $id ) {
 
 
                foreach ( $result as $id ) {
 
@@ -155,15 +160,18 @@ class UserOptions {
 
                                $userValue = $user->getOption( $this->mAnOption );
                                if ( $userValue <> $defaultOptions[$this->mAnOption] ) {
 
                                $userValue = $user->getOption( $this->mAnOption );
                                if ( $userValue <> $defaultOptions[$this->mAnOption] ) {
+                                       // @codingStandardsIgnoreStart Ignore silencing errors is discouraged warning
                                        @$ret[$this->mAnOption][$userValue]++;
                                        @$ret[$this->mAnOption][$userValue]++;
+                                       // @codingStandardsIgnoreEnd
                                }
                                }
-
                        } else {
 
                                foreach ( $defaultOptions as $name => $defaultValue ) {
                                        $userValue = $user->getOption( $name );
                                        if ( $userValue <> $defaultValue ) {
                        } else {
 
                                foreach ( $defaultOptions as $name => $defaultValue ) {
                                        $userValue = $user->getOption( $name );
                                        if ( $userValue <> $defaultValue ) {
+                                               // @codingStandardsIgnoreStart Ignore silencing errors is discouraged warning
                                                @$ret[$name][$userValue]++;
                                                @$ret[$name][$userValue]++;
+                                               // @codingStandardsIgnoreEnd
                                        }
                                }
                        }
                                        }
                                }
                        }
@@ -188,7 +196,7 @@ class UserOptions {
                        array( 'user_id' ),
                        array(),
                        __METHOD__
                        array( 'user_id' ),
                        array(),
                        __METHOD__
-                       );
+               );
 
                foreach ( $result as $id ) {
 
 
                foreach ( $result as $id ) {
 
@@ -200,7 +208,8 @@ class UserOptions {
                        if ( $curValue == $this->mOldValue ) {
 
                                if ( !$this->mQuiet ) {
                        if ( $curValue == $this->mOldValue ) {
 
                                if ( !$this->mQuiet ) {
-                                       print "Setting {$this->mAnOption} for $username from '{$this->mOldValue}' to '{$this->mNewValue}'): ";
+                                       print "Setting {$this->mAnOption} for $username from '{$this->mOldValue}' " .
+                                               "to '{$this->mNewValue}'): ";
                                }
 
                                // Change value
                                }
 
                                // Change value
@@ -213,7 +222,6 @@ class UserOptions {
                                if ( !$this->mQuiet ) {
                                        print " OK\n";
                                }
                                if ( !$this->mQuiet ) {
                                        print " OK\n";
                                }
-
                        } elseif ( !$this->mQuiet ) {
                                print "Not changing '$username' using <{$this->mAnOption}> = '$curValue'\n";
                        }
                        } elseif ( !$this->mQuiet ) {
                                print "Not changing '$username' using <{$this->mAnOption}> = '$curValue'\n";
                        }
@@ -230,6 +238,7 @@ class UserOptions {
                foreach ( $def as $optname => $defaultValue ) {
                        array_push( $ret, $optname );
                }
                foreach ( $def as $optname => $defaultValue ) {
                        array_push( $ret, $optname );
                }
+
                return $ret;
        }
 
                return $ret;
        }
 
@@ -238,7 +247,7 @@ class UserOptions {
        #
 
        public static function showUsageAndExit() {
        #
 
        public static function showUsageAndExit() {
-print <<<USAGE
+               print <<<USAGE
 
 This script pass through all users and change one of their options.
 The new option is NOT validated.
 
 This script pass through all users and change one of their options.
 The new option is NOT validated.
@@ -262,7 +271,7 @@ Options:
        --dry   : do not save user settings back to database
 
 USAGE;
        --dry   : do not save user settings back to database
 
 USAGE;
-       exit( 0 );
+               exit( 0 );
        }
 
        /**
        }
 
        /**
@@ -275,14 +284,14 @@ USAGE;
                        return true;
                }
 
                        return true;
                }
 
-print <<<WARN
+               print <<<WARN
 The script is about to change the skin for ALL USERS in the database.
 Users with option <$this->mAnOption> = '$this->mOldValue' will be made to use '$this->mNewValue'.
 
 Abort with control-c in the next five seconds....
 WARN;
                wfCountDown( 5 );
 The script is about to change the skin for ALL USERS in the database.
 Users with option <$this->mAnOption> = '$this->mOldValue' will be made to use '$this->mNewValue'.
 
 Abort with control-c in the next five seconds....
 WARN;
                wfCountDown( 5 );
+
                return true;
        }
                return true;
        }
-
 }
 }