Special:GadgetUsage - Lists all the gadgets on the wiki along with number of users. More...

Inheritance diagram for SpecialGadgetUsage:

[legend]

Collaboration diagram for SpecialGadgetUsage:

[legend]

Public Member Functions

__construct ( $name='GadgetUsage')

execute ( $par)

This is the actual workhorse.It does everything needed to make a real, honest-to-gosh query page.

Parameters

string | null $par

formatResult ( $skin, $result)

getOrderFields ()

Subclasses return an array of fields to order by here.

getQueryInfo ()

Define the database query that is used to generate the stats table.

isExpensive ()

Is this query expensive (for some definition of expensive)? Then we don't let it run in miser mode.

Public Member Functions inherited from QueryPage

closeList ()

delete (LinkTarget $title)

Remove a cached result.

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

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

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.

isSyndicated ()

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

linkParameters ()

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

openList ( $offset)

preprocessResults ( $db, $res)

Do any necessary preprocessing of the result object.

reallyDoQuery ( $limit, $offset=false)

Run the query and return the result.

recache ( $limit, $ignoreErrors=true)

Clear the cache and save new results.

setListoutput ( $bool)

A mutator for $this->listoutput;.

sortDescending ()

Override to sort by increasing values.

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.

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,... $params)

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

Public Attributes
	$activeUsers
	Flag for holding the value of config variable SpecialGadgetUsageActiveUsers.

Protected Member Functions
	getDefaultGadgets ( $gadgetRepo, $gadgetIds)
	Get a list of default gadgets.

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

	outputResults ( $out, $skin, $dbr, $res, $num, $offset)
	Format and output report results using the given information plus OutputPage.

	outputTableEnd ()
	Output the end of the table

	outputTableStart ()
	Output the start of the table Including opening.

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

	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.

	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.

	buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
	Generate (prev x\| next x) (20\|50\|100...) type links for paging.

	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	getDisabledQueryPages (Config $config)
	Get a list of query pages disabled and with it's run mode.

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
string null	$cachedTimestamp = null

int	$limit = 0

bool	$listoutput = false
	Whether or not we want plain listoutput rather than an ordered list.

int	$numRows
	The number of rows returned by the query.

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

bool	$shownavigation = true
	Whether to show prev/next links.

Protected Attributes inherited from SpecialPage
IContextSource	$mContext
	Current request context.

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Detailed Description

Special:GadgetUsage - Lists all the gadgets on the wiki along with number of users.

Definition at line 34 of file SpecialGadgetUsage.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialGadgetUsage::__construct ( $name = 'GadgetUsage' )

Definition at line 35 of file SpecialGadgetUsage.php.

References SpecialPage\getConfig().

Member Function Documentation

◆ execute()

SpecialGadgetUsage::execute ( $par )

This is the actual workhorse.It does everything needed to make a real, honest-to-gosh query page.

Parameters

string | null $par

Reimplemented from QueryPage.

Definition at line 45 of file SpecialGadgetUsage.php.

References SpecialPage\addHelpLink().

◆ formatResult()

SpecialGadgetUsage::formatResult	(		$skin,
			$result )

Parameters

Skin	$skin
object	$result	Result row

Returns: string|bool String of HTML

Reimplemented from QueryPage.

Definition at line 179 of file SpecialGadgetUsage.php.

References SpecialPage\getLanguage().

Referenced by outputResults().

◆ getDefaultGadgets()

SpecialGadgetUsage::getDefaultGadgets	(		$gadgetRepo,
			$gadgetIds )

protected

Get a list of default gadgets.

Parameters

GadgetRepo	$gadgetRepo
array	$gadgetIds	list of gagdet ids registered in the wiki

Returns: array

Definition at line 202 of file SpecialGadgetUsage.php.

Referenced by outputResults().

◆ getGroupName()

SpecialGadgetUsage::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 276 of file SpecialGadgetUsage.php.

◆ getOrderFields()

SpecialGadgetUsage::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: string[]

Since: 1.18

Reimplemented from QueryPage.

Definition at line 130 of file SpecialGadgetUsage.php.

◆ getQueryInfo()

SpecialGadgetUsage::getQueryInfo ( )

Define the database query that is used to generate the stats table.

This uses 1 of 2 possible queries, depending on $wgSpecialGadgetUsageActiveUsers.

The simple query is essentially: SELECT up_property, SUM(up_value) FROM user_properties WHERE up_property LIKE 'gadget-' GROUP BY up_property;

The more expensive query is: SELECT up_property, SUM(up_value), count(qcc_title) FROM user_properties LEFT JOIN user ON up_user = user_id LEFT JOIN querycachetwo ON user_name = qcc_title AND qcc_type = 'activeusers' AND up_value = 1 WHERE up_property LIKE 'gadget-' GROUP BY up_property;

Returns: array

Reimplemented from QueryPage.

Definition at line 80 of file SpecialGadgetUsage.php.

References $dbr, DB_REPLICA, and wfGetDB().

◆ isExpensive()

SpecialGadgetUsage::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 57 of file SpecialGadgetUsage.php.

◆ outputResults()

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

protected

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

Parameters

OutputPage	$out	OutputPage to print to
Skin	$skin	User skin to use
IDatabase	$dbr	Database (read) connection to use
IResultWrapper	$res	Result pointer
int	$num	Number of available result rows
int	$offset	Paging offset

Reimplemented from QueryPage.

Definition at line 225 of file SpecialGadgetUsage.php.

References $line, $res, formatResult(), SpecialPage\getConfig(), getDefaultGadgets(), SpecialPage\msg(), outputTableEnd(), outputTableStart(), and GadgetRepo\singleton().

◆ outputTableEnd()

SpecialGadgetUsage::outputTableEnd ( )

protected

Output the end of the table

Definition at line 167 of file SpecialGadgetUsage.php.

References SpecialPage\getOutput().

Referenced by outputResults().

◆ outputTableStart()

SpecialGadgetUsage::outputTableStart ( )

protected

Output the start of the table Including opening.

the thead element with column headers and the opening .

Definition at line 139 of file SpecialGadgetUsage.php.

References SpecialPage\getOutput(), and SpecialPage\msg().

Referenced by outputResults().

Member Data Documentation

◆ $activeUsers

bool SpecialGadgetUsage::$activeUsers

Flag for holding the value of config variable SpecialGadgetUsageActiveUsers.

Definition at line 55 of file SpecialGadgetUsage.php.

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

extensions/Gadgets/includes/SpecialGadgetUsage.php

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ execute()

◆ formatResult()

◆ getDefaultGadgets()

◆ getGroupName()

◆ getOrderFields()

◆ getQueryInfo()

◆ isExpensive()

◆ outputResults()

◆ outputTableEnd()

◆ outputTableStart()

Member Data Documentation

◆ $activeUsers