Bitrix API

Form extends Base

Class Form

Table of Contents

Constants

TYPE_CALL_TRACKER  = 'call.tracker'
TYPE_CALL_TRACKER_EDITOR  = 'call.tracker.ed'
TYPE_FORM  = 'form'
TYPE_GLOBAL  = 'global'
TYPE_GUEST  = 'guest'
TYPE_SITE_BUTTON  = 'button'

Methods

addCheckResourcesAgent()  : void
Add check resources agent.
build()  : bool
Build.
checkFileExists()  : bool
Check file exists.
checkResourcesFileExistsAgent()  : string
Check resources file exists.
configure()  : void
Configure. Set extensions and modules to controller.
configureFormEmbeddedScript()  : mixed
delete()  : void
Delete.
getContent()  : string
Get content.
getEmbeddedBody()  : string
Get embedded body.
getEmbeddedFileUrl()  : string
Get embedded body.
getEmbeddedModule()  : Module
Get embedded module.
getEmbeddedScript()  : string
Get embedded script.
getId()  : int|null
Get controller.
getLoader()  : Loader
Get embedded body.
getModule()  : Module|null
Get module.
getTagAttributes()  : array<string|int, mixed>
Get tag attributes.
hasRow()  : mixed
instance()  : static
Get instance.
isBuilt()  : bool
Return true if it was built.
onAfterBuild()  : void
rebuild()  : bool
Rebuild.
rebuildAgent()  : string
Rebuild agent.
rebuildAll()  : void
Rebuild all packs.
rebuildResources()  : string
Rebuild resources.
rebuildResourcesAgent()  : string
Rebuild resources agent.
setAdditionalFormOptions()  : mixed
setAdditionalOptions()  : mixed
setCacheTtl()  : $this
Get embedded body.
setTagAttribute()  : $this
Set tag attribute.

Constants

TYPE_CALL_TRACKER

public mixed TYPE_CALL_TRACKER = 'call.tracker'

TYPE_CALL_TRACKER_EDITOR

public mixed TYPE_CALL_TRACKER_EDITOR = 'call.tracker.ed'

TYPE_FORM

public mixed TYPE_FORM = 'form'

TYPE_GLOBAL

public mixed TYPE_GLOBAL = 'global'

TYPE_GUEST

public mixed TYPE_GUEST = 'guest'

TYPE_SITE_BUTTON

public mixed TYPE_SITE_BUTTON = 'button'

Methods

addCheckResourcesAgent()

Add check resources agent.

public static addCheckResourcesAgent() : void

build()

Build.

public build() : bool
Return values
bool

checkFileExists()

Check file exists.

public final checkFileExists() : bool
Return values
bool

checkResourcesFileExistsAgent()

Check resources file exists.

public static checkResourcesFileExistsAgent() : string
Return values
string

configure()

Configure. Set extensions and modules to controller.

public configure() : void

configureFormEmbeddedScript()

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

delete()

Delete.

public delete() : void

getContent()

Get content.

public getContent() : string
Return values
string

getEmbeddedBody()

Get embedded body.

public getEmbeddedBody() : string
Return values
string

getEmbeddedFileUrl()

Get embedded body.

public getEmbeddedFileUrl() : string
Return values
string

getEmbeddedModule()

Get embedded module.

public getEmbeddedModule() : Module
Return values
Module

getEmbeddedScript()

Get embedded script.

public getEmbeddedScript() : string
Return values
string

getId()

Get controller.

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

getModule()

Get module.

public getModule(string $name) : Module|null
Parameters
$name : string

Name.

Return values
Module|null

getTagAttributes()

Get tag attributes.

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

hasRow()

public hasRow() : mixed

instance()

Get instance.

public static instance(int $formId) : static
Parameters
$formId : int

Form ID.

Return values
static

isBuilt()

Return true if it was built.

public isBuilt([Date $dateFrom = null ]) : bool
Parameters
$dateFrom : Date = null

Check if file date update is greater Date from parameter.

Return values
bool

onAfterBuild()

public onAfterBuild(Result $result) : void
Parameters
$result : Result

rebuild()

Rebuild.

public final static rebuild(int $id) : bool
Parameters
$id : int

ID.

Return values
bool

rebuildAgent()

Rebuild agent.

public static rebuildAgent(int $formId) : string
Parameters
$formId : int

Form ID.

Return values
string

rebuildAll()

Rebuild all packs.

public final static rebuildAll() : void

rebuildResources()

Rebuild resources.

public static rebuildResources() : string
Return values
string

rebuildResourcesAgent()

Rebuild resources agent.

public static rebuildResourcesAgent() : string
Return values
string

setAdditionalFormOptions()

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

setAdditionalOptions()

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

setCacheTtl()

Get embedded body.

public setCacheTtl(int $cacheTtl) : $this
Parameters
$cacheTtl : int

Cache ttl.

Return values
$this

setTagAttribute()

Set tag attribute.

public setTagAttribute(string $key, mixed $value) : $this
Parameters
$key : string
$value : mixed
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results