FormElementDefinition uses RawConfigurationTrait
Read onlyYes
FinalYes
Identified, open form element definition from a prototype registry.
Table of Contents
Properties
- $formEditor : FormEditorDefinition
- $identifier : string
- $implementationClassName : string|null
- $properties : array<string|int, mixed>
- $raw : array<string|int, mixed>
- $rendererClassName : string|null
- $renderingOptions : array<string|int, mixed>
- $validators : array<string|int, mixed>
- $variants : 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.
- has() : bool
- Check whether the given dot-separated path exists in the raw configuration.
Properties
$formEditor
public
FormEditorDefinition
$formEditor
$identifier
public
string
$identifier
$implementationClassName
public
string|null
$implementationClassName
$properties
public
array<string|int, mixed>
$properties
$raw
public
array<string|int, mixed>
$raw
$rendererClassName
public
string|null
$rendererClassName
$renderingOptions
public
array<string|int, mixed>
$renderingOptions
$validators
public
array<string|int, mixed>
$validators
$variants
public
array<string|int, mixed>
$variants
Methods
__construct()
public
__construct(string $identifier, array<string, mixed> $raw, string|null $implementationClassName, string|null $rendererClassName, array<string, mixed> $properties, array<string, mixed> $renderingOptions, array<int|string, mixed> $validators, array<int|string, mixed> $variants, FormEditorDefinition $formEditor) : mixed
Parameters
- $identifier : string
- $raw : array<string, mixed>
- $implementationClassName : string|null
- $rendererClassName : string|null
- $properties : array<string, mixed>
- $renderingOptions : array<string, mixed>
- $validators : array<int|string, mixed>
- $variants : array<int|string, mixed>
- $formEditor : FormEditorDefinition
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>has()
Check whether the given dot-separated path exists in the raw configuration.
public
has(string $path) : bool
Parameters
- $path : string