Bitrix API

NodeMemberService implements NodeMemberService

Table of Contents

Interfaces

NodeMemberService

Methods

__construct()  : mixed
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()  : bool
removeUserMemberFromDepartment()  : NodeMember|null
removeUserMembersFromDepartmentByCollection()  : array<string|int, mixed>|NodeMemberCollection
saveUsersToDepartment()  : NodeMemberCollection

Methods

getMemberSubordination()

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
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
MemberSubordinateRelationType

getPagedEmployees()

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
NodeMemberCollection

moveUsersToDepartment()

public moveUsersToDepartment(Node $node[, array{MEMBER_HEAD?: list, MEMBER_EMPLOYEE?: list, MEMBER_DEPUTY_HEAD?: list$departmentUserIds = [] ]) : bool
Parameters
$node : Node
$departmentUserIds : array{MEMBER_HEAD?: list, MEMBER_EMPLOYEE?: list, MEMBER_DEPUTY_HEAD?: list} = []
Tags
throws
ArgumentException
throws
DuplicateEntryException
throws
SqlQueryException
throws
ObjectPropertyException
throws
SystemException
throws
CreationFailedException
Return values
bool

removeUserMembersFromDepartmentByCollection()

public removeUserMembersFromDepartmentByCollection(NodeMemberCollection $nodeMemberCollection) : array<string|int, mixed>|NodeMemberCollection
Parameters
$nodeMemberCollection : NodeMemberCollection
Tags
throws
UpdateFailedException
throws
WrongStructureItemException
throws
ArgumentException
throws
SqlQueryException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>|NodeMemberCollection

        
On this page

Search results