MediaWiki
master
|
Managers user groups. More...
Public Member Functions | |
__construct (ServiceOptions $options, ConfiguredReadOnlyMode $configuredReadOnlyMode, ILBFactory $loadBalancerFactory, HookContainer $hookContainer, UserEditTracker $userEditTracker, GroupPermissionsLookup $groupPermissionsLookup, JobQueueGroup $jobQueueGroup, LoggerInterface $logger, TempUserConfig $tempUserConfig, array $clearCacheCallbacks=[], $dbDomain=false) | |
addUserToAutopromoteOnceGroups (UserIdentity $user, string $event) | |
Add the user to the group if he/she meets given criteria. More... | |
addUserToGroup (UserIdentity $user, string $group, string $expiry=null, bool $allowUpdate=false) | |
Add the user to the given group. More... | |
addUserToMultipleGroups (UserIdentity $user, array $groups, string $expiry=null, bool $allowUpdate=false) | |
Add the user to the given list of groups. More... | |
clearCache (UserIdentity $user) | |
Cleans cached group memberships for a given user. More... | |
getGroupsChangeableBy (Authority $authority) | |
Returns an array of groups that this $actor can add and remove. More... | |
getGroupsChangeableByGroup (string $group) | |
Returns an array of the groups that a particular group can add/remove. More... | |
getUserAutopromoteGroups (UserIdentity $user) | |
Get the groups for the given user based on $wgAutopromote. More... | |
getUserAutopromoteOnceGroups (UserIdentity $user, string $event) | |
Get the groups for the given user based on the given criteria. More... | |
getUserEffectiveGroups (UserIdentity $user, int $queryFlags=self::READ_NORMAL, bool $recache=false) | |
Get the list of implicit group memberships the user has. More... | |
getUserFormerGroups (UserIdentity $user, int $queryFlags=self::READ_NORMAL) | |
Returns the groups the user has belonged to. More... | |
getUserGroupMemberships (UserIdentity $user, int $queryFlags=self::READ_NORMAL) | |
Loads and returns UserGroupMembership objects for all the groups a user currently belongs to. More... | |
getUserGroups (UserIdentity $user, int $queryFlags=self::READ_NORMAL) | |
Get the list of explicit group memberships this user has. More... | |
getUserImplicitGroups (UserIdentity $user, int $queryFlags=self::READ_NORMAL, bool $recache=false) | |
Get the list of implicit group memberships this user has. More... | |
listAllGroups () | |
Return the set of defined explicit groups. More... | |
listAllImplicitGroups () | |
Get a list of all configured implicit groups. More... | |
loadGroupMembershipsFromArray (UserIdentity $user, array $userGroups, int $queryFlags=self::READ_NORMAL) | |
Load the user groups cache from the provided user groups data. More... | |
newGroupMembershipFromRow (\stdClass $row) | |
Creates a new UserGroupMembership instance from $row. More... | |
newQueryBuilder (IDatabase $db) | |
Return the query builder to build upon and query. More... | |
purgeExpired () | |
Purge expired memberships from the user_groups table. More... | |
removeUserFromGroup (UserIdentity $user, string $group) | |
Remove the user from the given group. More... | |
Public Attributes | |
const | CONSTRUCTOR_OPTIONS |
![]() | |
const | READ_NONE = -1 |
Constants for object loading bitfield flags (higher => higher QoS) More... | |
MediaWiki\User\UserGroupManager::__construct | ( | ServiceOptions | $options, |
ConfiguredReadOnlyMode | $configuredReadOnlyMode, | ||
ILBFactory | $loadBalancerFactory, | ||
HookContainer | $hookContainer, | ||
UserEditTracker | $userEditTracker, | ||
GroupPermissionsLookup | $groupPermissionsLookup, | ||
JobQueueGroup | $jobQueueGroup, | ||
LoggerInterface | $logger, | ||
TempUserConfig | $tempUserConfig, | ||
array | $clearCacheCallbacks = [] , |
||
$dbDomain = false |
|||
) |
ServiceOptions | $options | |
ConfiguredReadOnlyMode | $configuredReadOnlyMode | |
ILBFactory | $loadBalancerFactory | |
HookContainer | $hookContainer | |
UserEditTracker | $userEditTracker | |
GroupPermissionsLookup | $groupPermissionsLookup | |
JobQueueGroup | $jobQueueGroup | for this $dbDomain |
LoggerInterface | $logger | |
TempUserConfig | $tempUserConfig | |
callable[] | $clearCacheCallbacks | |
string | false | $dbDomain |
Definition at line 168 of file UserGroupManager.php.
References MediaWiki\Config\ServiceOptions\assertRequiredOptions(), and Wikimedia\Rdbms\ILBFactory\getMainLB().
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.
UserIdentity | $user | User to add to the groups |
string | $event | Key in $wgAutopromoteOnce (each event has groups/criteria) |
Definition at line 619 of file UserGroupManager.php.
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.)
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 |
InvalidArgumentException |
Definition at line 750 of file UserGroupManager.php.
Referenced by MediaWiki\Specials\SpecialUserRights\doSaveUserGroups().
MediaWiki\User\UserGroupManager::addUserToMultipleGroups | ( | UserIdentity | $user, |
array | $groups, | ||
string | $expiry = null , |
||
bool | $allowUpdate = false |
||
) |
Add the user to the given list of groups.
UserIdentity | $user | |
string[] | $groups | Names of the groups 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 |
InvalidArgumentException |
Definition at line 868 of file UserGroupManager.php.
MediaWiki\User\UserGroupManager::clearCache | ( | UserIdentity | $user | ) |
Cleans cached group memberships for a given user.
UserIdentity | $user |
Definition at line 1120 of file UserGroupManager.php.
MediaWiki\User\UserGroupManager::getGroupsChangeableBy | ( | Authority | $authority | ) |
Returns an array of groups that this $actor can add and remove.
Authority | $authority |
Definition at line 1079 of file UserGroupManager.php.
Referenced by MediaWiki\Specials\SpecialUserRights\doSaveUserGroups(), and MediaWiki\Specials\SpecialUserRights\userCanChangeRights().
MediaWiki\User\UserGroupManager::getGroupsChangeableByGroup | ( | string | $group | ) |
Returns an array of the groups that a particular group can add/remove.
string | $group | The group to check for whether it can add/remove |
Definition at line 1050 of file UserGroupManager.php.
MediaWiki\User\UserGroupManager::getUserAutopromoteGroups | ( | UserIdentity | $user | ) |
Get the groups for the given user based on $wgAutopromote.
UserIdentity | $user | The user to get the groups for |
Definition at line 409 of file UserGroupManager.php.
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.
UserIdentity | $user | The user to get the groups for |
string | $event | Key in $wgAutopromoteOnce (each event has groups/criteria) |
Definition at line 435 of file UserGroupManager.php.
References User\newFromIdentity().
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
UserIdentity | $user | |
int | $queryFlags | |
bool | $recache | Whether to avoid the cache |
Definition at line 326 of file UserGroupManager.php.
References User\newFromIdentity().
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 getUserGroups().
The function will not return groups the user had belonged to before MW 1.17
UserIdentity | $user | |
int | $queryFlags |
Definition at line 369 of file UserGroupManager.php.
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.
UserIdentity | $user | the user to search for |
int | $queryFlags |
Definition at line 697 of file UserGroupManager.php.
Referenced by MediaWiki\Specials\SpecialUserRights\doSaveUserGroups().
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.
UserIdentity | $user | |
int | $queryFlags |
Definition at line 682 of file UserGroupManager.php.
Referenced by MediaWiki\Specials\SpecialUserRights\doSaveUserGroups().
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
UserIdentity | $user | |
int | $queryFlags | |
bool | $recache | Whether to avoid the cache |
Definition at line 282 of file UserGroupManager.php.
References MediaWiki\User\UserIdentity\getName(), and MediaWiki\User\UserIdentity\isRegistered().
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.
Definition at line 204 of file UserGroupManager.php.
Referenced by UsersPager\__construct().
MediaWiki\User\UserGroupManager::listAllImplicitGroups | ( | ) |
Get a list of all configured implicit groups.
Definition at line 221 of file UserGroupManager.php.
MediaWiki\User\UserGroupManager::loadGroupMembershipsFromArray | ( | UserIdentity | $user, |
array | $userGroups, | ||
int | $queryFlags = self::READ_NORMAL |
||
) |
Load the user groups cache from the provided user groups data.
UserIdentity | $user | |
array | $userGroups | an array of database query results |
int | $queryFlags |
Definition at line 252 of file UserGroupManager.php.
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.
\\stdClass | $row | A database result object |
Definition at line 234 of file UserGroupManager.php.
MediaWiki\User\UserGroupManager::newQueryBuilder | ( | IDatabase | $db | ) |
Return the query builder to build upon and query.
IDatabase | $db |
Definition at line 947 of file UserGroupManager.php.
MediaWiki\User\UserGroupManager::purgeExpired | ( | ) |
Purge expired memberships from the user_groups table.
Definition at line 964 of file UserGroupManager.php.
References $res, DB_PRIMARY, LIST_AND, and LIST_OR.
MediaWiki\User\UserGroupManager::removeUserFromGroup | ( | UserIdentity | $user, |
string | $group | ||
) |
Remove the user from the given group.
This takes immediate effect.
UserIdentity | $user | |
string | $group | Name of the group to remove |
InvalidArgumentException |
Definition at line 887 of file UserGroupManager.php.
References User\newFromIdentity().
Referenced by MediaWiki\Specials\SpecialUserRights\doSaveUserGroups().
const MediaWiki\User\UserGroupManager::CONSTRUCTOR_OPTIONS |
Definition at line 61 of file UserGroupManager.php.