Bitrix API

Role

Table of Contents

Methods

appendInstruction()  : $this
Append instruction text, not saves. Use after text formatting for example.
clear()  : void
Removes all roles from DB.
createRuntime()  : self
Creates runtime Role with specific instructions.
get()  : self|null
Returns Role instance by code.
getCode()  : string
getIndustryCode()  : string|null
Return role industry code.
getInstruction()  : string
getLibrarySystemRole()  : self
Returns universal Role instance.
getModifyTime()  : DateTime
getUniversalRole()  : self
Returns universal Role instance.
setInstruction()  : $this
Sets new instruction text, not saves. Use after text formatting for example.

Methods

appendInstruction()

Append instruction text, not saves. Use after text formatting for example.

public appendInstruction(string $instruction) : $this
Parameters
$instruction : string

New text to append to existing.

Return values
$this

clear()

Removes all roles from DB.

public static clear() : void

createRuntime()

Creates runtime Role with specific instructions.

public static createRuntime(string $instruction) : self
Parameters
$instruction : string

Role's instruction text.

Return values
self

get()

Returns Role instance by code.

public static get(string|null $code) : self|null
Parameters
$code : string|null

Role code.

Return values
self|null

getCode()

public getCode() : string
Return values
string

getIndustryCode()

Return role industry code.

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

getInstruction()

public getInstruction() : string
Return values
string

getLibrarySystemRole()

Returns universal Role instance.

public static getLibrarySystemRole() : self
Return values
self

getUniversalRole()

Returns universal Role instance.

public static getUniversalRole() : self
Return values
self

setInstruction()

Sets new instruction text, not saves. Use after text formatting for example.

public setInstruction(string $instruction) : $this
Parameters
$instruction : string

New instruction text.

Return values
$this

        
On this page

Search results