Bitrix API

User

Table of Contents

Methods

__construct()  : mixed
fetchOriginatorUser()  : self|null
getFields()  : array<string|int, mixed>
getGender()  : string|null
getId()  : int
getInvitationCounterValue()  : int
getStructureSort()  : array<string|int, mixed>
Returns sorted array of user id.
getTotalInvitationCounterValue()  : int
getUserRole()  : UserRole
getWaitConfirmationCounterValue()  : int
isAdmin()  : bool
isEmail()  : bool
isExternal()  : bool
isExtranet()  : bool
isInitializedUser()  : bool
isIntegrator()  : bool
isIntranet()  : bool
isShop()  : bool
numberOfInvitationsSent()  : int

Methods

__construct()

public __construct([int|null $userId = null ]) : mixed
Parameters
$userId : int|null = null
Tags
throws
ArgumentOutOfRangeException

fetchOriginatorUser()

public fetchOriginatorUser() : self|null
Return values
self|null

getFields()

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

getGender()

public getGender() : string|null
Return values
string|null

getId()

public getId() : int
Return values
int

getInvitationCounterValue()

public getInvitationCounterValue() : int
Return values
int

getStructureSort()

Returns sorted array of user id.

public getStructureSort([bool $onlyActive = true ][, bool $withInvited = true ]) : array<string|int, mixed>

Flags for correct complex sorting

Parameters
$onlyActive : bool = true
$withInvited : bool = true
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>

getTotalInvitationCounterValue()

public getTotalInvitationCounterValue() : int
Return values
int

getUserRole()

public getUserRole() : UserRole
Return values
UserRole

getWaitConfirmationCounterValue()

public getWaitConfirmationCounterValue() : int
Return values
int

isAdmin()

public isAdmin() : bool
Return values
bool

isEmail()

public isEmail() : bool
Return values
bool

isExternal()

public isExternal() : bool
Return values
bool

isExtranet()

public isExtranet() : bool
Return values
bool

isInitializedUser()

public isInitializedUser() : bool
Return values
bool

isIntegrator()

public isIntegrator() : bool
Return values
bool

isIntranet()

public isIntranet() : bool
Return values
bool

isShop()

public isShop() : bool
Return values
bool

numberOfInvitationsSent()

public numberOfInvitationsSent() : int
Return values
int

        
On this page

Search results