MediaWiki  master
SpecialMediaStatistics Class Reference
Inheritance diagram for SpecialMediaStatistics:
Collaboration diagram for SpecialMediaStatistics:

Public Member Functions

 __construct ( $name='MediaStatistics')
 
 formatResult ( $skin, $result)
 This method isn't used, since we override outputResults, but we need to implement since abstract in parent class. More...
 
 getOrderFields ()
 How to sort the results. More...
 
 getQueryInfo ()
 Query to do. More...
 
 isExpensive ()
 
 preprocessResults ( $dbr, $res)
 Initialize total values so we can figure out percentages later. More...
 
- Public Member Functions inherited from QueryPage
 closeList ()
 
 delete (LinkTarget $title)
 Remove a cached result. More...
 
 doQuery ( $offset=false, $limit=false)
 Somewhat deprecated, you probably want to be using execute() More...
 
 execute ( $par)
 This is the actual workhorse. More...
 
 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 ()
 
 getCacheOrderFields ()
 Return the order fields for fetchFromCache. More...
 
 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...
 
 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='', $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...
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. 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...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 execute ( $subPage)
 Default execute method Checks user permissions. More...
 
 getConfig ()
 Shortcut to get main config object. 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...
 
 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...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 getLinkRenderer ()
 
 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...
 
 getUser ()
 Shortcut to get the User executing this instance. More...
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion. More...
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode. More...
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. 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...
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included. More...
 
 msg ( $key,... $params)
 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...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 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...
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 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...
 

Public Attributes

 $totalBytes = 0
 

Protected Member Functions

 getGroupName ()
 What group to put the page in. More...
 
 getTableHeaderRow ()
 Get (not output) the header row for the table. More...
 
 makePercentPretty ( $decimal)
 
 outputMediaType ( $mediaType)
 Output a header for a new media type section. More...
 
 outputResults ( $out, $skin, $dbr, $res, $num, $offset)
 Output the results of the query. More...
 
 outputTableEnd ()
 Output closing More...
 
 outputTableRow ( $mime, $count, $bytes)
 Output a row of the stats table. More...
 
 outputTableStart ( $mediaType)
 Output the start of the table. More...
 
- 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. More...
 
 getDBLimit ( $uiLimit, $uiOffset)
 What is limit to fetch from DB. More...
 
 getLimitOffset ()
 Returns limit and offset, as returned by $this->getRequest()->getLimitOffset(). More...
 
 getMaxResults ()
 Get max number of results we can return in miser mode. More...
 
 outputResults ( $out, $skin, $dbr, $res, $num, $offset)
 Format and output report results using the given information plus OutputPage. More...
 
 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. 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...
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 getCacheTTL ()
 
 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...
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. More...
 
 getRobotPolicy ()
 Return the robot policy. More...
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches. More...
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Protected Attributes

 $totalCount = 0
 
 $totalPerType = 0
 
 $totalSize = 0
 
- 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. More...
 
int $numRows
 The number of rows returned by the query. More...
 
int $offset = 0
 The offset and limit in use, as passed to the query() function. More...
 
bool $shownavigation = true
 Whether to show prev/next links. More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Private Member Functions

 getExtensionList ( $mime)
 Given a mime type, return a comma separated list of allowed extensions. More...
 
 splitFakeTitle ( $fakeTitle)
 parse the fake title format that this special page abuses querycache with. More...
 

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. More...
 
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 If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below. More...
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name. More...
 
- 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). More...
 

Detailed Description

Definition at line 31 of file SpecialMediaStatistics.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialMediaStatistics::__construct (   $name = 'MediaStatistics')

Definition at line 44 of file SpecialMediaStatistics.php.

Member Function Documentation

◆ formatResult()

SpecialMediaStatistics::formatResult (   $skin,
  $result 
)

This method isn't used, since we override outputResults, but we need to implement since abstract in parent class.

Parameters
Skin$skin
stdClass$resultResult row
Returns
bool|string|void
Exceptions
MWException

Definition at line 358 of file SpecialMediaStatistics.php.

◆ getExtensionList()

SpecialMediaStatistics::getExtensionList (   $mime)
private

Given a mime type, return a comma separated list of allowed extensions.

Parameters
string$mimemime type
Returns
string Comma separated list of allowed extensions (e.g. ".ogg, .oga")

Definition at line 242 of file SpecialMediaStatistics.php.

References $ext, MediaWiki\MediaWikiServices\getInstance(), and SpecialPage\getLanguage().

Referenced by outputTableRow().

◆ getGroupName()

SpecialMediaStatistics::getGroupName ( )
protected

What group to put the page in.

Returns
string

Definition at line 345 of file SpecialMediaStatistics.php.

◆ getOrderFields()

SpecialMediaStatistics::getOrderFields ( )

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

Definition at line 107 of file SpecialMediaStatistics.php.

◆ getQueryInfo()

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

Definition at line 70 of file SpecialMediaStatistics.php.

References $dbr, DB_REPLICA, NS_MEDIA, and wfGetDB().

◆ getTableHeaderRow()

SpecialMediaStatistics::getTableHeaderRow ( )
protected

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

Returns
string The header row of the table

Definition at line 287 of file SpecialMediaStatistics.php.

References $header, SpecialPage\msg(), and Html\rawElement().

Referenced by outputTableStart().

◆ isExpensive()

SpecialMediaStatistics::isExpensive ( )

Definition at line 52 of file SpecialMediaStatistics.php.

◆ makePercentPretty()

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 222 of file SpecialMediaStatistics.php.

Referenced by outputTableEnd(), and outputTableRow().

◆ outputMediaType()

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 308 of file SpecialMediaStatistics.php.

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

Referenced by outputResults().

◆ outputResults()

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

Output the results of the query.

Parameters
OutputPage$out
Skin$skin(deprecated presumably)
IDatabase$dbr
IResultWrapper$resResults from query
int$numNumber of results
int$offsetPaging offset (Should always be 0 in our case)

Definition at line 121 of file SpecialMediaStatistics.php.

References $res, $totalBytes, $totalCount, SpecialPage\getOutput(), SpecialPage\msg(), outputMediaType(), outputTableEnd(), outputTableRow(), outputTableStart(), and splitFakeTitle().

◆ outputTableEnd()

SpecialMediaStatistics::outputTableEnd ( )
protected

◆ outputTableRow()

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 180 of file SpecialMediaStatistics.php.

References SpecialPage\$linkRenderer, getExtensionList(), SpecialPage\getLinkRenderer(), SpecialPage\getOutput(), SpecialPage\getTitleFor(), makePercentPretty(), SpecialPage\msg(), and Html\rawElement().

Referenced by outputResults().

◆ outputTableStart()

SpecialMediaStatistics::outputTableStart (   $mediaType)
protected

Output the start of the table.

Including opening

and first

with column headers.

Parameters
string$mediaType

Definition at line 263 of file SpecialMediaStatistics.php.

References SpecialPage\getOutput(), getTableHeaderRow(), Html\openElement(), and Html\rawElement().

Referenced by outputResults().

◆ preprocessResults()

SpecialMediaStatistics::preprocessResults (   $dbr,
  $res 
)

Initialize total values so we can figure out percentages later.

Parameters
IDatabase$dbr
IResultWrapper$res

Definition at line 368 of file SpecialMediaStatistics.php.

References $res, QueryPage\executeLBFromResultWrapper(), and splitFakeTitle().

◆ splitFakeTitle()

SpecialMediaStatistics::splitFakeTitle (   $fakeTitle)
private

parse the fake title format that this special page abuses querycache with.

Parameters
string$fakeTitleA string formatted as <media type>="">;<mime type>="">;<count>;<bytes>
Returns
array The constituant parts of $fakeTitle

Definition at line 337 of file SpecialMediaStatistics.php.

Referenced by outputResults(), and preprocessResults().

Member Data Documentation

◆ $totalBytes

SpecialMediaStatistics::$totalBytes = 0

Definition at line 32 of file SpecialMediaStatistics.php.

Referenced by outputResults().

◆ $totalCount

SpecialMediaStatistics::$totalCount = 0
protected

Definition at line 32 of file SpecialMediaStatistics.php.

Referenced by outputResults().

◆ $totalPerType

SpecialMediaStatistics::$totalPerType = 0
protected

Definition at line 37 of file SpecialMediaStatistics.php.

Referenced by outputTableEnd().

◆ $totalSize

SpecialMediaStatistics::$totalSize = 0
protected

Definition at line 42 of file SpecialMediaStatistics.php.


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