MediaWiki
master
|
Special page which uses a ChangesList to show query results. More...
Public Member Functions | |
__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 () | |
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... | |
![]() | |
__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... | |
doesWrites () | |
Indicates whether this special page may perform database writes. More... | |
getAssociatedNavigationLinks () | |
Return an array of strings representing page titles that are discoverable to end users via UI. More... | |
getAuthority () | |
Shortcut to get the Authority executing this instance. More... | |
getConfig () | |
Shortcut to get main config object. More... | |
getContentLanguage () | |
Shortcut to get content language. 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... | |
getShortDescription (string $path='') | |
Similar to getDescription but takes into account sub pages and designed for display in tabs. 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,... $params) | |
Wrapper around wfMessage that sets the current context. 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... | |
requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin') | |
If the user is not logged in or is a temporary user, throws UserNotLoggedIn. More... | |
run ( $subPage) | |
Entry point. More... | |
setContentLanguage (Language $contentLanguage) | |
Set content language. More... | |
setContext ( $context) | |
Sets the context this SpecialPage is executed in. More... | |
setHookContainer (HookContainer $hookContainer) | |
setLinkRenderer (LinkRenderer $linkRenderer) | |
setListed ( $listed) | |
Set whether this page is listed in Special:Specialpages, at run-time. More... | |
setSpecialPageFactory (SpecialPageFactory $specialPageFactory) | |
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 (UserIdentity $user) |
Static method to check whether StructuredFilter UI is enabled for the given user. More... | |
static | getRcFiltersConfigSummary (RL\Context $context) |
Get essential data about getRcFiltersConfigVars() for change detection. More... | |
static | getRcFiltersConfigVars (RL\Context $context) |
Get config vars to export with the mediawiki.rcfilters.filters.ui module. More... | |
![]() | |
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... | |
static | newSearchPage (User $user) |
Get the users preferred search page. More... | |
Protected Member Functions | |
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... | |
getCollapsedPreferenceName () | |
Preference name for collapsing the active filter display. More... | |
getDB () | |
Return a IDatabase object for reading. More... | |
getDefaultDaysPreferenceName () | |
Preference name for 'days'. More... | |
getFilterGroups () | |
Gets the currently registered filters groups. 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... | |
getLegacyShowHideFilters () | |
getLimitPreferenceName () | |
Getting the preference name for 'limit'. More... | |
getLinkDays () | |
getSavedQueriesPreferenceName () | |
Preference name for saved queries. More... | |
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... | |
![]() | |
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... | |
displayRestrictionError () | |
Output an error message telling the user what access level they have to have. More... | |
getAuthManager () | |
getCacheTTL () | |
getHookContainer () | |
getHookRunner () | |
getLanguageConverter () | |
Shortcut to get language's converter. 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... | |
getSpecialPageFactory () | |
getSubpagesForPrefixSearch () | |
Return an array of subpages that this special page will accept for prefix searches. 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... | |
prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null) | |
Perform a regular substring search for prefixSearchSubpages. More... | |
setAuthManager (AuthManager $authManager) | |
Set the injected AuthManager from the special page constructor. More... | |
setHeaders () | |
Sets headers - this should be called from the execute() method of all derived classes! More... | |
setReauthPostData (array $data) | |
Record preserved POST data after a reauthentication. More... | |
useTransactionalTimeLimit () | |
Call wfTransactionalTimeLimit() if this request was POSTed. More... | |
Protected Attributes | |
ChangesListFilterGroup[] | $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 |
![]() | |
IContextSource | $mContext |
Current request context. More... | |
bool | $mIncludable |
Whether the special page can be included in an article. More... | |
bool | $mIncluding |
Whether or not this special page is being included from an article. More... | |
string | $mName |
The canonical name of this special page Also used for the default. More... | |
string | $mRestriction |
Minimum user level required to access this page, or "" for anyone. More... | |
Additional Inherited Members | |
![]() | |
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... | |
Special page which uses a ChangesList to show query results.
Definition at line 38 of file ChangesListSpecialPage.php.
ChangesListSpecialPage::__construct | ( | $name, | |
$restriction | |||
) |
Definition at line 84 of file ChangesListSpecialPage.php.
References $dbr, $s, SpecialPage\getHookRunner(), LIST_OR, ChangesListStringOptionsFilterGroup\NONE, RecentChange\PRC_AUTOPATROLLED, RecentChange\PRC_PATROLLED, RecentChange\PRC_UNPATROLLED, RC_CATEGORIZE, RC_EDIT, RC_LOG, RC_NEW, RecentChange\SRC_CATEGORIZE, RecentChange\SRC_EDIT, RecentChange\SRC_LOG, and RecentChange\SRC_NEW.
|
protected |
Add page-specific modules.
Definition at line 1722 of file ChangesListSpecialPage.php.
References SpecialPage\getOutput(), SpecialPage\including(), and isStructuredFilterUiEnabled().
Referenced by execute().
|
protected |
Check if filters are in conflict and guaranteed to return no results.
Definition at line 584 of file ChangesListSpecialPage.php.
References getFilterGroups(), getOptions(), and wfLogWarning().
Referenced by SpecialWatchlist\doMainQuery().
|
protected |
Sets appropriate tables, fields, conditions, etc.
depending on which filters the user requested.
array | &$tables | Array of tables; see IDatabase::select $table |
array | &$fields | Array of fields; see IDatabase::select $vars |
array | &$conds | Array of conditions; see IDatabase::select $conds |
array | &$query_options | Array of query options; see IDatabase::select $options |
array | &$join_conds | Array of join conditions; see IDatabase::select $join_conds |
FormOptions | $opts |
Definition at line 1430 of file ChangesListSpecialPage.php.
References $dbr, getDB(), isStructuredFilterUiEnabled(), FormOptions\reset(), and wfTimestamp().
Referenced by getRows().
|
static |
Static method to check whether StructuredFilter UI is enabled for the given user.
UserIdentity | $user |
Reimplemented in SpecialWatchlist.
Definition at line 1886 of file ChangesListSpecialPage.php.
|
protected |
Check whether or not the page should load defaults, and if so, whether a default saved query is relevant to be redirected to.
If it is relevant, redirect properly with all necessary query parameters.
string | $subpage |
Definition at line 701 of file ChangesListSpecialPage.php.
References FormatJson\decode(), getOptions(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), getSavedQueriesPreferenceName(), SpecialPage\getUser(), SpecialPage\including(), and isStructuredFilterUiEnabled().
Referenced by execute().
|
protected |
Convert parameters values from true/false to 1/0 so they are not omitted by wfArrayToCgi() T38524.
array | $params |
Definition at line 1409 of file ChangesListSpecialPage.php.
Referenced by validateOptions().
ChangesListSpecialPage::doHeader | ( | $opts, | |
$numRows | |||
) |
Set the text to be displayed above the changes.
FormOptions | $opts | |
int | $numRows | Number of rows in the result to show after this header |
Reimplemented in SpecialWatchlist, and SpecialRecentChanges.
Definition at line 1595 of file ChangesListSpecialPage.php.
References setBottomText(), and setTopText().
|
protected |
Process the query.
array | $tables | Array of tables; see IDatabase::select $table |
array | $fields | Array of fields; see IDatabase::select $vars |
array | $conds | Array of conditions; see IDatabase::select $conds |
array | $query_options | Array of query options; see IDatabase::select $options |
array | $join_conds | Array of join conditions; see IDatabase::select $join_conds |
FormOptions | $opts |
Reimplemented in SpecialRecentChangesLinked, SpecialWatchlist, and SpecialRecentChanges.
Definition at line 1500 of file ChangesListSpecialPage.php.
References $dbr, getDB(), RecentChange\getQueryInfo(), ChangeTags\modifyDisplayQuery(), and runMainQueryHook().
Referenced by getRows().
ChangesListSpecialPage::execute | ( | $subpage | ) |
string | null | $subpage |
Reimplemented from SpecialPage.
Reimplemented in SpecialWatchlist, and SpecialRecentChanges.
Definition at line 620 of file ChangesListSpecialPage.php.
References $title, addModules(), considerActionsForDefaultSavedQuery(), SpecialPage\getConfig(), getOptions(), SpecialPage\getOutput(), SpecialPage\getRequest(), getRows(), SpecialPage\getUser(), includeRcFiltersApp(), MWExceptionHandler\logException(), LogFormatter\newFromRow(), NS_USER, NS_USER_TALK, SpecialPage\outputHeader(), outputTimeout(), SpecialPage\setHeaders(), RecentChange\SRC_LOG, and webOutput().
|
protected |
Fetch values for a FormOptions object from the WebRequest associated with this instance.
Intended for subclassing, e.g. to add a backwards-compatibility layer.
FormOptions | $opts |
Reimplemented in SpecialWatchlist.
Definition at line 1227 of file ChangesListSpecialPage.php.
References SpecialPage\getRequest().
Referenced by setup().
ChangesListSpecialPage::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.
string | $specialPageClassName | Class name of current special page |
IContextSource | $context | Context, for e.g. user |
IDatabase | $dbr | Database, for addQuotes, makeList, and similar |
array | &$tables | Array of tables; see IDatabase::select $table |
array | &$fields | Array of fields; see IDatabase::select $vars |
array | &$conds | Array of conditions; see IDatabase::select $conds |
array | &$query_options | Array of query options; see IDatabase::select $options |
array | &$join_conds | Array of join conditions; see IDatabase::select $join_conds |
array | $selectedExpLevels | The allowed active values, sorted |
int | $now | Number of seconds since the UNIX epoch, or 0 if not given (optional) |
Definition at line 1758 of file ChangesListSpecialPage.php.
References $dbr, SpecialPage\getConfig(), LIST_AND, and LIST_OR.
|
abstractprotected |
Preference name for collapsing the active filter display.
Reimplemented in SpecialWatchlist, and SpecialRecentChanges.
Referenced by includeRcFiltersApp().
|
protected |
Return a IDatabase object for reading.
Reimplemented in SpecialWatchlist, and SpecialRecentChanges.
Definition at line 1548 of file ChangesListSpecialPage.php.
References DB_REPLICA, and wfGetDB().
Referenced by buildQuery(), and doMainQuery().
ChangesListSpecialPage::getDefaultDays | ( | ) |
Get the default value of the number of days to display when loading the result set.
Supports fractional values, and should be cast to a float.
Definition at line 1913 of file ChangesListSpecialPage.php.
References getDefaultDaysPreferenceName(), and SpecialPage\getUser().
Referenced by getDefaultOptions(), and includeRcFiltersApp().
|
abstractprotected |
Preference name for 'days'.
Reimplemented in SpecialWatchlist, and SpecialRecentChanges.
Referenced by getDefaultDays(), and includeRcFiltersApp().
ChangesListSpecialPage::getDefaultLimit | ( | ) |
Get the default value of the number of changes to display when loading the result set.
Reimplemented in SpecialRecentChanges.
Definition at line 1899 of file ChangesListSpecialPage.php.
References getLimitPreferenceName(), and SpecialPage\getUser().
Referenced by getDefaultOptions(), and includeRcFiltersApp().
ChangesListSpecialPage::getDefaultOptions | ( | ) |
Get a FormOptions object containing the default options.
By default, returns some basic options. The filters listed explicitly here are overridden in this method, in subclasses, but most filters (e.g. hideminor, userExpLevel filters, and more) are structured. Structured filters are overridden in registerFilters. not here.
Reimplemented in SpecialRecentChangesLinked.
Definition at line 1122 of file ChangesListSpecialPage.php.
References FormOptions\FLOAT, getDefaultDays(), getDefaultLimit(), SpecialPage\getRequest(), FormOptions\INT, isStructuredFilterUiEnabled(), and FormOptions\STRING.
Referenced by setup().
ChangesListSpecialPage::getExtraOptions | ( | $opts | ) |
Get options to be displayed in a form.
FormOptions | $opts |
Reimplemented in SpecialRecentChangesLinked, and SpecialRecentChanges.
Definition at line 1634 of file ChangesListSpecialPage.php.
ChangesListSpecialPage::getFilterGroup | ( | $groupName | ) |
Gets a specified ChangesListFilterGroup by name.
string | $groupName | Name of group |
Definition at line 1176 of file ChangesListSpecialPage.php.
Referenced by registerFilters(), SpecialWatchlist\registerFilters(), and replaceOldOptions().
|
protected |
Gets the currently registered filters groups.
Definition at line 1165 of file ChangesListSpecialPage.php.
References $filterGroups.
Referenced by areFiltersInConflict().
|
protected |
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.
Reimplemented from SpecialPage.
Definition at line 1738 of file ChangesListSpecialPage.php.
|
protected |
Definition at line 1074 of file ChangesListSpecialPage.php.
Referenced by SpecialWatchlist\fetchOptionsFromRequest().
|
abstractprotected |
Getting the preference name for 'limit'.
Reimplemented in SpecialWatchlist, and SpecialRecentChanges.
Referenced by getDefaultLimit(), and includeRcFiltersApp().
|
protected |
Definition at line 771 of file ChangesListSpecialPage.php.
References SpecialPage\getConfig().
Referenced by includeRcFiltersApp().
ChangesListSpecialPage::getOptions | ( | ) |
Get the current FormOptions for this request.
Definition at line 936 of file ChangesListSpecialPage.php.
References $rcOptions, and setup().
Referenced by areFiltersInConflict(), considerActionsForDefaultSavedQuery(), execute(), SpecialWatchlist\execute(), and getRows().
|
static |
Get essential data about getRcFiltersConfigVars() for change detection.
RL\\Context | $context |
Definition at line 861 of file ChangesListSpecialPage.php.
References $lang, ChangeTags\getChangeTagListSummary(), and SpecialPage\getTitleFor().
|
static |
Get config vars to export with the mediawiki.rcfilters.filters.ui module.
RL\\Context | $context |
Definition at line 879 of file ChangesListSpecialPage.php.
References $lang, ChangeTags\getChangeTagList(), and SpecialPage\getTitleFor().
ChangesListSpecialPage::getRows | ( | ) |
Get the database result for this special page instance.
Used by ApiFeedRecentChanges.
Definition at line 918 of file ChangesListSpecialPage.php.
References buildQuery(), doMainQuery(), and getOptions().
Referenced by execute().
|
abstractprotected |
Preference name for saved queries.
Reimplemented in SpecialWatchlist, and SpecialRecentChanges.
Referenced by considerActionsForDefaultSavedQuery(), and includeRcFiltersApp().
ChangesListSpecialPage::getStructuredFilterJsData | ( | ) |
Gets structured filter information needed by JS.
Definition at line 1193 of file ChangesListSpecialPage.php.
References ChangesListFilterGroup\getPriority().
Referenced by includeRcFiltersApp().
|
protected |
Include the modules and configuration for the RCFilters app.
Conditional on the user having the feature enabled.
If it is disabled, add a <body> class marking that
Definition at line 799 of file ChangesListSpecialPage.php.
References getCollapsedPreferenceName(), SpecialPage\getConfig(), getDefaultDays(), getDefaultDaysPreferenceName(), getDefaultLimit(), getLimitPreferenceName(), getLinkDays(), SpecialPage\getOutput(), getSavedQueriesPreferenceName(), getStructuredFilterJsData(), SpecialPage\getUser(), SpecialPage\including(), isStructuredFilterUiEnabled(), and SpecialPage\msg().
Referenced by execute().
ChangesListSpecialPage::isStructuredFilterUiEnabled | ( | ) |
Check whether the structured filter UI is enabled.
Definition at line 1871 of file ChangesListSpecialPage.php.
References SpecialPage\getRequest(), and SpecialPage\getUser().
Referenced by addModules(), buildQuery(), considerActionsForDefaultSavedQuery(), SpecialWatchlist\execute(), getDefaultOptions(), includeRcFiltersApp(), makeLegend(), SpecialWatchlist\outputChangesList(), SpecialWatchlist\registerFilters(), and replaceOldOptions().
ChangesListSpecialPage::makeLegend | ( | ) |
Return the legend displayed within the fieldset.
Definition at line 1643 of file ChangesListSpecialPage.php.
References Html\closeElement(), Html\element(), Sanitizer\escapeClass(), SpecialPage\getContext(), SpecialPage\getRequest(), isStructuredFilterUiEnabled(), Html\openElement(), and Html\rawElement().
Referenced by SpecialWatchlist\outputChangesList().
|
abstract |
Build and output the actual changes list.
IResultWrapper | $rows | Database rows |
FormOptions | $opts |
Reimplemented in SpecialWatchlist, and SpecialRecentChanges.
Referenced by webOutput().
ChangesListSpecialPage::outputFeedLinks | ( | ) |
Reimplemented in SpecialWatchlist, and SpecialRecentChanges.
Definition at line 1577 of file ChangesListSpecialPage.php.
|
protected |
Add the "no results" message to the output.
Reimplemented in SpecialRecentChangesLinked.
Definition at line 892 of file ChangesListSpecialPage.php.
References SpecialPage\getOutput(), SpecialPage\msg(), and Html\rawElement().
|
protected |
Add the "timeout" message to the output.
Definition at line 905 of file ChangesListSpecialPage.php.
References SpecialPage\getOutput(), and SpecialPage\msg().
Referenced by execute().
ChangesListSpecialPage::parseParameters | ( | $par, | |
FormOptions | $opts | ||
) |
Process $par and put options found in $opts.
Used when including the page.
string | $par | |
FormOptions | $opts |
Reimplemented in SpecialRecentChangesLinked, and SpecialRecentChanges.
Definition at line 1239 of file ChangesListSpecialPage.php.
Referenced by setup().
ChangesListSpecialPage::registerFilterGroup | ( | ChangesListFilterGroup | $group | ) |
Register a structured changes list filter group.
ChangesListFilterGroup | $group |
Definition at line 1154 of file ChangesListSpecialPage.php.
References ChangesListFilterGroup\getName().
Referenced by SpecialWatchlist\registerFilters(), and registerFiltersFromDefinitions().
|
protected |
Register all filters and their groups (including those from hooks), plus handle conflicts and defaults.
You might want to customize these in the same method, in subclasses. You can call getFilterGroup to access a group, and (on the group) getFilter to access a filter, then make necessary modfications to the filter or group (e.g. with setDefault).
Reimplemented in SpecialWatchlist, and SpecialRecentChanges.
Definition at line 953 of file ChangesListSpecialPage.php.
References SpecialPage\getConfig(), getFilterGroup(), SpecialPage\getHookRunner(), SpecialPage\getUser(), SpecialPage\including(), registerFiltersFromDefinitions(), and transformFilterDefinition().
Referenced by setup().
|
protected |
Register filters from a definition object.
Array specifying groups and their filters; see Filter and ChangesListFilterGroup constructors.
There is light processing to simplify core maintenance.
array | $definition |
Definition at line 1048 of file ChangesListSpecialPage.php.
References registerFilterGroup(), and transformFilterDefinition().
Referenced by registerFilters().
ChangesListSpecialPage::replaceOldOptions | ( | FormOptions | $opts | ) |
Replace old options with their structured UI equivalents.
FormOptions | $opts |
Definition at line 1360 of file ChangesListSpecialPage.php.
References getFilterGroup(), isStructuredFilterUiEnabled(), FormOptions\reset(), and ChangesListStringOptionsFilterGroup\SEPARATOR.
Referenced by validateOptions().
|
protected |
Definition at line 1536 of file ChangesListSpecialPage.php.
References SpecialPage\getHookRunner(), and SpecialPage\getName().
Referenced by doMainQuery(), SpecialWatchlist\doMainQuery(), and SpecialRecentChangesLinked\doMainQuery().
ChangesListSpecialPage::setBottomText | ( | FormOptions | $opts | ) |
Send the text to be displayed after the options.
Should use $this->getOutput()->addWikiTextAsInterface() or similar methods to print the text.
FormOptions | $opts |
Definition at line 1621 of file ChangesListSpecialPage.php.
Referenced by doHeader().
ChangesListSpecialPage::setTopText | ( | FormOptions | $opts | ) |
Send the text to be displayed before the options.
Should use $this->getOutput()->addWikiTextAsInterface() or similar methods to print the text.
FormOptions | $opts |
Reimplemented in SpecialWatchlist, SpecialRecentChangesLinked, and SpecialRecentChanges.
Definition at line 1610 of file ChangesListSpecialPage.php.
Referenced by doHeader().
ChangesListSpecialPage::setup | ( | $parameters | ) |
Register all the filters, including legacy hook-driven ones.
Then create a FormOptions object with options as specified by the user
string | $parameters |
Definition at line 1096 of file ChangesListSpecialPage.php.
References fetchOptionsFromRequest(), getDefaultOptions(), parseParameters(), registerFilters(), and validateOptions().
Referenced by getOptions().
|
protected |
Transforms filter definition to prepare it for constructor.
See overrides of this method as well.
array | $filterDefinition | Original filter definition |
Reimplemented in SpecialWatchlist, and SpecialRecentChanges.
Definition at line 1034 of file ChangesListSpecialPage.php.
Referenced by registerFilters(), and registerFiltersFromDefinitions().
ChangesListSpecialPage::validateOptions | ( | FormOptions | $opts | ) |
Validate a FormOptions object generated by getDefaultOptions() with values already populated.
FormOptions | $opts |
Definition at line 1278 of file ChangesListSpecialPage.php.
References convertParamsForLink(), FormOptions\getChangedValues(), SpecialPage\getConfig(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), replaceOldOptions(), FormOptions\validateBounds(), FormOptions\validateIntBounds(), and wfArrayToCgi().
Referenced by setup().
ChangesListSpecialPage::webOutput | ( | $rows, | |
$opts | |||
) |
Send output to the OutputPage object, only called if not used feeds.
IResultWrapper | $rows | Database rows |
FormOptions | $opts |
Definition at line 1571 of file ChangesListSpecialPage.php.
References outputChangesList().
Referenced by execute().
|
protected |
Filter groups, and their contained filters This is an associative array (with group name as key) of ChangesListFilterGroup objects.
Definition at line 82 of file ChangesListSpecialPage.php.
Referenced by getFilterGroups().
|
protected |
Definition at line 44 of file ChangesListSpecialPage.php.
Referenced by getOptions().
|
protected |
Definition at line 41 of file ChangesListSpecialPage.php.