Bitrix API

StructureService

Table of Contents

Methods

getChildDepartments()  : array<string|int, array{id: int, name: string, depthLevel: int, headUserId: int, parent: int}>
getDepartmentHeadId()  : int
getDepartmentUserIds()  : array<string|int, int>
getInstance()  : self
getParentDepartments()  : array<string|int, array{id: int, name: string, depthLevel: int, headUserId: int, parent: int}>
getStructure()  : array<string|int, array{id: int, name: string, depthLevel: int, headUserId: int, parent: int}>
isCompanyStructureConverted()  : bool
resetCache()  : void

Methods

getChildDepartments()

public getChildDepartments(int $departmentId[, bool $recursion = false ][, bool $includeCurrentDepartment = false ]) : array<string|int, array{id: int, name: string, depthLevel: int, headUserId: int, parent: int}>
Parameters
$departmentId : int
$recursion : bool = false
$includeCurrentDepartment : bool = false
Return values
array<string|int, array{id: int, name: string, depthLevel: int, headUserId: int, parent: int}>

getDepartmentHeadId()

public getDepartmentHeadId(int $departmentId) : int
Parameters
$departmentId : int
Return values
int

getDepartmentUserIds()

public getDepartmentUserIds(int $departmentId[, bool $excludeHead = true ]) : array<string|int, int>
Parameters
$departmentId : int
$excludeHead : bool = true
Return values
array<string|int, int>

getParentDepartments()

public getParentDepartments(int $departmentId[, bool $recursion = false ][, bool $includeCurrentDepartment = false ]) : array<string|int, array{id: int, name: string, depthLevel: int, headUserId: int, parent: int}>
Parameters
$departmentId : int
$recursion : bool = false
$includeCurrentDepartment : bool = false
Return values
array<string|int, array{id: int, name: string, depthLevel: int, headUserId: int, parent: int}>

getStructure()

public getStructure() : array<string|int, array{id: int, name: string, depthLevel: int, headUserId: int, parent: int}>
Return values
array<string|int, array{id: int, name: string, depthLevel: int, headUserId: int, parent: int}>

isCompanyStructureConverted()

public isCompanyStructureConverted() : bool
Return values
bool

        
On this page

Search results