Bitrix API

TypePreset implements JsonSerializable

Table of Contents

Interfaces

JsonSerializable

Methods

__construct()  : mixed
TypePreset constructor.
createFromJson()  : TypePreset|null
Creates new preset from json string.
getCategory()  : string
Return category code of the preset.
getData()  : array<string|int, mixed>
Return data of the preset, containing settings for creating new dynamic type.
getDescription()  : string|null
Get description of the preset.
getIcon()  : string
Get path to the icon of the preset.
getId()  : string
Return identifier of this preset.
getTitle()  : string
Return title of the preset.
isDisabled()  : bool
Return disabled status of this preset.
jsonSerialize()  : array<string|int, mixed>
Prepares data for json.
setCategory()  : $this
Set category code of the preset.
setData()  : $this
Return data of the preset, containing settings for creating new dynamic type.
setDescription()  : $this
Set description of the preset.
setDisabled()  : $this
Set disabled status of this preset
setIcon()  : $this
Set path to the icon of the preset.
setId()  : $this
Set identifier of this preset
setTitle()  : $this
Set title of the preset.

Methods

__construct()

TypePreset constructor.

public __construct(array<string|int, mixed> $fields, array<string|int, mixed> $data) : mixed
Parameters
$fields : array<string|int, mixed>
$data : array<string|int, mixed>
Tags
throws
ArgumentNullException

createFromJson()

Creates new preset from json string.

public static createFromJson(string $json) : TypePreset|null
Parameters
$json : string
Return values
TypePreset|null

getCategory()

Return category code of the preset.

public getCategory() : string
Return values
string

getData()

Return data of the preset, containing settings for creating new dynamic type.

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

getDescription()

Get description of the preset.

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

getIcon()

Get path to the icon of the preset.

public getIcon() : string
Return values
string

getId()

Return identifier of this preset.

public getId() : string
Return values
string

getTitle()

Return title of the preset.

public getTitle() : string
Return values
string

isDisabled()

Return disabled status of this preset.

public isDisabled() : bool
Return values
bool

jsonSerialize()

Prepares data for json.

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

setCategory()

Set category code of the preset.

public setCategory(string $category) : $this
Parameters
$category : string
Return values
$this

setData()

Return data of the preset, containing settings for creating new dynamic type.

public setData(array<string|int, mixed> $data) : $this
Parameters
$data : array<string|int, mixed>
Return values
$this

setDescription()

Set description of the preset.

public setDescription(string $description) : $this
Parameters
$description : string
Return values
$this

setDisabled()

Set disabled status of this preset

public setDisabled(bool $isDisabled) : $this
Parameters
$isDisabled : bool
Return values
$this

setIcon()

Set path to the icon of the preset.

public setIcon(string $icon) : $this
Parameters
$icon : string
Return values
$this

setId()

Set identifier of this preset

public setId(string $id) : $this
Parameters
$id : string
Tags
throws
ArgumentNullException
Return values
$this

setTitle()

Set title of the preset.

public setTitle(string $title) : $this
Parameters
$title : string
Tags
throws
ArgumentNullException
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results