Managers user groups. More...

Inheritance diagram for MediaWiki\User\UserGroupManager:

Collaboration diagram for MediaWiki\User\UserGroupManager:

[legend]

Public Member Functions
	__construct (ServiceOptions $options, ConfiguredReadOnlyMode $configuredReadOnlyMode, ILBFactory $loadBalancerFactory, HookContainer $hookContainer, UserEditTracker $userEditTracker, LoggerInterface $logger, array $clearCacheCallbacks=[], $dbDomain=false)

	addUserToAutopromoteOnceGroups (UserIdentity $user, string $event)
	Add the user to the group if he/she meets given criteria.

	addUserToGroup (UserIdentity $user, string $group, string $expiry=null, bool $allowUpdate=false)
	Add the user to the given group.

	clearCache (UserIdentity $user)
	Cleans cached group memberships for a given user.

	getQueryInfo ()
	Return the tables and fields to be selected to construct new UserGroupMembership object using newGroupMembershipFromRow method.

	getUserAutopromoteGroups (UserIdentity $user)
	Get the groups for the given user based on $wgAutopromote.

	getUserAutopromoteOnceGroups (UserIdentity $user, string $event)
	Get the groups for the given user based on the given criteria.

	getUserEffectiveGroups (UserIdentity $user, int $queryFlags=self::READ_NORMAL, bool $recache=false)
	Get the list of implicit group memberships the user has.

	getUserFormerGroups (UserIdentity $user, int $queryFlags=self::READ_NORMAL)
	Returns the groups the user has belonged to.

	getUserGroupMemberships (UserIdentity $user, int $queryFlags=self::READ_NORMAL)
	Loads and returns UserGroupMembership objects for all the groups a user currently belongs to.

	getUserGroups (UserIdentity $user, int $queryFlags=self::READ_NORMAL)
	Get the list of explicit group memberships this user has.

	getUserImplicitGroups (UserIdentity $user, int $queryFlags=self::READ_NORMAL, bool $recache=false)
	Get the list of implicit group memberships this user has.

	listAllGroups ()
	Return the set of defined explicit groups.

	listAllImplicitGroups ()
	Get a list of all configured implicit groups.

	loadGroupMembershipsFromArray (UserIdentity $user, array $userGroups, int $queryFlags=self::READ_NORMAL)
	Load the user groups cache from the provided user groups data.

	newGroupMembershipFromRow (\stdClass $row)
	Creates a new UserGroupMembership instance from $row.

	purgeExpired ()
	Purge expired memberships from the user_groups table.

	removeUserFromGroup (UserIdentity $user, string $group)
	Remove the user from the given group.

Public Attributes
const	CONSTRUCTOR_OPTIONS

Public Attributes inherited from IDBAccessObject
const	READ_LOCKING = self::READ_LATEST \| 2
	Constants for object loading bitfield flags (higher => higher QoS)

const	READ_NONE = -1

Private Member Functions
	canUseCachedValues (UserIdentity $user, string $cacheKind, int $queryFlags)
	Determines if it's ok to use cached options values for a given user and query flags.

	checkCondition (array $cond, User $user)
	As recCheckCondition, but not recursive.

	clearUserCacheForKind (UserIdentity $user, string $cacheKind)
	Clears a cached group membership and query key for a given user.

	getCacheKey (UserIdentity $user)
	Gets a unique key for various caches.

	getDBConnectionRefForQueryFlags (int $queryFlags)

	recCheckCondition ( $cond, User $user)
	Recursively check a condition.

	setCache (UserIdentity $user, string $cacheKind, array $groupValue, int $queryFlags)
	Sets cached group memberships and query flags for a given user.

Private Attributes
callable[]	$clearCacheCallbacks

string false	$dbDomain

HookContainer	$hookContainer

HookRunner	$hookRunner

ILoadBalancer	$loadBalancer

ILBFactory	$loadBalancerFactory

LoggerInterface	$logger

ServiceOptions	$options

array	$queryFlagsUsedForCaching = []
	An assoc.

ReadOnlyMode	$readOnlyMode

UserEditTracker	$userEditTracker

array	$userGroupCache = []
	Service caches, an assoc.

const	CACHE_EFFECTIVE = 'effective'
	string key for effective groups cache

const	CACHE_FORMER = 'former'
	string key for former groups cache

const	CACHE_IMPLICIT = 'implicit'
	string key for implicit groups cache

const	CACHE_MEMBERSHIP = 'membership'
	string key for group memberships cache

Detailed Description

Managers user groups.

Since: 1.35

Definition at line 51 of file UserGroupManager.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\User\UserGroupManager::__construct	(	ServiceOptions	$options,
		ConfiguredReadOnlyMode	$configuredReadOnlyMode,
		ILBFactory	$loadBalancerFactory,
		HookContainer	$hookContainer,
		UserEditTracker	$userEditTracker,
		LoggerInterface	$logger,
		array	$clearCacheCallbacks = `[]`,
			$dbDomain = `false`
	)

Parameters

ServiceOptions	$options
ConfiguredReadOnlyMode	$configuredReadOnlyMode
ILBFactory	$loadBalancerFactory
HookContainer	$hookContainer
UserEditTracker	$userEditTracker
LoggerInterface	$logger
callable[]	$clearCacheCallbacks
string \| bool	$dbDomain

Definition at line 141 of file UserGroupManager.php.

References MediaWiki\User\UserGroupManager\$clearCacheCallbacks, MediaWiki\User\UserGroupManager\$dbDomain, MediaWiki\User\UserGroupManager\$hookContainer, MediaWiki\User\UserGroupManager\$loadBalancerFactory, MediaWiki\User\UserGroupManager\$logger, MediaWiki\User\UserGroupManager\$options, MediaWiki\User\UserGroupManager\$userEditTracker, MediaWiki\Config\ServiceOptions\assertRequiredOptions(), and Wikimedia\Rdbms\ILBFactory\getMainLB().

Member Function Documentation

◆ addUserToAutopromoteOnceGroups()

MediaWiki\User\UserGroupManager::addUserToAutopromoteOnceGroups	(	UserIdentity	$user,
		string	$event
	)

Add the user to the group if he/she meets given criteria.

Contrary to autopromotion by $wgAutopromote, the group will be possible to remove manually via Special:UserRights. In such case it will not be re-added automatically. The user will also not lose the group if they no longer meet the criteria.

Parameters

UserIdentity	$user	User to add to the groups
string	$event	Key in $wgAutopromoteOnce (each event has groups/criteria)

Returns: array Array of groups the user has been promoted to.

See also: $wgAutopromoteOnce

Definition at line 574 of file UserGroupManager.php.

◆ addUserToGroup()

MediaWiki\User\UserGroupManager::addUserToGroup	(	UserIdentity	$user,
		string	$group,
		string	$expiry = `null`,
		bool	$allowUpdate = `false`
	)

Add the user to the given group.

This takes immediate effect. If the user is already in the group, the expiry time will be updated to the new expiry time. (If $expiry is omitted or null, the membership will be altered to never expire.)

Parameters

UserIdentity	$user
string	$group	Name of the group to add
string \| null	$expiry	Optional expiry timestamp in any format acceptable to wfTimestamp(), or null if the group assignment should not expire
bool	$allowUpdate	Whether to perform "upsert" instead of INSERT

Exceptions

InvalidArgumentException

Returns: bool

Definition at line 712 of file UserGroupManager.php.

◆ canUseCachedValues()

MediaWiki\User\UserGroupManager::canUseCachedValues	(	UserIdentity	$user,
		string	$cacheKind,
		int	$queryFlags
	)

private

Determines if it's ok to use cached options values for a given user and query flags.

Parameters

UserIdentity	$user
string	$cacheKind	one of self::CACHE_* constants
int	$queryFlags

Returns: bool

Definition at line 1036 of file UserGroupManager.php.

◆ checkCondition()

MediaWiki\User\UserGroupManager::checkCondition	(	array	$cond,
		User	$user
	)

private

As recCheckCondition, but not recursive.

The only valid conditions are those whose first element is one of APCOND_* defined in Defines.php. Other types will throw an exception if no extension evaluates them.

Parameters

array	$cond	A condition, which must not contain other conditions
User	$user	The user to check the condition against

Returns: bool Whether the condition is true for the user

Exceptions

InvalidArgumentException if autopromote condition was not recognized.

Definition at line 496 of file UserGroupManager.php.

◆ clearCache()

MediaWiki\User\UserGroupManager::clearCache ( UserIdentity $user )

Cleans cached group memberships for a given user.

Parameters

UserIdentity $user

Definition at line 974 of file UserGroupManager.php.

◆ clearUserCacheForKind()

MediaWiki\User\UserGroupManager::clearUserCacheForKind	(	UserIdentity	$user,
		string	$cacheKind
	)

private

Clears a cached group membership and query key for a given user.

Parameters

UserIdentity	$user
string	$cacheKind	one of self::CACHE_* constants

Definition at line 1005 of file UserGroupManager.php.

◆ getCacheKey()

MediaWiki\User\UserGroupManager::getCacheKey ( UserIdentity $user )

private

Gets a unique key for various caches.

Parameters

UserIdentity $user

Returns: string

Definition at line 1025 of file UserGroupManager.php.

◆ getDBConnectionRefForQueryFlags()

MediaWiki\User\UserGroupManager::getDBConnectionRefForQueryFlags ( int $queryFlags )

private

Parameters

int $queryFlags a bit field composed of READ_XXX flags

Returns: DBConnRef

Definition at line 1015 of file UserGroupManager.php.

◆ getQueryInfo()

MediaWiki\User\UserGroupManager::getQueryInfo ( )

Return the tables and fields to be selected to construct new UserGroupMembership object using newGroupMembershipFromRow method.

Returns

array With three keys:

tables: (string[]) to include in the $table to IDatabase->select()
fields: (string[]) to include in the $vars to IDatabase->select()
joins: (string[]) to include in the $joins to IDatabase->select()

Definition at line 887 of file UserGroupManager.php.

◆ getUserAutopromoteGroups()

MediaWiki\User\UserGroupManager::getUserAutopromoteGroups ( UserIdentity $user )

Get the groups for the given user based on $wgAutopromote.

Parameters

UserIdentity $user The user to get the groups for

Returns: array Array of groups to promote to.

See also: $wgAutopromote

Definition at line 364 of file UserGroupManager.php.

◆ getUserAutopromoteOnceGroups()

MediaWiki\User\UserGroupManager::getUserAutopromoteOnceGroups	(	UserIdentity	$user,
		string	$event
	)

Get the groups for the given user based on the given criteria.

Does not return groups the user already belongs to or has once belonged.

Parameters

UserIdentity	$user	The user to get the groups for
string	$event	Key in $wgAutopromoteOnce (each event has groups/criteria)

Returns: array Groups the user should be promoted to.

See also: $wgAutopromoteOnce

Definition at line 390 of file UserGroupManager.php.

References User\newFromIdentity().

◆ getUserEffectiveGroups()

MediaWiki\User\UserGroupManager::getUserEffectiveGroups	(	UserIdentity	$user,
		int	$queryFlags = `self::READ_NORMAL`,
		bool	$recache = `false`
	)

Get the list of implicit group memberships the user has.

This includes all explicit groups, plus 'user' if logged in, '*' for all accounts, and autopromoted groups

Parameters

UserIdentity	$user
int	$queryFlags
bool	$recache	Whether to avoid the cache

Returns: string[] Array of String internal group names

Definition at line 281 of file UserGroupManager.php.

References User\newFromIdentity().

◆ getUserFormerGroups()

MediaWiki\User\UserGroupManager::getUserFormerGroups	(	UserIdentity	$user,
		int	$queryFlags = `self::READ_NORMAL`
	)

Returns the groups the user has belonged to.

The user may still belong to the returned groups. Compare with getGroups().

The function will not return groups the user had belonged to before MW 1.17

Parameters

UserIdentity	$user
int	$queryFlags

Returns: array Names of the groups the user has belonged to.

Definition at line 323 of file UserGroupManager.php.

◆ getUserGroupMemberships()

MediaWiki\User\UserGroupManager::getUserGroupMemberships	(	UserIdentity	$user,
		int	$queryFlags = `self::READ_NORMAL`
	)

Loads and returns UserGroupMembership objects for all the groups a user currently belongs to.

Parameters

UserIdentity	$user	the user to search for
int	$queryFlags

Returns: UserGroupMembership[] Associative array of (group name => UserGroupMembership object)

Definition at line 654 of file UserGroupManager.php.

◆ getUserGroups()

MediaWiki\User\UserGroupManager::getUserGroups	(	UserIdentity	$user,
		int	$queryFlags = `self::READ_NORMAL`
	)

Get the list of explicit group memberships this user has.

The implicit * and user groups are not included.

Parameters

UserIdentity	$user
int	$queryFlags

Returns: string[]

Definition at line 639 of file UserGroupManager.php.

◆ getUserImplicitGroups()

MediaWiki\User\UserGroupManager::getUserImplicitGroups	(	UserIdentity	$user,
		int	$queryFlags = `self::READ_NORMAL`,
		bool	$recache = `false`
	)

Get the list of implicit group memberships this user has.

This includes 'user' if logged in, '*' for all accounts, and autopromoted groups

Parameters

UserIdentity	$user
int	$queryFlags
bool	$recache	Whether to avoid the cache

Returns: string[] internal group names

Definition at line 241 of file UserGroupManager.php.

References MediaWiki\User\UserIdentity\isRegistered().

◆ listAllGroups()

MediaWiki\User\UserGroupManager::listAllGroups ( )

Return the set of defined explicit groups.

The implicit groups (by default *, 'user' and 'autoconfirmed') are not included, as they are defined automatically, not in the database.

Returns: string[] Array of internal group names

Definition at line 171 of file UserGroupManager.php.

◆ listAllImplicitGroups()

MediaWiki\User\UserGroupManager::listAllImplicitGroups ( )

Get a list of all configured implicit groups.

Returns: string[]

Definition at line 185 of file UserGroupManager.php.

◆ loadGroupMembershipsFromArray()

MediaWiki\User\UserGroupManager::loadGroupMembershipsFromArray	(	UserIdentity	$user,
		array	$userGroups,
		int	$queryFlags = `self::READ_NORMAL`
	)

Load the user groups cache from the provided user groups data.

Definition at line 216 of file UserGroupManager.php.

◆ newGroupMembershipFromRow()

MediaWiki\User\UserGroupManager::newGroupMembershipFromRow ( \stdClass $row )

Creates a new UserGroupMembership instance from $row.

The fields required to build an instance could be found using getQueryInfo() method.

Parameters

\\stdClass $row A database result object

Returns: UserGroupMembership

Definition at line 198 of file UserGroupManager.php.

◆ purgeExpired()

MediaWiki\User\UserGroupManager::purgeExpired ( )

Purge expired memberships from the user_groups table.

Definition at line 906 of file UserGroupManager.php.

References $res, and DB_MASTER.

◆ recCheckCondition()

MediaWiki\User\UserGroupManager::recCheckCondition	(		$cond,
		User	$user
	)

private

Recursively check a condition.

Conditions are in the form [ '&' or '|' or '^' or '!', cond1, cond2, ... ] where cond1, cond2, ... are themselves conditions; OR APCOND_EMAILCONFIRMED, OR [ APCOND_EMAILCONFIRMED ], OR [ APCOND_EDITCOUNT, number of edits ], OR [ APCOND_AGE, seconds since registration ], OR similar constructs defined by extensions. This function evaluates the former type recursively, and passes off to checkCondition for evaluation of the latter type.

Parameters

mixed	$cond	A condition, possibly containing other conditions
User	$user	The user to check the conditions against

Returns: bool Whether the condition is true

Definition at line 437 of file UserGroupManager.php.

◆ removeUserFromGroup()

MediaWiki\User\UserGroupManager::removeUserFromGroup	(	UserIdentity	$user,
		string	$group
	)

Remove the user from the given group.

This takes immediate effect.

Parameters

UserIdentity	$user
string	$group	Name of the group to remove

Exceptions

InvalidArgumentException

Returns: bool

Definition at line 823 of file UserGroupManager.php.

References User\newFromIdentity().

◆ setCache()

MediaWiki\User\UserGroupManager::setCache	(	UserIdentity	$user,
		string	$cacheKind,
		array	$groupValue,
		int	$queryFlags
	)

private

Sets cached group memberships and query flags for a given user.

Parameters

UserIdentity	$user
string	$cacheKind	one of self::CACHE_KIND_* constants
array	$groupValue
int	$queryFlags

Definition at line 988 of file UserGroupManager.php.

Member Data Documentation

◆ $clearCacheCallbacks

callable [] MediaWiki\User\UserGroupManager::$clearCacheCallbacks

private

Definition at line 88 of file UserGroupManager.php.

Referenced by MediaWiki\User\UserGroupManager\__construct().

◆ $dbDomain

string false MediaWiki\User\UserGroupManager::$dbDomain

private

Definition at line 91 of file UserGroupManager.php.

Referenced by MediaWiki\User\UserGroupManager\__construct().

◆ $hookContainer

HookContainer MediaWiki\User\UserGroupManager::$hookContainer

private

Definition at line 73 of file UserGroupManager.php.

Referenced by MediaWiki\User\UserGroupManager\__construct().

◆ $hookRunner

HookRunner MediaWiki\User\UserGroupManager::$hookRunner

private

Definition at line 76 of file UserGroupManager.php.

◆ $loadBalancer

ILoadBalancer MediaWiki\User\UserGroupManager::$loadBalancer

private

Definition at line 70 of file UserGroupManager.php.

◆ $loadBalancerFactory

ILBFactory MediaWiki\User\UserGroupManager::$loadBalancerFactory

private

Definition at line 67 of file UserGroupManager.php.

Referenced by MediaWiki\User\UserGroupManager\__construct().

◆ $logger

LoggerInterface MediaWiki\User\UserGroupManager::$logger

private

Definition at line 85 of file UserGroupManager.php.

Referenced by MediaWiki\User\UserGroupManager\__construct().

◆ $options

ServiceOptions MediaWiki\User\UserGroupManager::$options

private

Definition at line 64 of file UserGroupManager.php.

Referenced by MediaWiki\User\UserGroupManager\__construct().

◆ $queryFlagsUsedForCaching

array MediaWiki\User\UserGroupManager::$queryFlagsUsedForCaching = []

private

An assoc.

array that stores query flags used to retrieve user groups from the database and is stored in the following format:

userKey => [ self::CACHE_IMPLICIT => implicit groups query flag self::CACHE_EFFECTIVE => effective groups query flag self::CACHE_MEMBERSHIP => membership groups query flag self::CACHE_FORMER => former groups query flag ]

Definition at line 129 of file UserGroupManager.php.

◆ $readOnlyMode

ReadOnlyMode MediaWiki\User\UserGroupManager::$readOnlyMode

private

Definition at line 79 of file UserGroupManager.php.

◆ $userEditTracker

UserEditTracker MediaWiki\User\UserGroupManager::$userEditTracker

private

Definition at line 82 of file UserGroupManager.php.

Referenced by MediaWiki\User\UserGroupManager\__construct().

◆ $userGroupCache

array MediaWiki\User\UserGroupManager::$userGroupCache = []

private

Service caches, an assoc.

array keyed after the user-keys generated by the getCacheKey method and storing values in the following format:

userKey => [ self::CACHE_IMPLICIT => implicit groups cache self::CACHE_EFFECTIVE => effective groups cache self::CACHE_MEMBERSHIP => [ ] // Array of UserGroupMembership objects self::CACHE_FORMER => former groups cache ]

Definition at line 116 of file UserGroupManager.php.

◆ CACHE_EFFECTIVE

const MediaWiki\User\UserGroupManager::CACHE_EFFECTIVE = 'effective'

private

string key for effective groups cache

Definition at line 97 of file UserGroupManager.php.

◆ CACHE_FORMER

const MediaWiki\User\UserGroupManager::CACHE_FORMER = 'former'

private

string key for former groups cache

Definition at line 103 of file UserGroupManager.php.

◆ CACHE_IMPLICIT

const MediaWiki\User\UserGroupManager::CACHE_IMPLICIT = 'implicit'

private

string key for implicit groups cache

Definition at line 94 of file UserGroupManager.php.

◆ CACHE_MEMBERSHIP

const MediaWiki\User\UserGroupManager::CACHE_MEMBERSHIP = 'membership'

private

string key for group memberships cache

Definition at line 100 of file UserGroupManager.php.

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\User\UserGroupManager::CONSTRUCTOR_OPTIONS

Initial value:

= [
        'Autopromote',
        'AutopromoteOnce',
        'AutopromoteOnceLogInRC',
        'EmailAuthentication',
        'ImplicitGroups',
        'GroupPermissions',
        'RevokePermissions',
    ]

Definition at line 53 of file UserGroupManager.php.

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

includes/user/UserGroupManager.php

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addUserToAutopromoteOnceGroups()

◆ addUserToGroup()

◆ canUseCachedValues()

◆ checkCondition()

◆ clearCache()

◆ clearUserCacheForKind()

◆ getCacheKey()

◆ getDBConnectionRefForQueryFlags()

◆ getQueryInfo()

◆ getUserAutopromoteGroups()

◆ getUserAutopromoteOnceGroups()

◆ getUserEffectiveGroups()

◆ getUserFormerGroups()

◆ getUserGroupMemberships()

◆ getUserGroups()

◆ getUserImplicitGroups()

◆ listAllGroups()

◆ listAllImplicitGroups()

◆ loadGroupMembershipsFromArray()

◆ newGroupMembershipFromRow()

◆ purgeExpired()

◆ recCheckCondition()

◆ removeUserFromGroup()

◆ setCache()

Member Data Documentation

◆ $clearCacheCallbacks

◆ $dbDomain

◆ $hookContainer

◆ $hookRunner

◆ $loadBalancer

◆ $loadBalancerFactory

◆ $logger

◆ $options

◆ $queryFlagsUsedForCaching

◆ $readOnlyMode

◆ $userEditTracker

◆ $userGroupCache

◆ CACHE_EFFECTIVE

◆ CACHE_FORMER

◆ CACHE_IMPLICIT

◆ CACHE_MEMBERSHIP

◆ CONSTRUCTOR_OPTIONS