Bitrix API

UserService implements UserService

FinalYes

Table of Contents

Interfaces

UserService

Constants

USER_DEPARTMENT_EXISTS_KEY  = 'user/department/exists/%d'

Methods

__construct()  : mixed
filterEmployees()  : array<string|int, int>
Returns an array of users who are members of a department
findByNodeAndSearchQuery()  : array<int, array{id: int, name: string, avatar: ?string, url: string, workPosition: ?string}>
Returns an array of basic user information
getBaseInformation()  : array<string|int, mixed>
Returns an array of basic user information
getUserAvatar()  : string|null
getUserById()  : User|null
getUserCollectionFromMemberCollection()  : UserCollection
getUserName()  : string
getUserUrl()  : string
isEmployee()  : bool
Check if user have relation with department node
isUserInvited()  : bool

Constants

USER_DEPARTMENT_EXISTS_KEY

public mixed USER_DEPARTMENT_EXISTS_KEY = 'user/department/exists/%d'

Methods

filterEmployees()

Returns an array of users who are members of a department

public filterEmployees(array<string|int, int> $userIds) : array<string|int, int>
Parameters
$userIds : array<string|int, int>
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, int>

findByNodeAndSearchQuery()

Returns an array of basic user information

public findByNodeAndSearchQuery(Node $node, string $searchQuery) : array<int, array{id: int, name: string, avatar: ?string, url: string, workPosition: ?string}>
Parameters
$node : Node
$searchQuery : string
Return values
array<int, array{id: int, name: string, avatar: ?string, url: string, workPosition: ?string}>

getBaseInformation()

Returns an array of basic user information

public getBaseInformation(User $user) : array<string|int, mixed>
Parameters
$user : User
Return values
array<string|int, mixed> —

{ id: int, name: string, avatar: ?string, url: string, workPosition: ?string, }

getUserAvatar()

public getUserAvatar(User $user[, int $size = 25 ]) : string|null
Parameters
$user : User
$size : int = 25
Return values
string|null

getUserById()

public getUserById(int $userId) : User|null
Parameters
$userId : int
Return values
User|null

getUserName()

public getUserName(User $user) : string
Parameters
$user : User
Return values
string

getUserUrl()

public getUserUrl(User $user) : string
Parameters
$user : User
Return values
string

isEmployee()

Check if user have relation with department node

public isEmployee(int $userId) : bool
Parameters
$userId : int
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

isUserInvited()

public isUserInvited(User $user) : bool
Parameters
$user : User
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results