Bitrix API

Item

Settings field class

Table of Contents

Methods

create()  : self|null
Creates tuning Item by raw data.
getAdditional()  : array<string|int, mixed>
getCode()  : string
getHeader()  : string|null
getOnSave()  : OnSave|null
getOptions()  : array<string|int, mixed>
Return options of list element
getRecommended()  : array<string|int, mixed>
Get preferred option for list item
getSort()  : int|null
getTitle()  : string
getValue()  : mixed
isBoolean()  : bool
isList()  : bool
onSave()  : void
setAdditional()  : void
setOnSave()  : void
setOptions()  : void
Set options, if list element
setRecommended()  : void
Set preferred option for list item
setSort()  : void
setValue()  : void
toArray()  : array<string|int, mixed>
Return scalar data of item

Methods

create()

Creates tuning Item by raw data.

public static create(string $code, array<string|int, mixed> $data) : self|null
Parameters
$code : string

Unique tuning code.

$data : array<string|int, mixed>

Raw data.

Return values
self|null

getAdditional()

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

getCode()

public getCode() : string
Return values
string

getHeader()

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

getOptions()

Return options of list element

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

of code => option

getRecommended()

Get preferred option for list item

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

of stings (code of options)

getSort()

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

getTitle()

public getTitle() : string
Return values
string

getValue()

public getValue() : mixed

isBoolean()

public isBoolean() : bool
Return values
bool

isList()

public isList() : bool
Return values
bool

onSave()

public onSave() : void

setAdditional()

public setAdditional(array<string|int, mixed>|null $additional) : void
Parameters
$additional : array<string|int, mixed>|null

setOptions()

Set options, if list element

public setOptions(array<string|int, mixed> $options) : void
Parameters
$options : array<string|int, mixed>
  • array of code => option

setRecommended()

Set preferred option for list item

public setRecommended(string|array<string|int, mixed> $optionCodes) : void
Parameters
$optionCodes : string|array<string|int, mixed>

preferred options

setSort()

public setSort(int $sort) : void
Parameters
$sort : int
  • value of sorting, less sort will be higher

setValue()

public setValue(mixed $value) : void
Parameters
$value : mixed

toArray()

Return scalar data of item

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results