WantedQueryPage Class Reference
Class definition for a wanted query page like WantedPages, WantedTemplates, etc. More...
Inheritance diagram for WantedQueryPage:
Collaboration diagram for WantedQueryPage:
Public Member Functions | |
| forceExistenceCheck () | |
| Should formatResult() always check page existence, even if the results are fresh? This is a (hopefully temporary) kluge for Special:WantedFiles, which may contain false positives for files that exist e.g. More... | |
| formatResult ( $skin, $result) | |
| Format an individual result. More... | |
| isExpensive () | |
| Is this query expensive (for some definition of expensive)? Then we don't let it run in miser mode. More... | |
| isSyndicated () | |
| Sometime we don't want to build rss / atom feeds. More... | |
| preprocessResults ( $db, $res) | |
| Cache page existence for performance. More... | |
 Public Member Functions inherited from QueryPage | |
| closeList () | |
| doFeed ( $class='', $limit=50) | |
| Similar to above, but packaging in a syndicated feed instead of a web page. More... | |
| doQuery ( $offset=false, $limit=false) | |
| Somewhat deprecated, you probably want to be using execute() More... | |
| execute ( $par) | |
| This is the actual workhorse. More... | |
| feedDesc () | |
| feedItemAuthor ( $row) | |
| feedItemDesc ( $row) | |
| feedResult ( $row) | |
| Override for custom handling. More... | |
| feedTitle () | |
| feedUrl () | |
| fetchFromCache ( $limit, $offset=false) | |
| Fetch the query results from the query cache. More... | |
| getCachedTimestamp () | |
| getOrderFields () | |
| Subclasses return an array of fields to order by here. More... | |
| getPageHeader () | |
| The content returned by this function will be output before any result. More... | |
| getQueryInfo () | |
| Subclasses return an SQL query here, formatted as an array with the following keys: tables => Table(s) for passing to Database::select() fields => Field(s) for passing to Database::select(), may be * conds => WHERE conditions options => options join_conds => JOIN conditions. More... | |
| getRecacheDB () | |
| Get a DB connection to be used for slow recache queries. More... | |
| getSQL () | |
| For back-compat, subclasses may return a raw SQL query here, as a string. More... | |
| isCacheable () | |
| Is the output of this query cacheable? Non-cacheable expensive pages will be disabled in miser mode and will not have their results written to the querycache table. More... | |
| isCached () | |
| Whether or not the output of the page in question is retrieved from the database cache. More... | |
| linkParameters () | |
| If using extra form wheely-dealies, return a set of parameters here as an associative array. More... | |
| openList ( $offset) | |
| reallyDoQuery ( $limit, $offset=false) | |
| Run the query and return the result. More... | |
| recache ( $limit, $ignoreErrors=true) | |
| Clear the cache and save new results. More... | |
| setListoutput ( $bool) | |
| A mutator for $this->listoutput;. More... | |
| sortDescending () | |
| Override to sort by increasing values. More... | |
| tryLastResult () | |
| Some special pages (for example SpecialListusers) might not return the current object formatted, but return the previous one instead. More... | |
| usesTimestamps () | |
| Does this query return timestamps rather than integers in its 'value' field? If true, this class will convert 'value' to a UNIX timestamp for caching. 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... | |
| 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... | |
Private Member Functions | |
| makeWlhLink ( $title, $result) | |
| Make a "what links here" link for a given title. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from QueryPage | |
| static | getPages () |
| Get a list of query page classes and their associated special pages, for periodic updates. 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... | |
| Public Attributes inherited from QueryPage | |
| $limit = 0 | |
| bool | $listoutput = false |
| Whether or not we want plain listoutput rather than an ordered list. More... | |
| int | $offset = 0 |
| The offset and limit in use, as passed to the query() function. More... | |
| Protected Member Functions inherited from QueryPage | |
| outputResults ( $out, $skin, $dbr, $res, $num, $offset) | |
| Format and output report results using the given information plus OutputPage. 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... | |
| 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... | |
| getRobotPolicy () | |
| Return the robot policy. More... | |
| Protected Attributes inherited from QueryPage | |
| $cachedTimestamp = null | |
| $numRows | |
| The number of rows returned by the query. More... | |
| $shownavigation = true | |
| Wheter to show prev/next links. More... | |
| Protected Attributes inherited from SpecialPage | |
| IContextSource | $mContext |
| Current request context. More... | |
| $mIncludable | |
| $mIncluding | |
| $mName | |
Detailed Description
Class definition for a wanted query page like WantedPages, WantedTemplates, etc.
Definition at line 766 of file QueryPage.php.
Member Function Documentation
◆ forceExistenceCheck()
| WantedQueryPage::forceExistenceCheck | ( | ) |
Should formatResult() always check page existence, even if the results are fresh? This is a (hopefully temporary) kluge for Special:WantedFiles, which may contain false positives for files that exist e.g.
in a shared repo (bug 6220).
- Returns
- bool
Reimplemented in WantedFilesPage.
Definition at line 803 of file QueryPage.php.
Referenced by formatResult().
◆ formatResult()
| WantedQueryPage::formatResult | ( | $skin, | |
| $result | |||
| ) |
Format an individual result.
- Returns
- string
Reimplemented from QueryPage.
Reimplemented in WantedCategoriesPage.
Definition at line 814 of file QueryPage.php.
References $title, array(), forceExistenceCheck(), SpecialPage\getLanguage(), QueryPage\isCached(), Linker\link(), Title\makeTitleSafe(), makeWlhLink(), and SpecialPage\msg().
◆ isExpensive()
| WantedQueryPage::isExpensive | ( | ) |
Is this query expensive (for some definition of expensive)? Then we don't let it run in miser mode.
$wgDisableQueryPages causes all query pages to be declared expensive. Some query pages are always expensive.
- Returns
- bool
Reimplemented from QueryPage.
Definition at line 767 of file QueryPage.php.
◆ isSyndicated()
| WantedQueryPage::isSyndicated | ( | ) |
Sometime we don't want to build rss / atom feeds.
- Returns
- bool
Reimplemented from QueryPage.
Definition at line 771 of file QueryPage.php.
◆ makeWlhLink()
|
private |
Make a "what links here" link for a given title.
- Returns
- string
Definition at line 849 of file QueryPage.php.
References $title, SpecialPage\getTitleFor(), Linker\link(), and SpecialPage\msg().
Referenced by formatResult().
◆ preprocessResults()
| WantedQueryPage::preprocessResults | ( | $db, | |
| $res | |||
| ) |
Cache page existence for performance.
- Parameters
-
DatabaseBase $db ResultWrapper $res
Reimplemented from QueryPage.
Reimplemented in WantedCategoriesPage.
Definition at line 780 of file QueryPage.php.
The documentation for this class was generated from the following file:
- includes/QueryPage.php
