MediaWiki master
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
MediaWiki\Block\Restriction\AbstractRestriction Class Reference

Inherits MediaWiki\Block\Restriction\Restriction.

Inherited by MediaWiki\Block\Restriction\ActionRestriction, MediaWiki\Block\Restriction\NamespaceRestriction, and MediaWiki\Block\Restriction\PageRestriction.

Collaboration diagram for MediaWiki\Block\Restriction\AbstractRestriction:
Collaboration graph
[legend]

Public Member Functions

 __construct ( $blockId, $value)
 Create Restriction.
 
 equals (Restriction $other)
 Determine if a restriction equals another restriction.
Since
1.33
Parameters
Restriction$other
Returns
bool

 
 getBlockId ()
 Get the ID of the block.
Since
1.33
Returns
int

 
 getHash ()
 Create a unique hash of the block restriction based on the type and value.
Since
1.33
Returns
string

 
 getValue ()
 Get the value of the restriction.
Since
1.33
Returns
int

 
 setBlockId ( $blockId)
 Set the ID of the block.
Since
1.33
Parameters
int$blockId
Returns
self

 
 toRow ()
 Convert a restriction object into a row array for insertion.
Since
1.33
Returns
array

 
- Public Member Functions inherited from MediaWiki\Block\Restriction\Restriction
 matches (Title $title)
 Determine if a restriction matches a given title.
 

Static Public Member Functions

static getType ()
 Get the type of restriction.
Since
1.33
Returns
string

 
static getTypeId ()
 Get the ID of the type of restriction.This ID is used in the database.
Since
1.33
Returns
int

 
static newFromRow (\stdClass $row)
 Create a new Restriction from a database row.
Since
1.33
Parameters
\\stdClass$row
Returns
static

 

Public Attributes

const TYPE = ''
 String constant identifying the type of restriction.
 
const TYPE_ID = 0
 Numeric type identifier.
 

Protected Attributes

int $blockId
 
int $value
 

Detailed Description

Definition at line 25 of file AbstractRestriction.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Block\Restriction\AbstractRestriction::__construct ( $blockId,
$value )

Create Restriction.

Since
1.33
Parameters
int$blockId
int$value

Definition at line 56 of file AbstractRestriction.php.

References MediaWiki\Block\Restriction\AbstractRestriction\$blockId, and MediaWiki\Block\Restriction\AbstractRestriction\$value.

Member Function Documentation

◆ equals()

MediaWiki\Block\Restriction\AbstractRestriction::equals ( Restriction $other)

Determine if a restriction equals another restriction.

Since
1.33
Parameters
Restriction$other
Returns
bool

Implements MediaWiki\Block\Restriction\Restriction.

Definition at line 120 of file AbstractRestriction.php.

References MediaWiki\Block\Restriction\AbstractRestriction\getHash(), and MediaWiki\Block\Restriction\Restriction\getHash().

◆ getBlockId()

MediaWiki\Block\Restriction\AbstractRestriction::getBlockId ( )

Get the ID of the block.

Since
1.33
Returns
int

Implements MediaWiki\Block\Restriction\Restriction.

Definition at line 78 of file AbstractRestriction.php.

References MediaWiki\Block\Restriction\AbstractRestriction\$blockId.

Referenced by MediaWiki\Block\Restriction\AbstractRestriction\toRow().

◆ getHash()

MediaWiki\Block\Restriction\AbstractRestriction::getHash ( )

Create a unique hash of the block restriction based on the type and value.

Since
1.33
Returns
string

Implements MediaWiki\Block\Restriction\Restriction.

Definition at line 127 of file AbstractRestriction.php.

References MediaWiki\Block\Restriction\AbstractRestriction\getType(), and MediaWiki\Block\Restriction\AbstractRestriction\getValue().

Referenced by MediaWiki\Block\Restriction\AbstractRestriction\equals().

◆ getType()

static MediaWiki\Block\Restriction\AbstractRestriction::getType ( )
static

Get the type of restriction.

Since
1.33
Returns
string

Implements MediaWiki\Block\Restriction\Restriction.

Definition at line 64 of file AbstractRestriction.php.

Referenced by MediaWiki\Block\Restriction\AbstractRestriction\getHash().

◆ getTypeId()

static MediaWiki\Block\Restriction\AbstractRestriction::getTypeId ( )
static

Get the ID of the type of restriction.This ID is used in the database.

Since
1.33
Returns
int

Implements MediaWiki\Block\Restriction\Restriction.

Definition at line 71 of file AbstractRestriction.php.

Referenced by MediaWiki\Block\Restriction\AbstractRestriction\toRow().

◆ getValue()

MediaWiki\Block\Restriction\AbstractRestriction::getValue ( )

Get the value of the restriction.

Since
1.33
Returns
int

Implements MediaWiki\Block\Restriction\Restriction.

Definition at line 94 of file AbstractRestriction.php.

References MediaWiki\Block\Restriction\AbstractRestriction\$value.

Referenced by MediaWiki\Block\Restriction\AbstractRestriction\getHash(), MediaWiki\Block\Restriction\NamespaceRestriction\matches(), and MediaWiki\Block\Restriction\AbstractRestriction\toRow().

◆ newFromRow()

static MediaWiki\Block\Restriction\AbstractRestriction::newFromRow ( \stdClass $row)
static

Create a new Restriction from a database row.

Since
1.33
Parameters
\\stdClass$row
Returns
static

Implements MediaWiki\Block\Restriction\Restriction.

Reimplemented in MediaWiki\Block\Restriction\PageRestriction.

Definition at line 101 of file AbstractRestriction.php.

◆ setBlockId()

MediaWiki\Block\Restriction\AbstractRestriction::setBlockId ( $blockId)

Set the ID of the block.

Since
1.33
Parameters
int$blockId
Returns
self

Implements MediaWiki\Block\Restriction\Restriction.

Definition at line 85 of file AbstractRestriction.php.

References MediaWiki\Block\Restriction\AbstractRestriction\$blockId.

◆ toRow()

MediaWiki\Block\Restriction\AbstractRestriction::toRow ( )

Convert a restriction object into a row array for insertion.

Since
1.33
Returns
array

Implements MediaWiki\Block\Restriction\Restriction.

Definition at line 109 of file AbstractRestriction.php.

References MediaWiki\Block\Restriction\AbstractRestriction\getBlockId(), MediaWiki\Block\Restriction\AbstractRestriction\getTypeId(), and MediaWiki\Block\Restriction\AbstractRestriction\getValue().

Member Data Documentation

◆ $blockId

int MediaWiki\Block\Restriction\AbstractRestriction::$blockId
protected

Definition at line 42 of file AbstractRestriction.php.

Referenced by MediaWiki\Block\Restriction\AbstractRestriction\__construct(), MediaWiki\Block\Restriction\AbstractRestriction\getBlockId(), and MediaWiki\Block\Restriction\AbstractRestriction\setBlockId().

◆ $value

int MediaWiki\Block\Restriction\AbstractRestriction::$value
protected

Definition at line 47 of file AbstractRestriction.php.

Referenced by MediaWiki\Block\Restriction\AbstractRestriction\__construct(), and MediaWiki\Block\Restriction\AbstractRestriction\getValue().

◆ TYPE

const MediaWiki\Block\Restriction\AbstractRestriction::TYPE = ''

String constant identifying the type of restriction.

Expected to be overridden in subclasses with a non-empty string value.

Definition at line 31 of file AbstractRestriction.php.

◆ TYPE_ID

const MediaWiki\Block\Restriction\AbstractRestriction::TYPE_ID = 0

Numeric type identifier.

Expected to be overridden in subclasses with a non-zero integer number. Must not exceed 127 to fit into a TINYINT database field.

Definition at line 37 of file AbstractRestriction.php.

Referenced by MediaWiki\Specials\SpecialUnblock\execute().

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