MediaWiki  master
MediaWiki\Block\BlockActionInfo Class Reference

Defines the actions that can be blocked by a partial block. More...

Collaboration diagram for MediaWiki\Block\BlockActionInfo:

Public Member Functions

 __construct (HookContainer $hookContainer)
 
 getActionFromId (int $actionId)
 
 getAllBlockActions ()
 
 getIdFromAction (string $action)
 

Private Attributes

int[] null $allBlockActions = null
 Cache the array of actions. More...
 
HookRunner $hookRunner
 

Detailed Description

Defines the actions that can be blocked by a partial block.

They are always blocked by a sitewide block.

NB: The terms "right" and "action" are often used to describe the same string, depending on the context. E.g. a querystring might contain 'action=edit', but the PermissionManager will refer to the 'edit' right.

Here, we use "action", since a user may be in a group that has a certain right, while also being blocked from performing that action.

Since
1.37

Definition at line 40 of file BlockActionInfo.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Block\BlockActionInfo::__construct ( HookContainer  $hookContainer)
Parameters
HookContainer$hookContainer

Definition at line 77 of file BlockActionInfo.php.

Member Function Documentation

◆ getActionFromId()

MediaWiki\Block\BlockActionInfo::getActionFromId ( int  $actionId)
Parameters
int$actionId
Returns
string|false

Definition at line 106 of file BlockActionInfo.php.

References MediaWiki\Block\BlockActionInfo\getAllBlockActions().

◆ getAllBlockActions()

MediaWiki\Block\BlockActionInfo::getAllBlockActions ( )

◆ getIdFromAction()

MediaWiki\Block\BlockActionInfo::getIdFromAction ( string  $action)
Parameters
string$action
Returns
int|bool False if the action is not in the list of blockable actions

Definition at line 114 of file BlockActionInfo.php.

References MediaWiki\$action, and MediaWiki\Block\BlockActionInfo\getAllBlockActions().

Member Data Documentation

◆ $allBlockActions

int [] null MediaWiki\Block\BlockActionInfo::$allBlockActions = null
private

Cache the array of actions.

Definition at line 85 of file BlockActionInfo.php.

Referenced by MediaWiki\Block\BlockActionInfo\getAllBlockActions().

◆ $hookRunner

HookRunner MediaWiki\Block\BlockActionInfo::$hookRunner
private

Definition at line 42 of file BlockActionInfo.php.


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