Bitrix API

RoleService

Table of Contents

Methods

__construct()  : mixed
addCreationActions()  : void
addTranslateDescriptions()  : void
addTranslateNames()  : void
changeActivateRole()  : void
changeActivateRoles()  : Result
createRole()  : UpdateResult|AddResult
getAvatarIdByRoleId()  : int
getMainRoleDataByCode()  : array<string|int, mixed>
getMainRoleDataByCodes()  : array<string|int, mixed>
getRoleByCode()  : array<string|int, mixed>|null
getRoleByIdForUpdate()  : RoleForUpdateDto|null
getRoleIdByCode()  : int|null
getRoleIdInAccessibleList()  : int|null
saveRole()  : AddResult|UpdateResult|Result

Methods

addCreationActions()

public addCreationActions(int $roleId) : void
Parameters
$roleId : int

addTranslateDescriptions()

public addTranslateDescriptions(int $roleId, array<string|int, mixed> $descriptions[, bool $needDeleteOld = false ]) : void
Parameters
$roleId : int
$descriptions : array<string|int, mixed>
$needDeleteOld : bool = false

addTranslateNames()

public addTranslateNames(int $roleId, array<string|int, mixed> $names[, bool $needDeleteOld = false ]) : void
Parameters
$roleId : int
$names : array<string|int, mixed>
$needDeleteOld : bool = false

changeActivateRole()

public changeActivateRole(int $roleId, bool $needActivate, int $userId) : void
Parameters
$roleId : int
$needActivate : bool
$userId : int

changeActivateRoles()

public changeActivateRoles(array<string|int, mixed> $roleIds, bool $needActivate, int $userId) : Result
Parameters
$roleIds : array<string|int, mixed>
$needActivate : bool
$userId : int
Return values
Result

getAvatarIdByRoleId()

public getAvatarIdByRoleId(int $roleId) : int
Parameters
$roleId : int
Return values
int

getMainRoleDataByCode()

public getMainRoleDataByCode(string $code) : array<string|int, mixed>
Parameters
$code : string
Return values
array<string|int, mixed>

getMainRoleDataByCodes()

public getMainRoleDataByCodes(array<string|int, mixed> $roleCodes) : array<string|int, mixed>
Parameters
$roleCodes : array<string|int, mixed>
Return values
array<string|int, mixed>

getRoleByCode()

public getRoleByCode(array<string|int, mixed> $data) : array<string|int, mixed>|null
Parameters
$data : array<string|int, mixed>
Return values
array<string|int, mixed>|null

getRoleIdByCode()

public getRoleIdByCode(string $code) : int|null
Parameters
$code : string
Return values
int|null

getRoleIdInAccessibleList()

public getRoleIdInAccessibleList(int $userId, int $roleId[, bool|null $ignoreDelete = null ]) : int|null
Parameters
$userId : int
$roleId : int
$ignoreDelete : bool|null = null
Return values
int|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results