MediaWiki  1.23.0
SpecialActiveUsers Class Reference
Inheritance diagram for SpecialActiveUsers:
Collaboration diagram for SpecialActiveUsers:

Public Member Functions

 __construct ()
 Constructor. More...
 
 execute ( $par)
 Show the special page. 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...
 
 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...
 
 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 cacheUpdate (DatabaseBase $dbw)
 
static mergeActiveUsers ( $period)
 
- 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 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...
 

Static Protected Member Functions

static doQueryCacheUpdate (DatabaseBase $dbw, $window)
 Update the query cache as needed. More...
 

Additional Inherited Members

- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 

Detailed Description

Definition at line 218 of file SpecialActiveusers.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialActiveUsers::__construct ( )

Constructor.

Definition at line 223 of file SpecialActiveusers.php.

Member Function Documentation

◆ cacheUpdate()

static SpecialActiveUsers::cacheUpdate ( DatabaseBase  $dbw)
static
Parameters
DatabaseBase$dbwPassed in from updateSpecialPages.php
Returns
void

Definition at line 301 of file SpecialActiveusers.php.

References doQueryCacheUpdate(), and global.

◆ doQueryCacheUpdate()

static SpecialActiveUsers::doQueryCacheUpdate ( DatabaseBase  $dbw,
  $window 
)
staticprotected

Update the query cache as needed.

Parameters
DatabaseBase$dbw
integer$windowMaximum time range of new data to scan (in seconds)
Returns
bool Success

Definition at line 314 of file SpecialActiveusers.php.

References $name, $res, DatabaseBase\addQuotes(), array(), as, DatabaseBase\delete(), global, DatabaseBase\insert(), DatabaseBase\lock(), NS_USER, RC_EXTERNAL, DatabaseBase\replace(), DatabaseBase\select(), DatabaseBase\selectField(), DatabaseBase\timestamp(), TS_UNIX, DatabaseBase\unlock(), wfTimestamp(), wfWaitForSlaves(), and wfWikiID().

Referenced by cacheUpdate(), and mergeActiveUsers().

◆ execute()

SpecialActiveUsers::execute (   $par)

Show the special page.

Parameters
$parMixed: parameter passed to the page or null

Reimplemented from SpecialPage.

Definition at line 232 of file SpecialActiveusers.php.

References $out, array(), SpecialPage\getContext(), SpecialPage\getLanguage(), SpecialPage\getOutput(), global, SpecialPage\outputHeader(), Html\rawElement(), and SpecialPage\setHeaders().

◆ getGroupName()

SpecialActiveUsers::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 265 of file SpecialActiveusers.php.

◆ mergeActiveUsers()

static SpecialActiveUsers::mergeActiveUsers (   $period)
static
Parameters
integer$periodSeconds (do updates no more often than this)
Returns
integer How many seconds old the cache is

Definition at line 273 of file SpecialActiveusers.php.

References $dbr, array(), DB_MASTER, DB_SLAVE, doQueryCacheUpdate(), global, TS_UNIX, wfGetDB(), wfReadOnly(), and wfTimestamp().


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