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

Inheritance diagram for SpecialEditWatchlist:

[legend]

Collaboration diagram for SpecialEditWatchlist:

[legend]

Public Member Functions
	__construct (WatchedItemStoreInterface $watchedItemStore)

	doesWrites ()
	Indicates whether this special page may perform database writes.

	execute ( $mode)
	Main execution point.

	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 UnlistedSpecialPage
	__construct ( $name, $restriction='', $function=false, $file='default')
	Stable to call.

	isListed ()
	Whether this special page is listed in Special:SpecialPages Stable to override.

Public Member Functions inherited from 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.

	getConfig ()
	Shortcut to get main config object.

	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 Stable to override.

	getName ()
	Get the name of this Special Page.

	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}} Stable to override.

	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes.

	listed ( $x=null)
	Get or set whether this special page is listed in Special:SpecialPages.

	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.

	run ( $subPage)
	Entry point.

	setContext ( $context)
	Sets the context this SpecialPage is executed in.

	setHookContainer (HookContainer $hookContainer)

	setLinkRenderer (LinkRenderer $linkRenderer)

	setListed ( $listed)
	Set whether this page is listed in Special:Specialpages, at run-time.

	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 ( $lang, LinkRenderer $linkRenderer=null)
	Build a set of links for convenient navigation between watchlist viewing and editing modes.

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

Static Public Member Functions inherited from 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.

Public Attributes
const	EDIT_CLEAR = 1
	Editing modes.

const	EDIT_NORMAL = 3

const	EDIT_RAW = 2

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 SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

	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 Stable to override.

	getCacheTTL ()
	Stable to override.

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

	getLanguageConverter ()
	Shortcut to get language's converter.

	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.

	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)
	Perform a regular substring search for prefixSearchSubpages.

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

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

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

Protected Attributes
	$successMessage

	$toc

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

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Private Member Functions
	buildRemoveLine ( $title, string $expiryDaysText='')
	Build the label for a checkbox, with a link to the title, and various additional bits.

	checkTitle ( $title, $namespace, $dbKey)
	Validates watchlist entry.

	cleanupWatchlist ()
	Attempts to clean up broken items.

	clearUserWatchedItems (string $messageFor)
	Makes a decision about using the JobQueue or not for clearing a users watchlist.

	clearUserWatchedItemsNow (string $messageFor)
	You should call clearUserWatchedItems() instead to decide if this should use the JobQueue.

	clearUserWatchedItemsUsingJobQueue ()
	You should call clearUserWatchedItems() instead to decide if this should use the JobQueue.

	extractTitles ( $list)
	Extract a list of titles from a blob of text, returning (prefixed) strings; unwatchable titles are ignored.

	getExpandedTargets (array $targets)

	getWatchlist ()
	Prepare a list of titles on a user's watchlist (excluding talk pages) and return an array of (prefixed) strings.

	initServices ()
	Initialize any services we'll need (unless it has already been provided via a setter).

	runWatchUnwatchCompleteHook ( $action, $targets)

	showTitles ( $titles, &$output)
	Print out a list of linked titles.

	unwatchTitles (array $targets)
	Remove a list of titles from a user's watchlist.

	watchTitles (array $targets)
	Add a list of targets to a user's watchlist.

Private Attributes
	$badItems = []

bool	$isWatchlistExpiryEnabled
	Watchlist Expiry flag.

TitleParser	$titleParser

WatchedItemStoreInterface	$watchedItemStore

Additional Inherited Members
Static Protected Member Functions inherited from 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 41 of file SpecialEditWatchlist.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialEditWatchlist::__construct ( WatchedItemStoreInterface $watchedItemStore )

Definition at line 69 of file SpecialEditWatchlist.php.

References $watchedItemStore, and SpecialPage\getConfig().

Member Function Documentation

◆ buildRemoveLine()

SpecialEditWatchlist::buildRemoveLine	(		$title,
		string	$expiryDaysText = '' )

private

Build the label for a checkbox, with a link to the title, and various additional bits.

Parameters

Title	$title
string	$expiryDaysText	message shows the number of days a title has remaining in a user's watchlist. If this param is not empty then include a message that states the time remaining in a watchlist.

Returns: string

Definition at line 688 of file SpecialEditWatchlist.php.

References $title.

◆ buildTools()

static SpecialEditWatchlist::buildTools	(		$lang,
		LinkRenderer	$linkRenderer = null )

static

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

Parameters

Language	$lang
LinkRenderer \| null	$linkRenderer

Returns: string

Definition at line 817 of file SpecialEditWatchlist.php.

References $lang, $wgLang, SpecialPage\getTitleFor(), and wfMessage().

Referenced by SpecialWatchlist\doHeader().

◆ checkTitle()

SpecialEditWatchlist::checkTitle	(	$title,
		$namespace,
		$dbKey )

private

Validates watchlist entry.

Parameters

Title	$title
int	$namespace
string	$dbKey

Returns: bool Whether this item is valid

Definition at line 457 of file SpecialEditWatchlist.php.

References $title.

◆ cleanupWatchlist()

SpecialEditWatchlist::cleanupWatchlist ( )

private

Attempts to clean up broken items.

Definition at line 479 of file SpecialEditWatchlist.php.

References $title, getUser(), and wfDebug().

◆ clearUserWatchedItems()

SpecialEditWatchlist::clearUserWatchedItems ( string $messageFor )

private

Makes a decision about using the JobQueue or not for clearing a users watchlist.

Also displays the appropriate messages to the user based on that decision.

Parameters

string $messageFor 'raw' or 'clear'. Only used when JobQueue is not used.

Definition at line 285 of file SpecialEditWatchlist.php.

Referenced by submitRaw().

◆ clearUserWatchedItemsNow()

SpecialEditWatchlist::clearUserWatchedItemsNow ( string $messageFor )

private

You should call clearUserWatchedItems() instead to decide if this should use the JobQueue.

Parameters

string $messageFor 'raw' or 'clear'

Definition at line 298 of file SpecialEditWatchlist.php.

◆ clearUserWatchedItemsUsingJobQueue()

SpecialEditWatchlist::clearUserWatchedItemsUsingJobQueue ( )

private

You should call clearUserWatchedItems() instead to decide if this should use the JobQueue.

Definition at line 315 of file SpecialEditWatchlist.php.

◆ doesWrites()

SpecialEditWatchlist::doesWrites ( )

Indicates whether this special page may perform database writes.

Stable to override

Returns: bool

Since: 1.27

Reimplemented from SpecialPage.

Definition at line 85 of file SpecialEditWatchlist.php.

◆ execute()

SpecialEditWatchlist::execute ( $mode )

Main execution point.

Parameters

string | null $mode

Reimplemented from SpecialPage.

Definition at line 94 of file SpecialEditWatchlist.php.

References $args, SpecialPage\checkPermissions(), SpecialPage\checkReadOnly(), EDIT_CLEAR, EDIT_NORMAL, EDIT_RAW, executeViewEditWatchlist(), getClearForm(), getMode(), SpecialPage\getOutput(), getRawForm(), SpecialPage\getRequest(), SpecialPage\getTitleFor(), initServices(), SpecialPage\msg(), SpecialPage\outputHeader(), outputSubtitle(), SpecialPage\requireLogin(), and SpecialPage\setHeaders().

◆ executeViewEditWatchlist()

SpecialEditWatchlist::executeViewEditWatchlist ( )

protected

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

Definition at line 163 of file SpecialEditWatchlist.php.

References getNormalForm(), SpecialPage\getOutput(), SpecialPage\getTitleFor(), and SpecialPage\msg().

Referenced by execute().

◆ extractTitles()

SpecialEditWatchlist::extractTitles ( $list )

private

Extract a list of titles from a blob of text, returning (prefixed) strings; unwatchable titles are ignored.

Parameters

string $list

Returns: array

Definition at line 198 of file SpecialEditWatchlist.php.

References $title, and Title\isWatchable().

Referenced by submitRaw().

◆ getClearForm()

SpecialEditWatchlist::getClearForm ( )

protected

Get a form for clearing the watchlist.

Returns: HTMLForm

Definition at line 768 of file SpecialEditWatchlist.php.

References getContext().

Referenced by execute().

◆ getExpandedTargets()

SpecialEditWatchlist::getExpandedTargets ( array $targets )

private

Parameters

string[] | LinkTarget[] $targets

Returns: TitleValue[]

Definition at line 565 of file SpecialEditWatchlist.php.

References NS_MAIN.

◆ getMode()

static SpecialEditWatchlist::getMode	(		$request,
			$par )

static

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

Parameters

WebRequest	$request
string	$par

Returns: int

Definition at line 791 of file SpecialEditWatchlist.php.

Referenced by execute(), and SpecialWatchlist\execute().

◆ getNormalForm()

SpecialEditWatchlist::getNormalForm ( )

protected

Get the standard watchlist editing form.

Returns: HTMLForm

Definition at line 612 of file SpecialEditWatchlist.php.

References $title, getContext(), NS_MAIN, Linker\tocIndent(), Linker\tocLine(), Linker\tocLineEnd(), and Linker\tocList().

Referenced by executeViewEditWatchlist().

◆ getRawForm()

SpecialEditWatchlist::getRawForm ( )

protected

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

Returns: HTMLForm

Definition at line 741 of file SpecialEditWatchlist.php.

References getContext().

Referenced by execute().

◆ getSubpagesForPrefixSearch()

SpecialEditWatchlist::getSubpagesForPrefixSearch ( )

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

See also: also SpecialWatchlist::getSubpagesForPrefixSearch

Returns: string[] subpages

Reimplemented from SpecialPage.

Definition at line 182 of file SpecialEditWatchlist.php.

◆ getWatchlist()

SpecialEditWatchlist::getWatchlist ( )

private

Prepare a list of titles on a user's watchlist (excluding talk pages) and return an array of (prefixed) strings.

Returns: array

Definition at line 378 of file SpecialEditWatchlist.php.

References $title, and getUser().

Referenced by submitRaw().

◆ getWatchlistInfo()

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 419 of file SpecialEditWatchlist.php.

References getContext(), getUser(), and WatchedItemStoreInterface\SORT_ASC.

◆ initServices()

SpecialEditWatchlist::initServices ( )

private

Initialize any services we'll need (unless it has already been provided via a setter).

This allows for dependency injection even though we don't control object creation.

Definition at line 79 of file SpecialEditWatchlist.php.

Referenced by execute().

◆ outputSubtitle()

SpecialEditWatchlist::outputSubtitle ( )

protected

Renders a subheader on the watchlist page.

Definition at line 148 of file SpecialEditWatchlist.php.

References SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), SpecialPage\getName(), SpecialPage\getOutput(), SpecialPage\getUser(), and SpecialPage\msg().

Referenced by execute().

◆ runWatchUnwatchCompleteHook()

SpecialEditWatchlist::runWatchUnwatchCompleteHook	(		$action,
			$targets )

private

Parameters

string	$action	Can be "Watch" or "Unwatch"
string[] \| LinkTarget[]	$targets

Returns: bool

Exceptions

FatalError
MWException

Definition at line 545 of file SpecialEditWatchlist.php.

References $title, and getUser().

◆ showTitles()

SpecialEditWatchlist::showTitles	(		$titles,
		&	$output )

private

Print out a list of linked titles.

$titles can be an array of strings or Title objects; the former is preferred, since Titles are very memory-heavy

Parameters

array	$titles	Array of strings, or Title objects
string	&$output

Definition at line 329 of file SpecialEditWatchlist.php.

References $title.

Referenced by submitRaw().

◆ submitClear()

SpecialEditWatchlist::submitClear ( $data )

Handler for the clear form submission.

Parameters

array $data

Returns: bool

Definition at line 274 of file SpecialEditWatchlist.php.

◆ submitNormal()

SpecialEditWatchlist::submitNormal ( $data )

Definition at line 588 of file SpecialEditWatchlist.php.

◆ submitRaw()

SpecialEditWatchlist::submitRaw ( $data )

Definition at line 227 of file SpecialEditWatchlist.php.

References clearUserWatchedItems(), extractTitles(), SpecialPage\getUser(), getWatchlist(), SpecialPage\msg(), showTitles(), unwatchTitles(), and watchTitles().

◆ unwatchTitles()

SpecialEditWatchlist::unwatchTitles ( array $targets )

private

Remove a list of titles from a user's watchlist.

$titles can be an array of strings or Title objects; the former is preferred, since Titles are very memory-heavy

Parameters

string[] | LinkTarget[] $targets

Returns: bool

Exceptions

FatalError
MWException

Definition at line 531 of file SpecialEditWatchlist.php.

References getUser().

Referenced by submitRaw().

◆ watchTitles()

SpecialEditWatchlist::watchTitles ( array $targets )

private

Add a list of targets to a user's watchlist.

Parameters

string[] | LinkTarget[] $targets

Returns: bool

Exceptions

FatalError
MWException

Definition at line 513 of file SpecialEditWatchlist.php.

References getUser().

Referenced by submitRaw().

Member Data Documentation

◆ $badItems

SpecialEditWatchlist::$badItems = []

private

Definition at line 54 of file SpecialEditWatchlist.php.

◆ $isWatchlistExpiryEnabled

bool SpecialEditWatchlist::$isWatchlistExpiryEnabled

private

Watchlist Expiry flag.

Definition at line 67 of file SpecialEditWatchlist.php.

◆ $successMessage

SpecialEditWatchlist::$successMessage

protected

Definition at line 50 of file SpecialEditWatchlist.php.

◆ $titleParser

TitleParser SpecialEditWatchlist::$titleParser

private

Definition at line 59 of file SpecialEditWatchlist.php.

◆ $toc

SpecialEditWatchlist::$toc

protected

Definition at line 52 of file SpecialEditWatchlist.php.

◆ $watchedItemStore

WatchedItemStoreInterface SpecialEditWatchlist::$watchedItemStore

private

Definition at line 64 of file SpecialEditWatchlist.php.

Referenced by __construct().

◆ EDIT_CLEAR

const 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 46 of file SpecialEditWatchlist.php.

Referenced by execute(), and SpecialWatchlist\execute().

◆ EDIT_NORMAL

const SpecialEditWatchlist::EDIT_NORMAL = 3

Definition at line 48 of file SpecialEditWatchlist.php.

Referenced by execute().

◆ EDIT_RAW

const SpecialEditWatchlist::EDIT_RAW = 2

Definition at line 47 of file SpecialEditWatchlist.php.

Referenced by execute(), and SpecialWatchlist\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

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildRemoveLine()

◆ buildTools()

◆ checkTitle()

◆ cleanupWatchlist()

◆ clearUserWatchedItems()

◆ clearUserWatchedItemsNow()

◆ clearUserWatchedItemsUsingJobQueue()

◆ doesWrites()

◆ execute()

◆ executeViewEditWatchlist()

◆ extractTitles()

◆ getClearForm()

◆ getExpandedTargets()

◆ getMode()

◆ getNormalForm()

◆ getRawForm()

◆ getSubpagesForPrefixSearch()

◆ getWatchlist()

◆ getWatchlistInfo()

◆ initServices()

◆ outputSubtitle()

◆ runWatchUnwatchCompleteHook()

◆ showTitles()

◆ submitClear()

◆ submitNormal()

◆ submitRaw()

◆ unwatchTitles()

◆ watchTitles()

Member Data Documentation

◆ $badItems

◆ $isWatchlistExpiryEnabled

◆ $successMessage

◆ $titleParser

◆ $toc

◆ $watchedItemStore

◆ EDIT_CLEAR

◆ EDIT_NORMAL

◆ EDIT_RAW