Bitrix API

Format

FinalYes

Class Format

Table of Contents

Methods

__construct()  : mixed
Format constructor.
getCode()  : string
getDelimiter()  : string
getDescription()  : string
getFieldForUnRecognized()  : int
getLanguageId()  : string
getName()  : string
getTemplate()  : Template|null
setCode()  : $this
setDelimiter()  : $this
setDescription()  : $this
setFieldForUnRecognized()  : $this
setLanguageId()  : $this
setName()  : $this
setTemplateCollection()  : $this
toJson()  : string
Convert Format to JSON

Methods

__construct()

Format constructor.

public __construct(string $languageId) : mixed
Parameters
$languageId : string

getCode()

public getCode() : string
Return values
string

getDelimiter()

public getDelimiter() : string
Return values
string

getDescription()

public getDescription() : string
Return values
string

getFieldForUnRecognized()

public getFieldForUnRecognized() : int
Return values
int

getLanguageId()

public getLanguageId() : string
Return values
string

getName()

public getName() : string
Return values
string

getTemplate()

public getTemplate([string $type = TemplateType::DEFAULT ]) : Template|null
Parameters
$type : string = TemplateType::DEFAULT

See TemplateType

Return values
Template|null

setCode()

public setCode(string $code) : $this
Parameters
$code : string
Return values
$this

setDelimiter()

public setDelimiter(string $delimiter) : $this
Parameters
$delimiter : string
Return values
$this

setDescription()

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

setFieldForUnRecognized()

public setFieldForUnRecognized(int $fieldType) : $this
Parameters
$fieldType : int
Return values
$this

setLanguageId()

public setLanguageId(string $languageId) : $this
Parameters
$languageId : string
Return values
$this

setName()

public setName(string $name) : $this
Parameters
$name : string
Return values
$this

toJson()

Convert Format to JSON

public toJson() : string
Tags
throws
ArgumentException
Return values
string

        
On this page

Search results