NodeMemberService
Table of Contents
Constants
- MEMBER_TO_MEMBER_SUBORDINATE_CACHE_KEY = 'node_member/member_from/%d/member_to/%d'
Methods
- getAllEmployees() : NodeMemberCollection
- getDefaultHeadRoleEmployees() : NodeMemberCollection
- getMemberInformation() : NodeMember
- getMemberSubordination() : MemberSubordinateRelationType
- Calculates relation between members with id $memberId and member with id $targetMemberId Simplified: Who is member for targetMember
- getPagedEmployees() : NodeMemberCollection
- moveMember() : NodeMember
- moveUsersToDepartment() : array<string|int, mixed>
- removeUserMemberFromDepartment() : NodeMember|null
- removeUserMembersFromDepartmentByCollection() : NodeMemberCollection
- saveUsersToDepartment() : NodeMemberCollection
Constants
MEMBER_TO_MEMBER_SUBORDINATE_CACHE_KEY
public
mixed
MEMBER_TO_MEMBER_SUBORDINATE_CACHE_KEY
= 'node_member/member_from/%d/member_to/%d'
Methods
getAllEmployees()
public
getAllEmployees(int $nodeId[, bool $withAllChildNodes = false ][, bool $onlyActive = true ]) : NodeMemberCollection
Parameters
- $nodeId : int
- $withAllChildNodes : bool = false
- $onlyActive : bool = true
Return values
NodeMemberCollectiongetDefaultHeadRoleEmployees()
public
getDefaultHeadRoleEmployees(int $nodeId) : NodeMemberCollection
Parameters
- $nodeId : int
Return values
NodeMemberCollectiongetMemberInformation()
public
getMemberInformation(int $memberId) : NodeMember
Parameters
- $memberId : int
Return values
NodeMembergetMemberSubordination()
Calculates relation between members with id $memberId and member with id $targetMemberId Simplified: Who is member for targetMember
public
getMemberSubordination(int $memberId, int $targetMemberId) : MemberSubordinateRelationType
Parameters
- $memberId : int
- $targetMemberId : int
Tags
Return values
MemberSubordinateRelationTypegetPagedEmployees()
public
getPagedEmployees(int $nodeId[, bool $withAllChildNodes = false ][, int $offset = 0 ][, int $limit = 500 ][, bool $onlyActive = true ]) : NodeMemberCollection
Parameters
- $nodeId : int
- $withAllChildNodes : bool = false
- $offset : int = 0
- $limit : int = 500
- $onlyActive : bool = true
Return values
NodeMemberCollectionmoveMember()
public
moveMember(NodeMember $nodeMember, Node $node) : NodeMember
Parameters
- $nodeMember : NodeMember
- $node : Node
Return values
NodeMembermoveUsersToDepartment()
public
moveUsersToDepartment(Node $node[, array<string|int, mixed> $departmentUserIds = [] ]) : array<string|int, mixed>
Parameters
- $node : Node
- $departmentUserIds : array<string|int, mixed> = []
Tags
Return values
array<string|int, mixed>removeUserMemberFromDepartment()
public
removeUserMemberFromDepartment(NodeMember $nodeMember) : NodeMember|null
Parameters
- $nodeMember : NodeMember
Return values
NodeMember|nullremoveUserMembersFromDepartmentByCollection()
public
removeUserMembersFromDepartmentByCollection(NodeMemberCollection $nodeMemberCollection) : NodeMemberCollection
Parameters
- $nodeMemberCollection : NodeMemberCollection
Return values
NodeMemberCollectionsaveUsersToDepartment()
public
saveUsersToDepartment(Node $node[, array<string|int, mixed> $departmentUserIds = [] ]) : NodeMemberCollection
Parameters
- $node : Node
- $departmentUserIds : array<string|int, mixed> = []