MediaWiki  master
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
MediaWiki\Block\Restriction\PageRestriction Class Reference
Inheritance diagram for MediaWiki\Block\Restriction\PageRestriction:
Inheritance graph
[legend]
Collaboration diagram for MediaWiki\Block\Restriction\PageRestriction:
Collaboration graph
[legend]

Public Member Functions

 getTitle ()
 
 matches (Title $title)
 Determine if a restriction matches a given title.
Since
1.33
Parameters
Title$title
Returns
bool
More...
 
 setTitle (Title $title)
 
- Public Member Functions inherited from MediaWiki\Block\Restriction\AbstractRestriction
 __construct ( $blockId, $value)
 Create Restriction. More...
 
 equals (Restriction $other)
 Determine if a restriction equals another restriction.
Since
1.33
Parameters
Restriction$other
Returns
bool
More...
 
 getBlockId ()
 Get the ID of the block.
Since
1.33
Returns
int
More...
 
 getHash ()
 Create a unique hash of the block restriction based on the type and value.
Since
1.33
Returns
string
More...
 
 getValue ()
 Get the value of the restriction.
Since
1.33
Returns
int
More...
 
 setBlockId ( $blockId)
 Set the ID of the block.
Since
1.33
Parameters
int$blockId
Returns
self
More...
 
 toRow ()
 Convert a restriction object into a row array for insertion.
Since
1.33
Returns
array
More...
 

Static Public Member Functions

static newFromRow (\stdClass $row)
 Create a new Restriction from a database row.
Since
1.33
Parameters
\\stdClass$row
Returns
static
More...
 
static newFromTitle ( $title)
 
- Static Public Member Functions inherited from MediaWiki\Block\Restriction\AbstractRestriction
static getType ()
 Get the type of restriction.
Since
1.33
Returns
string
More...
 
static getTypeId ()
 Get the ID of the type of restriction.This ID is used in the database.
Since
1.33
Returns
int
More...
 

Public Attributes

const TYPE = 'page'
 
const TYPE_ID = 1
 
- Public Attributes inherited from MediaWiki\Block\Restriction\AbstractRestriction
const TYPE = ''
 String constant identifying the type of restriction. More...
 
const TYPE_ID = 0
 Numeric type identifier. More...
 

Protected Attributes

Title false null $title
 
- Protected Attributes inherited from MediaWiki\Block\Restriction\AbstractRestriction
int $blockId
 
int $value
 

Detailed Description

Definition at line 27 of file PageRestriction.php.

Member Function Documentation

◆ getTitle()

MediaWiki\Block\Restriction\PageRestriction::getTitle ( )
Since
1.33
Returns
Title|false

Definition at line 70 of file PageRestriction.php.

References MediaWiki\Block\Restriction\PageRestriction\$title, and MediaWiki\Title\Title\newFromID().

Referenced by MediaWiki\Block\Restriction\PageRestriction\matches(), and MediaWiki\Specials\SpecialBlock\maybeAlterFormDefaults().

◆ matches()

MediaWiki\Block\Restriction\PageRestriction::matches ( Title  $title)

Determine if a restriction matches a given title.

Since
1.33
Parameters
Title$title
Returns
bool

Implements MediaWiki\Block\Restriction\Restriction.

Definition at line 47 of file PageRestriction.php.

References MediaWiki\Title\Title\equals(), and MediaWiki\Block\Restriction\PageRestriction\getTitle().

◆ newFromRow()

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

Create a new Restriction from a database row.

Since
1.33
Parameters
\\stdClass$row
Returns
static

Reimplemented from MediaWiki\Block\Restriction\AbstractRestriction.

Definition at line 81 of file PageRestriction.php.

References MediaWiki\Block\Restriction\PageRestriction\$title, and MediaWiki\Title\Title\newFromRow().

◆ newFromTitle()

static MediaWiki\Block\Restriction\PageRestriction::newFromTitle (   $title)
static
Access: internal
Since
1.36
Parameters
string | Title$title
Returns
self

Definition at line 105 of file PageRestriction.php.

References MediaWiki\Block\Restriction\PageRestriction\$title, MediaWiki\Title\Title\getArticleID(), and MediaWiki\Title\Title\newFromText().

◆ setTitle()

MediaWiki\Block\Restriction\PageRestriction::setTitle ( Title  $title)
Since
1.33
Parameters
Title$title
Returns
self

Definition at line 60 of file PageRestriction.php.

References MediaWiki\Block\Restriction\PageRestriction\$title.

Member Data Documentation

◆ $title

Title false null MediaWiki\Block\Restriction\PageRestriction::$title
protected

Definition at line 42 of file PageRestriction.php.

Referenced by MediaWiki\Block\Restriction\PageRestriction\getTitle(), MediaWiki\Block\Restriction\PageRestriction\newFromRow(), MediaWiki\Block\Restriction\PageRestriction\newFromTitle(), and MediaWiki\Block\Restriction\PageRestriction\setTitle().

◆ TYPE

const MediaWiki\Block\Restriction\PageRestriction::TYPE = 'page'

Definition at line 32 of file PageRestriction.php.

Referenced by MediaWiki\Pager\BlockListPager\preprocessResults().

◆ TYPE_ID

const MediaWiki\Block\Restriction\PageRestriction::TYPE_ID = 1

Definition at line 37 of file PageRestriction.php.

Referenced by MediaWiki\Block\BlockRestrictionStore\loadByBlockId().

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