Bitrix API

Field extends Field

Tags
see
Field

Table of Contents

Methods

__construct()  : mixed
assemble()  : void
Assemble field data.
getData()  : array<string|int, mixed>|null
Get Field Data.
getDataItem()  : mixed|null
Get Data Item by key.
getDataProvider()  : DataProvider
Get Data Provider.
getIconParams()  : array<string|int, mixed>
Get field icon url and title
getId()  : string
Get Field ID.
getName()  : string
Get localized name.
getSectionId()  : string
Get field section id
getSubtype()  : string|null
getType()  : string
Get Field Type.
isDefault()  : bool
Check if default field.
isPartial()  : bool
Check if partial field.
markAsDefault()  : mixed
Mark Field as default.
prepareHtml()  : string
Prepare Field additional HTML.
setDataProvider()  : mixed
Set Data Provider.
setIconParams()  : void
Set field icon url and title
setID()  : mixed
Set Field ID.
setName()  : mixed
Set localized name.
setSectionId()  : void
Set field section id
setSubtype()  : void
setType()  : mixed
Set Field Type.
toArray()  : array<string|int, mixed>
Put Field Parameters in array.

Methods

__construct()

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

assemble()

Assemble field data.

public assemble() : void

This method will complete initialization of partially initialized field.

getData()

Get Field Data.

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

getDataItem()

Get Data Item by key.

public getDataItem(string $key) : mixed|null
Parameters
$key : string

Data Item Key.

Return values
mixed|null

getIconParams()

Get field icon url and title

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

getId()

Get Field ID.

public getId() : string
Return values
string

getName()

Get localized name.

public getName() : string
Return values
string

getSectionId()

Get field section id

public getSectionId() : string
Return values
string

getSubtype()

public getSubtype() : string|null
Return values
string|null

getType()

Get Field Type.

public getType() : string
Return values
string

isDefault()

Check if default field.

public isDefault() : bool
Return values
bool

isPartial()

Check if partial field.

public isPartial() : bool

Partial Field does not have data. Field is not completely initialized. You may call "assemble" to load required data in it.

Return values
bool

markAsDefault()

Mark Field as default.

public markAsDefault(bool $isDefault) : mixed
Parameters
$isDefault : bool

Default Field Flag.

prepareHtml()

Prepare Field additional HTML.

public prepareHtml() : string
Return values
string

setDataProvider()

Set Data Provider.

public setDataProvider(DataProvider $dataProvider) : mixed
Parameters
$dataProvider : DataProvider

Data Provider.

setIconParams()

Set field icon url and title

public setIconParams(array<string|int, mixed> $iconParams) : void
Parameters
$iconParams : array<string|int, mixed>

setID()

Set Field ID.

public setID(string $id) : mixed
Parameters
$id : string

Field ID.

setName()

Set localized name.

public setName(string $name) : mixed
Parameters
$name : string

Field Name.

setSectionId()

Set field section id

public setSectionId(string $sectionId) : void
Parameters
$sectionId : string

setSubtype()

public setSubtype(string|null $subtype) : void
Parameters
$subtype : string|null

setType()

Set Field Type.

public setType(string $type) : mixed
Parameters
$type : string

Field Type Name.

toArray()

Put Field Parameters in array.

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

Options array.

Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results