MediaWiki  1.28.1
SpecialWatchlist Class Reference

A special page that lists last changes made to the wiki, limited to user-defined list of titles. More...

Inheritance diagram for SpecialWatchlist:
Collaboration diagram for SpecialWatchlist:

Public Member Functions

 __construct ($page= 'Watchlist', $restriction= 'viewmywatchlist')
 
 buildMainQueryConds (FormOptions $opts)
 Return an array of conditions depending of options set in $opts. More...
 
 cutoffselector ($options)
 
 doesWrites ()
 
 doHeader ($opts, $numRows)
 Set the text to be displayed above the changes. More...
 
 doMainQuery ($conds, $opts)
 Process the query. More...
 
 execute ($subpage)
 Main execution point. More...
 
 getDefaultOptions ()
 Get a FormOptions object containing the default options. More...
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept. More...
 
 outputChangesList ($rows, $opts)
 Build and output the actual changes list. More...
 
 outputFeedLinks ()
 Output feed links. More...
 
 setTopText (FormOptions $opts)
 
- Public Member Functions inherited from ChangesListSpecialPage
 buildMainQueryConds (FormOptions $opts)
 Return an array of conditions depending of options set in $opts. More...
 
 doHeader ($opts, $numRows)
 Set the text to be displayed above the changes. More...
 
 doMainQuery ($conds, $opts)
 Process the query. More...
 
 execute ($subpage)
 Main execution point. More...
 
 getDefaultOptions ()
 Get a FormOptions object containing the default options. More...
 
 getExtraOptions ($opts)
 Get options to be displayed in a form. More...
 
 getOptions ()
 Get the current FormOptions for this request. More...
 
 getRows ()
 Get the database result for this special page instance. More...
 
 makeLegend ()
 Return the legend displayed within the fieldset. More...
 
 outputChangesList ($rows, $opts)
 Build and output the actual changes list. More...
 
 outputFeedLinks ()
 Output feed links. More...
 
 parseParameters ($par, FormOptions $opts)
 Process $par and put options found in $opts. More...
 
 setBottomText (FormOptions $opts)
 Send the text to be displayed after the options. More...
 
 setTopText (FormOptions $opts)
 Send the text to be displayed before the options. More...
 
 setup ($parameters)
 Create a FormOptions object with options as specified by the user. More...
 
 validateOptions (FormOptions $opts)
 Validate a FormOptions object generated by getDefaultOptions() with values already populated. More...
 
 webOutput ($rows, $opts)
 Send output to the OutputPage object, only called if not used feeds. 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...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. More...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 execute ($subPage)
 Default execute method Checks user permissions. More...
 
 getConfig ()
 Shortcut to get main config object. 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...
 
 getSkin ()
 Shortcut to get the skin being used for this instance. More...
 
 getTitle ($subpage=false)
 Get a self-referential title object. 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...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages. 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 ()
 Wrapper around wfMessage that sets the current context. More...
 
 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...
 
 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...
 
 run ($subPage)
 Entry point. More...
 
 setContext ($context)
 Sets the context this SpecialPage is executed in. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! More...
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ($listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 

Protected Member Functions

 countItems ()
 Count the number of paired items on a user's watchlist. More...
 
 fetchOptionsFromRequest ($opts)
 Fetch values for a FormOptions object from the WebRequest associated with this instance. More...
 
 getCustomFilters ()
 Get custom show/hide filters. More...
 
 getDB ()
 Return a IDatabase object for reading. More...
 
 runMainQueryHook (&$tables, &$fields, &$conds, &$query_options, &$join_conds, $opts)
 
 showHideCheck ($options, $message, $name, $value)
 
- Protected Member Functions inherited from ChangesListSpecialPage
 addModules ()
 Add page-specific modules. More...
 
 fetchOptionsFromRequest ($opts)
 Fetch values for a FormOptions object from the WebRequest associated with this instance. More...
 
 getCustomFilters ()
 Get custom show/hide filters. More...
 
 getDB ()
 Return a IDatabase object for reading. More...
 
 getGroupName ()
 
 runMainQueryHook (&$tables, &$fields, &$conds, &$query_options, &$join_conds, $opts)
 
- 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...
 
 checkLoginSecurityLevel ($level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 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...
 
 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...
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches. More...
 
 prefixSearchString ($search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Additional Inherited Members

- 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 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...
 
- Protected Attributes inherited from ChangesListSpecialPage
array $customFilters
 
FormOptions $rcOptions
 
string $rcSubpage
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Detailed Description

A special page that lists last changes made to the wiki, limited to user-defined list of titles.

Definition at line 32 of file SpecialWatchlist.php.

Constructor & Destructor Documentation

SpecialWatchlist::__construct (   $page = 'Watchlist',
  $restriction = 'viewmywatchlist' 
)

Definition at line 33 of file SpecialWatchlist.php.

References $page.

Member Function Documentation

SpecialWatchlist::buildMainQueryConds ( FormOptions  $opts)

Return an array of conditions depending of options set in $opts.

Parameters
FormOptions$opts
Returns
array

Definition at line 188 of file SpecialWatchlist.php.

References $dbr, and getDB().

SpecialWatchlist::countItems ( )
protected

Count the number of paired items on a user's watchlist.

The assumption made here is that when a subject page is watched a talk page is also watched. Hence the number of individual items is halved.

Returns
int

Definition at line 656 of file SpecialWatchlist.php.

References $count, and SpecialPage\getUser().

Referenced by setTopText().

SpecialWatchlist::cutoffselector (   $options)
SpecialWatchlist::doesWrites ( )

Definition at line 37 of file SpecialWatchlist.php.

SpecialWatchlist::doMainQuery (   $conds,
  $opts 
)

Process the query.

Parameters
array$conds
FormOptions$opts
Returns
bool|ResultWrapper Result or false (for Recentchangeslinked only)

Definition at line 208 of file SpecialWatchlist.php.

References $dbr, $tables, $user, LogPage\DELETED_ACTION, LogPage\DELETED_RESTRICTED, SpecialPage\getConfig(), getDB(), SpecialPage\getUser(), LIST_OR, ChangeTags\modifyDisplayQuery(), RC_LOG, Hooks\run(), runMainQueryHook(), and RecentChange\selectFields().

SpecialWatchlist::fetchOptionsFromRequest (   $opts)
protected

Fetch values for a FormOptions object from the WebRequest associated with this instance.

Maps old pre-1.23 request parameters Watchlist used to use (different from Recentchanges' ones) to the current ones.

Parameters
FormOptions$opts
Returns
FormOptions

Definition at line 156 of file SpecialWatchlist.php.

References $from, $params, $request, as, and SpecialPage\getRequest().

SpecialWatchlist::getCustomFilters ( )
protected

Get custom show/hide filters.

Returns
array Map of filter URL param names to properties (msg/default)

Definition at line 138 of file SpecialWatchlist.php.

References ChangesListSpecialPage\$customFilters, and Hooks\run().

Referenced by doHeader().

SpecialWatchlist::getDB ( )
protected

Return a IDatabase object for reading.

Returns
IDatabase

Definition at line 316 of file SpecialWatchlist.php.

References DB_REPLICA, and wfGetDB().

Referenced by buildMainQueryConds(), doMainQuery(), and outputChangesList().

SpecialWatchlist::getDefaultOptions ( )

Get a FormOptions object containing the default options.

Returns
FormOptions

Definition at line 111 of file SpecialWatchlist.php.

References $user, FormOptions\FLOAT, SpecialPage\getRequest(), and SpecialPage\getUser().

SpecialWatchlist::getSubpagesForPrefixSearch ( )

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

See also
also SpecialEditWatchlist::getSubpagesForPrefixSearch
Returns
string[] subpages

Definition at line 98 of file SpecialWatchlist.php.

SpecialWatchlist::outputChangesList (   $rows,
  $opts 
)
SpecialWatchlist::outputFeedLinks ( )

Output feed links.

Definition at line 323 of file SpecialWatchlist.php.

References $user, SpecialPage\addFeedLinks(), and SpecialPage\getUser().

SpecialWatchlist::runMainQueryHook ( $tables,
$fields,
$conds,
$query_options,
$join_conds,
  $opts 
)
protected

Definition at line 300 of file SpecialWatchlist.php.

References $tables, and Hooks\run().

Referenced by doMainQuery().

SpecialWatchlist::showHideCheck (   $options,
  $message,
  $name,
  $value 
)
protected

Definition at line 638 of file SpecialWatchlist.php.

References $name, $options, $value, Xml\checkLabel(), SpecialPage\msg(), and text.

Referenced by doHeader().


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