MediaWiki  REL1_24
SpecialLog Class Reference

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

Inheritance diagram for SpecialLog:
Collaboration diagram for SpecialLog:

List of all members.

Public Member Functions

 __construct ()
 execute ($par)
 Default execute method Checks user permissions.
 prefixSearchSubpages ($search, $limit=10)
 Return an array of subpages beginning with $search that this special page will accept.

Protected Member Functions

 addHeader ($type)
 Set page title and show header for this log type.
 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'.

Private Member Functions

 getRevisionButton ($formcontents)
 parseParams (FormOptions $opts, $par)
 show (FormOptions $opts, array $extraConds)

Private Attributes

 $typeOnUser
 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.

Detailed Description

A special page that lists log entries.

Definition at line 31 of file SpecialLog.php.


Constructor & Destructor Documentation

Definition at line 43 of file SpecialLog.php.


Member Function Documentation

SpecialLog::addHeader ( type) [protected]

Set page title and show header for this log type.

Parameters:
string$type
Since:
1.19

Definition at line 236 of file SpecialLog.php.

References $type, and SpecialPage\getOutput().

Referenced by show().

SpecialLog::execute ( subPage)

Default execute method Checks user permissions.

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

Parameters:
string | null$subPage

Reimplemented from SpecialPage.

Definition at line 47 of file SpecialLog.php.

References $type, FormOptions\add(), array(), false, SpecialPage\getConfig(), SpecialPage\getRequest(), SpecialPage\getUser(), FormOptions\INTNULL, IP\isIPAddress(), LogPage\isLogType(), Title\makeTitleSafe(), User\newFromName(), Title\newFromText(), SpecialPage\outputHeader(), parseParams(), SpecialPage\setHeaders(), show(), and wfRunHooks().

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

Returns:
string
Since:
1.21

Reimplemented from SpecialPage.

Definition at line 242 of file SpecialLog.php.

SpecialLog::parseParams ( FormOptions opts,
par 
) [private]

Definition at line 131 of file SpecialLog.php.

References array(), SpecialPage\getConfig(), and FormOptions\setValue().

Referenced by execute().

SpecialLog::prefixSearchSubpages ( search,
limit = 10 
)

Return an array of subpages beginning with $search that this special page will accept.

Parameters:
string$searchPrefix to search for
int$limitMaximum number of results to return
Returns:
string[] Matching subpages

Reimplemented from SpecialPage.

Definition at line 124 of file SpecialLog.php.

References $limit, SpecialPage\getConfig(), and SpecialPage\prefixSearchArray().


Member Data Documentation

SpecialLog::$typeOnUser [private]
Initial value:
 array(
        'block',
        'newusers',
        'rights',
    )

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.

Definition at line 37 of file SpecialLog.php.


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