MediaWiki  master
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')
 
 cutoffselector ( $options)
 
 doesWrites ()
 
 doHeader ( $opts, $numRows)
 Set the text to be displayed above the changes. More...
 
 execute ( $subpage)
 Main execution point. 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
 __construct ( $name, $restriction)
 
 doHeader ( $opts, $numRows)
 Set the text to be displayed above the changes. More...
 
 execute ( $subpage)
 
 filterOnUserExperienceLevel ( $specialPageClassName, $context, $dbr, &$tables, &$fields, &$conds, &$query_options, &$join_conds, $selectedExpLevels, $now=0)
 Filter on users' experience levels; this will not be called if nothing is selected. More...
 
 getDefaultDays ()
 Get the default value of the number of days to display when loading the result set. More...
 
 getDefaultLimit ()
 Get the default value of the number of changes to display when loading the result set. More...
 
 getDefaultOptions ()
 Get a FormOptions object containing the default options. More...
 
 getExtraOptions ( $opts)
 Get options to be displayed in a form. More...
 
 getFilterGroup ( $groupName)
 Gets a specified ChangesListFilterGroup by name. More...
 
 getOptions ()
 Get the current FormOptions for this request. More...
 
 getRows ()
 Get the database result for this special page instance. More...
 
 getStructuredFilterJsData ()
 Gets structured filter information needed by JS. More...
 
 isStructuredFilterUiEnabled ()
 Check whether the structured filter UI is enabled. 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...
 
 registerFilterGroup (ChangesListFilterGroup $group)
 Register a structured changes list filter group. More...
 
 replaceOldOptions (FormOptions $opts)
 Replace old options with their structured UI equivalents. 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)
 Register all the filters, including legacy hook-driven ones. 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...
 
 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 ( $key)
 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...
 

Static Public Member Functions

static checkStructuredFilterUiEnabled ( $user)
 
- Static Public Member Functions inherited from ChangesListSpecialPage
static checkStructuredFilterUiEnabled ( $user)
 Static method to check whether StructuredFilter UI is enabled for the given user. More...
 
static getRcFiltersConfigSummary (ResourceLoaderContext $context)
 Get essential data about getRcFiltersConfigVars() for change detection. More...
 
static getRcFiltersConfigVars (ResourceLoaderContext $context)
 Get config vars to export with the mediawiki.rcfilters.filters.ui module. 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...
 

Protected Member Functions

 countItems ()
 Count the number of paired items on a user's watchlist. More...
 
 doMainQuery ( $tables, $fields, $conds, $query_options, $join_conds, FormOptions $opts)
 
 fetchOptionsFromRequest ( $opts)
 Fetch values for a FormOptions object from the WebRequest associated with this instance. More...
 
 getDB ()
 Return a IDatabase object for reading. More...
 
 isChangeEffectivelySeen (RecentChange $rc)
 
 registerFilters ()
 
 showHideCheck ( $options, $message, $name, $value, $inStructuredUi)
 
 transformFilterDefinition (array $filterDefinition)
 
- Protected Member Functions inherited from ChangesListSpecialPage
 addModules ()
 Add page-specific modules. More...
 
 areFiltersInConflict ()
 Check if filters are in conflict and guaranteed to return no results. More...
 
 buildQuery (&$tables, &$fields, &$conds, &$query_options, &$join_conds, FormOptions $opts)
 Sets appropriate tables, fields, conditions, etc. More...
 
 considerActionsForDefaultSavedQuery ( $subpage)
 Check whether or not the page should load defaults, and if so, whether a default saved query is relevant to be redirected to. More...
 
 convertParamsForLink ( $params)
 Convert parameters values from true/false to 1/0 so they are not omitted by wfArrayToCgi() T38524. More...
 
 doMainQuery ( $tables, $fields, $conds, $query_options, $join_conds, FormOptions $opts)
 Process the query. More...
 
 fetchOptionsFromRequest ( $opts)
 Fetch values for a FormOptions object from the WebRequest associated with this instance. More...
 
 getDB ()
 Return a IDatabase object for reading. More...
 
 getFilterGroups ()
 Gets the currently registered filters groups. More...
 
 getGroupName ()
 
 getLegacyShowHideFilters ()
 
 includeRcFiltersApp ()
 Include the modules and configuration for the RCFilters app. More...
 
 outputNoResults ()
 Add the "no results" message to the output. More...
 
 outputTimeout ()
 Add the "timeout" message to the output. More...
 
 registerFilters ()
 Register all filters and their groups (including those from hooks), plus handle conflicts and defaults. More...
 
 registerFiltersFromDefinitions (array $definition)
 Register filters from a definition object. More...
 
 runMainQueryHook (&$tables, &$fields, &$conds, &$query_options, &$join_conds, $opts)
 
 transformFilterDefinition (array $filterDefinition)
 Transforms filter definition to prepare it for constructor. 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...
 
 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...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Static Protected Attributes

static $collapsedPreferenceName = 'rcfilters-wl-collapsed'
 
static $daysPreferenceName = 'watchlistdays'
 
static $limitPreferenceName = 'wllimit'
 
static $savedQueriesPreferenceName = 'rcfilters-wl-saved-queries'
 
- Static Protected Attributes inherited from ChangesListSpecialPage
static string $collapsedPreferenceName
 Preference name for collapsing the active filter display. More...
 
static string $daysPreferenceName
 Preference name for 'days'. More...
 
static string $limitPreferenceName
 Preference name for 'limit'. More...
 
static string $savedQueriesPreferenceName
 Preference name for saved queries. More...
 

Private Member Functions

 getLatestNotificationTimestamp (RecentChange $rc)
 

Private Attributes

float int $maxDays
 
 $watchStore
 WatchedItemStore. More...
 

Additional Inherited Members

- Public Attributes inherited from ChangesListSpecialPage
const TAG_DESC_CHARACTER_LIMIT = 120
 Maximum length of a tag description in UTF-8 characters. More...
 
- Static Protected Member Functions inherited from ChangesListSpecialPage
static getChangeTagInfo (ResourceLoaderContext $context)
 Get (cheap to compute) information about change tags. More...
 
static getChangeTagList (ResourceLoaderContext $context)
 Get information about change tags to export to JS via getRcFiltersConfigVars(). More...
 
static getChangeTagListSummary (ResourceLoaderContext $context)
 Get information about change tags for use in getRcFiltersConfigSummary(). 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
 $filterGroups = []
 Filter groups, and their contained filters This is an associative array (with group name as key) of ChangesListFilterGroup objects. More...
 
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 34 of file SpecialWatchlist.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 45 of file SpecialWatchlist.php.

References SpecialPage\getConfig().

Member Function Documentation

◆ checkStructuredFilterUiEnabled()

static SpecialWatchlist::checkStructuredFilterUiEnabled (   $user)
static

◆ countItems()

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 860 of file SpecialWatchlist.php.

References SpecialPage\getUser().

Referenced by setTopText().

◆ cutoffselector()

SpecialWatchlist::cutoffselector (   $options)

Definition at line 746 of file SpecialWatchlist.php.

References $maxDays, $name, $options, $value, as, SpecialPage\getUser(), and SpecialPage\msg().

Referenced by doHeader().

◆ doesWrites()

SpecialWatchlist::doesWrites ( )

Definition at line 52 of file SpecialWatchlist.php.

◆ doHeader()

◆ doMainQuery()

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

◆ execute()

◆ fetchOptionsFromRequest()

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 305 of file SpecialWatchlist.php.

References $filter, $params, $request, as, ChangesListSpecialPage\getLegacyShowHideFilters(), and SpecialPage\getRequest().

◆ getDB()

SpecialWatchlist::getDB ( )
protected

Return a IDatabase object for reading.

Returns
IDatabase

Definition at line 445 of file SpecialWatchlist.php.

References DB_REPLICA, and wfGetDB().

Referenced by doMainQuery(), and outputChangesList().

◆ getLatestNotificationTimestamp()

SpecialWatchlist::getLatestNotificationTimestamp ( RecentChange  $rc)
private
Parameters
RecentChange$rc
Returns
string|null TS_MW timestamp of first unseen revision or null if there isn't one

Definition at line 880 of file SpecialWatchlist.php.

References RecentChange\getAttribute(), RecentChange\getTitle(), and SpecialPage\getUser().

Referenced by isChangeEffectivelySeen().

◆ getSubpagesForPrefixSearch()

SpecialWatchlist::getSubpagesForPrefixSearch ( )

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

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

Definition at line 130 of file SpecialWatchlist.php.

◆ isChangeEffectivelySeen()

SpecialWatchlist::isChangeEffectivelySeen ( RecentChange  $rc)
protected
Parameters
RecentChange$rc
Returns
bool User viewed the revision or a newer one

Definition at line 870 of file SpecialWatchlist.php.

References RecentChange\getAttribute(), getLatestNotificationTimestamp(), and null.

Referenced by outputChangesList(), and registerFilters().

◆ outputChangesList()

SpecialWatchlist::outputChangesList (   $rows,
  $opts 
)

◆ outputFeedLinks()

SpecialWatchlist::outputFeedLinks ( )

Output feed links.

Definition at line 452 of file SpecialWatchlist.php.

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

◆ registerFilters()

◆ setTopText()

◆ showHideCheck()

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

Definition at line 832 of file SpecialWatchlist.php.

References $attribs, $name, $options, $value, Html\check(), SpecialPage\msg(), and Html\rawElement().

Referenced by doHeader().

◆ transformFilterDefinition()

SpecialWatchlist::transformFilterDefinition ( array  $filterDefinition)
protected

Definition at line 141 of file SpecialWatchlist.php.

Member Data Documentation

◆ $collapsedPreferenceName

SpecialWatchlist::$collapsedPreferenceName = 'rcfilters-wl-collapsed'
staticprotected

Definition at line 38 of file SpecialWatchlist.php.

◆ $daysPreferenceName

SpecialWatchlist::$daysPreferenceName = 'watchlistdays'
staticprotected

Definition at line 36 of file SpecialWatchlist.php.

◆ $limitPreferenceName

SpecialWatchlist::$limitPreferenceName = 'wllimit'
staticprotected

Definition at line 37 of file SpecialWatchlist.php.

◆ $maxDays

float int SpecialWatchlist::$maxDays
private

Definition at line 41 of file SpecialWatchlist.php.

Referenced by cutoffselector().

◆ $savedQueriesPreferenceName

SpecialWatchlist::$savedQueriesPreferenceName = 'rcfilters-wl-saved-queries'
staticprotected

Definition at line 35 of file SpecialWatchlist.php.

◆ $watchStore

SpecialWatchlist::$watchStore
private

WatchedItemStore.

Definition at line 43 of file SpecialWatchlist.php.


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