Bitrix API

UserProvider extends BaseProvider

Table of Contents

Methods

__construct()  : mixed
doSearch()  : void
fillDialog()  : void
formatUserName()  : string
getAllowedFields()  : array<string|int, mixed>
getChildren()  : void
getCurrentUserId()  : int
getExtranetUserUrl()  : string
getIntranetUserUrl()  : string
getItems()  : array<string|int, Item>
getOption()  : mixed
getOptions()  : array<string|int, mixed>
getPreselectedItems()  : array<string|int, Item>
getSelectedItems()  : array<string|int, Item>
getUser()  : EO_User|null
getUserCollection()  : EO_User_Collection
getUserItems()  : array<string|int, mixed>
getUsers()  : EO_User_Collection
getUserType()  : string
getUserUrl()  : string
handleBeforeItemSave()  : void
isAvailable()  : bool
isExtranetUser()  : bool
isIntegrator()  : bool
isIntranetUser()  : bool
makeItem()  : Item
makeItems()  : array<string|int, mixed>
makeUserAvatar()  : string|null
makeUserItems()  : array<string|int, mixed>
shouldFillDialog()  : bool

Methods

__construct()

public __construct([array<string|int, mixed> $options = [] ]) : mixed
Parameters
$options : array<string|int, mixed> = []

formatUserName()

public static formatUserName(EO_User $user[, array<string|int, mixed> $options = [] ]) : string
Parameters
$user : EO_User
$options : array<string|int, mixed> = []
Return values
string

getAllowedFields()

public static getAllowedFields() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCurrentUserId()

public static getCurrentUserId() : int
Return values
int

getExtranetUserUrl()

public static getExtranetUserUrl([int|null $userId = null ]) : string
Parameters
$userId : int|null = null
Return values
string

getIntranetUserUrl()

public static getIntranetUserUrl([int|null $userId = null ]) : string
Parameters
$userId : int|null = null
Return values
string

getItems()

public getItems(array<string|int, mixed> $ids) : array<string|int, Item>
Parameters
$ids : array<string|int, mixed>
Return values
array<string|int, Item>

getOption()

public getOption(string $option[, mixed $defaultValue = null ]) : mixed
Parameters
$option : string
$defaultValue : mixed = null

getOptions()

public getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPreselectedItems()

public getPreselectedItems(array<string|int, mixed> $ids) : array<string|int, Item>
Parameters
$ids : array<string|int, mixed>
Return values
array<string|int, Item>

getSelectedItems()

public getSelectedItems(array<string|int, mixed> $ids) : array<string|int, Item>
Parameters
$ids : array<string|int, mixed>
Return values
array<string|int, Item>

getUser()

public static getUser(int $userId[, array<string|int, mixed> $options = [] ]) : EO_User|null
Parameters
$userId : int
$options : array<string|int, mixed> = []
Return values
EO_User|null

getUserCollection()

public getUserCollection([array<string|int, mixed> $options = [] ]) : EO_User_Collection
Parameters
$options : array<string|int, mixed> = []
Return values
EO_User_Collection

getUserItems()

public getUserItems([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$options : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getUsers()

public static getUsers([array<string|int, mixed> $options = [] ]) : EO_User_Collection
Parameters
$options : array<string|int, mixed> = []
Return values
EO_User_Collection

getUserType()

public static getUserType(EO_User $user) : string
Parameters
$user : EO_User
Return values
string

getUserUrl()

public static getUserUrl([int|null $userId = null ]) : string
Parameters
$userId : int|null = null
Return values
string

isAvailable()

public isAvailable() : bool
Return values
bool

isExtranetUser()

public static isExtranetUser([int $userId = null ]) : bool
Parameters
$userId : int = null
Return values
bool

isIntegrator()

public static isIntegrator([int $userId = null ]) : bool
Parameters
$userId : int = null
Return values
bool

isIntranetUser()

public static isIntranetUser([int $userId = null ]) : bool
Parameters
$userId : int = null
Return values
bool

makeItem()

public static makeItem(EO_User $user[, array<string|int, mixed> $options = [] ]) : Item
Parameters
$user : EO_User
$options : array<string|int, mixed> = []
Return values
Item

makeItems()

public static makeItems(EO_User_Collection $users[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$users : EO_User_Collection
$options : array<string|int, mixed> = []
Return values
array<string|int, mixed>

makeUserAvatar()

public static makeUserAvatar(EO_User $user) : string|null
Parameters
$user : EO_User
Return values
string|null

makeUserItems()

public makeUserItems(EO_User_Collection $users[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$users : EO_User_Collection
$options : array<string|int, mixed> = []
Return values
array<string|int, mixed>

shouldFillDialog()

public shouldFillDialog() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results