MediaWiki  master
MediaWiki\Block\SystemBlock Class Reference

System blocks are temporary blocks that are created on enforcement (e.g. More...

Inheritance diagram for MediaWiki\Block\SystemBlock:
Collaboration diagram for MediaWiki\Block\SystemBlock:

Public Member Functions

 __construct (array $options=[])
 Create a new block with specified parameters on a user, IP or IP range. More...
 
 appliesToPasswordReset ()
 Check if the block prevents a user from resetting their password.
Since
1.33
Returns
bool The block blocks password reset
More...
 
 getBlocker ()
 Get the user who applied this block.
Returns
UserIdentity|null user identity or null. May be an external user.
More...
 
 getBy ()
 Get the user id of the blocking sysop.
Returns
int (0 for foreign users)
More...
 
 getByName ()
 Get the username of the blocking sysop.
Returns
string
More...
 
 getIdentifier ()
 Get the information that identifies this block, such that a user could look up everything that can be found about this block.Typically a scalar ID (integer or string), but can also return a list of IDs, or an associative array encoding a composite ID. Must be safe to serialize as JSON.
Returns
mixed Identifying information
More...
 
 getSystemBlockType ()
 Get the system block type, if any. More...
 
- Public Member Functions inherited from MediaWiki\Block\AbstractBlock
 appliesToNamespace ( $ns)
 Checks if a block applies to a particular namespace. More...
 
 appliesToPage ( $pageId)
 Checks if a block applies to a particular page. More...
 
 appliesToRight ( $right)
 Determine whether the block prevents a given right. More...
 
 appliesToTitle (Title $title)
 Checks if a block applies to a particular title. More...
 
 appliesToUsertalk (Title $usertalk=null)
 Determine whether the block allows the user to edit their own user talk page. More...
 
 getExpiry ()
 Get the block expiry time. More...
 
 getHideName ()
 Get whether the block hides the target's username. More...
 
 getId ()
 Get the block ID. More...
 
 getPermissionsError (IContextSource $context)
 Get the key and parameters for the corresponding error message. More...
 
 getReason ()
 Get the reason given for creating the block, as a string. More...
 
 getReasonComment ()
 Get the reason for creating the block. More...
 
 getTarget ()
 Get the target for this particular block. More...
 
 getTargetAndType ()
 Get the target and target type for this particular block. More...
 
 getTargetName ()
 
 getTargetUserIdentity ()
 
 getTimestamp ()
 Get the timestamp indicating when the block was created. More...
 
 getType ()
 Get the type of target for this particular block. More...
 
 isBlocking ( $target)
 
 isCreateAccountBlocked ( $x=null)
 Get or set the flag indicating whether this block blocks the target from creating an account. More...
 
 isEmailBlocked ( $x=null)
 Get or set the flag indicating whether this block blocks the target from sending emails. More...
 
 isHardblock ( $x=null)
 Get/set whether the block is a hardblock (affects logged-in users on a given IP/range) More...
 
 isSitewide ( $x=null)
 Indicates that the block is a sitewide block. More...
 
 isUsertalkEditAllowed ( $x=null)
 Get or set the flag indicating whether this block blocks the target from editing their own user talk page. More...
 
 setExpiry ( $expiry)
 Set the block expiry time. More...
 
 setHideName ( $hideName)
 Set whether ths block hides the target's username. More...
 
 setReason ( $reason)
 Set the reason for creating the block. More...
 
 setTarget ( $target)
 Set the target for this block, and update $this->type accordingly. More...
 
 setTimestamp ( $timestamp)
 Set the timestamp indicating when the block was created. More...
 
- Public Member Functions inherited from MediaWiki\Block\Block
 isCreateAccountBlocked ()
 Get the flag indicating whether this block blocks the target from creating an account. More...
 
 isHardblock ()
 Returns whether the block is a hardblock (affects logged-in users on a given IP/range) More...
 
 isSitewide ()
 Indicates that the block is a sitewide block. More...
 

Private Attributes

string null $systemBlockType
 

Additional Inherited Members

- Public Attributes inherited from MediaWiki\Block\AbstractBlock
string $mExpiry = ''
 
bool $mHideName = false
 
string $mTimestamp = ''
 
- Public Attributes inherited from MediaWiki\Block\Block
const TYPE_AUTO = 4
 
const TYPE_ID = 5
 
const TYPE_IP = 2
 
const TYPE_RANGE = 3
 
const TYPE_USER = 1
 
- Protected Attributes inherited from MediaWiki\Block\AbstractBlock
bool $allowUsertalk = false
 
bool $blockCreateAccount = false
 
bool $isHardblock
 
bool $isSitewide = true
 
bool $mBlockEmail = false
 
CommentStoreComment $reason
 
UserIdentity string null $target
 
int null $type
 AbstractBlock::TYPE_ constant. More...
 

Detailed Description

System blocks are temporary blocks that are created on enforcement (e.g.

from IP lists) and are not saved to the database. The target of a system block is an IP address. System blocks do not give rise to autoblocks and are not tracked with cookies.

Since
1.34

Definition at line 35 of file SystemBlock.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Block\SystemBlock::__construct ( array  $options = [])

Create a new block with specified parameters on a user, IP or IP range.

Parameters
array$optionsParameters of the block, with options supported by AbstractBlock::__construct, and also:
  • systemBlock: (string) Indicate that this block is automatically created by MediaWiki rather than being stored in the database. Value is a string to return from self::getSystemBlockType().

Reimplemented from MediaWiki\Block\AbstractBlock.

Definition at line 48 of file SystemBlock.php.

Member Function Documentation

◆ appliesToPasswordReset()

MediaWiki\Block\SystemBlock::appliesToPasswordReset ( )

Check if the block prevents a user from resetting their password.

Since
1.33
Returns
bool The block blocks password reset

Reimplemented from MediaWiki\Block\AbstractBlock.

Definition at line 84 of file SystemBlock.php.

References MediaWiki\Block\SystemBlock\getSystemBlockType(), and MediaWiki\Block\Block\isCreateAccountBlocked().

◆ getBlocker()

MediaWiki\Block\SystemBlock::getBlocker ( )

Get the user who applied this block.

Returns
UserIdentity|null user identity or null. May be an external user.

Implements MediaWiki\Block\Block.

Definition at line 116 of file SystemBlock.php.

◆ getBy()

MediaWiki\Block\SystemBlock::getBy ( )

Get the user id of the blocking sysop.

Returns
int (0 for foreign users)

Reimplemented from MediaWiki\Block\AbstractBlock.

Definition at line 102 of file SystemBlock.php.

◆ getByName()

MediaWiki\Block\SystemBlock::getByName ( )

Get the username of the blocking sysop.

Returns
string

Reimplemented from MediaWiki\Block\AbstractBlock.

Definition at line 109 of file SystemBlock.php.

◆ getIdentifier()

MediaWiki\Block\SystemBlock::getIdentifier ( )

Get the information that identifies this block, such that a user could look up everything that can be found about this block.Typically a scalar ID (integer or string), but can also return a list of IDs, or an associative array encoding a composite ID. Must be safe to serialize as JSON.

Returns
mixed Identifying information

Implements MediaWiki\Block\Block.

Definition at line 77 of file SystemBlock.php.

References MediaWiki\Block\SystemBlock\getSystemBlockType().

◆ getSystemBlockType()

MediaWiki\Block\SystemBlock::getSystemBlockType ( )

Get the system block type, if any.

A SystemBlock can have the following types:

  • 'proxy': the IP is listed in $wgProxyList
  • 'dnsbl': the IP is associated with a listed domain in $wgDnsBlacklistUrls
  • 'wgSoftBlockRanges': the IP is covered by $wgSoftBlockRanges
  • 'global-block': for backwards compatibility with the UserIsBlockedGlobally hook
Since
1.29
Returns
string|null

Definition at line 70 of file SystemBlock.php.

References MediaWiki\Block\SystemBlock\$systemBlockType.

Referenced by MediaWiki\Block\SystemBlock\appliesToPasswordReset(), and MediaWiki\Block\SystemBlock\getIdentifier().

Member Data Documentation

◆ $systemBlockType

string null MediaWiki\Block\SystemBlock::$systemBlockType
private

Definition at line 37 of file SystemBlock.php.

Referenced by MediaWiki\Block\SystemBlock\getSystemBlockType().


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