GroupsService
in package
Class GroupsService
Tags
Table of Contents
- $circlesRequest : DeprecatedCirclesRequest
- $circlesService : CirclesService
- $configService : ConfigService
- $eventsService : EventsService
- $groupManager : IGroupManager
- $l10n : IL10N
- $membersRequest : DeprecatedMembersRequest
- $miscService : MiscService
- $userId : string
- $userManager : IUserManager
- __construct() : mixed
- GroupsService constructor.
- levelGroup() : array<string|int, mixed>
- linkGroup() : array<string|int, mixed>
- onGroupRemoved() : mixed
- When a group is removed, remove it from all Circles
- unlinkGroup() : array<string|int, mixed>
- editGroupLevel() : mixed
- getFreshNewMember() : null|DeprecatedMember
- Check if a fresh member can be generated (by linkGroup)
Properties
$circlesRequest
private
DeprecatedCirclesRequest
$circlesRequest
$circlesService
private
CirclesService
$circlesService
$configService
private
ConfigService
$configService
$eventsService
private
EventsService
$eventsService
$groupManager
private
IGroupManager
$groupManager
$l10n
private
IL10N
$l10n
$membersRequest
private
DeprecatedMembersRequest
$membersRequest
$miscService
private
MiscService
$miscService
$userId
private
string
$userId
$userManager
private
IUserManager
$userManager
Methods
__construct()
GroupsService constructor.
public
__construct(string $userId, IL10N $l10n, IGroupManager $groupManager, IUserManager $userManager, ConfigService $configService, DeprecatedCirclesRequest $circlesRequest, DeprecatedMembersRequest $membersRequest, CirclesService $circlesService, EventsService $eventsService, MiscService $miscService) : mixed
Parameters
- $userId : string
- $l10n : IL10N
- $groupManager : IGroupManager
- $userManager : IUserManager
- $configService : ConfigService
- $circlesRequest : DeprecatedCirclesRequest
- $membersRequest : DeprecatedMembersRequest
- $circlesService : CirclesService
- $eventsService : EventsService
- $miscService : MiscService
Return values
mixed —levelGroup()
public
levelGroup(string $circleUniqueId, string $groupId, int $level) : array<string|int, mixed>
Parameters
- $circleUniqueId : string
- $groupId : string
- $level : int
Tags
Return values
array<string|int, mixed> —linkGroup()
public
linkGroup(string $circleUniqueId, string $groupId) : array<string|int, mixed>
Parameters
- $circleUniqueId : string
- $groupId : string
Tags
Return values
array<string|int, mixed> —onGroupRemoved()
When a group is removed, remove it from all Circles
public
onGroupRemoved(string $groupId) : mixed
Parameters
- $groupId : string
Return values
mixed —unlinkGroup()
public
unlinkGroup(string $circleUniqueId, string $groupId) : array<string|int, mixed>
Parameters
- $circleUniqueId : string
- $groupId : string
Tags
Return values
array<string|int, mixed> —editGroupLevel()
private
editGroupLevel(DeprecatedCircle $circle, DeprecatedMember $group, $level) : mixed
Parameters
- $circle : DeprecatedCircle
- $group : DeprecatedMember
- $level :
Tags
Return values
mixed —getFreshNewMember()
Check if a fresh member can be generated (by linkGroup)
private
getFreshNewMember( $circleId, $groupId) : null|DeprecatedMember