Bitrix API

Agreement

Class Agreement

Table of Contents

Methods

acceptByCurrentUser() : bool: Return true if user accepted agreement.
getErrorText() : string: Get agreement error text.
getText() : string: Get agreement text.
isAcceptedByUser() : bool: Checks if User have access to module.
requestFromCurrentUser() : void: Request agreement accept.

acceptByCurrentUser()

Return true if user accepted agreement.


    public
            static        acceptByCurrentUser() : bool

Return values

bool

getErrorText()

Get agreement error text.


    public
            static        getErrorText() : string

Return values

string

getText()

Get agreement text.


    public
            static        getText([bool $asRichHtml = false ]) : string

Parameters

$asRichHtml : bool = false: Get as rich html.

Return values

string

isAcceptedByUser()

Checks if User have access to module.


    public
            static        isAcceptedByUser(int $userId) : bool

Parameters

$userId : int: User ID.

Return values

bool

requestFromCurrentUser()

Request agreement accept.


    public
            static        requestFromCurrentUser() : void