[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

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

(no description)

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

Defines 3 classes

SpecialEditWatchlist:: (23 methods):
  __construct()
  execute()
  outputSubtitle()
  executeViewEditWatchlist()
  prefixSearchSubpages()
  extractTitles()
  submitRaw()
  submitClear()
  showTitles()
  getWatchlist()
  getWatchlistInfo()
  checkTitle()
  cleanupWatchlist()
  clearWatchlist()
  watchTitles()
  unwatchTitles()
  submitNormal()
  getNormalForm()
  buildRemoveLine()
  getRawForm()
  getClearForm()
  getMode()
  buildTools()

EditWatchlistNormalHTMLForm:: (2 methods):
  getLegend()
  getBody()

EditWatchlistCheckboxSeriesField:: (1 method):
  validate()


Class: SpecialEditWatchlist  - X-Ref

Provides the UI through which users can perform editing
operations on their watchlist

__construct()   X-Ref
No description

execute( $mode )   X-Ref
Main execution point

param: int $mode

outputSubtitle()   X-Ref
Renders a subheader on the watchlist page.


executeViewEditWatchlist()   X-Ref
Executes an edit mode for the watchlist view, from which you can manage your watchlist


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

extractTitles( $list )   X-Ref
Extract a list of titles from a blob of text, returning
(prefixed) strings; unwatchable titles are ignored

param: string $list
return: array

submitRaw( $data )   X-Ref
No description

submitClear( $data )   X-Ref
No description

showTitles( $titles, &$output )   X-Ref
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

param: array $titles Array of strings, or Title objects
param: string $output

getWatchlist()   X-Ref
Prepare a list of titles on a user's watchlist (excluding talk pages)
and return an array of (prefixed) strings

return: array

getWatchlistInfo()   X-Ref
Get a list of titles on a user's watchlist, excluding talk pages,
and return as a two-dimensional array with namespace and title.

return: array

checkTitle( $title, $namespace, $dbKey )   X-Ref
Validates watchlist entry

param: Title $title
param: int $namespace
param: string $dbKey
return: bool Whether this item is valid

cleanupWatchlist()   X-Ref
Attempts to clean up broken items


clearWatchlist()   X-Ref
Remove all titles from a user's watchlist


watchTitles( $titles )   X-Ref
Add a list of titles to a user's watchlist

$titles can be an array of strings or Title objects; the former
is preferred, since Titles are very memory-heavy

param: array $titles Array of strings, or Title objects

unwatchTitles( $titles )   X-Ref
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

param: array $titles Array of strings, or Title objects

submitNormal( $data )   X-Ref
No description

getNormalForm()   X-Ref
Get the standard watchlist editing form

return: HTMLForm

buildRemoveLine( $title )   X-Ref
Build the label for a checkbox, with a link to the title, and various additional bits

param: Title $title
return: string

getRawForm()   X-Ref
Get a form for editing the watchlist in "raw" mode

return: HTMLForm

getClearForm()   X-Ref
Get a form for clearing the watchlist

return: HTMLForm

getMode( $request, $par )   X-Ref
Determine whether we are editing the watchlist, and if so, what
kind of editing operation

param: WebRequest $request
param: string $par
return: int

buildTools( $unused )   X-Ref
Build a set of links for convenient navigation
between watchlist viewing and editing modes

param: null $unused
return: string

Class: EditWatchlistNormalHTMLForm  - X-Ref

Extend HTMLForm purely so we can have a more sane way of getting the section headers

getLegend( $namespace )   X-Ref
No description

getBody()   X-Ref
No description

Class: EditWatchlistCheckboxSeriesField  - X-Ref

validate( $value, $alldata )   X-Ref
HTMLMultiSelectField throws validation errors if we get input data
that doesn't match the data set in the form setup. This causes
problems if something gets removed from the watchlist while the
form is open (bug 32126), but we know that invalid items will
be harmless so we can override it here.

param: string $value The value the field was submitted with
param: array $alldata The data collected from the form
return: bool|string Bool true on success, or String error to display.



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