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

Inheritance diagram for SpecialEditWatchlist:

Collaboration diagram for SpecialEditWatchlist:

Public Member Functions
	__construct ()
	execute ($mode)
	Main execution point.
	submitNormal ($data)
	submitRaw ($data)
Static Public Member Functions
static	buildTools ($unused)
	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.
Public Attributes
const	EDIT_CLEAR = 1
	Editing modes.
const	EDIT_NORMAL = 3
const	EDIT_RAW = 2
Protected Member Functions
	getNormalForm ()
	Get the standard watchlist editing form.
	getRawForm ()
	Get a form for editing the watchlist in "raw" mode.
Protected Attributes
	$successMessage
	$toc
Private Member Functions
	buildRemoveLine ($title)
	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.
	clearWatchlist ()
	Remove all titles from a user's watchlist.
	extractTitles ($list)
	Extract a list of titles from a blob of text, returning (prefixed) strings; unwatchable titles are ignored.
	getWatchlist ()
	Prepare a list of titles on a user's watchlist (excluding talk pages) and return an array of (prefixed) strings.
	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.
	showTitles ($titles, &$output)
	Print out a list of linked titles.
	unwatchTitles ($titles)
	Remove a list of titles from a user's watchlist.
	watchTitles ($titles)
	Add a list of titles to a user's watchlist.
Private Attributes
	$badItems = array()

Detailed Description

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

Author:: Rob Church <[email protected]>

Definition at line 37 of file SpecialEditWatchlist.php.

Constructor & Destructor Documentation

SpecialEditWatchlist::__construct ( )

Definition at line 51 of file SpecialEditWatchlist.php.

Member Function Documentation

SpecialEditWatchlist::buildRemoveLine ( $ title ) [private]

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

Parameters:

$title Title

Returns:: string

Definition at line 569 of file SpecialEditWatchlist.php.

References $link, $title, $tools, array(), SpecialPage\getLanguage(), SpecialPage\getSkin(), SpecialPage\getTitleFor(), Linker\link(), Linker\linkKnown(), SpecialPage\msg(), and wfRunHooks().

Referenced by getNormalForm().

static SpecialEditWatchlist::buildTools ( $ unused ) [static]

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

Parameters:

$unused

Returns:: string

Definition at line 660 of file SpecialEditWatchlist.php.

References $tools, $wgLang, array(), as, SpecialPage\getTitleFor(), global, Linker\linkKnown(), Html\rawElement(), text, and wfMessage().

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

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

References $title, and array().

Referenced by getNormalForm(), and getWatchlist().

SpecialEditWatchlist::cleanupWatchlist ( ) [private]

Attempts to clean up broken items.

Definition at line 359 of file SpecialEditWatchlist.php.

References $title, $user, array(), as, SpecialPage\getUser(), list, wfDebug(), and wfGetDB().

Referenced by getNormalForm(), and getWatchlist().

SpecialEditWatchlist::clearWatchlist ( ) [private]

Remove all titles from a user's watchlist.

Definition at line 391 of file SpecialEditWatchlist.php.

References array(), SpecialPage\getUser(), and wfGetDB().

Referenced by submitRaw().

SpecialEditWatchlist::execute ( $ mode )

Main execution point.

Parameters:

$mode int

Reimplemented from SpecialPage.

Definition at line 60 of file SpecialEditWatchlist.php.

References $form, $out, array(), buildTools(), SpecialPage\checkPermissions(), SpecialPage\checkReadOnly(), getMode(), SpecialPage\getName(), getNormalForm(), SpecialPage\getOutput(), getRawForm(), SpecialPage\getRequest(), SpecialPage\getTitle(), SpecialPage\getTitleFor(), SpecialPage\getUser(), Linker\linkKnown(), SpecialPage\msg(), SpecialPage\outputHeader(), and SpecialPage\setHeaders().

SpecialEditWatchlist::extractTitles ( $ list ) [private]

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

Parameters:

$list String

Returns:: array

Definition at line 132 of file SpecialEditWatchlist.php.

References $title, $titles, array(), as, Title\newFromText(), and GenderCache\singleton().

Referenced by submitRaw().

static SpecialEditWatchlist::getMode	(	$	request,
		$	par
	)		`[static]`

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

Parameters:

$request	WebRequest
$par	mixed

Returns:: int

Definition at line 635 of file SpecialEditWatchlist.php.

References EDIT_CLEAR, EDIT_NORMAL, and EDIT_RAW.

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

SpecialEditWatchlist::getNormalForm ( ) [protected]

Get the standard watchlist editing form.

Returns:: HTMLForm

Definition at line 503 of file SpecialEditWatchlist.php.

References $count, $form, $title, $wgContLang, array(), as, buildRemoveLine(), checkTitle(), cleanupWatchlist(), SpecialPage\getContext(), SpecialPage\getLanguage(), SpecialPage\getTitle(), getWatchlistInfo(), global, Title\makeTitleSafe(), SpecialPage\msg(), Linker\tocIndent(), Linker\tocLine(), Linker\tocLineEnd(), and Linker\tocList().

Referenced by execute().

SpecialEditWatchlist::getRawForm ( ) [protected]

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

Returns:: HTMLForm

Definition at line 605 of file SpecialEditWatchlist.php.

References $form, $titles, array(), SpecialPage\getContext(), SpecialPage\getTitle(), getWatchlist(), and SpecialPage\msg().

Referenced by execute().

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

References $dbr, $res, $title, $titles, array(), as, checkTitle(), cleanupWatchlist(), SpecialPage\getUser(), Title\makeTitleSafe(), GenderCache\singleton(), and wfGetDB().

Referenced by getRawForm(), and submitRaw().

SpecialEditWatchlist::getWatchlistInfo ( ) [private]

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

References $dbr, $lb, $res, $titles, array(), as, SpecialPage\getUser(), MWNamespace\isTalk(), and wfGetDB().

Referenced by getNormalForm().

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	of strings, or Title objects
	$output	String

Definition at line 216 of file SpecialEditWatchlist.php.

References $batch, $output, $title, $titles, as, Linker\link(), SpecialPage\msg(), and Title\newFromText().

Referenced by submitNormal(), and submitRaw().

SpecialEditWatchlist::submitNormal ( $ data )

Definition at line 479 of file SpecialEditWatchlist.php.

References $titles, array(), as, SpecialPage\msg(), showTitles(), and unwatchTitles().

SpecialEditWatchlist::submitRaw ( $ data )

Definition at line 161 of file SpecialEditWatchlist.php.

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

SpecialEditWatchlist::unwatchTitles ( $ titles ) [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:

array $titles of strings, or Title objects

Definition at line 444 of file SpecialEditWatchlist.php.

References $title, $titles, array(), as, WikiPage\factory(), MWNamespace\getSubject(), MWNamespace\getTalk(), SpecialPage\getUser(), Title\newFromText(), wfGetDB(), and wfRunHooks().

Referenced by submitNormal(), and submitRaw().

SpecialEditWatchlist::watchTitles ( $ titles ) [private]

Add a list of titles to 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:

array $titles of strings, or Title objects

Definition at line 408 of file SpecialEditWatchlist.php.

References $title, $titles, array(), as, MWNamespace\getSubject(), MWNamespace\getTalk(), SpecialPage\getUser(), Title\newFromText(), and wfGetDB().

Referenced by submitRaw().

Member Data Documentation

SpecialEditWatchlist::$badItems = array() [private]

Definition at line 49 of file SpecialEditWatchlist.php.

SpecialEditWatchlist::$successMessage [protected]

Definition at line 45 of file SpecialEditWatchlist.php.

SpecialEditWatchlist::$toc [protected]

Definition at line 47 of file SpecialEditWatchlist.php.

const SpecialEditWatchlist::EDIT_CLEAR = 1

Editing modes.

Definition at line 41 of file SpecialEditWatchlist.php.

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

const SpecialEditWatchlist::EDIT_NORMAL = 3

Definition at line 43 of file SpecialEditWatchlist.php.

Referenced by getMode().

const SpecialEditWatchlist::EDIT_RAW = 2

Definition at line 42 of file SpecialEditWatchlist.php.

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

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

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation