[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/specials/ -> SpecialWatchlist.php (summary)

Implements Special:Watchlist This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size: 616 lines (17 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

SpecialWatchlist:: (19 methods):
  __construct()
  execute()
  prefixSearchSubpages()
  getDefaultOptions()
  getCustomFilters()
  fetchOptionsFromRequest()
  buildMainQueryConds()
  doMainQuery()
  runMainQueryHook()
  getDB()
  outputFeedLinks()
  outputChangesList()
  doHeader()
  setTopText()
  showHideLink()
  hoursLink()
  daysLink()
  cutoffLinks()
  countItems()


Class: SpecialWatchlist  - X-Ref

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

__construct( $page = 'Watchlist', $restriction = 'viewmywatchlist' )   X-Ref
No description

execute( $subpage )   X-Ref
Main execution point

param: string $subpage

prefixSearchSubpages( $search, $limit = 10 )   X-Ref
Return an array of subpages beginning with $search that this special page will accept.

param: string $search Prefix to search for
param: int $limit Maximum number of results to return
return: string[] Matching subpages

getDefaultOptions()   X-Ref
Get a FormOptions object containing the default options

return: FormOptions

getCustomFilters()   X-Ref
Get custom show/hide filters

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

fetchOptionsFromRequest( $opts )   X-Ref
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.

param: FormOptions $opts
return: FormOptions

buildMainQueryConds( FormOptions $opts )   X-Ref
Return an array of conditions depending of options set in $opts

param: FormOptions $opts
return: array

doMainQuery( $conds, $opts )   X-Ref
Process the query

param: array $conds
param: FormOptions $opts
return: bool|ResultWrapper Result or false (for Recentchangeslinked only)

runMainQueryHook( &$tables, &$fields, &$conds, &$query_options, &$join_conds, $opts )   X-Ref
No description

getDB()   X-Ref
Return a DatabaseBase object for reading

return: DatabaseBase

outputFeedLinks()   X-Ref
Output feed links.


outputChangesList( $rows, $opts )   X-Ref
Build and output the actual changes list.

param: ResultWrapper $rows Database rows
param: FormOptions $opts

doHeader( $opts, $numRows )   X-Ref
Set the text to be displayed above the changes

param: FormOptions $opts
param: int $numRows Number of rows in the result to show after this header

setTopText( FormOptions $opts )   X-Ref
No description

showHideLink( $options, $message, $name, $value )   X-Ref
No description

hoursLink( $h, $options = array()   X-Ref
No description

daysLink( $d, $options = array()   X-Ref
No description

cutoffLinks( $days, $options = array()   X-Ref
Returns html

param: int $days This gets overwritten, so is not used
param: array $options Query parameters for URL
return: string

countItems( $dbr )   X-Ref
Count the number of items on a user's watchlist

param: DatabaseBase $dbr A database connection
return: int



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1