MediaWiki  master
SpecialLog Class Reference

A special page that lists log entries. More...

Inheritance diagram for SpecialLog:
Collaboration diagram for SpecialLog:

Public Member Functions

 __construct (LinkBatchFactory $linkBatchFactory, ILoadBalancer $loadBalancer, ActorNormalization $actorNormalization, UserIdentityLookup $userIdentityLookup)
 
 execute ( $par)
 Default execute method Checks user permissions. More...
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept. 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...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 getAuthority ()
 Shortcut to get the Authority executing this instance. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContentLanguage ()
 Shortcut to get content language. 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...
 
 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...
 
 setContentLanguage (Language $contentLanguage)
 Set content language. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 setSpecialPageFactory (SpecialPageFactory $specialPageFactory)
 
 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 getLogTypesOnUser (HookRunner $runner=null)
 List log type for which the target is a user Thus if the given target is in NS_MAIN we can alter it to be an NS_USER Title user instead. 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...
 

Protected Member Functions

 addHeader ( $type)
 Set page title and show header for this log type. More...
 
 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...
 
 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...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. More...
 
 getAuthManager ()
 
 getCacheTTL ()
 
 getHookContainer ()
 
 getHookRunner ()
 
 getLanguageConverter ()
 Shortcut to get language's converter. 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...
 
 getSpecialPageFactory ()
 
 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...
 
 prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setAuthManager (AuthManager $authManager)
 Set the injected AuthManager from the special page constructor. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Private Member Functions

 getActionButtons ( $formcontents)
 
 parseParams (FormOptions $opts, $par)
 Set options based on the subpage title parts: More...
 
 show (FormOptions $opts, array $extraConds)
 

Private Attributes

ActorNormalization $actorNormalization
 
LinkBatchFactory $linkBatchFactory
 
ILoadBalancer $loadBalancer
 
UserIdentityLookup $userIdentityLookup
 

Additional Inherited Members

- 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...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
bool $mIncludable
 Whether the special page can be included in an article. More...
 
bool $mIncluding
 Whether or not this special page is being included from an article. More...
 
string $mName
 The canonical name of this special page Also used for the default. More...
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone. More...
 

Detailed Description

A special page that lists log entries.

Definition at line 36 of file SpecialLog.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialLog::__construct ( LinkBatchFactory  $linkBatchFactory,
ILoadBalancer  $loadBalancer,
ActorNormalization  $actorNormalization,
UserIdentityLookup  $userIdentityLookup 
)
Parameters
LinkBatchFactory$linkBatchFactory
ILoadBalancer$loadBalancer
ActorNormalization$actorNormalization
UserIdentityLookup$userIdentityLookup

Definition at line 56 of file SpecialLog.php.

References $actorNormalization, $linkBatchFactory, $loadBalancer, and $userIdentityLookup.

Member Function Documentation

◆ addHeader()

SpecialLog::addHeader (   $type)
protected

Set page title and show header for this log type.

Parameters
string$type
Since
1.19

Definition at line 367 of file SpecialLog.php.

References $type, and SpecialPage\getOutput().

Referenced by show().

◆ execute()

SpecialLog::execute (   $subPage)

Default execute method Checks user permissions.

This must be overridden by subclasses; it will be made abstract in a future version

Stability: stable
to override
Parameters
string | null$subPage

Reimplemented from SpecialPage.

Definition at line 69 of file SpecialLog.php.

References $dbr, $type, FormOptions\add(), SpecialPage\addHelpLink(), DB_REPLICA, SpecialPage\getAuthority(), SpecialPage\getConfig(), SpecialPage\getHookRunner(), MWTimestamp\getInstance(), SpecialPage\getOutput(), SpecialPage\getRequest(), FormOptions\INTNULL, LogPage\isLogType(), Title\makeTitleSafe(), Title\newFromText(), NS_MAIN, NS_USER, SpecialPage\outputHeader(), parseParams(), SpecialPage\setHeaders(), and show().

◆ getActionButtons()

◆ getGroupName()

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

Stability: stable
to override
Returns
string
Since
1.21

Reimplemented from SpecialPage.

Definition at line 374 of file SpecialLog.php.

◆ getLogTypesOnUser()

static SpecialLog::getLogTypesOnUser ( HookRunner  $runner = null)
static

List log type for which the target is a user Thus if the given target is in NS_MAIN we can alter it to be an NS_USER Title user instead.

Since
1.25
1.36 Added $runner parameter
Parameters
HookRunner | null$runner
Returns
array

Definition at line 177 of file SpecialLog.php.

References Hooks\runner().

◆ getSubpagesForPrefixSearch()

SpecialLog::getSubpagesForPrefixSearch ( )

Return an array of subpages that this special page will accept.

Returns
string[] subpages

Reimplemented from SpecialPage.

Definition at line 197 of file SpecialLog.php.

References LogPage\validTypes().

◆ parseParams()

SpecialLog::parseParams ( FormOptions  $opts,
  $par 
)
private

Set options based on the subpage title parts:

  • One part that is a valid log type: Special:Log/logtype
  • Two parts: Special:Log/logtype/username
  • Otherwise, assume the whole subpage is a username.
Parameters
FormOptions$opts
string$par

Definition at line 213 of file SpecialLog.php.

References FormOptions\setValue(), and LogPage\validTypes().

Referenced by execute().

◆ show()

SpecialLog::show ( FormOptions  $opts,
array  $extraConds 
)
private

Member Data Documentation

◆ $actorNormalization

ActorNormalization SpecialLog::$actorNormalization
private

Definition at line 45 of file SpecialLog.php.

Referenced by __construct().

◆ $linkBatchFactory

LinkBatchFactory SpecialLog::$linkBatchFactory
private

Definition at line 39 of file SpecialLog.php.

Referenced by __construct().

◆ $loadBalancer

ILoadBalancer SpecialLog::$loadBalancer
private

Definition at line 42 of file SpecialLog.php.

Referenced by __construct().

◆ $userIdentityLookup

UserIdentityLookup SpecialLog::$userIdentityLookup
private

Definition at line 48 of file SpecialLog.php.

Referenced by __construct().


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