MediaWiki master
MediaWiki\Specials\SpecialMediaStatistics Class Reference

Implements Special:MediaStatistics. More...

Inherits MediaWiki\SpecialPage\QueryPage.

Collaboration diagram for MediaWiki\Specials\SpecialMediaStatistics:

Public Member Functions

 __construct (MimeAnalyzer $mimeAnalyzer, IConnectionProvider $dbProvider, LinkBatchFactory $linkBatchFactory)
 
 formatResult ( $skin, $result)
 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

 
 getQueryInfo ()
 Query to do.
 
 isExpensive ()
 Should this query page only be updated offline on large wikis?
 
 preprocessResults ( $dbr, $res)
 Initialize total values so we can figure out percentages later.
 
- Public Member Functions inherited from MediaWiki\SpecialPage\QueryPage
 delete (LinkTarget $title)
 Remove a cached result.
 
 deleteAllCachedData ()
 Remove all cached value This is needed when the page is no longer using the cache.
 
 doQuery ( $offset=false, $limit=false)
 Somewhat deprecated, you probably want to be using execute()
 
 execute ( $par)
 This is the actual workhorse.
 
 fetchFromCache ( $limit, $offset=false)
 Fetch the query results from the query cache.
 
 getCachedTimestamp ()
 
 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 ()
 Sometimes we don't want to build rss / atom feeds.
 
 reallyDoQuery ( $limit, $offset=false)
 Run the query and return the result.
 
 recache ( $limit, $unused=true)
 Clear the cache and save new results.
 
 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 MediaWiki\SpecialPage\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.
 
 doesWrites ()
 Indicates whether POST requests to this special page require write access to the wiki.
 
 getAssociatedNavigationLinks ()
 Return an array of strings representing page titles that are discoverable to end users via UI.
 
 getAuthority ()
 Shortcut to get the Authority executing this instance.
 
 getConfig ()
 Shortcut to get main config object.
 
 getContentLanguage ()
 Shortcut to get content language.
 
 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 canonical, unlocalized name of this special page without namespace.
 
 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.
 
 getShortDescription (string $path='')
 Similar to getDescription, but takes into account subpages and designed for display in tabs.
 
 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.
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included.
 
 msg ( $key,... $params)
 Wrapper around wfMessage that sets the current context.
 
 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.
 
 requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin', bool $alwaysRedirectToLoginPage=false)
 If the user is not logged in or is a temporary user, throws UserNotLoggedIn.
 
 run ( $subPage)
 Entry point.
 
 setContentLanguage (Language $contentLanguage)
 Set content language.
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in.
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setSpecialPageFactory (SpecialPageFactory $specialPageFactory)
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).
 

Public Attributes

const MAX_LIMIT = 5000
 

Protected Member Functions

 getGroupName ()
 What group to put the page in.
 
 getOrderFields ()
 How to sort the results.
 
 getTableHeaderRow ()
 Get (not output) the header row for the table.
 
 makePercentPretty ( $decimal)
 
 outputMediaType ( $mediaType)
 Output a header for a new media type section.
 
 outputResults ( $out, $skin, $dbr, $res, $num, $offset)
 Output the results of the query.
 
 outputTableEnd ()
 Output closing
 
 outputTableRow ( $mime, $count, $bytes)
 Output a row of the stats table.
 
 outputTableStart ( $mediaType)
 Output the start of the table.
 
- Protected Member Functions inherited from MediaWiki\SpecialPage\QueryPage
 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.
 
 getCacheOrderFields ()
 Return the order fields for fetchFromCache.
 
 getDatabaseProvider ()
 
 getDBLimit ( $uiLimit, $uiOffset)
 What is limit to fetch from DB.
 
 getDBLoadBalancer ()
 
 getLimitOffset ()
 Returns limit and offset, as returned by $this->getRequest()->getLimitOffsetForUser().
 
 getLinkBatchFactory ()
 
 getMaxResults ()
 Get max number of results we can return in miser mode.
 
 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.
 
 linkParameters ()
 If using extra form wheely-dealies, return a set of parameters here as an associative array.
 
 openList ( $offset)
 
 setDatabaseProvider (IConnectionProvider $databaseProvider)
 
 setDBLoadBalancer (ILoadBalancer $loadBalancer)
 
 setLinkBatchFactory (LinkBatchFactory $linkBatchFactory)
 
 setListoutput ( $bool)
 A mutator for $this->listoutput;.
 
 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.
 
 sortDescending ()
 Override to sort by increasing values.
 
- Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links.
 
 afterExecute ( $subPage)
 Gets called after.
 
 authorizeAction (?string $action=null)
 Utility function for authorizing an action to be performed by the special page.
 
 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.
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have.
 
 getAuthManager ()
 
 getCacheTTL ()
 
 getHookContainer ()
 
 getHookRunner ()
 
 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.
 
 getSpecialPageFactory ()
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches.
 
 outputHeader ( $summaryMessageKey='')
 Outputs a summary message on top of special pages By default the message key is the canonical name of the special page May be overridden, i.e.
 
 prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
 Perform a regular substring search for prefixSearchSubpages.
 
 setAuthManager (AuthManager $authManager)
 Set the injected AuthManager from the special page constructor.
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes!
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication.
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed.
 

Protected Attributes

int $countPerType = 0
 Combined file count of all files in a section.
 
int $totalBytes = 0
 
int $totalCount = 0
 
int $totalPerType = 0
 Combined file size of all files in a section.
 
int $totalSize = 0
 Combined file size of all files.
 
- Protected Attributes inherited from MediaWiki\SpecialPage\QueryPage
string null false $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 MediaWiki\SpecialPage\SpecialPage
IContextSource $mContext
 Current request context.
 
bool $mIncludable
 Whether the special page can be included in an article.
 
bool $mIncluding
 Whether or not this special page is being included from an article.
 
string $mName
 The canonical name of this special page Also used as the message key for the default.
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone.
 

Additional Inherited Members

- Static Public Member Functions inherited from MediaWiki\SpecialPage\QueryPage
static getDisabledQueryPages (Config $config)
 Get a list of disabled query pages and their 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 MediaWiki\SpecialPage\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 newSearchPage (User $user)
 Get the users preferred search page.
 
- Static Protected Member Functions inherited from MediaWiki\SpecialPage\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).
 

Detailed Description

Implements Special:MediaStatistics.

Author
Brian Wolff

Definition at line 41 of file SpecialMediaStatistics.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Specials\SpecialMediaStatistics::__construct ( MimeAnalyzer $mimeAnalyzer,
IConnectionProvider $dbProvider,
LinkBatchFactory $linkBatchFactory )
Parameters
MimeAnalyzer$mimeAnalyzer
IConnectionProvider$dbProvider
LinkBatchFactory$linkBatchFactory

Definition at line 70 of file SpecialMediaStatistics.php.

References MediaWiki\Specials\SpecialMediaStatistics\MAX_LIMIT, MediaWiki\SpecialPage\QueryPage\setDatabaseProvider(), and MediaWiki\SpecialPage\QueryPage\setLinkBatchFactory().

Member Function Documentation

◆ formatResult()

MediaWiki\Specials\SpecialMediaStatistics::formatResult ( $skin,
$result )

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 from MediaWiki\SpecialPage\QueryPage.

Definition at line 385 of file SpecialMediaStatistics.php.

◆ getGroupName()

MediaWiki\Specials\SpecialMediaStatistics::getGroupName ( )
protected

What group to put the page in.

Returns
string

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 380 of file SpecialMediaStatistics.php.

◆ getOrderFields()

MediaWiki\Specials\SpecialMediaStatistics::getOrderFields ( )
protected

How to sort the results.

It's important that img_media_type come first, otherwise the tables will be fragmented.

Returns
array Fields to sort by

Reimplemented from MediaWiki\SpecialPage\QueryPage.

Definition at line 140 of file SpecialMediaStatistics.php.

◆ getQueryInfo()

MediaWiki\Specials\SpecialMediaStatistics::getQueryInfo ( )

Query to do.

This abuses the query cache table by storing mime types as "titles".

This will store entries like [[Media:BITMAP;image/jpeg;200;20000]] where the form is Media type;mime type;count;bytes.

This relies on the behaviour that when value is tied, the order things come out of querycache table is the order they went in. Which is hacky. However, other special pages like Special:Deadendpages and Special:BrokenRedirects also rely on this.

Returns
array

Reimplemented from MediaWiki\SpecialPage\QueryPage.

Definition at line 103 of file SpecialMediaStatistics.php.

References MediaWiki\SpecialPage\QueryPage\getDatabaseProvider(), and NS_MEDIA.

◆ getTableHeaderRow()

MediaWiki\Specials\SpecialMediaStatistics::getTableHeaderRow ( )
protected

Get (not output) the header row for the table.

Returns
string The header row of the table

Definition at line 322 of file SpecialMediaStatistics.php.

References $header, and MediaWiki\SpecialPage\SpecialPage\msg().

Referenced by MediaWiki\Specials\SpecialMediaStatistics\outputTableStart().

◆ isExpensive()

MediaWiki\Specials\SpecialMediaStatistics::isExpensive ( )

Should this query page only be updated offline on large wikis?

If the query for this page is considered too expensive to run on-demand for large wikis (e.g. every time the special page is viewed), then implement this as returning true.

"Large wikis" are those that enable $wgMiserMode. The value of ::isExpensive() has no effect by default when $wgMiserMode is off.

It is expected that such large wikis, periodically run the UpdateSpecialPages maintenance script to update these query pages.

By enabling $wgDisableQueryPages, all query pages will be considered as expensive and updated offline only, even query pages that do not mark themselves as expensive.

Stability: stable
to override
Returns
bool

Reimplemented from MediaWiki\SpecialPage\QueryPage.

Definition at line 85 of file SpecialMediaStatistics.php.

◆ makePercentPretty()

MediaWiki\Specials\SpecialMediaStatistics::makePercentPretty ( $decimal)
protected
Parameters
float$decimalA decimal percentage (ie for 12.3%, this would be 0.123)
Returns
string The percentage formatted so that 3 significant digits are shown.

Definition at line 260 of file SpecialMediaStatistics.php.

Referenced by MediaWiki\Specials\SpecialMediaStatistics\outputTableEnd(), and MediaWiki\Specials\SpecialMediaStatistics\outputTableRow().

◆ outputMediaType()

MediaWiki\Specials\SpecialMediaStatistics::outputMediaType ( $mediaType)
protected

Output a header for a new media type section.

Parameters
string$mediaTypeA media type (e.g. from the MEDIATYPE_xxx constants)

Definition at line 343 of file SpecialMediaStatistics.php.

References MediaWiki\Html\element(), MediaWiki\SpecialPage\SpecialPage\getOutput(), and MediaWiki\SpecialPage\SpecialPage\msg().

Referenced by MediaWiki\Specials\SpecialMediaStatistics\outputResults().

◆ outputResults()

MediaWiki\Specials\SpecialMediaStatistics::outputResults ( $out,
$skin,
$dbr,
$res,
$num,
$offset )
protected

◆ outputTableEnd()

◆ outputTableRow()

MediaWiki\Specials\SpecialMediaStatistics::outputTableRow ( $mime,
$count,
$bytes )
protected

Output a row of the stats table.

Parameters
string$mimemime type (e.g. image/jpeg)
int$countNumber of images of this type
int$bytesTotal space for images of this type

Definition at line 217 of file SpecialMediaStatistics.php.

References MediaWiki\SpecialPage\SpecialPage\getLinkRenderer(), MediaWiki\SpecialPage\SpecialPage\getOutput(), MediaWiki\SpecialPage\SpecialPage\getTitleFor(), MediaWiki\Specials\SpecialMediaStatistics\makePercentPretty(), and MediaWiki\SpecialPage\SpecialPage\msg().

Referenced by MediaWiki\Specials\SpecialMediaStatistics\outputResults().

◆ outputTableStart()

MediaWiki\Specials\SpecialMediaStatistics::outputTableStart ( $mediaType)
protected

Output the start of the table.

Including opening

and first

with column headers.

Parameters
string$mediaType

Definition at line 298 of file SpecialMediaStatistics.php.

References MediaWiki\SpecialPage\SpecialPage\getOutput(), and MediaWiki\Specials\SpecialMediaStatistics\getTableHeaderRow().

Referenced by MediaWiki\Specials\SpecialMediaStatistics\outputResults().

◆ preprocessResults()

MediaWiki\Specials\SpecialMediaStatistics::preprocessResults ( $dbr,
$res )

Initialize total values so we can figure out percentages later.

Parameters
IDatabase$dbr
IResultWrapper$res

Reimplemented from MediaWiki\SpecialPage\QueryPage.

Definition at line 395 of file SpecialMediaStatistics.php.

References MediaWiki\SpecialPage\QueryPage\executeLBFromResultWrapper().

Member Data Documentation

◆ $countPerType

int MediaWiki\Specials\SpecialMediaStatistics::$countPerType = 0
protected

Combined file count of all files in a section.

Definition at line 56 of file SpecialMediaStatistics.php.

◆ $totalBytes

int MediaWiki\Specials\SpecialMediaStatistics::$totalBytes = 0
protected

◆ $totalCount

int MediaWiki\Specials\SpecialMediaStatistics::$totalCount = 0
protected

◆ $totalPerType

int MediaWiki\Specials\SpecialMediaStatistics::$totalPerType = 0
protected

Combined file size of all files in a section.

Definition at line 51 of file SpecialMediaStatistics.php.

Referenced by MediaWiki\Specials\SpecialMediaStatistics\outputTableEnd().

◆ $totalSize

int MediaWiki\Specials\SpecialMediaStatistics::$totalSize = 0
protected

Combined file size of all files.

Definition at line 61 of file SpecialMediaStatistics.php.

◆ MAX_LIMIT

const MediaWiki\Specials\SpecialMediaStatistics::MAX_LIMIT = 5000

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