userOptions Class Reference

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().

---

Member Function Documentation

userOptions::CHANGER

(

)

[private]

Change our users options.

Definition at line 184 of file userOptions.inc.

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

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

This is used to check options.

Only needed on construction

Parameters:

$opts	array
$args	array

Returns:

bool

Definition at line 61 of file userOptions.inc.

Referenced by __construct().

static userOptions::getDefaultOptionsNames

(

)

[static]

Return an array of option names.

Returns:

array

Definition at line 229 of file userOptions.inc.

References $ret, array(), as, and User\getDefaultOptions().

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

load script options in the object

Parameters:

$opts	array
$args	array

Returns:

bool

Definition at line 81 of file userOptions.inc.

Referenced by __construct().

userOptions::LISTER

(

)

[private]

List default options and their value.

Definition at line 120 of file userOptions.inc.

References $value, as, and User\getDefaultOptions().

userOptions::run

(

)

Definition at line 106 of file userOptions.inc.

static userOptions::showUsageAndExit

(

)

[static]

Definition at line 242 of file userOptions.inc.

References available, change, database, is, it, list, of, options(), php, print, save, settings, and user.

Referenced by __construct().

userOptions::USAGER

(

)

[private]

List options usage.

Definition at line 133 of file userOptions.inc.

References $count, $dbr, $defaultOptions, $name, $result, $ret, $user, $value, array(), as, User\getDefaultOptions(), User\newFromId(), print, and wfGetDB().

userOptions::warn

(

)

The warning message and countdown.

Returns:

bool

Definition at line 274 of file userOptions.inc.

References change, database, in, is, print, skin(), wfCountDown(), and will.

Referenced by CHANGER().

---

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:

• maintenance/userOptions.inc