MediaWiki  1.23.8
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

 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...
 
 formatResult ( $skin, $result)
 Formats the results of the query for display. 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...
 
 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...
 
 linkParameters ()
 If using extra form wheely-dealies, return a set of parameters here as an associative array. More...
 
 openList ( $offset)
 
 preprocessResults ( $db, $res)
 Do any necessary preprocessing of the result object. More...
 
 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...
 

Static Public Member Functions

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

 $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

 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

 $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

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.

Definition at line 30 of file QueryPage.php.

Member Function Documentation

◆ closeList()

QueryPage::closeList ( )
Returns
string

Definition at line 659 of file QueryPage.php.

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

◆ doFeed()

QueryPage::doFeed (   $class = '',
  $limit = 50 
)

Similar to above, but packaging in a syndicated feed instead of a web page.

Parameters
string$class
int$limit
Returns
bool

Definition at line 676 of file QueryPage.php.

References $limit, $res, as, feedDesc(), feedResult(), feedTitle(), feedUrl(), SpecialPage\getOutput(), global, and reallyDoQuery().

◆ doQuery()

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

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

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

Reimplemented in LinkSearchPage.

Definition at line 423 of file QueryPage.php.

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

◆ execute()

◆ feedDesc()

QueryPage::feedDesc ( )

Definition at line 753 of file QueryPage.php.

References SpecialPage\msg().

Referenced by doFeed().

◆ feedItemAuthor()

QueryPage::feedItemAuthor (   $row)

Definition at line 743 of file QueryPage.php.

Referenced by feedResult().

◆ feedItemDesc()

QueryPage::feedItemDesc (   $row)

Definition at line 739 of file QueryPage.php.

Referenced by feedResult().

◆ feedResult()

QueryPage::feedResult (   $row)

Override for custom handling.

If the titles/links are ok, just do feedItemDesc()

Parameters
object$row
Returns
FeedItem|null

Definition at line 714 of file QueryPage.php.

References $title, feedItemAuthor(), feedItemDesc(), and Title\makeTitle().

Referenced by doFeed().

◆ feedTitle()

QueryPage::feedTitle ( )

Definition at line 747 of file QueryPage.php.

References SpecialPage\getDescription(), and global.

Referenced by doFeed().

◆ feedUrl()

QueryPage::feedUrl ( )

Definition at line 757 of file QueryPage.php.

References SpecialPage\getPageTitle().

Referenced by doFeed().

◆ fetchFromCache()

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

Fetch the query results from the query cache.

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

Definition at line 438 of file QueryPage.php.

References $dbr, $limit, $offset, $options, $res, array(), DB_SLAVE, SpecialPage\getName(), sortDescending(), and wfGetDB().

Referenced by doQuery(), and execute().

◆ formatResult()

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

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 off of it. If the function returns false, the line output will be skipped.

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

Reimplemented in PageQueryPage, WantedQueryPage, LinkSearchPage, FileDuplicateSearchPage, MIMEsearchPage, SpecialPagesWithProp, DoubleRedirectsPage, MostlinkedPage, ListredirectsPage, MostlinkedTemplatesPage, BrokenRedirectsPage, MostinterwikisPage, ListDuplicatedFilesPage, MostcategoriesPage, WantedCategoriesPage, ShortPagesPage, MostlinkedCategoriesPage, UnwatchedpagesPage, FewestrevisionsPage, UnusedtemplatesPage, AncientPagesPage, UnusedCategoriesPage, ImageQueryPage, PopularPagesPage, and UncategorizedCategoriesPage.

Referenced by outputResults().

◆ getCachedTimestamp()

QueryPage::getCachedTimestamp ( )

Definition at line 462 of file QueryPage.php.

References $cachedTimestamp, $dbr, $fname, array(), DB_SLAVE, SpecialPage\getName(), and wfGetDB().

Referenced by execute().

◆ getOrderFields()

QueryPage::getOrderFields ( )

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.

Returns
array
Since
1.18

Reimplemented in LinkSearchPage, SpecialPagesWithProp, DoubleRedirectsPage, MIMEsearchPage, BrokenRedirectsPage, LonelyPagesPage, DeadendPagesPage, WithoutInterwikiPage, UncategorizedPagesPage, UnwatchedpagesPage, ListredirectsPage, and ShortPagesPage.

Definition at line 175 of file QueryPage.php.

References array().

Referenced by reallyDoQuery().

◆ getPageHeader()

QueryPage::getPageHeader ( )

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

Returns
string

Reimplemented in UnusedtemplatesPage, UnusedimagesPage, BrokenRedirectsPage, DoubleRedirectsPage, WithoutInterwikiPage, WantedFilesPage, UnusedCategoriesPage, DeadendPagesPage, and LonelyPagesPage.

Definition at line 262 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
array

Definition at line 66 of file QueryPage.php.

References array(), global, and wfRunHooks().

Referenced by QueryAllSpecialPagesTest\__construct(), 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.

Returns
array
Since
1.18

Reimplemented in LinkSearchPage, DoubleRedirectsPage, SpecialPagesWithProp, WithoutInterwikiPage, FileDuplicateSearchPage, WantedFilesPage, MostlinkedTemplatesPage, DeadendPagesPage, WantedPagesPage, ListDuplicatedFilesPage, MIMEsearchPage, BrokenRedirectsPage, LonelyPagesPage, UncategorizedPagesPage, UnusedtemplatesPage, ListredirectsPage, UncategorizedImagesPage, MostlinkedPage, UnusedimagesPage, UnwatchedpagesPage, MostcategoriesPage, MostimagesPage, MostinterwikisPage, AncientPagesPage, FewestrevisionsPage, PopularPagesPage, MostlinkedCategoriesPage, ShortPagesPage, UnusedCategoriesPage, WantedTemplatesPage, and WantedCategoriesPage.

Definition at line 152 of file QueryPage.php.

Referenced by reallyDoQuery().

◆ getRecacheDB()

QueryPage::getRecacheDB ( )

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

Definition at line 361 of file QueryPage.php.

References array(), DB_SLAVE, SpecialPage\getName(), and wfGetDB().

Referenced by reallyDoQuery().

◆ getSQL()

QueryPage::getSQL ( )

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 162 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.

Returns
bool
Since
1.18

Reimplemented in LinkSearchPage, FileDuplicateSearchPage, MIMEsearchPage, and SpecialPagesWithProp.

Definition at line 221 of file QueryPage.php.

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

◆ isCached()

◆ 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.

Returns
bool

Reimplemented from SpecialPage.

Reimplemented in WantedQueryPage, WithoutInterwikiPage, DeadendPagesPage, LonelyPagesPage, MostlinkedTemplatesPage, UncategorizedPagesPage, UncategorizedImagesPage, MostlinkedPage, UnwatchedpagesPage, ListDuplicatedFilesPage, MIMEsearchPage, MostcategoriesPage, MostimagesPage, MostinterwikisPage, UnusedtemplatesPage, BrokenRedirectsPage, ListredirectsPage, AncientPagesPage, DoubleRedirectsPage, FewestrevisionsPage, PopularPagesPage, UnusedimagesPage, and UnusedCategoriesPage.

Definition at line 209 of file QueryPage.php.

References global.

Referenced by isCached().

◆ isSyndicated()

◆ linkParameters()

QueryPage::linkParameters ( )

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).

Returns
array

Reimplemented in LinkSearchPage, FileDuplicateSearchPage, and MIMEsearchPage.

Definition at line 273 of file QueryPage.php.

References array().

Referenced by execute().

◆ openList()

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

Definition at line 652 of file QueryPage.php.

References $offset.

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

◆ outputResults()

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

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

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

Reimplemented in ImageQueryPage.

Definition at line 599 of file QueryPage.php.

References $html, $line, $out, $res, $skin, $wgContLang, array(), closeList(), formatResult(), global, openList(), and tryLastResult().

Referenced by execute().

◆ preprocessResults()

QueryPage::preprocessResults (   $db,
  $res 
)

◆ reallyDoQuery()

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

Run the query and return the result.

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

Definition at line 372 of file QueryPage.php.

References $dbr, $fname, $limit, $offset, $options, $query, $res, $tables, array(), as, getOrderFields(), getQueryInfo(), getRecacheDB(), getSQL(), and sortDescending().

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

◆ recache()

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

Clear the cache and save new results.

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

Definition at line 297 of file QueryPage.php.

References $e, $fname, $res, $value, array(), as, DB_MASTER, SpecialPage\getName(), isCacheable(), reallyDoQuery(), TS_UNIX, usesTimestamps(), wfGetDB(), and wfTimestamp().

◆ setListoutput()

QueryPage::setListoutput (   $bool)

A mutator for $this->listoutput;.

Parameters
bool$bool

Definition at line 122 of file QueryPage.php.

Referenced by WantedPagesPage\execute().

◆ sortDescending()

◆ tryLastResult()

QueryPage::tryLastResult ( )

Some special pages (for example SpecialListusers) might not return the current object formatted, but return the previous one instead.

Setting this to return true will ensure formatResult() is called one more time to make sure that the very last result is formatted as well.

Returns
bool

Definition at line 285 of file QueryPage.php.

Referenced by outputResults().

◆ 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()

Returns
bool
Since
1.18

Reimplemented in UnusedimagesPage, and AncientPagesPage.

Definition at line 189 of file QueryPage.php.

Referenced by recache().

Member Data Documentation

◆ $cachedTimestamp

QueryPage::$cachedTimestamp = null
protected

Definition at line 51 of file QueryPage.php.

Referenced by getCachedTimestamp().

◆ $limit

QueryPage::$limit = 0

Definition at line 42 of file QueryPage.php.

Referenced by doFeed(), LinkSearchPage\doQuery(), fetchFromCache(), and reallyDoQuery().

◆ $listoutput

bool QueryPage::$listoutput = false

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

Definition at line 35 of file QueryPage.php.

◆ $numRows

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 49 of file QueryPage.php.

Referenced by FileDuplicateSearchPage\execute().

◆ $offset

int QueryPage::$offset = 0

The offset and limit in use, as passed to the query() function.

Definition at line 41 of file QueryPage.php.

Referenced by LinkSearchPage\doQuery(), doQuery(), fetchFromCache(), openList(), and reallyDoQuery().

◆ $shownavigation

QueryPage::$shownavigation = true
protected

Wheter to show prev/next links.

Definition at line 56 of file QueryPage.php.


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