MediaWiki REL1_37
|
Provides the UI through which users can perform editing operations on their watchlist. More...
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. | |
getSubpagesForPrefixSearch () | |
Return an array of subpages that this special page will accept. | |
submitClear ( $data) | |
Handler for the clear form submission. | |
submitNormal ( $data) | |
submitRaw ( $data) | |
![]() | |
__construct ( $name, $restriction='', $function=false, $file='default') | |
isListed () | |
Whether this special page is listed in Special:SpecialPages. | |
![]() | |
__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 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}}. | |
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. | |
setContentLanguage (Language $contentLanguage) | |
Set content language. | |
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. | |
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 ( $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 | 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. | |
![]() | |
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. | |
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 () | |
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. | |
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 | |
$toc | |
![]() | |
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 for the default. | |
string | $mRestriction |
Minimum user level required to access this page, or "" for anyone. | |
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. | |
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. | |
Additional Inherited Members | |
![]() | |
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). | |
Provides the UI through which users can perform editing operations on their watchlist.
Definition at line 44 of file SpecialEditWatchlist.php.
SpecialEditWatchlist::__construct | ( | WatchedItemStoreInterface | $watchedItemStore = null , |
TitleParser | $titleParser = null , |
||
GenderCache | $genderCache = null , |
||
LinkBatchFactory | $linkBatchFactory = null , |
||
NamespaceInfo | $nsInfo = null , |
||
WikiPageFactory | $wikiPageFactory = null , |
||
WatchlistManager | $watchlistManager = null |
||
) |
WatchedItemStoreInterface | null | $watchedItemStore | |
TitleParser | null | $titleParser | |
GenderCache | null | $genderCache | |
LinkBatchFactory | null | $linkBatchFactory | |
NamespaceInfo | null | $nsInfo | |
WikiPageFactory | null | $wikiPageFactory | |
WatchlistManager | null | $watchlistManager |
Definition at line 89 of file SpecialEditWatchlist.php.
References $genderCache, $linkBatchFactory, $nsInfo, $titleParser, $watchedItemStore, $watchlistManager, and $wikiPageFactory.
|
private |
Build the label for a checkbox, with a link to the title, and various additional bits.
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. |
Definition at line 700 of file SpecialEditWatchlist.php.
References $title.
|
static |
Build a set of links for convenient navigation between watchlist viewing and editing modes.
Language | $lang | |
LinkRenderer | null | $linkRenderer |
Definition at line 829 of file SpecialEditWatchlist.php.
References $lang, $wgLang, SpecialPage\getTitleFor(), and wfMessage().
Referenced by SpecialWatchlist\doHeader().
|
private |
Validates watchlist entry.
Title | $title | |
int | $namespace | |
string | $dbKey |
Definition at line 471 of file SpecialEditWatchlist.php.
References $title.
|
private |
Attempts to clean up broken items.
Definition at line 493 of file SpecialEditWatchlist.php.
|
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.
string | $messageFor | 'raw' or 'clear'. Only used when JobQueue is not used. |
Definition at line 300 of file SpecialEditWatchlist.php.
Referenced by submitRaw().
|
private |
You should call clearUserWatchedItems() instead to decide if this should use the JobQueue.
string | $messageFor | 'raw' or 'clear' |
Definition at line 313 of file SpecialEditWatchlist.php.
|
private |
You should call clearUserWatchedItems() instead to decide if this should use the JobQueue.
Definition at line 330 of file SpecialEditWatchlist.php.
SpecialEditWatchlist::doesWrites | ( | ) |
Indicates whether this special page may perform database writes.
Reimplemented from SpecialPage.
Definition at line 110 of file SpecialEditWatchlist.php.
SpecialEditWatchlist::execute | ( | $mode | ) |
Main execution point.
string | null | $mode |
Reimplemented from SpecialPage.
Definition at line 119 of file SpecialEditWatchlist.php.
References SpecialPage\checkPermissions(), SpecialPage\checkReadOnly(), EDIT_CLEAR, EDIT_NORMAL, EDIT_RAW, executeViewEditWatchlist(), getClearForm(), getMode(), SpecialPage\getOutput(), getRawForm(), SpecialPage\getRequest(), SpecialPage\getTitleFor(), SpecialPage\msg(), SpecialPage\outputHeader(), outputSubtitle(), SpecialPage\requireLogin(), and SpecialPage\setHeaders().
|
protected |
Executes an edit mode for the watchlist view, from which you can manage your watchlist.
Definition at line 179 of file SpecialEditWatchlist.php.
References getNormalForm(), SpecialPage\getOutput(), SpecialPage\getTitleFor(), and SpecialPage\msg().
Referenced by execute().
|
private |
Extract a list of titles from a blob of text, returning (prefixed) strings; unwatchable titles are ignored.
string | $list |
Definition at line 213 of file SpecialEditWatchlist.php.
References $title, and Title\isWatchable().
Referenced by submitRaw().
|
protected |
Get a form for clearing the watchlist.
Definition at line 780 of file SpecialEditWatchlist.php.
References getContext().
Referenced by execute().
|
private |
string[] | LinkTarget[] | $targets |
Definition at line 578 of file SpecialEditWatchlist.php.
References NS_MAIN.
|
static |
Determine whether we are editing the watchlist, and if so, what kind of editing operation.
WebRequest | $request | |
string | null | $par |
Definition at line 803 of file SpecialEditWatchlist.php.
Referenced by execute(), and SpecialWatchlist\execute().
|
protected |
Get the standard watchlist editing form.
Definition at line 624 of file SpecialEditWatchlist.php.
References $title, getContext(), NS_MAIN, Linker\tocIndent(), Linker\tocLine(), Linker\tocLineEnd(), and Linker\tocList().
Referenced by executeViewEditWatchlist().
|
protected |
Get a form for editing the watchlist in "raw" mode.
Definition at line 753 of file SpecialEditWatchlist.php.
References getContext().
Referenced by execute().
SpecialEditWatchlist::getSubpagesForPrefixSearch | ( | ) |
Return an array of subpages that this special page will accept.
Reimplemented from SpecialPage.
Definition at line 197 of file SpecialEditWatchlist.php.
|
private |
Prepare a list of titles on a user's watchlist (excluding talk pages) and return an array of (prefixed) strings.
Definition at line 393 of file SpecialEditWatchlist.php.
References $title.
Referenced by submitRaw().
|
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.
Definition at line 434 of file SpecialEditWatchlist.php.
References getContext(), and WatchedItemStoreInterface\SORT_ASC.
|
protected |
Renders a subheader on the watchlist page.
Definition at line 164 of file SpecialEditWatchlist.php.
References SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), SpecialPage\getName(), SpecialPage\getOutput(), SpecialPage\getUser(), and SpecialPage\msg().
Referenced by execute().
|
private |
string | $action | Can be "Watch" or "Unwatch" |
string[] | LinkTarget[] | $targets |
FatalError | |
MWException |
Definition at line 558 of file SpecialEditWatchlist.php.
References $title.
|
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
array | $titles | Array of strings, or Title objects |
string | &$output |
Definition at line 344 of file SpecialEditWatchlist.php.
References $title.
Referenced by submitRaw().
SpecialEditWatchlist::submitClear | ( | $data | ) |
Handler for the clear form submission.
array | $data |
Definition at line 289 of file SpecialEditWatchlist.php.
SpecialEditWatchlist::submitNormal | ( | $data | ) |
Definition at line 600 of file SpecialEditWatchlist.php.
SpecialEditWatchlist::submitRaw | ( | $data | ) |
Definition at line 242 of file SpecialEditWatchlist.php.
References clearUserWatchedItems(), extractTitles(), SpecialPage\getUser(), getWatchlist(), SpecialPage\msg(), showTitles(), unwatchTitles(), and watchTitles().
|
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
string[] | LinkTarget[] | $targets |
FatalError | |
MWException |
Definition at line 544 of file SpecialEditWatchlist.php.
Referenced by submitRaw().
|
private |
Add a list of targets to a user's watchlist.
string[] | LinkTarget[] | $targets |
FatalError | |
MWException |
Definition at line 526 of file SpecialEditWatchlist.php.
Referenced by submitRaw().
|
private |
Definition at line 57 of file SpecialEditWatchlist.php.
|
private |
Definition at line 66 of file SpecialEditWatchlist.php.
Referenced by __construct().
|
private |
Definition at line 69 of file SpecialEditWatchlist.php.
Referenced by __construct().
|
private |
Definition at line 72 of file SpecialEditWatchlist.php.
Referenced by __construct().
|
protected |
Definition at line 53 of file SpecialEditWatchlist.php.
|
private |
Definition at line 60 of file SpecialEditWatchlist.php.
Referenced by __construct().
|
protected |
Definition at line 55 of file SpecialEditWatchlist.php.
|
private |
Definition at line 63 of file SpecialEditWatchlist.php.
Referenced by __construct().
|
private |
Definition at line 78 of file SpecialEditWatchlist.php.
Referenced by __construct().
|
private |
Definition at line 75 of file SpecialEditWatchlist.php.
Referenced by __construct().
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 49 of file SpecialEditWatchlist.php.
Referenced by execute(), and SpecialWatchlist\execute().
const SpecialEditWatchlist::EDIT_NORMAL = 3 |
Definition at line 51 of file SpecialEditWatchlist.php.
Referenced by execute().
const SpecialEditWatchlist::EDIT_RAW = 2 |
Definition at line 50 of file SpecialEditWatchlist.php.
Referenced by execute(), and SpecialWatchlist\execute().