Provides the UI through which users can perform editing operations on their watchlist. More...

Inherits MediaWiki\SpecialPage\UnlistedSpecialPage.

Collaboration diagram for MediaWiki\Specials\SpecialEditWatchlist:

[legend]

Public Member Functions

__construct (WatchedItemStoreInterface $watchedItemStore=null, TitleParser $titleParser=null, GenderCache $genderCache=null, LinkBatchFactory $linkBatchFactory=null, NamespaceInfo $nsInfo=null, WikiPageFactory $wikiPageFactory=null, WatchlistManager $watchlistManager=null)

doesWrites ()

Indicates whether this special page may perform database writes.

execute ( $mode)

Main execution point.

getAssociatedNavigationLinks ()

Return an array of strings representing page titles that are discoverable to end users via UI.

Since: 1.39

Stability: stable: to call or override

Returns: string[] strings representing page titles that can be rendered by skins if required.

getShortDescription (string $path='')

Similar to getDescription but takes into account sub pages and designed for display in tabs.

Since: 1.39

Stability: stable: to override if special page has complex parameter handling. Use default message keys where possible.

Parameters

string $path (optional)

Returns: string

getSubpagesForPrefixSearch ()

Return an array of subpages that this special page will accept.

submitClear ( $data)

Handler for the clear form submission.

submitNormal ( $data)

submitRaw ( $data)

Public Member Functions inherited from MediaWiki\SpecialPage\UnlistedSpecialPage

__construct ( $name, $restriction='', $function=false, $file='default')

isListed ()

Whether this special page is listed in Special:SpecialPages.

Public Member Functions inherited from MediaWiki\SpecialPage\SpecialPage

__construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)

Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called.

addHelpLink ( $to, $overrideBaseUrl=false)

Adds help link with an icon via page indicators.

checkPermissions ()

Checks if userCanExecute, and if not throws a PermissionsError.

checkReadOnly ()

If the wiki is currently in readonly mode, throws a ReadOnlyError.

getAuthority ()

Shortcut to get the Authority executing this instance.

getConfig ()

Shortcut to get main config object.

getContentLanguage ()

Shortcut to get content language.

getContext ()

Gets the context this SpecialPage is executed in.

getDescription ()

Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages.

getFinalGroupName ()

Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side.

getFullTitle ()

Return the full title, including $par.

getLanguage ()

Shortcut to get user's language.

getLinkRenderer ()

getLocalName ()

Get the localised name of the special page.

getName ()

Get the canonical, unlocalized name of this special page without namespace.

getOutput ()

Get the OutputPage being used for this instance.

getPageTitle ( $subpage=false)

Get a self-referential title object.

getRequest ()

Get the WebRequest being used for this instance.

getRestriction ()

Get the permission that a user must have to execute this page.

getSkin ()

Shortcut to get the skin being used for this instance.

getUser ()

Shortcut to get the User executing this instance.

including ( $x=null)

Whether the special page is being evaluated via transclusion.

isCached ()

Is this page cached? Expensive pages are cached or disabled in miser mode.

isExpensive ()

Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.

isIncludable ()

Whether it's allowed to transclude the special page via {{Special:Foo/params}}.

isRestricted ()

Can be overridden by subclasses with more complicated permissions schemes.

maxIncludeCacheTime ()

How long to cache page when it is being included.

msg ( $key,... $params)

Wrapper around wfMessage that sets the current context.

prefixSearchSubpages ( $search, $limit, $offset)

Return an array of subpages beginning with $search that this special page will accept.

requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')

If the user is not logged in, throws UserNotLoggedIn error.

requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')

If the user is not logged in or is a temporary user, throws UserNotLoggedIn.

run ( $subPage)

Entry point.

setContentLanguage (Language $contentLanguage)

Set content language.

setContext ( $context)

Sets the context this SpecialPage is executed in.

setHookContainer (HookContainer $hookContainer)

setLinkRenderer (LinkRenderer $linkRenderer)

setSpecialPageFactory (SpecialPageFactory $specialPageFactory)

userCanExecute (User $user)

Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

Static Public Member Functions
static	buildTools ( $unused, LinkRenderer $linkRenderer=null, $selectedMode=false)
	Build a set of links for convenient navigation between watchlist viewing and editing modes.

static	getMode ( $request, $par, $defaultValue=false)
	Determine whether we are editing the watchlist, and if so, what kind of editing operation.

Static Public Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
static	getSafeTitleFor ( $name, $subpage=false)
	Get a localised Title object for a page name with a possibly unvalidated subpage.

static	getTitleFor ( $name, $subpage=false, $fragment='')
	Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below.

static	getTitleValueFor ( $name, $subpage=false, $fragment='')
	Get a localised TitleValue object for a specified special page name.

static	newSearchPage (User $user)
	Get the users preferred search page.

Public Attributes
const	EDIT_CLEAR = 1
	Editing modes.

const	EDIT_NORMAL = 3

const	EDIT_RAW = 2

const	VIEW = 4

Protected Member Functions
	executeViewEditWatchlist ()
	Executes an edit mode for the watchlist view, from which you can manage your watchlist.

	getClearForm ()
	Get a form for clearing the watchlist.

	getNormalForm ()
	Get the standard watchlist editing form.

	getRawForm ()
	Get a form for editing the watchlist in "raw" mode.

	getWatchlistInfo ()
	Get a list of titles on a user's watchlist, excluding talk pages, and return as a two-dimensional array with namespace and title.

	outputSubtitle ()
	Renders a subheader on the watchlist page.

Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

	authorizeAction (?string $action=null)
	Utility function for authorizing an action to be performed by the special page.

	beforeExecute ( $subPage)
	Gets called before.

	buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
	Generate (prev x\| next x) (20\|50\|100...) type links for paging.

	checkLoginSecurityLevel ( $level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process.

	displayRestrictionError ()
	Output an error message telling the user what access level they have to have.

	getAuthManager ()

	getCacheTTL ()

	getGroupName ()
	Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

	getHookContainer ()

	getHookRunner ()

	getLoginSecurityLevel ()
	Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.

	getRobotPolicy ()
	Return the robot policy.

	getSpecialPageFactory ()

	outputHeader ( $summaryMessageKey='')
	Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e.

	prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
	Perform a regular substring search for prefixSearchSubpages.

	setAuthManager (AuthManager $authManager)
	Set the injected AuthManager from the special page constructor.

	setHeaders ()
	Sets headers - this should be called from the execute() method of all derived classes!

	setReauthPostData (array $data)
	Record preserved POST data after a reauthentication.

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Protected Attributes
	$successMessage

TOCData	$tocData

Protected Attributes inherited from MediaWiki\SpecialPage\SpecialPage
IContextSource	$mContext
	Current request context.

bool	$mIncludable
	Whether the special page can be included in an article.

bool	$mIncluding
	Whether or not this special page is being included from an article.

string	$mName
	The canonical name of this special page Also used as the message key for the default.

string	$mRestriction
	Minimum user level required to access this page, or "" for anyone.

Additional Inherited Members
Static Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
static	prefixSearchArray ( $search, $limit, array $subpages, $offset)
	Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query).

Detailed Description

Provides the UI through which users can perform editing operations on their watchlist.

Author: Rob Church robch.nosp@m.ur@g.nosp@m.mail..nosp@m.com

Definition at line 72 of file SpecialEditWatchlist.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Specials\SpecialEditWatchlist::__construct	(	WatchedItemStoreInterface	$watchedItemStore = null,
		TitleParser	$titleParser = null,
		GenderCache	$genderCache = null,
		LinkBatchFactory	$linkBatchFactory = null,
		NamespaceInfo	$nsInfo = null,
		WikiPageFactory	$wikiPageFactory = null,
		WatchlistManager	$watchlistManager = null )

Parameters

WatchedItemStoreInterface \| null	$watchedItemStore
TitleParser \| null	$titleParser
GenderCache \| null	$genderCache
LinkBatchFactory \| null	$linkBatchFactory
NamespaceInfo \| null	$nsInfo
WikiPageFactory \| null	$wikiPageFactory
WatchlistManager \| null	$watchlistManager

Definition at line 109 of file SpecialEditWatchlist.php.

References MediaWiki\MediaWikiServices\getInstance().

Member Function Documentation

◆ buildTools()

static MediaWiki\Specials\SpecialEditWatchlist::buildTools	(		$unused,
		LinkRenderer	$linkRenderer = null,
			$selectedMode = false )

static

Build a set of links for convenient navigation between watchlist viewing and editing modes.

Parameters

mixed	$unused
LinkRenderer \| null	$linkRenderer
int \| false	$selectedMode	result of self::getMode

Returns: string

Definition at line 924 of file SpecialEditWatchlist.php.

References wfMessage().

Referenced by MediaWiki\Specials\SpecialEditWatchlist\outputSubtitle().

◆ doesWrites()

MediaWiki\Specials\SpecialEditWatchlist::doesWrites ( )

Indicates whether this special page may perform database writes.

Stability: stable: to override

Returns: bool

Since: 1.27

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 130 of file SpecialEditWatchlist.php.

◆ execute()

MediaWiki\Specials\SpecialEditWatchlist::execute ( $mode )

Main execution point.

Parameters

string | null $mode

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 139 of file SpecialEditWatchlist.php.

◆ executeViewEditWatchlist()

MediaWiki\Specials\SpecialEditWatchlist::executeViewEditWatchlist ( )

protected

Executes an edit mode for the watchlist view, from which you can manage your watchlist.

Definition at line 240 of file SpecialEditWatchlist.php.

References MediaWiki\SpecialPage\SpecialPage\getTitleFor(), StatusValue\isGood(), and MediaWiki\Parser\ParserOutput\setTOCData().

Referenced by MediaWiki\Specials\SpecialEditWatchlist\execute().

◆ getAssociatedNavigationLinks()

MediaWiki\Specials\SpecialEditWatchlist::getAssociatedNavigationLinks ( )

Return an array of strings representing page titles that are discoverable to end users via UI.

Since: 1.39

Stability: stable: to call or override

Returns: string[] strings representing page titles that can be rendered by skins if required.

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 226 of file SpecialEditWatchlist.php.

◆ getClearForm()

MediaWiki\Specials\SpecialEditWatchlist::getClearForm ( )

protected

Get a form for clearing the watchlist.

Returns: HTMLForm

Definition at line 872 of file SpecialEditWatchlist.php.

References getContext().

Referenced by MediaWiki\Specials\SpecialEditWatchlist\execute().

◆ getMode()

static MediaWiki\Specials\SpecialEditWatchlist::getMode	(	$request,
		$par,
		$defaultValue = false )

static

Determine whether we are editing the watchlist, and if so, what kind of editing operation.

Parameters

WebRequest	$request
string \| null	$par
int \| false	$defaultValue	to use if not known.

Returns: int|false

Definition at line 895 of file SpecialEditWatchlist.php.

Referenced by MediaWiki\Specials\SpecialEditWatchlist\execute(), and MediaWiki\Specials\SpecialWatchlist\execute().

◆ getNormalForm()

MediaWiki\Specials\SpecialEditWatchlist::getNormalForm ( )

protected

Get the standard watchlist editing form.

Returns: HTMLForm

Definition at line 692 of file SpecialEditWatchlist.php.

References getContext(), and NS_MAIN.

◆ getRawForm()

MediaWiki\Specials\SpecialEditWatchlist::getRawForm ( )

protected

Get a form for editing the watchlist in "raw" mode.

Returns: HTMLForm

Definition at line 846 of file SpecialEditWatchlist.php.

References getContext().

Referenced by MediaWiki\Specials\SpecialEditWatchlist\execute().

◆ getShortDescription()

MediaWiki\Specials\SpecialEditWatchlist::getShortDescription ( string $path = '' )

Similar to getDescription but takes into account sub pages and designed for display in tabs.

Since: 1.39

Stability: stable: to override if special page has complex parameter handling. Use default message keys where possible.

Parameters

string $path (optional)

Returns: string

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 233 of file SpecialEditWatchlist.php.

◆ getSubpagesForPrefixSearch()

MediaWiki\Specials\SpecialEditWatchlist::getSubpagesForPrefixSearch ( )

Return an array of subpages that this special page will accept.

See also: also SpecialWatchlist::getSubpagesForPrefixSearch

Returns: string[] subpages

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 269 of file SpecialEditWatchlist.php.

◆ getWatchlistInfo()

MediaWiki\Specials\SpecialEditWatchlist::getWatchlistInfo ( )

protected

Get a list of titles on a user's watchlist, excluding talk pages, and return as a two-dimensional array with namespace and title.

Returns: array

Definition at line 503 of file SpecialEditWatchlist.php.

References getContext(), and getUser().

◆ outputSubtitle()

MediaWiki\Specials\SpecialEditWatchlist::outputSubtitle ( )

protected

Renders a subheader on the watchlist page.

Definition at line 197 of file SpecialEditWatchlist.php.

References MediaWiki\Specials\SpecialEditWatchlist\buildTools(), MediaWiki\Html\element(), MediaWiki\SpecialPage\SpecialPage\getLinkRenderer(), MediaWiki\SpecialPage\SpecialPage\getName(), MediaWiki\SpecialPage\SpecialPage\getOutput(), MediaWiki\SpecialPage\SpecialPage\getSkin(), MediaWiki\SpecialPage\SpecialPage\getUser(), and MediaWiki\SpecialPage\SpecialPage\msg().

Referenced by MediaWiki\Specials\SpecialEditWatchlist\execute().

◆ submitClear()

MediaWiki\Specials\SpecialEditWatchlist::submitClear ( $data )

Handler for the clear form submission.

Parameters

array $data

Returns: bool

Definition at line 356 of file SpecialEditWatchlist.php.

◆ submitNormal()

MediaWiki\Specials\SpecialEditWatchlist::submitNormal ( $data )

Definition at line 665 of file SpecialEditWatchlist.php.

◆ submitRaw()

MediaWiki\Specials\SpecialEditWatchlist::submitRaw ( $data )

Definition at line 311 of file SpecialEditWatchlist.php.

References getUser().

Member Data Documentation

◆ $successMessage

MediaWiki\Specials\SpecialEditWatchlist::$successMessage

protected

Definition at line 82 of file SpecialEditWatchlist.php.

◆ $tocData

TOCData MediaWiki\Specials\SpecialEditWatchlist::$tocData

protected

Definition at line 85 of file SpecialEditWatchlist.php.

◆ EDIT_CLEAR

const MediaWiki\Specials\SpecialEditWatchlist::EDIT_CLEAR = 1

Editing modes.

EDIT_CLEAR is no longer used; the "Clear" link scared people too much. Now it's passed on to the raw editor, from which it's very easy to clear.

Definition at line 77 of file SpecialEditWatchlist.php.

Referenced by MediaWiki\Specials\SpecialEditWatchlist\execute(), and MediaWiki\Specials\SpecialWatchlist\execute().

◆ EDIT_NORMAL

const MediaWiki\Specials\SpecialEditWatchlist::EDIT_NORMAL = 3

Definition at line 79 of file SpecialEditWatchlist.php.

Referenced by MediaWiki\Specials\SpecialEditWatchlist\execute().

◆ EDIT_RAW

const MediaWiki\Specials\SpecialEditWatchlist::EDIT_RAW = 2

Definition at line 78 of file SpecialEditWatchlist.php.

Referenced by MediaWiki\Specials\SpecialEditWatchlist\execute(), and MediaWiki\Specials\SpecialWatchlist\execute().

◆ VIEW

const MediaWiki\Specials\SpecialEditWatchlist::VIEW = 4

Definition at line 80 of file SpecialEditWatchlist.php.

Referenced by MediaWiki\Specials\SpecialEditWatchlist\execute().

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

includes/specials/SpecialEditWatchlist.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildTools()

◆ doesWrites()

◆ execute()

◆ executeViewEditWatchlist()

◆ getAssociatedNavigationLinks()

◆ getClearForm()

◆ getMode()

◆ getNormalForm()

◆ getRawForm()

◆ getShortDescription()

◆ getSubpagesForPrefixSearch()

◆ getWatchlistInfo()

◆ outputSubtitle()

◆ submitClear()

◆ submitNormal()

◆ submitRaw()

Member Data Documentation

◆ $successMessage

◆ $tocData

◆ EDIT_CLEAR

◆ EDIT_NORMAL

◆ EDIT_RAW

◆ VIEW