MediaWiki  REL1_19
Public Member Functions | Static Public Member Functions | Public Attributes | Private Member Functions | Private Attributes
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

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

Private Member Functions

 CHANGER ()
 Change our users options.
 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.

Private Attributes

 $mMode

Detailed Description

Definition at line 33 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 44 of file userOptions.inc.

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

Here is the call graph for this function:

Member Function Documentation

userOptions::CHANGER ( ) [private]

Change our users options.

Definition at line 184 of file userOptions.inc.

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

Here is the call graph for this function:

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

This is used to check options.

Only needed on construction

Parameters:
$optsarray
$argsarray
Returns:
bool

Definition at line 61 of file userOptions.inc.

Referenced by __construct().

Here is the caller graph for this function:

static userOptions::getDefaultOptionsNames ( ) [static]

Return an array of option names.

Returns:
array

Definition at line 227 of file userOptions.inc.

References User\getDefaultOptions().

Here is the call graph for this function:

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

load script options in the object

Parameters:
$optsarray
$argsarray
Returns:
true

Definition at line 81 of file userOptions.inc.

References false.

Referenced by __construct().

Here is the caller graph for this function:

userOptions::LISTER ( ) [private]

List default options and their value.

Definition at line 120 of file userOptions.inc.

References User\getDefaultOptions().

Here is the call graph for this function:

userOptions::run ( )

Definition at line 106 of file userOptions.inc.

static userOptions::showUsageAndExit ( ) [static]

Definition at line 240 of file userOptions.inc.

References print.

Referenced by __construct().

Here is the caller graph for this function:

userOptions::USAGER ( ) [private]

List options usage.

Definition at line 133 of file userOptions.inc.

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

Here is the call graph for this function:

userOptions::warn ( )

The warning message and countdown.

Returns:
bool

Definition at line 272 of file userOptions.inc.

References print, and wfCountDown().

Referenced by CHANGER().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

userOptions::$mAnOption

Definition at line 37 of file userOptions.inc.

userOptions::$mDry

Definition at line 36 of file userOptions.inc.

userOptions::$mMode [private]

Definition at line 41 of file userOptions.inc.

userOptions::$mNewValue

Definition at line 39 of file userOptions.inc.

userOptions::$mOldValue

Definition at line 38 of file userOptions.inc.

userOptions::$mQuick

Definition at line 34 of file userOptions.inc.

userOptions::$mQuiet

Definition at line 35 of file userOptions.inc.

userOptions::$mReady

Definition at line 41 of file userOptions.inc.

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