userOptions Class Reference
[Maintenance]

List of all members.

Public Member Functions

 __construct ($opts, $args)
 Constructor.
 run ()
 warn ()
 The warning message and countdown.

Static Public Member Functions

static getDefaultOptionsNames ()
 Return an array of option names.
static showUsageAndExit ()

Public Attributes

 $mQuick
 $mQuiet
 $mDry
 $mAnOption
 $mOldValue
 $mNewValue

Private Member Functions

 checkOpts ($opts, $args)
 This is used to check options.
 initializeOpts ($opts, $args)
 load script options in the object
 LISTER ()
 List default options and their value.
 USAGER ()
 List options usage.
 CHANGER ()
 Change our users options.

Private Attributes

 $mMode
 $mReady


Detailed Description

Definition at line 16 of file userOptions.inc.


Constructor & Destructor Documentation

userOptions::__construct ( opts,
args 
)

Constructor.

Will show usage and exit if script options are not correct

Definition at line 27 of file userOptions.inc.

References $args, checkOpts(), initializeOpts(), and showUsageAndExit().


Member Function Documentation

userOptions::CHANGER (  )  [private]

Change our users options.

Definition at line 153 of file userOptions.inc.

References $dbr, $result, $user, $username, User::newFromId(), print, warn(), and wfGetDB().

userOptions::checkOpts ( opts,
args 
) [private]

This is used to check options.

Only needed on construction

Definition at line 37 of file userOptions.inc.

References $args, and $usage.

Referenced by __construct().

static userOptions::getDefaultOptionsNames (  )  [static]

Return an array of option names.

Definition at line 194 of file userOptions.inc.

References User::getDefaultOptions().

userOptions::initializeOpts ( opts,
args 
) [private]

load script options in the object

Definition at line 50 of file userOptions.inc.

References $args.

Referenced by __construct().

userOptions::LISTER (  )  [private]

List default options and their value.

Definition at line 89 of file userOptions.inc.

References User::getDefaultOptions(), and printf().

userOptions::run (  ) 

Definition at line 75 of file userOptions.inc.

static userOptions::showUsageAndExit (  )  [static]

Definition at line 208 of file userOptions.inc.

References is(), pass(), print, and usage().

Referenced by __construct().

userOptions::USAGER (  )  [private]

List options usage.

Definition at line 102 of file userOptions.inc.

References $count, $dbr, $name, $result, $user, User::getDefaultOptions(), User::newFromId(), print, and wfGetDB().

userOptions::warn (  ) 

The warning message and countdown.

Definition at line 237 of file userOptions.inc.

References $i, is(), print, and print_c().

Referenced by CHANGER().


Member Data Documentation

userOptions::$mAnOption

Definition at line 20 of file userOptions.inc.

userOptions::$mDry

Definition at line 19 of file userOptions.inc.

userOptions::$mMode [private]

Definition at line 24 of file userOptions.inc.

userOptions::$mNewValue

Definition at line 22 of file userOptions.inc.

userOptions::$mOldValue

Definition at line 21 of file userOptions.inc.

userOptions::$mQuick

Definition at line 17 of file userOptions.inc.

userOptions::$mQuiet

Definition at line 18 of file userOptions.inc.

userOptions::$mReady [private]

Definition at line 24 of file userOptions.inc.


The documentation for this class was generated from the following file:

Generated on Sat Sep 5 02:08:50 2009 for MediaWiki by  doxygen 1.5.9