MediaWiki  master
SpecialBlockList Class Reference

A special page that lists existing blocks. More...

Inheritance diagram for SpecialBlockList:
Collaboration diagram for SpecialBlockList:

Public Member Functions

 __construct (PermissionManager $permManager, LinkBatchFactory $linkBatchFactory, BlockRestrictionStore $blockRestrictionStore, ILoadBalancer $loadBalancer, SpecialPageFactory $specialPageFactory, ActorMigration $actorMigration, CommentStore $commentStore)
 
 execute ( $par)
 
- 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...
 
 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 Stable to override. 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}} Stable to override. More...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages Stable to override. 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...
 
 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...
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 

Protected Member Functions

 getBlockListPager ()
 Setup a new BlockListPager instance. More...
 
 getDB ()
 Return a IDatabase object for reading. 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...
 
 showList (BlockListPager $pager)
 Show the list of blocked accounts matching the actual filter. 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 Stable to override. More...
 
 getCacheTTL ()
 Stable to override. More...
 
 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...
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches. 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...
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! Stable to override. More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Protected Attributes

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

Private Attributes

ActorMigration $actorMigration
 
BlockRestrictionStore $blockRestrictionStore
 
CommentStore $commentStore
 
LinkBatchFactory $linkBatchFactory
 
ILoadBalancer $loadBalancer
 
PermissionManager $permManager
 
SpecialPageFactory $specialPageFactory
 

Additional Inherited Members

- 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

A special page that lists existing blocks.

Definition at line 38 of file SpecialBlockList.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialBlockList::__construct ( PermissionManager  $permManager,
LinkBatchFactory  $linkBatchFactory,
BlockRestrictionStore  $blockRestrictionStore,
ILoadBalancer  $loadBalancer,
SpecialPageFactory  $specialPageFactory,
ActorMigration  $actorMigration,
CommentStore  $commentStore 
)

Member Function Documentation

◆ execute()

◆ getBlockListPager()

SpecialBlockList::getBlockListPager ( )
protected

Setup a new BlockListPager instance.

Returns
BlockListPager

Definition at line 178 of file SpecialBlockList.php.

References $target, $type, getDB(), and LIST_OR.

Referenced by execute().

◆ getDB()

SpecialBlockList::getDB ( )
protected

Return a IDatabase object for reading.

Returns
IDatabase

Definition at line 312 of file SpecialBlockList.php.

References DB_REPLICA.

Referenced by getBlockListPager().

◆ getGroupName()

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

Stable to override

Returns
string
Since
1.21

Reimplemented from SpecialPage.

Definition at line 303 of file SpecialBlockList.php.

◆ showList()

SpecialBlockList::showList ( BlockListPager  $pager)
protected

Show the list of blocked accounts matching the actual filter.

Parameters
BlockListPager$pagerThe BlockListPager instance for this page

Definition at line 260 of file SpecialBlockList.php.

References Html\element(), TablePager\getFullOutput(), SpecialPage\getHookRunner(), IndexPager\getNumRows(), SpecialPage\getOutput(), SpecialPage\msg(), and Html\rawElement().

Referenced by execute().

Member Data Documentation

◆ $actorMigration

ActorMigration SpecialBlockList::$actorMigration
private

Definition at line 61 of file SpecialBlockList.php.

Referenced by __construct().

◆ $blockRestrictionStore

BlockRestrictionStore SpecialBlockList::$blockRestrictionStore
private

Definition at line 52 of file SpecialBlockList.php.

Referenced by __construct().

◆ $blockType

SpecialBlockList::$blockType
protected

Definition at line 43 of file SpecialBlockList.php.

◆ $commentStore

CommentStore SpecialBlockList::$commentStore
private

Definition at line 64 of file SpecialBlockList.php.

Referenced by __construct().

◆ $linkBatchFactory

LinkBatchFactory SpecialBlockList::$linkBatchFactory
private

Definition at line 49 of file SpecialBlockList.php.

Referenced by __construct().

◆ $loadBalancer

ILoadBalancer SpecialBlockList::$loadBalancer
private

Definition at line 55 of file SpecialBlockList.php.

Referenced by __construct().

◆ $options

SpecialBlockList::$options
protected

Definition at line 41 of file SpecialBlockList.php.

◆ $permManager

PermissionManager SpecialBlockList::$permManager
private

Definition at line 46 of file SpecialBlockList.php.

Referenced by __construct().

◆ $specialPageFactory

SpecialPageFactory SpecialBlockList::$specialPageFactory
private

Definition at line 58 of file SpecialBlockList.php.

Referenced by __construct().

◆ $target

SpecialBlockList::$target
protected

Definition at line 39 of file SpecialBlockList.php.

Referenced by execute(), and getBlockListPager().


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