MediaWiki\Extension\GlobalWatchlist\SpecialGlobalWatchlistSettings Class Reference

Inheritance diagram for MediaWiki\Extension\GlobalWatchlist\SpecialGlobalWatchlistSettings:

Collaboration diagram for MediaWiki\Extension\GlobalWatchlist\SpecialGlobalWatchlistSettings:

Public Member Functions
	__construct (LoggerInterface $logger, ExtensionRegistry $extensionRegistry, SettingsManager $settingsManager, SpecialPageFactory $specialPageFactory, UserOptionsLookup $userOptionsLookup)
	execute ( $par)
	onSubmit (array $data, HTMLForm $form=null)
	onSuccess ()
	Settings were saved successfully.
	doesWrites ()
	isListed ()
	Only shown for logged in users.

Static Public Member Functions
static	newFromGlobalState (SettingsManager $settingsManager, SpecialPageFactory $specialPageFactory, UserOptionsLookup $userOptionsLookup)
	Need a factory method to inject LoggerInstance and ExtensionRegistry, which are not available from the service container.

Protected Member Functions
	getFormFields ()
	Get an HTMLForm descriptor array.
	getDisplayFormat ()
	Display form as OOUI.
	getMessagePrefix ()
	Get message prefix for HTMLForm.
	alterForm (HTMLForm $form)
	Set correct label for submit button.
	getGroupName ()

Detailed Description

Author

DannyS712

Constructor & Destructor Documentation

__construct()

MediaWiki\Extension\GlobalWatchlist\SpecialGlobalWatchlistSettings::__construct	(	LoggerInterface	$logger,
		ExtensionRegistry	$extensionRegistry,
		SettingsManager	$settingsManager,
		SpecialPageFactory	$specialPageFactory,
		UserOptionsLookup	$userOptionsLookup )

Parameters

LoggerInterface	$logger
ExtensionRegistry	$extensionRegistry
SettingsManager	$settingsManager
SpecialPageFactory	$specialPageFactory
UserOptionsLookup	$userOptionsLookup

Member Function Documentation

alterForm()

MediaWiki\Extension\GlobalWatchlist\SpecialGlobalWatchlistSettings::alterForm ( HTMLForm $form )

protected

Set correct label for submit button.

Parameters

HTMLForm

$form

doesWrites()

MediaWiki\Extension\GlobalWatchlist\SpecialGlobalWatchlistSettings::doesWrites

(

)

Returns

bool

execute()

MediaWiki\Extension\GlobalWatchlist\SpecialGlobalWatchlistSettings::execute

(

$par

)

Parameters

string | null

$par

getDisplayFormat()

MediaWiki\Extension\GlobalWatchlist\SpecialGlobalWatchlistSettings::getDisplayFormat ( )

protected

Display form as OOUI.

Returns

string

getFormFields()

MediaWiki\Extension\GlobalWatchlist\SpecialGlobalWatchlistSettings::getFormFields ( )

protected

Get an HTMLForm descriptor array.

Returns

array

getGroupName()

MediaWiki\Extension\GlobalWatchlist\SpecialGlobalWatchlistSettings::getGroupName ( )

protected

Returns

string

getMessagePrefix()

MediaWiki\Extension\GlobalWatchlist\SpecialGlobalWatchlistSettings::getMessagePrefix ( )

protected

Get message prefix for HTMLForm.

Returns

string

isListed()

MediaWiki\Extension\GlobalWatchlist\SpecialGlobalWatchlistSettings::isListed

(

)

Only shown for logged in users.

Returns

bool

newFromGlobalState()

static MediaWiki\Extension\GlobalWatchlist\SpecialGlobalWatchlistSettings::newFromGlobalState ( SettingsManager $settingsManager, SpecialPageFactory $specialPageFactory, UserOptionsLookup $userOptionsLookup )

static

Need a factory method to inject LoggerInstance and ExtensionRegistry, which are not available from the service container.

Parameters

SettingsManager	$settingsManager
SpecialPageFactory	$specialPageFactory
UserOptionsLookup	$userOptionsLookup

Returns

SpecialGlobalWatchlistSettings

onSubmit()

MediaWiki\Extension\GlobalWatchlist\SpecialGlobalWatchlistSettings::onSubmit	(	array	$data,
		HTMLForm	$form = null )

Parameters

array	$data
HTMLForm | null	$form

Returns

bool|string|array|Status

---

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

• includes/SpecialGlobalWatchlistSettings.php