MediaWiki master
MediaWiki\Block\BlockPermissionChecker Class Reference

Block permissions. More...

Public Member Functions

 __construct (ServiceOptions $options, BlockUtils $blockUtils, $target, Authority $performer)
 
 checkBasePermissions ( $checkHideuser=false)
 Check the base permission that applies to either block or unblock.
 
 checkBlockPermissions ()
 Checks block-related permissions (doesn't check any other permissions)
 
 checkEmailPermissions ()
 Check permission to block emailing.
 

Public Attributes

const CONSTRUCTOR_OPTIONS
 

Detailed Description

Block permissions.

This class is responsible for making sure a user has permission to block.

This class is usable for both blocking and unblocking.

Since
1.35

Definition at line 38 of file BlockPermissionChecker.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Block\BlockPermissionChecker::__construct ( ServiceOptions $options,
BlockUtils $blockUtils,
$target,
Authority $performer )
Parameters
ServiceOptions$options
BlockUtils$blockUtils
UserIdentity | string | null$target
Authority$performer

Definition at line 64 of file BlockPermissionChecker.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions(), and MediaWiki\Block\BlockUtils\parseBlockTarget().

Member Function Documentation

◆ checkBasePermissions()

MediaWiki\Block\BlockPermissionChecker::checkBasePermissions ( $checkHideuser = false)

Check the base permission that applies to either block or unblock.

Since
1.36
Parameters
bool$checkHideuser
Returns
bool|string

Definition at line 83 of file BlockPermissionChecker.php.

◆ checkBlockPermissions()

MediaWiki\Block\BlockPermissionChecker::checkBlockPermissions ( )

Checks block-related permissions (doesn't check any other permissions)

T17810: Site-wide blocked admins should not be able to block/unblock others with one exception; they can block the user who blocked them, to reduce advantage of a malicious account blocking all admins (T150826).

T208965: Partially blocked admins can block and unblock others as normal.

Returns
bool|string True when checks passed, message code for failures

Definition at line 109 of file BlockPermissionChecker.php.

References MediaWiki\User\UserIdentity\equals(), and MediaWiki\User\UserIdentity\getId().

◆ checkEmailPermissions()

MediaWiki\Block\BlockPermissionChecker::checkEmailPermissions ( )

Check permission to block emailing.

Since
1.36
Returns
bool

Definition at line 161 of file BlockPermissionChecker.php.

References MediaWiki\MainConfigNames\EnableUserEmail.

Member Data Documentation

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\Block\BlockPermissionChecker::CONSTRUCTOR_OPTIONS
Initial value:
= [
]
const EnableUserEmail
Name constant for the EnableUserEmail setting, for use with Config::get()
Access: internal
only for use by ServiceWiring and BlockPermissionCheckerFactory

Definition at line 52 of file BlockPermissionChecker.php.


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