Bitrix API

Agreement

Class Agreement

Table of Contents

Constants

ACTIVE  = 'Y'
NOT_ACTIVE  = 'N'
TYPE_CUSTOM  = 'C'
TYPE_STANDARD  = 'S'

Methods

__construct()  : mixed
Construct.
getActiveList()  : array<string|int, mixed>
Get active agreement list.
getData()  : array<string|int, mixed>
Get agreement data.
getErrors()  : array<string|int, Error>
Get errors.
getFields()  : array<string|int, mixed>
Return fields.
getFieldValues()  : array<string|int, mixed>
Return field values.
getHtml()  : string
Get html.
getId()  : int
Get agreement ID.
getLabel()  : string
Get label with synbols '%' for link in label text.
getLabelText()  : string
Get label text.
getText()  : string
Get text.
getTitle()  : string
Get title.
getTypeNames()  : array<string|int, mixed>
Get types.
getUrl()  : string
Get url.
hasErrors()  : bool
Has errors.
isActive()  : string
Return true if is active.
isAgreementTextHtml()  : bool
isExist()  : bool
Return true if is exist.
load()  : string
Return true if is used.
mergeData()  : void
Merge agreement data.
save()  : void
Save agreement data.
setData()  : void
Set agreement data.
setReplace()  : $this
Set replace.

Constants

TYPE_STANDARD

public mixed TYPE_STANDARD = 'S'

Methods

__construct()

Construct.

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

Agreement ID.

$replace : array<string|int, mixed> = array()

Replace data.

getActiveList()

Get active agreement list.

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

getData()

Get agreement data.

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

getErrors()

Get errors.

public getErrors() : array<string|int, Error>
Return values
array<string|int, Error>

getFields()

Return fields.

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

getFieldValues()

Return field values.

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

getHtml()

Get html.

public getHtml() : string
Return values
string

getId()

Get agreement ID.

public getId() : int
Return values
int

getLabel()

Get label with synbols '%' for link in label text.

public getLabel() : string
Return values
string

getLabelText()

Get label text.

public getLabelText() : string
Return values
string

getText()

Get text.

public getText([bool $cutTitle = false ]) : string
Parameters
$cutTitle : bool = false

Cut title.

Return values
string

getTitle()

Get title.

public getTitle() : string
Return values
string

getTypeNames()

Get types.

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

getUrl()

Get url.

public getUrl() : string
Return values
string

hasErrors()

Has errors.

public hasErrors() : bool
Return values
bool

isActive()

Return true if is active.

public isActive() : string
Return values
string

isAgreementTextHtml()

public isAgreementTextHtml() : bool
Return values
bool

isExist()

Return true if is exist.

public isExist() : bool
Return values
bool

load()

Return true if is used.

public load(int $id) : string
Parameters
$id : int

Agreement ID.

Return values
string

mergeData()

Merge agreement data.

public mergeData(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>

Data.

save()

Save agreement data.

public save() : void

setData()

Set agreement data.

public setData(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>

Data.

setReplace()

Set replace.

public setReplace(array<string|int, mixed> $replace) : $this
Parameters
$replace : array<string|int, mixed>

Replace data.

Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results