UserOptions Class Reference

Public Member Functions
	__construct ( $opts, $args)
	Constructor.
	run ()
	Dumb stuff to run a mode.
	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

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
	$mReady

Detailed Description

Definition at line 33 of file userOptions.inc.

Constructor & Destructor Documentation

__construct()

UserOptions::__construct	(		$opts,
			$args )

Constructor.

Will show usage and exit if script options are not correct

Parameters

array	$opts
array	$args

Definition at line 48 of file userOptions.inc.

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

Member Function Documentation

CHANGER()

UserOptions::CHANGER ( )

private

Change our users options.

Definition at line 192 of file userOptions.inc.

References $dbr, $username, DB_REPLICA, print, warn(), and wfGetDB().

checkOpts()

UserOptions::checkOpts ( $opts, $args )

private

This is used to check options.

Only needed on construction

Parameters

array	$opts
array	$args

Returns

bool

Definition at line 64 of file userOptions.inc.

References $args.

Referenced by __construct().

getDefaultOptionsNames()

static UserOptions::getDefaultOptionsNames ( )

static

Return an array of option names.

Returns

array

Definition at line 235 of file userOptions.inc.

References $ret.

initializeOpts()

UserOptions::initializeOpts ( $opts, $args )

private

load script options in the object

Parameters

array	$opts
array	$args

Returns

bool

Definition at line 84 of file userOptions.inc.

References $args.

Referenced by __construct().

LISTER()

UserOptions::LISTER ( )

private

List default options and their value.

Definition at line 124 of file userOptions.inc.

References $opt, and $value.

run()

UserOptions::run

(

)

Dumb stuff to run a mode.

Returns

bool

Definition at line 111 of file userOptions.inc.

showUsageAndExit()

static UserOptions::showUsageAndExit ( )

static

Definition at line 245 of file userOptions.inc.

References list, options(), print, save, and settings.

Referenced by __construct().

USAGER()

UserOptions::USAGER ( )

private

List options usage.

Definition at line 139 of file userOptions.inc.

References $dbr, $mAnOption, $name, $ret, $value, DB_REPLICA, print, and wfGetDB().

warn()

UserOptions::warn

(

)

The warning message and countdown.

Returns

bool

Definition at line 277 of file userOptions.inc.

References c, made, print, skin(), and wfCountDown().

Referenced by CHANGER().

Member Data Documentation

$mAnOption

UserOptions::$mAnOption

Definition at line 37 of file userOptions.inc.

Referenced by USAGER().

$mDry

UserOptions::$mDry

Definition at line 36 of file userOptions.inc.

$mMode

UserOptions::$mMode

private

Definition at line 41 of file userOptions.inc.

$mNewValue

UserOptions::$mNewValue

Definition at line 39 of file userOptions.inc.

$mOldValue

UserOptions::$mOldValue

Definition at line 38 of file userOptions.inc.

$mQuick

UserOptions::$mQuick

Definition at line 34 of file userOptions.inc.

$mQuiet

UserOptions::$mQuiet

Definition at line 35 of file userOptions.inc.

$mReady

UserOptions::$mReady

private

Definition at line 41 of file userOptions.inc.

---

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

• maintenance/userOptions.inc