Bitrix API

Form

Table of Contents

Constants

PHONE_VERIFY_ENTITY  = 'crm_webform'
REDIRECT_DELAY  = 5

Methods

__construct()  : mixed
activate()  : mixed
actualizeFormsActiveState()  : mixed
addResult()  : mixed
buildScript()  : mixed
canActivateForm()  : mixed
canRemoveCopyright()  : mixed
check()  : mixed
checkSecurityCode()  : mixed
cleanCacheByTag()  : mixed
copy()  : mixed
delete()  : mixed
fill()  : mixed
get()  : mixed
getAgreementUrl()  : mixed
getAllowedEntitySchemes()  : mixed
getButtonCaption()  : mixed
getCacheTag()  : mixed
getCounters()  : mixed
getCurrencyId()  : mixed
getDependencies()  : mixed
getDesignOptions()  : array<string|int, mixed>
Get design options.
getErrors()  : mixed
getExternalAnalyticsData()  : mixed
getFailureText()  : string
Get failure text.
getFields()  : mixed
getFieldsByType()  : array<string|int, mixed>
getFieldsDescription()  : mixed
getFieldsMap()  : mixed
getId()  : mixed
getIdByCode()  : mixed
getIntegration()  : mixed
getLandingUrl()  : mixed
getLanguageId()  : mixed
getMaxActivatedFormLimit()  : mixed
getName()  : string
getPresetFields()  : mixed
getRedirectDelay()  : int
Get redirect delay.
getRefill()  : array<string|int, mixed>
Get refill options.
getScripts()  : mixed
getSuccessPageUrl()  : mixed
getSuccessText()  : string
Get success text.
hasErrors()  : mixed
hasField()  : bool
hasResult()  : mixed
incCounterEndFill()  : mixed
incCounterStartFill()  : mixed
incCounterView()  : mixed
isActive()  : mixed
isCallback()  : mixed
isEmbeddingAvailable()  : mixed
isEmbeddingEnabled()  : mixed
isPayable()  : bool
Return true if form payable.
isSystem()  : mixed
isUsedCaptcha()  : mixed
isWhatsApp()  : mixed
load()  : mixed
loadOnlyForm()  : mixed
merge()  : mixed
onAfterSetOptionCrmWebFormMaxActivated()  : mixed
onBitrix24LicenseChange()  : mixed
resetCounters()  : mixed
save()  : mixed
sendScriptsEmail()  : mixed
set()  : mixed
setDesignOptions()  : $this
Set design options.
setEmbeddingEnabled()  : $this
Set design options.
setId()  : mixed
setSystem()  : mixed
updateBackgroundImage()  : mixed

Constants

PHONE_VERIFY_ENTITY

public mixed PHONE_VERIFY_ENTITY = 'crm_webform'

REDIRECT_DELAY

public mixed REDIRECT_DELAY = 5

Methods

__construct()

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

activate()

public static activate(mixed $formId[, mixed $isActivate = true ][, mixed $changeUserBy = null ]) : mixed
Parameters
$formId : mixed
$isActivate : mixed = true
$changeUserBy : mixed = null

actualizeFormsActiveState()

public static actualizeFormsActiveState([mixed $maxActivated = null ]) : mixed
Parameters
$maxActivated : mixed = null

addResult()

public addResult(mixed $resultFields[, mixed $resultParameters = array() ]) : mixed
Parameters
$resultFields : mixed
$resultParameters : mixed = array()

buildScript()

public buildScript() : mixed

canActivateForm()

public static canActivateForm() : mixed

canRemoveCopyright()

public static canRemoveCopyright() : mixed

check()

public check() : mixed

checkSecurityCode()

public checkSecurityCode(mixed $code) : mixed
Parameters
$code : mixed

cleanCacheByTag()

public static cleanCacheByTag(mixed $formId) : mixed
Parameters
$formId : mixed

copy()

public static copy(mixed $formId[, mixed $userId = null ]) : mixed
Parameters
$formId : mixed
$userId : mixed = null

delete()

public static delete(mixed $formId[, mixed $forceSystem = false ]) : mixed
Parameters
$formId : mixed
$forceSystem : mixed = false

fill()

public fill() : mixed

get()

public get() : mixed

getAgreementUrl()

public getAgreementUrl() : mixed

getAllowedEntitySchemes()

public getAllowedEntitySchemes() : mixed

getButtonCaption()

public getButtonCaption() : mixed

getCacheTag()

public static getCacheTag(mixed $formId) : mixed
Parameters
$formId : mixed

getCounters()

public static getCounters(mixed $formId[, mixed $schemeId = null ]) : mixed
Parameters
$formId : mixed
$schemeId : mixed = null

getCurrencyId()

public getCurrencyId() : mixed

getDependencies()

public getDependencies([mixed $opposites = true ]) : mixed
Parameters
$opposites : mixed = true

getDesignOptions()

Get design options.

public getDesignOptions([bool $asTyped = false ]) : array<string|int, mixed>
Parameters
$asTyped : bool = false

Return as typed.

Return values
array<string|int, mixed>

getErrors()

public getErrors() : mixed

getExternalAnalyticsData()

public getExternalAnalyticsData() : mixed

getFailureText()

Get failure text.

public getFailureText() : string
Return values
string

getFields()

public getFields() : mixed

getFieldsByType()

public getFieldsByType(string $type) : array<string|int, mixed>
Parameters
$type : string
Return values
array<string|int, mixed>

getFieldsDescription()

public getFieldsDescription() : mixed

getFieldsMap()

public getFieldsMap() : mixed

getId()

public getId() : mixed

getIdByCode()

public static getIdByCode(mixed $formCode) : mixed
Parameters
$formCode : mixed

getIntegration()

public getIntegration() : mixed

getLandingUrl()

public getLandingUrl() : mixed

getLanguageId()

public getLanguageId() : mixed

getMaxActivatedFormLimit()

public static getMaxActivatedFormLimit() : mixed

getName()

public getName() : string
Return values
string

getPresetFields()

public getPresetFields() : mixed

getRedirectDelay()

Get redirect delay.

public getRedirectDelay() : int
Return values
int

getRefill()

Get refill options.

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

getScripts()

public getScripts(mixed $publicFormPath) : mixed
Parameters
$publicFormPath : mixed

getSuccessPageUrl()

public getSuccessPageUrl() : mixed

getSuccessText()

Get success text.

public getSuccessText() : string
Return values
string

hasErrors()

public hasErrors() : mixed

hasField()

public hasField(string $code) : bool
Parameters
$code : string
Return values
bool

hasResult()

public hasResult(mixed $originId) : mixed
Parameters
$originId : mixed

incCounterEndFill()

public static incCounterEndFill(mixed $formId) : mixed
Parameters
$formId : mixed

incCounterStartFill()

public static incCounterStartFill(mixed $formId) : mixed
Parameters
$formId : mixed

incCounterView()

public static incCounterView(mixed $formId) : mixed
Parameters
$formId : mixed

isActive()

public isActive() : mixed

isCallback()

public isCallback() : mixed

isEmbeddingAvailable()

public isEmbeddingAvailable() : mixed

isEmbeddingEnabled()

public isEmbeddingEnabled() : mixed

isPayable()

Return true if form payable.

public isPayable() : bool
Return values
bool

isSystem()

public isSystem() : mixed

isUsedCaptcha()

public isUsedCaptcha() : mixed

isWhatsApp()

public isWhatsApp() : mixed

load()

public load(mixed $id) : mixed
Parameters
$id : mixed

loadOnlyForm()

public loadOnlyForm(mixed $id) : mixed
Parameters
$id : mixed

merge()

public merge(mixed $params) : mixed
Parameters
$params : mixed

onAfterSetOptionCrmWebFormMaxActivated()

public static onAfterSetOptionCrmWebFormMaxActivated(Event $event) : mixed
Parameters
$event : Event

onBitrix24LicenseChange()

public static onBitrix24LicenseChange(Event $event) : mixed
Parameters
$event : Event

resetCounters()

public static resetCounters(mixed $formId) : mixed
Parameters
$formId : mixed

save()

public save([mixed $onlyCheck = false ]) : mixed
Parameters
$onlyCheck : mixed = false

sendScriptsEmail()

public sendScriptsEmail(mixed $email) : mixed
Parameters
$email : mixed

set()

public set(array<string|int, mixed> $params) : mixed
Parameters
$params : array<string|int, mixed>

setDesignOptions()

Set design options.

public setDesignOptions([array<string|int, mixed> $options = [] ]) : $this
Parameters
$options : array<string|int, mixed> = []

Options.

Return values
$this

setEmbeddingEnabled()

Set design options.

public setEmbeddingEnabled(bool $mode) : $this
Parameters
$mode : bool

Mode.

Return values
$this

setId()

public setId(mixed $id) : mixed
Parameters
$id : mixed

setSystem()

public setSystem() : mixed

updateBackgroundImage()

public static updateBackgroundImage(mixed $formId, mixed $fileId) : mixed
Parameters
$formId : mixed
$fileId : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results