MediaWiki  1.23.12
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...
 
 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...
 
 outputChangesList ( $rows, $opts)
 Build and output the actual changes list. More...
 
 outputFeedLinks ()
 Output feed links. More...
 
 setTopText (FormOptions $opts)
 Send the text to be displayed before the options. More...
 
- Public Member Functions inherited from ChangesListSpecialPage
 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...
 
 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...
 
 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='default', $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...
 
 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...
 
 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...
 
 getFile ()
 Get the file which will be included by SpecialPage::execute() if your extension is still stuck in the past and hasn't overridden the execute() method. 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...
 
 getLang ()
 Shortcut to get user's language. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 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...
 
 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...
 
 requireLogin ( $reasonMsg=null, $titleMsg=null)
 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...
 
 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 ( $dbr)
 Count the number of items on a user's watchlist. More...
 
 cutoffLinks ( $days, $options=array())
 Returns html. More...
 
 daysLink ( $d, $options=array())
 
 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 DatabaseBase object for reading. More...
 
 hoursLink ( $h, $options=array())
 
 showHideLink ( $options, $message, $name, $value)
 
- Protected Member Functions inherited from ChangesListSpecialPage
 addModules ()
 Add page-specific modules. More...
 
 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...
 
- 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...
 
 getRobotPolicy ()
 Return the robot policy. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ChangesListSpecialPage
static makeLegend (IContextSource $context)
 Return the legend displayed within the fieldset. 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. 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
 

Detailed Description

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

Definition at line 30 of file SpecialWatchlist.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 31 of file SpecialWatchlist.php.

Member Function Documentation

◆ buildMainQueryConds()

SpecialWatchlist::buildMainQueryConds ( FormOptions  $opts)

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

Parameters
FormOptions$opts
Returns
array

Reimplemented from ChangesListSpecialPage.

Definition at line 160 of file SpecialWatchlist.php.

References $dbr, and getDB().

◆ countItems()

SpecialWatchlist::countItems (   $dbr)
protected

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

Parameters
DatabaseBase$dbrA database connection
Returns
Integer

Definition at line 586 of file SpecialWatchlist.php.

References $count, $dbr, array(), and SpecialPage\getUser().

Referenced by setTopText().

◆ cutoffLinks()

SpecialWatchlist::cutoffLinks (   $days,
  $options = array() 
)
protected

Returns html.

Parameters
int$daysThis gets overwritten, so is not used
array$optionsQuery parameters for URL
Returns
string

Definition at line 562 of file SpecialWatchlist.php.

References $options, array(), as, daysLink(), SpecialPage\getLanguage(), hoursLink(), and SpecialPage\msg().

Referenced by doHeader().

◆ daysLink()

SpecialWatchlist::daysLink (   $d,
  $options = array() 
)
protected

◆ doHeader()

SpecialWatchlist::doHeader (   $opts,
  $numRows 
)

◆ doMainQuery()

SpecialWatchlist::doMainQuery (   $conds,
  $opts 
)

Process the query.

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

Reimplemented from ChangesListSpecialPage.

Definition at line 180 of file SpecialWatchlist.php.

References $dbr, $tables, $user, array(), LogPage\DELETED_ACTION, LogPage\DELETED_RESTRICTED, getDB(), SpecialPage\getUser(), global, LIST_OR, ChangeTags\modifyDisplayQuery(), RC_LOG, RecentChange\selectFields(), and wfRunHooks().

◆ 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$parameters
Returns
FormOptions

Reimplemented from ChangesListSpecialPage.

Definition at line 128 of file SpecialWatchlist.php.

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

◆ getCustomFilters()

SpecialWatchlist::getCustomFilters ( )
protected

Get custom show/hide filters.

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

Reimplemented from ChangesListSpecialPage.

Definition at line 110 of file SpecialWatchlist.php.

References ChangesListSpecialPage\$customFilters, array(), and wfRunHooks().

Referenced by doHeader().

◆ getDB()

SpecialWatchlist::getDB ( )
protected

Return a DatabaseBase object for reading.

Returns
DatabaseBase

Reimplemented from ChangesListSpecialPage.

Definition at line 281 of file SpecialWatchlist.php.

References DB_SLAVE, and wfGetDB().

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

◆ getDefaultOptions()

SpecialWatchlist::getDefaultOptions ( )

Get a FormOptions object containing the default options.

Returns
FormOptions

Reimplemented from ChangesListSpecialPage.

Definition at line 87 of file SpecialWatchlist.php.

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

◆ hoursLink()

SpecialWatchlist::hoursLink (   $h,
  $options = array() 
)
protected

◆ outputChangesList()

SpecialWatchlist::outputChangesList (   $rows,
  $opts 
)

Build and output the actual changes list.

Parameters
ResultWrapper$rowsDatabase rows
FormOptions$opts

Reimplemented from ChangesListSpecialPage.

Definition at line 307 of file SpecialWatchlist.php.

References $dbr, $output, $s, $user, array(), as, SpecialPage\getContext(), getDB(), SpecialPage\getOutput(), SpecialPage\getUser(), global, ChangesList\newFromContext(), RecentChange\newFromRow(), and wfGetLB().

◆ outputFeedLinks()

SpecialWatchlist::outputFeedLinks ( )

Output feed links.

Reimplemented from ChangesListSpecialPage.

Definition at line 288 of file SpecialWatchlist.php.

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

◆ setTopText()

SpecialWatchlist::setTopText ( FormOptions  $opts)

Send the text to be displayed before the options.

Should use $this->getOutput()->addWikiText() or similar methods to print the text.

Parameters
FormOptions$opts

Reimplemented from ChangesListSpecialPage.

Definition at line 469 of file SpecialWatchlist.php.

References $dbr, $form, $user, $value, array(), as, Xml\closeElement(), countItems(), Xml\fieldset(), FormOptions\getChangedValues(), SpecialPage\getContext(), getDB(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getUser(), global, Html\hidden(), ChangesListSpecialPage\makeLegend(), SpecialPage\msg(), Xml\openElement(), Xml\submitButton(), and text.

Referenced by doHeader().

◆ showHideLink()

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

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