Bitrix API

Component

Table of Contents

Methods

getComponentName()  : string
Returns name of a component to include, e.g., bitrix:intranet.component
getComponentParams()  : array<string|int, mixed>
Returns array of params ($arParams) of component to include
getComponentTemplate()  : string
Returns name of a component template, e.g., '.default'
setComponentName()  : Component
Set name of a component to include, e.g., bitrix:intranet.component
setComponentParams()  : Component
Sets array of params ($arParams) of component to include
setComponentTemplate()  : Component
Sets name of a component template, e.g., '.default'

Methods

getComponentName()

Returns name of a component to include, e.g., bitrix:intranet.component

public getComponentName() : string
Return values
string

getComponentParams()

Returns array of params ($arParams) of component to include

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

getComponentTemplate()

Returns name of a component template, e.g., '.default'

public getComponentTemplate() : string
Return values
string

setComponentName()

Set name of a component to include, e.g., bitrix:intranet.component

public setComponentName(string $componentName) : Component
Parameters
$componentName : string
Return values
Component

setComponentParams()

Sets array of params ($arParams) of component to include

public setComponentParams(array<string|int, mixed> $componentParams) : Component
Parameters
$componentParams : array<string|int, mixed>
Return values
Component

setComponentTemplate()

Sets name of a component template, e.g., '.default'

public setComponentTemplate(string $componentTemplate) : Component
Parameters
$componentTemplate : string
Return values
Component 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results