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
stringgetDelimiter()
public
getDelimiter() : string
Return values
stringgetDescription()
public
getDescription() : string
Return values
stringgetFieldForUnRecognized()
public
getFieldForUnRecognized() : int
Return values
intgetLanguageId()
public
getLanguageId() : string
Return values
stringgetName()
public
getName() : string
Return values
stringgetTemplate()
public
getTemplate([string $type = TemplateType::DEFAULT ]) : Template|null
Parameters
- $type : string = TemplateType::DEFAULT
-
See TemplateType
Return values
Template|nullsetCode()
public
setCode(string $code) : $this
Parameters
- $code : string
Return values
$thissetDelimiter()
public
setDelimiter(string $delimiter) : $this
Parameters
- $delimiter : string
Return values
$thissetDescription()
public
setDescription(string $description) : $this
Parameters
- $description : string
Return values
$thissetFieldForUnRecognized()
public
setFieldForUnRecognized(int $fieldType) : $this
Parameters
- $fieldType : int
Return values
$thissetLanguageId()
public
setLanguageId(string $languageId) : $this
Parameters
- $languageId : string
Return values
$thissetName()
public
setName(string $name) : $this
Parameters
- $name : string
Return values
$thissetTemplateCollection()
public
setTemplateCollection(TemplateCollection $templateCollection) : $this
Parameters
- $templateCollection : TemplateCollection
Return values
$thistoJson()
Convert Format to JSON
public
toJson() : string