Bitrix API

Form

Table of Contents

Methods

appendField()  : self
appendFieldsFromFieldSet()  : self
create()  : self
delete()  : Result
getFieldSet()  : Item|null
getFieldSetValues()  : array<string|int, mixed>
getFillEventName()  : string
getId()  : int|null
getLoaderScript()  : string
getPersonalizationData()  : string
getRequisitePresetId()  : int|null
getRequisitePresetIdByFieldSet()  : int|null
isExists()  : bool
load()  : self
loadByXmlId()  : self
restoreDefaultFieldSet()  : void
save()  : Result
setButtonCaption()  : self
setDynamicTypeId()  : self
setFields()  : self
setName()  : self
setRefillButtonCaption()  : self
setRequisitePresetId()  : self
setResultText()  : self
setXmlId()  : self

Methods

appendField()

public appendField(array<string|int, mixed> $options) : self
Parameters
$options : array<string|int, mixed>
Return values
self

appendFieldsFromFieldSet()

public appendFieldsFromFieldSet(int $entityTypeId[, int|null $requisitePresetId = null ]) : self
Parameters
$entityTypeId : int
$requisitePresetId : int|null = null
Return values
self

create()

public static create([string $type = 'sign' ]) : self
Parameters
$type : string = 'sign'
Return values
self

delete()

public delete() : Result
Return values
Result

getFieldSet()

public static getFieldSet(int $entityTypeId[, int|null $presetId = null ]) : Item|null
Parameters
$entityTypeId : int
$presetId : int|null = null
Return values
Item|null

getFieldSetValues()

public static getFieldSetValues(int $entityTypeId, int $entityId[, array<string|int, mixed> $options = [] ][, int|null $requisitePresetId = null ]) : array<string|int, mixed>
Parameters
$entityTypeId : int
$entityId : int
$options : array<string|int, mixed> = []
$requisitePresetId : int|null = null
Return values
array<string|int, mixed>

getFillEventName()

public getFillEventName() : string
Return values
string

getId()

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

getLoaderScript()

public getLoaderScript([string $formInstanceId = '' ]) : string
Parameters
$formInstanceId : string = ''
Return values
string

getPersonalizationData()

public getPersonalizationData(int $entityId[, int $contactId = null ][, int $companyId = null ]) : string
Parameters
$entityId : int
$contactId : int = null
$companyId : int = null
Return values
string

getRequisitePresetId()

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

getRequisitePresetIdByFieldSet()

public getRequisitePresetIdByFieldSet(int $entityTypeId) : int|null
Parameters
$entityTypeId : int
Return values
int|null

isExists()

public isExists() : bool
Return values
bool

load()

public load(int $id) : self
Parameters
$id : int
Return values
self

loadByXmlId()

public loadByXmlId(string $xmlId) : self
Parameters
$xmlId : string
Return values
self

restoreDefaultFieldSet()

public static restoreDefaultFieldSet(int $entityTypeId[, int|null $presetId = null ]) : void
Parameters
$entityTypeId : int
$presetId : int|null = null

save()

public save() : Result
Return values
Result

setButtonCaption()

public setButtonCaption(string $text) : self
Parameters
$text : string
Return values
self

setDynamicTypeId()

public setDynamicTypeId(int $typeId) : self
Parameters
$typeId : int
Return values
self

setFields()

public setFields(array<string|int, mixed> $list) : self
Parameters
$list : array<string|int, mixed>
Return values
self

setName()

public setName(string $name) : self
Parameters
$name : string
Return values
self

setRefillButtonCaption()

public setRefillButtonCaption(string $text) : self
Parameters
$text : string
Return values
self

setRequisitePresetId()

public setRequisitePresetId(int $requisitePresetId) : self
Parameters
$requisitePresetId : int
Return values
self

setResultText()

public setResultText(string $successText[, string $failureText = null ]) : self
Parameters
$successText : string
$failureText : string = null
Return values
self

setXmlId()

public setXmlId(string $xmlId) : self
Parameters
$xmlId : string
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results