[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/specialpage/ -> ChangesListSpecialPage.php (summary)

Special page which uses a ChangesList to show query results. 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: 468 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 22 functions

  execute()
  getRows()
  getOptions()
  setup()
  getDefaultOptions()
  getCustomFilters()
  fetchOptionsFromRequest()
  parseParameters()
  validateOptions()
  buildMainQueryConds()
  doMainQuery()
  runMainQueryHook()
  getDB()
  webOutput()
  outputFeedLinks()
  doHeader()
  setTopText()
  setBottomText()
  getExtraOptions()
  makeLegend()
  addModules()
  getGroupName()

Functions
Functions that are not part of a class:

execute( $subpage )   X-Ref
Main execution point

param: string $subpage

getRows()   X-Ref
Get the database result for this special page instance. Used by ApiFeedRecentChanges.

return: bool|ResultWrapper Result or false

getOptions()   X-Ref
Get the current FormOptions for this request

return: FormOptions

setup( $parameters )   X-Ref
Create a FormOptions object with options as specified by the user

param: array $parameters
return: FormOptions

getDefaultOptions()   X-Ref
Get a FormOptions object containing the default options. By default returns some basic options,
you might want to not call parent method and discard them, or to override default values.

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.

Intended for subclassing, e.g. to add a backwards-compatibility layer.

param: FormOptions $opts
return: FormOptions

parseParameters( $par, FormOptions $opts )   X-Ref
Process $par and put options found in $opts. Used when including the page.

param: string $par
param: FormOptions $opts

validateOptions( FormOptions $opts )   X-Ref
Validate a FormOptions object generated by getDefaultOptions() with values already populated.

param: FormOptions $opts

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

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

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

return: DatabaseBase

webOutput( $rows, $opts )   X-Ref
Send output to the OutputPage object, only called if not used feeds

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

outputFeedLinks()   X-Ref
Output feed links.


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
Send the text to be displayed before the options. Should use $this->getOutput()->addWikiText()
or similar methods to print the text.

param: FormOptions $opts

setBottomText( FormOptions $opts )   X-Ref
Send the text to be displayed after the options. Should use $this->getOutput()->addWikiText()
or similar methods to print the text.

param: FormOptions $opts

getExtraOptions( $opts )   X-Ref
Get options to be displayed in a form

param: FormOptions $opts
return: array

makeLegend( IContextSource $context )   X-Ref
Return the legend displayed within the fieldset

param: IContextSource $context The object available as $this in non-static functions
return: string

addModules()   X-Ref
Add page-specific modules.


getGroupName()   X-Ref
No description



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