EditorDefinition uses RawConfigurationTrait
Read onlyYes
FinalYes
Open form editor definition.
Table of Contents
Properties
- $description : string|null
- $doNotSetIfPropertyValueIsEmpty : bool|null
- $identifier : string|null
- $label : string|null
- $propertyPath : string|null
- $raw : array<string|int, mixed>
- $templateName : string|null
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
$description
public
string|null
$description
$doNotSetIfPropertyValueIsEmpty
public
bool|null
$doNotSetIfPropertyValueIsEmpty
$identifier
public
string|null
$identifier
$label
public
string|null
$label
$propertyPath
public
string|null
$propertyPath
$raw
public
array<string|int, mixed>
$raw
$templateName
public
string|null
$templateName
Methods
__construct()
public
__construct(array<string, mixed> $raw, string|null $identifier, string|null $templateName, string|null $label, string|null $description, string|null $propertyPath, bool|null $doNotSetIfPropertyValueIsEmpty) : mixed
Parameters
- $raw : array<string, mixed>
- $identifier : string|null
- $templateName : string|null
- $label : string|null
- $description : string|null
- $propertyPath : string|null
- $doNotSetIfPropertyValueIsEmpty : bool|null
fromArray()
public
static fromArray(array<string, mixed> $configuration) : self
Parameters
- $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