BatchableGroupSyncInjector
in
Represents a GroupSyncInjector which can add multiple groups to a {@see User} at once.
Tags
Table of Contents
Methods
- batchAddGroups() : false|array<string|int, mixed>
- Add multiple groups to a user at once.
- batchRemoveGroups() : false|array<string|int, mixed>
- Remove multiple groups from a user at once.
Methods
batchAddGroups()
Add multiple groups to a user at once.
public
batchAddGroups(User $user, array<string|int, mixed> $group_ids) : false|array<string|int, mixed>
Parameters
- $user : User
-
The user to add groups to
- $group_ids : array<string|int, mixed>
-
Array of native group IDs to remove
Return values
false|array<string|int, mixed> —Array of group IDs and the status of the operation for each, or false if error
batchRemoveGroups()
Remove multiple groups from a user at once.
public
batchRemoveGroups(User $user, array<string|int, mixed> $group_ids) : false|array<string|int, mixed>
Parameters
- $user : User
-
The user to remove groups from
- $group_ids : array<string|int, mixed>
-
Array of native group IDs to remove
Return values
false|array<string|int, mixed> —Array of group IDs and the status of the operation for each, or false if error