MediaWiki master
MediaWiki\Permissions\GroupPermissionsLookup Class Reference

Public Member Functions

 __construct (ServiceOptions $options)
 
 getGrantedPermissions (string $group)
 Get a list of permissions granted to this group.
 
 getGroupPermissions (array $groups)
 Get the permissions associated with membership in a combination of groups.
 
 getGroupsWithPermission (string $permission)
 Get all the groups who have a given permission.
 
 getRevokedPermissions (string $group)
 Get a list of permissions revoked from this group.
 
 groupHasPermission (string $group, string $permission)
 Check, if the given group has the given permission.
 

Public Attributes

const CONSTRUCTOR_OPTIONS
 

Detailed Description

Definition at line 40 of file GroupPermissionsLookup.php.

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getGrantedPermissions()

MediaWiki\Permissions\GroupPermissionsLookup::getGrantedPermissions ( string $group)

Get a list of permissions granted to this group.

This must NOT be used for permissions checking as it does not check whether a permission has been revoked from this group.

Parameters
string$groupGroup to get permissions of
Returns
string[]
Since
1.38

Definition at line 118 of file GroupPermissionsLookup.php.

◆ getGroupPermissions()

MediaWiki\Permissions\GroupPermissionsLookup::getGroupPermissions ( array $groups)

Get the permissions associated with membership in a combination of groups.

Group-based revocation of a permission negates all group-based assignments of that permission.

Parameters
string[]$groupsinternal group names
Returns
string[] permission key names for given groups combined

Definition at line 162 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 202 of file GroupPermissionsLookup.php.

◆ getRevokedPermissions()

MediaWiki\Permissions\GroupPermissionsLookup::getRevokedPermissions ( string $group)

Get a list of permissions revoked from this group.

Parameters
string$groupGroup to get revoked permissions of
Returns
string[]
Since
1.38

Definition at line 139 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$groupGroup to check
string$permissionRole to check
Returns
bool

Definition at line 82 of file GroupPermissionsLookup.php.

Member Data Documentation

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\Permissions\GroupPermissionsLookup::CONSTRUCTOR_OPTIONS
Initial value:
= [
]
const GroupInheritsPermissions
Name constant for the GroupInheritsPermissions setting, for use with Config::get()
const RevokePermissions
Name constant for the RevokePermissions setting, for use with Config::get()
const GroupPermissions
Name constant for the GroupPermissions setting, for use with Config::get()
Access: internal

Definition at line 45 of file GroupPermissionsLookup.php.


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