Bitrix API

User

Table of Contents

Methods

__construct()  : mixed
getAccessCode()  : string
getActive()  : bool|null
getAuthPhoneNumber()  : string|null
getConfirmCode()  : string|null
getDepartmetnsIds()  : array<string|int, mixed>|null
getEmail()  : string|null
getExternalAuthId()  : string|null
getGroupIds()  : array<string|int, mixed>|null
getId()  : int|null
getInviteStatus()  : InvitationStatus
getLastName()  : string|null
getLogin()  : string|null
getName()  : string|null
getPhoneNumber()  : string|null
getRole()  : UserRole
getXmlId()  : string|null
initByArray()  : self
isAdmin()  : bool
isCollaber()  : bool
isEmail()  : bool
isExternal()  : bool
isExtranet()  : bool
isIntegrator()  : bool
isIntranet()  : bool
isShop()  : bool
setActive()  : void
setAuthPhoneNumber()  : void
setConfirmCode()  : void
setDepartmetnsIds()  : void
setEmail()  : void
setExternalAuthId()  : void
setGroupIds()  : void
setId()  : void
setLastName()  : void
setLogin()  : void
setName()  : void
setPhoneNumber()  : void
setXmlId()  : void

Methods

__construct()

public __construct([int|null $id = null ][, array<string|int, mixed>|null $departmetnsIds = null ][, string|null $login = null ][, string|null $email = null ][, string|null $name = null ][, string|null $lastName = null ][, string|null $confirmCode = null ][, array<string|int, mixed>|null $groupIds = null ][, string|null $phoneNumber = null ][, string|null $xmlId = null ][, bool|null $active = null ][, string|null $externalAuthId = null ][, string|null $authPhoneNumber = null ]) : mixed
Parameters
$id : int|null = null
$departmetnsIds : array<string|int, mixed>|null = null
$login : string|null = null
$email : string|null = null
$name : string|null = null
$lastName : string|null = null
$confirmCode : string|null = null
$groupIds : array<string|int, mixed>|null = null
$phoneNumber : string|null = null
$xmlId : string|null = null
$active : bool|null = null
$externalAuthId : string|null = null
$authPhoneNumber : string|null = null

getAccessCode()

public getAccessCode() : string
Return values
string

getActive()

public getActive() : bool|null
Return values
bool|null

getAuthPhoneNumber()

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

getConfirmCode()

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

getDepartmetnsIds()

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

getEmail()

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

getExternalAuthId()

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

getGroupIds()

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

getId()

public getId() : int|null
Return values
int|null

getLastName()

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

getLogin()

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

getName()

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

getPhoneNumber()

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

getXmlId()

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

initByArray()

public static initByArray(array<string|int, mixed> $userData) : self
Parameters
$userData : array<string|int, mixed>
Return values
self

isAdmin()

public isAdmin() : bool
Return values
bool

isCollaber()

public isCollaber() : 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

isIntegrator()

public isIntegrator() : bool
Return values
bool

isIntranet()

public isIntranet() : bool
Return values
bool

isShop()

public isShop() : bool
Return values
bool

setActive()

public setActive(bool|null $active) : void
Parameters
$active : bool|null

setAuthPhoneNumber()

public setAuthPhoneNumber(string|null $authPhoneNumber) : void
Parameters
$authPhoneNumber : string|null

setConfirmCode()

public setConfirmCode(string|null $confirmCode) : void
Parameters
$confirmCode : string|null

setDepartmetnsIds()

public setDepartmetnsIds(array<string|int, mixed>|null $departmetnsIds) : void
Parameters
$departmetnsIds : array<string|int, mixed>|null

setEmail()

public setEmail(string|null $email) : void
Parameters
$email : string|null

setExternalAuthId()

public setExternalAuthId(string|null $externalAuthId) : void
Parameters
$externalAuthId : string|null

setGroupIds()

public setGroupIds(array<string|int, mixed>|null $groupIds) : void
Parameters
$groupIds : array<string|int, mixed>|null

setId()

public setId(int|null $id) : void
Parameters
$id : int|null

setLastName()

public setLastName(string|null $lastName) : void
Parameters
$lastName : string|null

setLogin()

public setLogin(string|null $login) : void
Parameters
$login : string|null

setName()

public setName(string|null $name) : void
Parameters
$name : string|null

setPhoneNumber()

public setPhoneNumber(string|null $phoneNumber) : void
Parameters
$phoneNumber : string|null

setXmlId()

public setXmlId(string|null $xmlId) : void
Parameters
$xmlId : string|null

        
On this page

Search results