MediaWiki master
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
MWRestrictions Class Reference

A class to check request restrictions expressed as a JSON object. More...

Inherits Stringable.

Collaboration diagram for MWRestrictions:
Collaboration graph
[legend]

Public Member Functions

 __toString ()
 
 check (WebRequest $request)
 Test against the passed WebRequest.
 
 checkIP ( $ip)
 Test if an IP address is allowed by the restrictions.
 
 toArray ()
 Return the restrictions as an array.
 
 toJson ( $pretty=false)
 Return the restrictions as a JSON string.
 
 userCan (LinkTarget $target)
 Test whether an action on the target is allowed by the restrictions.
 

Static Public Member Functions

static newDefault ()
 
static newFromArray (array $restrictions)
 
static newFromJson ( $json)
 

Public Attributes

StatusValue $validity
 

Protected Member Functions

 __construct (?array $restrictions=null)
 

Detailed Description

A class to check request restrictions expressed as a JSON object.

Definition at line 19 of file MWRestrictions.php.

Constructor & Destructor Documentation

◆ __construct()

MWRestrictions::__construct ( ?array $restrictions = null)
protected
Parameters
array | null$restrictions
Exceptions
InvalidArgumentException

Definition at line 33 of file MWRestrictions.php.

Member Function Documentation

◆ __toString()

MWRestrictions::__toString ( )

Definition at line 124 of file MWRestrictions.php.

References toJson().

◆ check()

MWRestrictions::check ( WebRequest $request)

Test against the passed WebRequest.

Parameters
WebRequest$request
Returns
Status

Definition at line 133 of file MWRestrictions.php.

References checkIP(), and MediaWiki\Request\WebRequest\getIP().

◆ checkIP()

MWRestrictions::checkIP ( $ip)

Test if an IP address is allowed by the restrictions.

Parameters
string$ip
Returns
bool

Definition at line 161 of file MWRestrictions.php.

Referenced by check().

◆ newDefault()

static MWRestrictions::newDefault ( )
static
Returns
MWRestrictions

Definition at line 43 of file MWRestrictions.php.

Referenced by MediaWiki\HTMLForm\Field\HTMLRestrictionsField\getDefault().

◆ newFromArray()

static MWRestrictions::newFromArray ( array $restrictions)
static
Parameters
array$restrictions
Returns
MWRestrictions
Exceptions
InvalidArgumentException

Definition at line 52 of file MWRestrictions.php.

Referenced by MediaWiki\HTMLForm\Field\HTMLRestrictionsField\loadDataFromRequest().

◆ newFromJson()

static MWRestrictions::newFromJson ( $json)
static
Parameters
string$jsonJSON representation of the restrictions
Returns
MWRestrictions
Exceptions
InvalidArgumentException

Definition at line 61 of file MWRestrictions.php.

◆ toArray()

MWRestrictions::toArray ( )

Return the restrictions as an array.

Returns
array

Definition at line 107 of file MWRestrictions.php.

Referenced by toJson().

◆ toJson()

MWRestrictions::toJson ( $pretty = false)

Return the restrictions as a JSON string.

Parameters
bool | string$prettyPretty-print the JSON output, see FormatJson::encode
Returns
string

Definition at line 120 of file MWRestrictions.php.

References toArray().

Referenced by __toString().

◆ userCan()

MWRestrictions::userCan ( LinkTarget $target)

Test whether an action on the target is allowed by the restrictions.

Access: internal
Parameters
LinkTarget$target
Returns
StatusValue

Definition at line 149 of file MWRestrictions.php.

Member Data Documentation

◆ $validity

StatusValue MWRestrictions::$validity

Definition at line 27 of file MWRestrictions.php.

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