MWGrants Class Reference

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

Detailed Description

Deprecated

since 1.38, hard deprecated since 1.39 Use GrantsInfo and GrantsLocalization instead

A collection of public static functions to deal with grants.

Definition at line 29 of file MWGrants.php.

Member Function Documentation

getGrantGroups()

static MWGrants::getGrantGroups ( $grantsFilter = null )

static

Divide the grants into groups.

Deprecated

since 1.38, hard deprecated since 1.39 Use GrantsInfo::getGrantGroups() instead

Parameters

string[] | null

$grantsFilter

Returns

array Map of (group => (grant list))

Definition at line 110 of file MWGrants.php.

References wfDeprecated().

getGrantRights()

static MWGrants::getGrantRights ( $grants )

static

Fetch the rights allowed by a set of grants.

Deprecated

since 1.38, hard deprecated since 1.39 Use GrantsInfo::getGrantRights() instead

Parameters

string[] | string

$grants

Returns

string[]

Definition at line 86 of file MWGrants.php.

References wfDeprecated().

getGrantsLink()

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.

Deprecated

since 1.38, hard deprecated since 1.39 Use GrantsLocalization::getGrantsLink() instead

Parameters

string	$grant	the grant name
Language | string | null	$lang

Returns

string (proto-relative) HTML link

Definition at line 139 of file MWGrants.php.

References $lang, and wfDeprecated().

getGrantsWikiText()

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

static

Generate wikitext to display a list of grants.

Deprecated

since 1.38, hard deprecated since 1.39 Use GrantsLocalization::getGrantsWikiText() instead

Parameters

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

Returns

string Wikitext

Definition at line 153 of file MWGrants.php.

References $lang, and wfDeprecated().

getHiddenGrants()

static MWGrants::getHiddenGrants ( )

static

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

Deprecated

since 1.38, hard deprecated since 1.39 Use GrantsInfo::getHiddenGrants() instead

Returns

string[]

Definition at line 121 of file MWGrants.php.

References wfDeprecated().

getRightsByGrant()

static MWGrants::getRightsByGrant ( )

static

Map all grants to corresponding user rights.

Deprecated

since 1.38, hard deprecated since 1.39 Use GrantsInfo::getRightsByGrant() instead

Returns

array grant => array of rights

Definition at line 48 of file MWGrants.php.

References wfDeprecated().

getValidGrants()

static MWGrants::getValidGrants ( )

static

List all known grants.

Deprecated

since 1.38, hard deprecated since 1.39 Use GrantsInfo::getValidGrants() instead

Returns

array

Definition at line 37 of file MWGrants.php.

References wfDeprecated().

grantName()

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

static

Fetch the description of the grant.

Deprecated

since 1.38, hard deprecated since 1.39 Use GrantsLocalization::getGrantDescription() instead

Parameters

string	$grant
Language | string | null	$lang

Returns

string Grant description

Definition at line 61 of file MWGrants.php.

References $lang, and wfDeprecated().

grantNames()

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

static

Fetch the descriptions for the grants.

Deprecated

since 1.38, hard deprecated since 1.39 Use GrantsLocalization::getGrantDescriptions() instead

Parameters

string[]	$grants
Language | string | null	$lang

Returns

string[] Corresponding grant descriptions

Definition at line 74 of file MWGrants.php.

References $lang, and wfDeprecated().

grantsAreValid()

static MWGrants::grantsAreValid ( array $grants )

static

Test that all grants in the list are known.

Deprecated

since 1.38, hard deprecated since 1.39 Use GrantsInfo::grantsAreValid() instead

Parameters

string[]

$grants

Returns

bool

Definition at line 98 of file MWGrants.php.

References wfDeprecated().

---

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

• includes/MWGrants.php