MediaWiki  master
MWGrants Class Reference

A collection of public static functions to deal with grants. More...

Static Public Member Functions

static getGrantGroups ($grantsFilter=null)
 Divide the grants into groups. More...
 
static getGrantRights ($grants)
 Fetch the rights allowed by a set of grants. More...
 
static getGrantsLink ($grant, $lang=null)
 Generate a link to Special:ListGrants for a particular grant name. More...
 
static getGrantsWikiText ($grantsFilter, $lang=null)
 Generate wikitext to display a list of grants. More...
 
static getHiddenGrants ()
 Get the list of grants that are hidden and should always be granted. More...
 
static getRightsByGrant ()
 Map all grants to corresponding user rights. More...
 
static getValidGrants ()
 List all known grants. More...
 
static grantName ($grant, $lang=null)
 Fetch the display name of the grant. More...
 
static grantNames (array $grants, $lang=null)
 Fetch the display names for the grants. More...
 
static grantsAreValid (array $grants)
 Test that all grants in the list are known. More...
 

Detailed Description

A collection of public static functions to deal with grants.

Definition at line 25 of file MWGrants.php.

Member Function Documentation

static MWGrants::getGrantGroups (   $grantsFilter = null)
static

Divide the grants into groups.

Parameters
string[]|null$grantsFilter
Returns
array Map of (group => (grant list))

Definition at line 133 of file MWGrants.php.

References as, and global.

Referenced by MWGrantsTest\testGetGrantGroups().

static MWGrants::getGrantRights (   $grants)
static

Fetch the rights allowed by a set of grants.

Parameters
string[]|string$grants
Returns
string[]

Definition at line 107 of file MWGrants.php.

References array(), as, and global.

Referenced by MediaWiki\Session\Session\BotPasswordSessionProvider\newSessionForRequest(), MediaWiki\Session\Session\BotPasswordSessionProvider\refreshSessionInfo(), and MWGrantsTest\testGetGrantRights().

static MWGrants::getGrantsLink (   $grant,
  $lang = null 
)
static

Generate a link to Special:ListGrants for a particular grant name.

This should be used to link end users to a full description of what rights they are giving when they authorize a grant.

Parameters
string$grantthe grant name
Language | string | null$lang
Returns
string (proto-relative) HTML link

Definition at line 181 of file MWGrants.php.

References $lang, $linkRenderer, and SpecialPage\getTitleFor().

static MWGrants::getGrantsWikiText (   $grantsFilter,
  $lang = null 
)
static

Generate wikitext to display a list of grants.

Parameters
string[]|null$grantsFilter If non-null, only display these grants.
Language | string | null$lang
Returns
string Wikitext

Definition at line 195 of file MWGrants.php.

References $lang, $s, $wgContLang, as, Language\factory(), global, and wfMessage().

static MWGrants::getHiddenGrants ( )
static

Get the list of grants that are hidden and should always be granted.

Returns
string[]

Definition at line 159 of file MWGrants.php.

References as, and global.

Referenced by SpecialBotPasswords\getFormFields(), SpecialBotPasswords\save(), and MWGrantsTest\testGetHiddenGrants().

static MWGrants::getRightsByGrant ( )
static

Map all grants to corresponding user rights.

Returns
array grant => array of rights

Definition at line 41 of file MWGrants.php.

References $res, as, and global.

Referenced by SpecialBotPasswords\getFormFields(), and MWGrantsTest\testGetRightsByGrant().

static MWGrants::getValidGrants ( )
static

List all known grants.

Returns
array

Definition at line 31 of file MWGrants.php.

References global.

Referenced by SpecialBotPasswords\getFormFields(), and MWGrantsTest\testGetValidGrants().

static MWGrants::grantName (   $grant,
  $lang = null 
)
static

Fetch the display name of the grant.

Parameters
string$grant
Language | string | null$lang
Returns
string Grant description

Definition at line 57 of file MWGrants.php.

References $lang, Language\factory(), and wfMessage().

static MWGrants::grantNames ( array  $grants,
  $lang = null 
)
static

Fetch the display names for the grants.

Parameters
string[]$grants
Language | string | null$lang
Returns
string[] Corresponding grant descriptions

Definition at line 88 of file MWGrants.php.

References $lang, $ret, as, and Language\factory().

static MWGrants::grantsAreValid ( array  $grants)
static

Test that all grants in the list are known.

Parameters
string[]$grants
Returns
bool

Definition at line 124 of file MWGrants.php.

Referenced by MWGrantsTest\testGrantsAreValid().


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