Options
Component options
Table of Contents
Properties
- $data : array<string|int, mixed>
- Component data file content
- $optionsFile : string
- Optins file
- $removeIncludeOptions : bool
- Remove include options
- $styles : array<string|int, mixed>
- Component styles file content
Methods
- getOption() : mixed
- Get option
- loadOptions() : void
- Load options json file
- mergeData() : void
- Add data to context array
- mergeStyles() : void
- Add styles to context array
- setOption() : void
- Set option value
- setOptionFile() : void
- Set option file name
- componentTypeOption() : void
- Component type option
- getOptionsFileName() : string|null
- Get options file name
- loadJsonFile() : bool
- Load styles json file
- processDataOption() : void
- Process component include data file option
- processStylesOption() : void
- Process component include styles option
- resolveOptionsFileName() : void
- Resolve options file name
- setOptionsFileName() : void
- Set options file name
Properties
$data
Component data file content
protected
array<string|int, mixed>
$data
= []
$optionsFile
Optins file
protected
string
$optionsFile
= 'component.json'
$removeIncludeOptions
Remove include options
protected
bool
$removeIncludeOptions
= false
$styles
Component styles file content
protected
array<string|int, mixed>
$styles
= []
Methods
getOption()
Get option
public
getOption(string $key[, mixed $default = null ]) : mixed
Parameters
- $key : string
- $default : mixed = null
loadOptions()
Load options json file
public
loadOptions([bool $useParent = true ]) : void
Parameters
- $useParent : bool = true
mergeData()
Add data to context array
public
mergeData() : void
mergeStyles()
Add styles to context array
public
mergeStyles() : void
setOption()
Set option value
public
setOption(string $key, mixed $value) : void
Parameters
- $key : string
- $value : mixed
setOptionFile()
Set option file name
public
setOptionFile(string $name) : void
Parameters
- $name : string
componentTypeOption()
Component type option
protected
componentTypeOption() : void
getOptionsFileName()
Get options file name
protected
getOptionsFileName() : string|null
Return values
string|nullloadJsonFile()
Load styles json file
protected
loadJsonFile(string $fileName, string $key) : bool
Parameters
- $fileName : string
- $key : string
Return values
boolprocessDataOption()
Process component include data file option
protected
processDataOption() : void
processStylesOption()
Process component include styles option
protected
processStylesOption() : void
resolveOptionsFileName()
Resolve options file name
protected
resolveOptionsFileName([string|null $path = null ][, bool $useParent = true ]) : void
Parameters
- $path : string|null = null
- $useParent : bool = true
setOptionsFileName()
Set options file name
protected
setOptionsFileName(string $fileName) : void
Parameters
- $fileName : string