ShortPagesPage Class Reference

SpecialShortpages extends QueryPage. More...

Inheritance diagram for ShortPagesPage:

Collaboration diagram for ShortPagesPage:

Public Member Functions
	__construct ( $name='Shortpages')
	formatResult ( $skin, $result)
	getOrderFields ()
	Subclasses return an array of fields to order by here.
	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.
	isSyndicated ()
	Sometime we don't want to build rss / atom feeds.
	preprocessResults ( $db, $res)
	reallyDoQuery ( $limit, $offset=false)
	Run the query and return the result.
	sortDescending ()
	Override to sort by increasing values.
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.
	doQuery ( $offset=false, $limit=false)
	Somewhat deprecated, you probably want to be using execute()
	execute ( $par)
	This is the actual workhorse.
	feedDesc ()
	feedItemAuthor ( $row)
	feedItemDesc ( $row)
	feedResult ( $row)
	Override for custom handling.
	feedTitle ()
	feedUrl ()
	fetchFromCache ( $limit, $offset=false)
	Fetch the query results from the query cache.
	getCachedTimestamp ()
	getCacheOrderFields ()
	Return the order fields for fetchFromCache.
	getPageHeader ()
	The content returned by this function will be output before any result.
	getRecacheDB ()
	Get a DB connection to be used for slow recache queries.
	getSQL ()
	For back-compat, subclasses may return a raw SQL query here, as a string.
	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.
	isCached ()
	Whether or not the output of the page in question is retrieved from the database cache.
	isExpensive ()
	Is this query expensive (for some definition of expensive)? Then we don't let it run in miser mode.
	linkParameters ()
	If using extra form wheely-dealies, return a set of parameters here as an associative array.
	openList ( $offset)
	recache ( $limit, $ignoreErrors=true)
	Clear the cache and save new results.
	setListoutput ( $bool)
	A mutator for $this->listoutput;.
	tryLastResult ()
	Some special pages (for example SpecialListusers used to) might not return the current object formatted, but return the previous one instead.
	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.
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.
	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators.
	checkPermissions ()
	Checks if userCanExecute, and if not throws a PermissionsError.
	checkReadOnly ()
	If the wiki is currently in readonly mode, throws a ReadOnlyError.
	displayRestrictionError ()
	Output an error message telling the user what access level they have to have.
	doesWrites ()
	Indicates whether this special page may perform database writes.
	getConfig ()
	Shortcut to get main config object.
	getContext ()
	Gets the context this SpecialPage is executed in.
	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.
	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.
	getFullTitle ()
	Return the full title, including $par.
	getLanguage ()
	Shortcut to get user's language.
	getLinkRenderer ()
	getLocalName ()
	Get the localised name of the special page.
	getName ()
	Get the name of this Special Page.
	getOutput ()
	Get the OutputPage being used for this instance.
	getPageTitle ( $subpage=false)
	Get a self-referential title object.
	getRequest ()
	Get the WebRequest being used for this instance.
	getRestriction ()
	Get the permission that a user must have to execute this page.
	getSkin ()
	Shortcut to get the skin being used for this instance.
	getTitle ( $subpage=false)
	Get a self-referential title object.
	getUser ()
	Shortcut to get the User executing this instance.
	including ( $x=null)
	Whether the special page is being evaluated via transclusion.
	isIncludable ()
	Whether it's allowed to transclude the special page via {{Special:Foo/params}}.
	isListed ()
	Whether this special page is listed in Special:SpecialPages.
	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes.
	listed ( $x=null)
	Get or set whether this special page is listed in Special:SpecialPages.
	maxIncludeCacheTime ()
	How long to cache page when it is being included.
	msg ( $key)
	Wrapper around wfMessage that sets the current context.
	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.
	prefixSearchSubpages ( $search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept.
	requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	If the user is not logged in, throws UserNotLoggedIn error.
	run ( $subPage)
	Entry point.
	setContext ( $context)
	Sets the context this SpecialPage is executed in.
	setHeaders ()
	Sets headers - this should be called from the execute() method of all derived classes!
	setLinkRenderer (LinkRenderer $linkRenderer)
	setListed ( $listed)
	Set whether this page is listed in Special:Specialpages, at run-time.
	userCanExecute (User $user)
	Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

Protected Member Functions
	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'.
Protected Member Functions inherited from QueryPage
	executeLBFromResultWrapper (IResultWrapper $res, $ns=null)
	Creates a new LinkBatch object, adds all pages from the passed ResultWrapper (MUST include title and optional the namespace field) and executes the batch.
	getDBLimit ( $uiLimit, $uiOffset)
	What is limit to fetch from DB.
	getLimitOffset ()
	Returns limit and offset, as returned by $this->getRequest()->getLimitOffset().
	getMaxResults ()
	Get max number of results we can return in miser mode.
	outputResults ( $out, $skin, $dbr, $res, $num, $offset)
	Format and output report results using the given information plus OutputPage.
	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.
Protected Member Functions inherited from SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.
	afterExecute ( $subPage)
	Gets called after.
	beforeExecute ( $subPage)
	Gets called before.
	checkLoginSecurityLevel ( $level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process.
	getCacheTTL ()
	getLoginSecurityLevel ()
	Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.
	getRobotPolicy ()
	Return the robot policy.
	getSubpagesForPrefixSearch ()
	Return an array of subpages that this special page will accept for prefix searches.
	prefixSearchString ( $search, $limit, $offset)
	Perform a regular substring search for prefixSearchSubpages.
	setReauthPostData (array $data)
	Record preserved POST data after a reauthentication.
	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

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.
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.
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.
static	getTitleValueFor ( $name, $subpage=false, $fragment='')
	Get a localised TitleValue object for a specified special page name.
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).
Protected Attributes inherited from QueryPage
	$cachedTimestamp = null
int	$limit = 0
bool	$listoutput = false
	Whether or not we want plain listoutput rather than an ordered list.
	$numRows
	The number of rows returned by the query.
int	$offset = 0
	The offset and limit in use, as passed to the query() function.
	$shownavigation = true
	Whether to show prev/next links.
Protected Attributes inherited from SpecialPage
IContextSource	$mContext
	Current request context.
	$mIncludable
	$mIncluding
	$mName
	$mRestriction

Detailed Description

SpecialShortpages extends QueryPage.

It is used to return the shortest pages in the database.

Definition at line 33 of file SpecialShortpages.php.

Constructor & Destructor Documentation

__construct()

ShortPagesPage::__construct

(

$name = 'Shortpages'

)

Reimplemented in LongPagesPage.

Definition at line 35 of file SpecialShortpages.php.

Member Function Documentation

formatResult()

ShortPagesPage::formatResult	(		$skin,
			$result )

Parameters

Skin	$skin
object	$result	Result row

Returns

string

Reimplemented from QueryPage.

Definition at line 142 of file SpecialShortpages.php.

References SpecialPage\$linkRenderer, SpecialPage\getContext(), Linker\getInvalidTitleDescription(), SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), QueryPage\isCached(), SpecialPage\msg(), and text.

getGroupName()

ShortPagesPage::getGroupName ( )

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

Returns

string

Since

1.21

Reimplemented from SpecialPage.

Reimplemented in LongPagesPage.

Definition at line 175 of file SpecialShortpages.php.

getOrderFields()

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

Definition at line 121 of file SpecialShortpages.php.

Referenced by reallyDoQuery().

getQueryInfo()

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

Definition at line 43 of file SpecialShortpages.php.

References $options, $tables, and SpecialPage\getConfig().

Referenced by reallyDoQuery().

isSyndicated()

ShortPagesPage::isSyndicated

(

)

Sometime we don't want to build rss / atom feeds.

Returns

bool

Reimplemented from QueryPage.

Definition at line 39 of file SpecialShortpages.php.

preprocessResults()

ShortPagesPage::preprocessResults	(		$db,
			$res )

Parameters

IDatabase	$db
IResultWrapper	$res

Reimplemented from QueryPage.

Definition at line 129 of file SpecialShortpages.php.

References $res, and QueryPage\executeLBFromResultWrapper().

reallyDoQuery()

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

Run the query and return the result.

Parameters

int | bool	$limit	Numerical limit or false for no limit
int | bool	$offset	Numerical offset or false for no offset

Returns

IResultWrapper

Since

1.18

Reimplemented from QueryPage.

Definition at line 70 of file SpecialShortpages.php.

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

sortDescending()

ShortPagesPage::sortDescending

(

)

Override to sort by increasing values.

Returns

bool

Reimplemented from QueryPage.

Reimplemented in LongPagesPage.

Definition at line 133 of file SpecialShortpages.php.

Referenced by reallyDoQuery().

---

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

• includes/specials/SpecialShortpages.php