MediaWiki  master
SpecialEditWatchlist Class Reference

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 (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. More...
 
 execute ( $mode)
 Main execution point. More...
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept. More...
 
 submitClear ( $data)
 Handler for the clear form submission. More...
 
 submitNormal ( $data)
 
 submitRaw ( $data)
 
- Public Member Functions inherited from UnlistedSpecialPage
 __construct ( $name, $restriction='', $function=false, $file='default')
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages. More...
 
- 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. More...
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError. More...
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError. More...
 
 getAssociatedNavigationLinks ()
 Return an array of strings representing page titles that are discoverable to end users via UI. More...
 
 getAuthority ()
 Shortcut to get the Authority executing this instance. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContentLanguage ()
 Shortcut to get content language. More...
 
 getContext ()
 Gets the context this SpecialPage is executed in. More...
 
 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. More...
 
 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. More...
 
 getFullTitle ()
 Return the full title, including $par. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 getLinkRenderer ()
 
 getLocalName ()
 Get the localised name of the special page. More...
 
 getName ()
 Get the name of this Special Page. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission that a user must have to execute this page. More...
 
 getShortDescription (string $path='')
 Similar to getDescription but takes into account sub pages and designed for display in tabs. More...
 
 getSkin ()
 Shortcut to get the skin being used for this instance. More...
 
 getUser ()
 Shortcut to get the User executing this instance. More...
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion. More...
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode. More...
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More...
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}}. More...
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes. More...
 
 listed ( $x=null)
 Get or set whether this special page is listed in Special:SpecialPages. More...
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included. More...
 
 msg ( $key,... $params)
 Wrapper around wfMessage that sets the current context. More...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error. More...
 
 requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in or is a temporary user, throws UserNotLoggedIn. More...
 
 run ( $subPage)
 Entry point. More...
 
 setContentLanguage (Language $contentLanguage)
 Set content language. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 setSpecialPageFactory (SpecialPageFactory $specialPageFactory)
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 

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. More...
 
static getMode ( $request, $par, $defaultValue=false)
 Determine whether we are editing the watchlist, and if so, what kind of editing operation. More...
 
- 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. More...
 
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. More...
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name. More...
 
static newSearchPage (User $user)
 Get the users preferred search page. More...
 

Public Attributes

const EDIT_CLEAR = 1
 Editing modes. More...
 
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. More...
 
 getClearForm ()
 Get a form for clearing the watchlist. More...
 
 getNormalForm ()
 Get the standard watchlist editing form. More...
 
 getRawForm ()
 Get a form for editing the watchlist in "raw" mode. More...
 
 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. More...
 
 outputSubtitle ()
 Renders a subheader on the watchlist page. More...
 
- Protected Member Functions inherited from SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links. More...
 
 afterExecute ( $subPage)
 Gets called after. More...
 
 beforeExecute ( $subPage)
 Gets called before. More...
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. More...
 
 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'. More...
 
 getHookContainer ()
 
 getHookRunner ()
 
 getLanguageConverter ()
 Shortcut to get language's converter. More...
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. More...
 
 getRobotPolicy ()
 Return the robot policy. More...
 
 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. More...
 
 prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setAuthManager (AuthManager $authManager)
 Set the injected AuthManager from the special page constructor. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Protected Attributes

 $successMessage
 
 $toc
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
bool $mIncludable
 Whether the special page can be included in an article. More...
 
bool $mIncluding
 Whether or not this special page is being included from an article. More...
 
string $mName
 The canonical name of this special page Also used for the default. More...
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone. More...
 

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

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

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ buildTools()

static 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$selectedModeresult of self::getMode
Returns
string

Definition at line 848 of file SpecialEditWatchlist.php.

References SpecialPage\getTitleFor(), Html\rawElement(), and wfMessage().

Referenced by SpecialWatchlist\doHeader().

◆ doesWrites()

SpecialEditWatchlist::doesWrites ( )

Indicates whether this special page may perform database writes.

Stability: stable
to override
Returns
bool
Since
1.27

Reimplemented from SpecialPage.

Definition at line 114 of file SpecialEditWatchlist.php.

◆ execute()

◆ executeViewEditWatchlist()

SpecialEditWatchlist::executeViewEditWatchlist ( )
protected

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

Definition at line 197 of file SpecialEditWatchlist.php.

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

Referenced by execute().

◆ getClearForm()

SpecialEditWatchlist::getClearForm ( )
protected

Get a form for clearing the watchlist.

Returns
HTMLForm

Definition at line 798 of file SpecialEditWatchlist.php.

References getContext().

Referenced by execute().

◆ getMode()

static 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$defaultValueto use if not known.
Returns
int|false

Definition at line 821 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 638 of file SpecialEditWatchlist.php.

References $title, getContext(), Title\makeTitleSafe(), 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 772 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 215 of file SpecialEditWatchlist.php.

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

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

◆ outputSubtitle()

SpecialEditWatchlist::outputSubtitle ( )
protected

Renders a subheader on the watchlist page.

Definition at line 172 of file SpecialEditWatchlist.php.

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

Referenced by execute().

◆ submitClear()

SpecialEditWatchlist::submitClear (   $data)

Handler for the clear form submission.

Parameters
array$data
Returns
bool

Definition at line 304 of file SpecialEditWatchlist.php.

◆ submitNormal()

SpecialEditWatchlist::submitNormal (   $data)

Definition at line 614 of file SpecialEditWatchlist.php.

◆ submitRaw()

SpecialEditWatchlist::submitRaw (   $data)

Definition at line 257 of file SpecialEditWatchlist.php.

References SpecialPage\getUser(), and SpecialPage\msg().

Member Data Documentation

◆ $successMessage

SpecialEditWatchlist::$successMessage
protected

Definition at line 54 of file SpecialEditWatchlist.php.

◆ $toc

SpecialEditWatchlist::$toc
protected

Definition at line 56 of file SpecialEditWatchlist.php.

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

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

◆ EDIT_NORMAL

const SpecialEditWatchlist::EDIT_NORMAL = 3

Definition at line 52 of file SpecialEditWatchlist.php.

Referenced by execute().

◆ EDIT_RAW

const SpecialEditWatchlist::EDIT_RAW = 2

Definition at line 51 of file SpecialEditWatchlist.php.

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


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