MediaWiki  master
QueryPage Class Reference

This is a class for doing query pages; since they're almost all the same, we factor out some of the functionality into a superclass, and let subclasses derive from it. More...

Inheritance diagram for QueryPage:
Collaboration diagram for QueryPage:

Public Member Functions

 delete (LinkTarget $title)
 Remove a cached result. More...
 
 doQuery ( $offset=false, $limit=false)
 Somewhat deprecated, you probably want to be using execute() More...
 
 execute ( $par)
 This is the actual workhorse. More...
 
 fetchFromCache ( $limit, $offset=false)
 Fetch the query results from the query cache Stable to override. More...
 
 getCachedTimestamp ()
 
 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...
 
 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...
 
 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...
 
 reallyDoQuery ( $limit, $offset=false)
 Run the query and return the result Stable to override. More...
 
 recache ( $limit, $ignoreErrors=true)
 Clear the cache and save new results. 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='', $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...
 
 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 Stable to override. 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...
 
 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}} Stable to override. More...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages Stable to override. 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...
 
 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 getDisabledQueryPages (Config $config)
 Get a list of query pages disabled and with it's run mode. More...
 
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 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...
 

Protected Member Functions

 closeList ()
 
 executeLBFromResultWrapper (IResultWrapper $res, $ns=null)
 Creates a new LinkBatch object, adds all pages from the passed result wrapper (MUST include title and optional the namespace field) and executes the batch. More...
 
 formatResult ( $skin, $result)
 Formats the results of the query for display. More...
 
 getCacheOrderFields ()
 Return the order fields for fetchFromCache. More...
 
 getDBLimit ( $uiLimit, $uiOffset)
 What is limit to fetch from DB. More...
 
 getDBLoadBalancer ()
 
 getLimitOffset ()
 Returns limit and offset, as returned by $this->getRequest()->getLimitOffsetForUser(). More...
 
 getLinkBatchFactory ()
 
 getMaxResults ()
 Get max number of results we can return in miser mode. More...
 
 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...
 
 getRecacheDB ()
 Get a DB connection to be used for slow recache queries Stable to override. More...
 
 getSQL ()
 For back-compat, subclasses may return a raw SQL query here, as a string. More...
 
 linkParameters ()
 If using extra form wheely-dealies, return a set of parameters here as an associative array. More...
 
 openList ( $offset)
 
 outputResults ( $out, $skin, $dbr, $res, $num, $offset)
 Format and output report results using the given information plus OutputPage. More...
 
 preprocessResults ( $db, $res)
 Do any necessary preprocessing of the result object. More...
 
 setDBLoadBalancer (ILoadBalancer $loadBalancer)
 
 setLinkBatchFactory (LinkBatchFactory $linkBatchFactory)
 
 setListoutput ( $bool)
 A mutator for $this->listoutput;. More...
 
 showEmptyText ()
 Outputs some kind of an informative message (via OutputPage) to let the user know that the query returned nothing and thus there's nothing to show. More...
 
 sortDescending ()
 Override to sort by increasing values. 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...
 
 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 Stable to override. More...
 
 getAuthManager ()
 
 getCacheTTL ()
 Stable to override. 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...
 
 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! Stable to override. More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Protected Attributes

string null $cachedTimestamp = null
 
int $limit = 0
 
bool $listoutput = false
 Whether or not we want plain listoutput rather than an ordered list. More...
 
int $numRows
 The number of rows returned by the query. More...
 
int $offset = 0
 The offset and limit in use, as passed to the query() function. More...
 
bool $shownavigation = true
 Whether to show prev/next links. More...
 
- Protected Attributes inherited from SpecialPage
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...
 

Private Attributes

LinkBatchFactory null $linkBatchFactory = null
 
ILoadBalancer null $loadBalancer = null
 

Additional Inherited Members

- Static Protected Member Functions inherited from SpecialPage
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...
 

Detailed Description

This is a class for doing query pages; since they're almost all the same, we factor out some of the functionality into a superclass, and let subclasses derive from it.

Stable to extend

Definition at line 41 of file QueryPage.php.

Member Function Documentation

◆ closeList()

QueryPage::closeList ( )
protected
Returns
string

Definition at line 830 of file QueryPage.php.

Referenced by outputResults(), and SpecialFileDuplicateSearch\showList().

◆ delete()

QueryPage::delete ( LinkTarget  $title)

Remove a cached result.

Useful for interactive backlogs where the user can fix problems in-place.

Parameters
LinkTarget$titleThe page to remove.
Since
1.34

Definition at line 455 of file QueryPage.php.

References $title, DB_MASTER, getDBLoadBalancer(), SpecialPage\getName(), and isCached().

◆ doQuery()

QueryPage::doQuery (   $offset = false,
  $limit = false 
)

Somewhat deprecated, you probably want to be using execute()

Parameters
int | bool$offset
int | bool$limit
Returns
IResultWrapper

Definition at line 525 of file QueryPage.php.

References $offset, fetchFromCache(), isCacheable(), isCached(), and reallyDoQuery().

◆ execute()

◆ executeLBFromResultWrapper()

QueryPage::executeLBFromResultWrapper ( IResultWrapper  $res,
  $ns = null 
)
protected

Creates a new LinkBatch object, adds all pages from the passed result wrapper (MUST include title and optional the namespace field) and executes the batch.

This operation will pre-cache LinkCache information like page existence and information for stub color and redirect hints.

Note
Call self::setLinkBatchFactory from special page constructor when use
Parameters
IResultWrapper$resThe result wrapper to process. Needs to include the title field and namespace field, if the $ns parameter isn't set.
null$nsUse this namespace for the given titles in the result wrapper, instead of the namespace value of $res.

Definition at line 855 of file QueryPage.php.

References $res, and getLinkBatchFactory().

Referenced by PageQueryPage\preprocessResults(), WantedQueryPage\preprocessResults(), SpecialAncientPages\preprocessResults(), SpecialBrokenRedirects\preprocessResults(), SpecialFewestRevisions\preprocessResults(), SpecialLinkSearch\preprocessResults(), SpecialListDuplicatedFiles\preprocessResults(), SpecialMIMESearch\preprocessResults(), SpecialMostCategories\preprocessResults(), SpecialMostInterwikis\preprocessResults(), SpecialMostLinked\preprocessResults(), SpecialMostLinkedCategories\preprocessResults(), SpecialMostLinkedTemplates\preprocessResults(), SpecialShortPages\preprocessResults(), SpecialUnusedCategories\preprocessResults(), SpecialUnusedTemplates\preprocessResults(), and SpecialMediaStatistics\preprocessResults().

◆ fetchFromCache()

QueryPage::fetchFromCache (   $limit,
  $offset = false 
)

Fetch the query results from the query cache Stable to override.

Parameters
int | bool$limitNumerical limit or false for no limit
int | bool$offsetNumerical offset or false for no offset
Returns
IResultWrapper
Since
1.18

Definition at line 542 of file QueryPage.php.

References $dbr, $limit, $offset, DB_REPLICA, getCacheOrderFields(), getDBLoadBalancer(), SpecialPage\getName(), and sortDescending().

Referenced by doQuery(), and execute().

◆ formatResult()

QueryPage::formatResult (   $skin,
  $result 
)
abstractprotected

Formats the results of the query for display.

The skin is the current skin; you can use it for making links. The result is a single row of result data. You should be able to grab SQL results from it. If the function returns false, the line output will be skipped.

Parameters
Skin$skin
stdClass$resultResult row
Returns
string|bool String or false to skip

Reimplemented in PageQueryPage, SpecialWantedCategories, SpecialUnwatchedPages, SpecialUnusedTemplates, SpecialUnusedCategories, SpecialUncategorizedCategories, SpecialShortPages, SpecialPagesWithProp, SpecialMostLinkedTemplates, SpecialMostLinkedCategories, SpecialMostLinked, SpecialMostInterwikis, SpecialMostCategories, SpecialMIMESearch, SpecialMediaStatistics, SpecialListRedirects, SpecialListDuplicatedFiles, SpecialLinkSearch, SpecialFileDuplicateSearch, SpecialFewestRevisions, SpecialDoubleRedirects, SpecialBrokenRedirects, SpecialAncientPages, WantedQueryPage, and ImageQueryPage.

Referenced by outputResults().

◆ getCachedTimestamp()

QueryPage::getCachedTimestamp ( )
Returns
string

Definition at line 589 of file QueryPage.php.

References $cachedTimestamp, $dbr, DB_REPLICA, getDBLoadBalancer(), and SpecialPage\getName().

Referenced by execute().

◆ getCacheOrderFields()

QueryPage::getCacheOrderFields ( )
protected

Return the order fields for fetchFromCache.

Default is to always use "ORDER BY value" which was the default prior to this function. Stable to override

Returns
array
Since
1.29

Reimplemented in WantedQueryPage.

Definition at line 582 of file QueryPage.php.

Referenced by fetchFromCache().

◆ getDBLimit()

QueryPage::getDBLimit (   $uiLimit,
  $uiOffset 
)
protected

What is limit to fetch from DB.

Used to make it appear the DB stores less results then it actually does

Parameters
int$uiLimitLimit from UI
int$uiOffsetOffset from UI
Returns
int Limit to use for DB (not including extra row to see if at end)

Definition at line 632 of file QueryPage.php.

References $limit, SpecialPage\getConfig(), and getMaxResults().

Referenced by execute().

◆ getDBLoadBalancer()

◆ getDisabledQueryPages()

static QueryPage::getDisabledQueryPages ( Config  $config)
static

Get a list of query pages disabled and with it's run mode.

Parameters
Config$config
Returns
string[]

Definition at line 158 of file QueryPage.php.

References Config\get().

Referenced by execute(), and UpdateSpecialPages\execute().

◆ getLimitOffset()

QueryPage::getLimitOffset ( )
protected

Returns limit and offset, as returned by $this->getRequest()->getLimitOffsetForUser().

Subclasses may override this to further restrict or modify limit and offset.

Note
Restricts the offset parameter, as most query pages have inefficient paging

Its generally expected that the returned limit will not be 0, and the returned offset will be less than the max results.

Since
1.26
Returns
int[] list( $limit, $offset )

Definition at line 611 of file QueryPage.php.

References $limit, $offset, SpecialPage\getConfig(), getMaxResults(), SpecialPage\getRequest(), and SpecialPage\getUser().

Referenced by execute().

◆ getLinkBatchFactory()

QueryPage::getLinkBatchFactory ( )
finalprotected
Since
1.36
Returns
LinkBatchFactory

Definition at line 144 of file QueryPage.php.

References $linkBatchFactory.

Referenced by executeLBFromResultWrapper().

◆ getMaxResults()

QueryPage::getMaxResults ( )
protected

Get max number of results we can return in miser mode.

Most QueryPage subclasses use inefficient paging, so limit the max amount we return This matters for uncached query pages that might otherwise accept an offset of 3 million

Stable to override

Since
1.27
Returns
int

Reimplemented in SpecialLinkSearch.

Definition at line 652 of file QueryPage.php.

References SpecialPage\getConfig().

Referenced by execute(), getDBLimit(), and getLimitOffset().

◆ getOrderFields()

QueryPage::getOrderFields ( )
protected

Subclasses return an array of fields to order by here.

Don't append DESC to the field names, that'll be done automatically if sortDescending() returns true. Stable to override

Returns
string[]
Since
1.18

Reimplemented in SpecialWithoutInterwiki, SpecialUnwatchedPages, SpecialUnusedTemplates, SpecialUnusedCategories, SpecialUncategorizedPages, SpecialUncategorizedImages, SpecialShortPages, SpecialPagesWithProp, SpecialMIMESearch, SpecialMediaStatistics, SpecialLonelyPages, SpecialListRedirects, SpecialLinkSearch, SpecialDoubleRedirects, SpecialDeadendPages, SpecialBrokenRedirects, and WantedQueryPage.

Definition at line 237 of file QueryPage.php.

Referenced by reallyDoQuery().

◆ getPageHeader()

QueryPage::getPageHeader ( )
protected

The content returned by this function will be output before any result.

Stable to override

Returns
string

Reimplemented in SpecialWithoutInterwiki, WantedFilesPage, SpecialUnusedTemplates, SpecialUnusedImages, SpecialUnusedCategories, SpecialMIMESearch, SpecialLonelyPages, SpecialDoubleRedirects, SpecialDeadendPages, and SpecialBrokenRedirects.

Definition at line 328 of file QueryPage.php.

Referenced by execute().

◆ getPages()

static QueryPage::getPages ( )
static

Get a list of query page classes and their associated special pages, for periodic updates.

DO NOT CHANGE THIS LIST without testing that maintenance/updateSpecialPages.php still works.

Returns
string[][]

Definition at line 85 of file QueryPage.php.

References Hooks\runner().

Referenced by ApiQueryQueryPage\__construct(), and UpdateSpecialPages\execute().

◆ getQueryInfo()

QueryPage::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.

Note that the query itself should return the following three columns: 'namespace', 'title', and 'value'. 'value' is used for sorting.

These may be stored in the querycache table for expensive queries, and that cached data will be returned sometimes, so the presence of extra fields can't be relied upon. The cached 'value' column will be an integer; non-numeric values are useful only for sorting the initial query (except if they're timestamps, see usesTimestamps()).

Don't include an ORDER or LIMIT clause, they will be added.

If this function is not overridden or returns something other than an array, getSQL() will be used instead. This is for backwards compatibility only and is strongly deprecated. Stable to override

Returns
array
Since
1.18

Reimplemented in SpecialWithoutInterwiki, SpecialWantedTemplates, WantedPagesPage, WantedFilesPage, SpecialWantedCategories, SpecialUnwatchedPages, SpecialUnusedTemplates, SpecialUnusedImages, SpecialUnusedCategories, SpecialUncategorizedPages, SpecialUncategorizedImages, SpecialUncategorizedCategories, SpecialShortPages, SpecialPagesWithProp, SpecialMostLinkedTemplates, SpecialMostLinkedCategories, SpecialMostLinked, SpecialMostInterwikis, MostimagesPage, SpecialMostCategories, SpecialMIMESearch, SpecialMediaStatistics, SpecialLonelyPages, SpecialListRedirects, SpecialListDuplicatedFiles, SpecialLinkSearch, SpecialFileDuplicateSearch, SpecialFewestRevisions, SpecialDoubleRedirects, SpecialDeadendPages, SpecialBrokenRedirects, and SpecialAncientPages.

Definition at line 213 of file QueryPage.php.

Referenced by reallyDoQuery().

◆ getRecacheDB()

QueryPage::getRecacheDB ( )
protected

Get a DB connection to be used for slow recache queries Stable to override.

Returns
IDatabase

Definition at line 444 of file QueryPage.php.

References DB_REPLICA, getDBLoadBalancer(), and SpecialPage\getName().

Referenced by execute(), reallyDoQuery(), and SpecialShortPages\reallyDoQuery().

◆ getSQL()

QueryPage::getSQL ( )
protected

For back-compat, subclasses may return a raw SQL query here, as a string.

This is strongly deprecated; getQueryInfo() should be overridden instead.

Exceptions
MWException
Returns
string

Definition at line 223 of file QueryPage.php.

Referenced by reallyDoQuery().

◆ isCacheable()

QueryPage::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.

Stable to override

Returns
bool
Since
1.18

Reimplemented in SpecialPagesWithProp, SpecialMIMESearch, SpecialLinkSearch, and SpecialFileDuplicateSearch.

Definition at line 286 of file QueryPage.php.

Referenced by doQuery(), execute(), and recache().

◆ isCached()

QueryPage::isCached ( )

Whether or not the output of the page in question is retrieved from the database cache.

Stable to override

Returns
bool

Reimplemented from SpecialPage.

Reimplemented in SpecialFileDuplicateSearch.

Definition at line 297 of file QueryPage.php.

References SpecialPage\getConfig(), and isExpensive().

Referenced by delete(), doQuery(), execute(), WantedQueryPage\formatResult(), SpecialMostCategories\formatResult(), SpecialMostInterwikis\formatResult(), SpecialShortPages\formatResult(), SpecialWantedCategories\formatResult(), and SpecialWithoutInterwiki\getPageHeader().

◆ isExpensive()

QueryPage::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.

Stable to override

Returns
bool

Reimplemented from SpecialPage.

Reimplemented in SpecialWithoutInterwiki, SpecialUnwatchedPages, SpecialUnusedTemplates, SpecialUnusedImages, SpecialUnusedCategories, SpecialUncategorizedPages, SpecialUncategorizedImages, SpecialMostLinkedTemplates, SpecialMostLinked, SpecialMostInterwikis, MostimagesPage, SpecialMostCategories, SpecialMIMESearch, SpecialMediaStatistics, SpecialLonelyPages, SpecialListRedirects, SpecialListDuplicatedFiles, SpecialFewestRevisions, SpecialDoubleRedirects, SpecialDeadendPages, SpecialBrokenRedirects, SpecialAncientPages, and WantedQueryPage.

Definition at line 274 of file QueryPage.php.

References SpecialPage\getConfig().

Referenced by isCached().

◆ isSyndicated()

◆ linkParameters()

QueryPage::linkParameters ( )
protected

If using extra form wheely-dealies, return a set of parameters here as an associative array.

They will be encoded and added to the paging links (prev/next/lengths).

Stable to override

Returns
array

Reimplemented in SpecialMIMESearch, SpecialLinkSearch, and SpecialFileDuplicateSearch.

Definition at line 351 of file QueryPage.php.

Referenced by execute().

◆ openList()

QueryPage::openList (   $offset)
protected
Parameters
int$offset
Returns
string

Definition at line 823 of file QueryPage.php.

References $offset.

Referenced by outputResults(), and SpecialFileDuplicateSearch\showList().

◆ outputResults()

QueryPage::outputResults (   $out,
  $skin,
  $dbr,
  $res,
  $num,
  $offset 
)
protected

Format and output report results using the given information plus OutputPage.

Stable to override

Parameters
OutputPage$outOutputPage to print to
Skin$skinUser skin to use
IDatabase$dbrDatabase (read) connection to use
IResultWrapper$resResult pointer
int$numNumber of available result rows
int$offsetPaging offset

Reimplemented in SpecialMediaStatistics, and ImageQueryPage.

Definition at line 789 of file QueryPage.php.

References $line, $res, closeList(), formatResult(), SpecialPage\getContentLanguage(), and openList().

Referenced by execute().

◆ preprocessResults()

◆ reallyDoQuery()

QueryPage::reallyDoQuery (   $limit,
  $offset = false 
)

Run the query and return the result Stable to override.

Parameters
int | bool$limitNumerical limit or false for no limit
int | bool$offsetNumerical offset or false for no offset
Returns
IResultWrapper
Since
1.18

Reimplemented in SpecialShortPages.

Definition at line 474 of file QueryPage.php.

References $dbr, $limit, $offset, $res, getOrderFields(), getQueryInfo(), getRecacheDB(), getSQL(), and sortDescending().

Referenced by doQuery(), execute(), and recache().

◆ recache()

QueryPage::recache (   $limit,
  $ignoreErrors = true 
)

Clear the cache and save new results.

Stable to override

Parameters
int | bool$limitLimit for SQL statement
bool$ignoreErrorsWhether to ignore database errors
Exceptions
DBError|Exception
Returns
bool|int

Definition at line 365 of file QueryPage.php.

References $res, DB_MASTER, Wikimedia\Rdbms\IDatabase\delete(), getDBLoadBalancer(), SpecialPage\getName(), Wikimedia\Rdbms\IDatabase\insert(), isCacheable(), reallyDoQuery(), Wikimedia\Rdbms\IDatabase\timestamp(), usesTimestamps(), and wfTimestamp().

◆ setDBLoadBalancer()

◆ setLinkBatchFactory()

◆ setListoutput()

QueryPage::setListoutput (   $bool)
protected

A mutator for $this->listoutput;.

Parameters
bool$bool

Definition at line 182 of file QueryPage.php.

Referenced by WantedPagesPage\execute().

◆ showEmptyText()

QueryPage::showEmptyText ( )
protected

Outputs some kind of an informative message (via OutputPage) to let the user know that the query returned nothing and thus there's nothing to show.

Since
1.26

Definition at line 339 of file QueryPage.php.

References SpecialPage\getOutput().

Referenced by execute().

◆ sortDescending()

◆ usesTimestamps()

QueryPage::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.

NOTE: formatRow() may get timestamps in TS_MW (mysql), TS_DB (pgsql) or TS_UNIX (querycache) format, so be sure to always run them through wfTimestamp() Stable to override

Returns
bool
Since
1.18

Reimplemented in SpecialUnusedImages, and SpecialAncientPages.

Definition at line 252 of file QueryPage.php.

Referenced by recache().

Member Data Documentation

◆ $cachedTimestamp

string null QueryPage::$cachedTimestamp = null
protected

Definition at line 63 of file QueryPage.php.

Referenced by getCachedTimestamp().

◆ $limit

◆ $linkBatchFactory

◆ $listoutput

bool QueryPage::$listoutput = false
protected

Whether or not we want plain listoutput rather than an ordered list.

Definition at line 43 of file QueryPage.php.

◆ $loadBalancer

◆ $numRows

int QueryPage::$numRows
protected

The number of rows returned by the query.

Reading this variable only makes sense in functions that are run after the query has been done, such as preprocessResults() and formatRow().

Definition at line 58 of file QueryPage.php.

Referenced by SpecialFileDuplicateSearch\execute().

◆ $offset

int QueryPage::$offset = 0
protected

◆ $shownavigation

bool QueryPage::$shownavigation = true
protected

Whether to show prev/next links.

Definition at line 68 of file QueryPage.php.


The documentation for this class was generated from the following file: