MediaWiki\Permissions\GroupPermissionsLookup Class Reference

Public Member Functions
	__construct (ServiceOptions $options)
	getGroupPermissions (array $groups)
	Get the permissions associated with a given list of groups.
	getGroupsWithPermission (string $permission)
	Get all the groups who have a given permission.
	groupHasPermission (string $group, string $permission)
	Check, if the given group has the given permission.

Private Attributes
array	$groupPermissions
array	$revokePermissions

Detailed Description

Definition at line 30 of file GroupPermissionsLookup.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Permissions\GroupPermissionsLookup::__construct

(

ServiceOptions

$options

)

Definition at line 50 of file GroupPermissionsLookup.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions(), and MediaWiki\Config\ServiceOptions\get().

Member Function Documentation

getGroupPermissions()

MediaWiki\Permissions\GroupPermissionsLookup::getGroupPermissions

(

array

$groups

)

Get the permissions associated with a given list of groups.

Parameters

string[]

$groups

internal group names

Returns

string[] permission key names for given groups combined

Definition at line 81 of file GroupPermissionsLookup.php.

getGroupsWithPermission()

MediaWiki\Permissions\GroupPermissionsLookup::getGroupsWithPermission

(

string

$permission

)

Get all the groups who have a given permission.

Parameters

string

$permission

Returns

string[] internal group names with the given permission

Definition at line 112 of file GroupPermissionsLookup.php.

groupHasPermission()

MediaWiki\Permissions\GroupPermissionsLookup::groupHasPermission	(	string	$group,
		string	$permission
	)

Check, if the given group has the given permission.

If you're wanting to check whether all users have a permission, use PermissionManager::isEveryoneAllowed() instead. That properly checks if it's revoked from anyone.

Parameters

string	$group	Group to check
string	$permission	Role to check

Returns

bool

Definition at line 68 of file GroupPermissionsLookup.php.

Member Data Documentation

$groupPermissions

array MediaWiki\Permissions\GroupPermissionsLookup::$groupPermissions

private

Initial value:

=[,,]
    public const CONSTRUCTOR_OPTIONS  
        'GroupPermissions'
        'RevokePermissions'

Definition at line 42 of file GroupPermissionsLookup.php.

$revokePermissions

array MediaWiki\Permissions\GroupPermissionsLookup::$revokePermissions

private

Definition at line 45 of file GroupPermissionsLookup.php.

---

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

• includes/Permissions/GroupPermissionsLookup.php