ComponentEditor
Component editor options
Table of Contents
Properties
- $editorOptions : array<string|int, mixed>
- Editor options
- $editorOptionsFile : string
- Optins file
Methods
- getEditorOption() : mixed
- Get editor option
- loadEditorOptions() : void
- Load editor options json file
- mergeEditorOptions() : void
- Add editor options to context array
- setEditorOption() : void
- Set editor option value
- getEditorOptionsFileName() : string|null
- Get editor options file name
- resolveEditorOptionsFileName() : void
- Resolve editor options file name
- setEditorOptionsFileName() : void
- Set editor options file name
Properties
$editorOptions
Editor options
protected
array<string|int, mixed>
$editorOptions
= []
$editorOptionsFile
Optins file
protected
string
$editorOptionsFile
= 'editor.json'
Methods
getEditorOption()
Get editor option
public
getEditorOption(string $key[, mixed $default = null ]) : mixed
Parameters
- $key : string
- $default : mixed = null
loadEditorOptions()
Load editor options json file
public
loadEditorOptions() : void
mergeEditorOptions()
Add editor options to context array
public
mergeEditorOptions() : void
setEditorOption()
Set editor option value
public
setEditorOption(string $key, mixed $value) : void
Parameters
- $key : string
- $value : mixed
getEditorOptionsFileName()
Get editor options file name
protected
getEditorOptionsFileName() : string|null
Return values
string|nullresolveEditorOptionsFileName()
Resolve editor options file name
protected
resolveEditorOptionsFileName([string|null $path = null ]) : void
Parameters
- $path : string|null = null
setEditorOptionsFileName()
Set editor options file name
protected
setEditorOptionsFileName(string $fileName) : void
Parameters
- $fileName : string