Special:LinkSearch to search the external-links table. More...

Inheritance diagram for LinkSearchPage:

Collaboration diagram for LinkSearchPage:

[legend]

Public Member Functions
	__construct ( $name='LinkSearch')

	doQuery ( $offset=false, $limit=false)
	Override to check query validity. More...

	execute ( $par)
	This is the actual workhorse. More...

	formatResult ( $skin, $result)

	getOrderFields ()
	Override to squash the ORDER BY. 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...

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

	isSyndicated ()
	Disable RSS/Atom feeds. More...

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

	setPageLinkRenderer (PageLinkRenderer $linkRenderer)
	Initialize or override the PageLinkRenderer LinkSearchPage collaborates with. More...

	setParams ( $params)

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

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

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

	getSQL ()
	For back-compat, subclasses may return a raw SQL query here, as a string. 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...

	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	mungeQuery ( $query, $prot)
	Return an appropriately formatted LIKE query and the clause. More...

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

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

	getRobotPolicy ()
	Return the robot policy. More...

Protected Attributes
PageLinkRenderer	$linkRenderer = null

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

Private Member Functions
	initServices ()
	Initialize any services we'll need (unless it has already been provided via a setter). More...

Additional Inherited Members
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...

Detailed Description

Special:LinkSearch to search the external-links table.

Definition at line 29 of file SpecialLinkSearch.php.

Constructor & Destructor Documentation

◆ __construct()

LinkSearchPage::__construct ( $name = 'LinkSearch' )

Definition at line 41 of file SpecialLinkSearch.php.

References $name.

Member Function Documentation

◆ doQuery()

LinkSearchPage::doQuery	(	$offset = `false`,
		$limit = `false`
	)

Override to check query validity.

Parameters

mixed	$offset	Numerical offset or false for no offset
mixed	$limit	Numerical limit or false for no limit

Reimplemented from QueryPage.

Definition at line 274 of file SpecialLinkSearch.php.

References QueryPage\$limit, QueryPage\$offset, SpecialPage\getOutput(), list, and mungeQuery().

◆ execute()

LinkSearchPage::execute ( $par )

This is the actual workhorse.

It does everything needed to make a real, honest-to-gosh query page.

Parameters

string $par

Returns: int

Reimplemented from QueryPage.

Definition at line 79 of file SpecialLinkSearch.php.

References $out, $s, array(), as, Html\closeElement(), Html\element(), execute(), SpecialPage\getLanguage(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), global, Html\hidden(), initServices(), Xml\inputLabel(), SpecialPage\msg(), Html\namespaceSelector(), Html\openElement(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), setParams(), Xml\submitButton(), text, and wfParseUrl().

◆ formatResult()

LinkSearchPage::formatResult	(	$skin,
		$result
	)

Parameters

Skin	$skin
object	$result	Result row

Returns: string

Reimplemented from QueryPage.

Definition at line 258 of file SpecialLinkSearch.php.

References $title, Linker\makeExternalLink(), and SpecialPage\msg().

◆ getGroupName()

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

Definition at line 297 of file SpecialLinkSearch.php.

◆ getOrderFields()

LinkSearchPage::getOrderFields ( )

Override to squash the ORDER BY.

We do a truncated index search, so the optimizer won't trust it as good enough for optimizing sort. The implicit ordering from the scan will usually do well enough for our needs.

Returns: array

Reimplemented from QueryPage.

Definition at line 293 of file SpecialLinkSearch.php.

References array().

◆ getQueryInfo()

LinkSearchPage::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 218 of file SpecialLinkSearch.php.

References $dbr, $retval, array(), DB_SLAVE, global, LinkFilter\keepOneWildcard(), list, mungeQuery(), and wfGetDB().

◆ initServices()

LinkSearchPage::initServices ( )

private

Initialize any services we'll need (unless it has already been provided via a setter).

This allows for dependency injection even though we don't control object creation.

Definition at line 67 of file SpecialLinkSearch.php.

References SpecialPage\getContext(), and GenderCache\singleton().

Referenced by execute().

◆ isCacheable()

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

Definition at line 75 of file SpecialLinkSearch.php.

◆ isSyndicated()

LinkSearchPage::isSyndicated ( )

Disable RSS/Atom feeds.

Returns: bool

Reimplemented from QueryPage.

Definition at line 172 of file SpecialLinkSearch.php.

◆ linkParameters()

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

Definition at line 207 of file SpecialLinkSearch.php.

References $params, array(), and global.

◆ mungeQuery()

static LinkSearchPage::mungeQuery	(	$query,
		$prot
	)

static

Return an appropriately formatted LIKE query and the clause.

Parameters

String	$query	Search pattern to search for
String	$prot	Protocol, e.g. 'http://'

Returns: array

Definition at line 184 of file SpecialLinkSearch.php.

References $dbr, $query, array(), DB_SLAVE, LinkFilter\makeLikeArray(), and wfGetDB().

Referenced by doQuery(), and getQueryInfo().

◆ setPageLinkRenderer()

LinkSearchPage::setPageLinkRenderer ( PageLinkRenderer $linkRenderer )

Initialize or override the PageLinkRenderer LinkSearchPage collaborates with.

Useful mainly for testing.

Todo:: : query logic and rendering logic should be split and also injected

Parameters

PageLinkRenderer $linkRenderer

Definition at line 57 of file SpecialLinkSearch.php.

References $linkRenderer.

◆ setParams()

LinkSearchPage::setParams ( $params )

Definition at line 35 of file SpecialLinkSearch.php.

References $params.

Referenced by execute().

Member Data Documentation

◆ $linkRenderer

PageLinkRenderer LinkSearchPage::$linkRenderer = null

protected

Definition at line 33 of file SpecialLinkSearch.php.

Referenced by setPageLinkRenderer().

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

includes/specials/SpecialLinkSearch.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doQuery()

◆ execute()

◆ formatResult()

◆ getGroupName()

◆ getOrderFields()

◆ getQueryInfo()

◆ initServices()

◆ isCacheable()

◆ isSyndicated()

◆ linkParameters()

◆ mungeQuery()

◆ setPageLinkRenderer()

◆ setParams()

Member Data Documentation

◆ $linkRenderer