FinisherDefinition uses RawConfigurationTrait
Read onlyYes
FinalYes
Identified, open finisher definition from a prototype registry.
Table of Contents
Properties
- $formEditor : FormEditorDefinition
- $formEngine : FormEngineDefinition|null
- $identifier : string
- $implementationClassName : string|null
- $options : array<string|int, mixed>
- $raw : array<string|int, mixed>
Methods
- __construct() : mixed
- fromArray() : self
- get() : mixed
- Read a value from the raw configuration using a dot-separated path.
- getRaw() : array<string, mixed>
- Return the complete raw configuration array this DTO was built from.
- getTranslationFiles() : array<int, string>
- Resolve finisher-specific translation files, falling back to the prototype configuration.
- has() : bool
- Check whether the given dot-separated path exists in the raw configuration.
Properties
$formEditor
public
FormEditorDefinition
$formEditor
$formEngine
public
FormEngineDefinition|null
$formEngine
$identifier
public
string
$identifier
$implementationClassName
public
string|null
$implementationClassName
$options
public
array<string|int, mixed>
$options
$raw
public
array<string|int, mixed>
$raw
Methods
__construct()
public
__construct(string $identifier, array<string, mixed> $raw, string|null $implementationClassName, array<string, mixed> $options, FormEditorDefinition $formEditor, FormEngineDefinition|null $formEngine) : mixed
Parameters
- $identifier : string
- $raw : array<string, mixed>
- $implementationClassName : string|null
- $options : array<string, mixed>
- $formEditor : FormEditorDefinition
- $formEngine : FormEngineDefinition|null
fromArray()
public
static fromArray(string $identifier, array<string, mixed> $configuration) : self
Parameters
- $identifier : string
- $configuration : array<string, mixed>
Return values
selfget()
Read a value from the raw configuration using a dot-separated path.
public
get(string $path[, mixed $default = null ]) : mixed
Example: $dto->get('formEditor.dynamicJavaScriptModules.app').
Parameters
- $path : string
- $default : mixed = null
getRaw()
Return the complete raw configuration array this DTO was built from.
public
getRaw() : array<string, mixed>
Use this to reach custom keys that are not (yet) mapped to typed properties, e.g. properties registered by third-party extensions.
Return values
array<string, mixed>getTranslationFiles()
Resolve finisher-specific translation files, falling back to the prototype configuration.
public
getTranslationFiles(FormEngineDefinition|null $prototypeFormEngine) : array<int, string>
Parameters
- $prototypeFormEngine : FormEngineDefinition|null
Return values
array<int, string>has()
Check whether the given dot-separated path exists in the raw configuration.
public
has(string $path) : bool
Parameters
- $path : string