FormEditorDefinition uses RawConfigurationTrait
Read onlyYes
FinalYes
Shared open form editor metadata of form elements, finishers and validators.
Table of Contents
Properties
- $editors : EditorDefinitionCollection
- $group : string|null
- $groupSorting : int|null
- $iconIdentifier : string|null
- $label : string|null
- $predefinedDefaults : array<string|int, mixed>
- $propertyCollections : PropertyCollectionDefinitionCollection
- $raw : array<string|int, mixed>
Methods
- __construct() : mixed
- fromArray() : self
- get() : mixed
- Read a value from the raw configuration using a dot-separated path.
- getPropertyGridPropertyPaths() : array<int, string>
- getPropertyGridPropertyPathsForCollection() : array<int, string>
- 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
$editors
public
EditorDefinitionCollection
$editors
$group
public
string|null
$group
$groupSorting
public
int|null
$groupSorting
$iconIdentifier
public
string|null
$iconIdentifier
$label
public
string|null
$label
$predefinedDefaults
public
array<string|int, mixed>
$predefinedDefaults
$propertyCollections
public
PropertyCollectionDefinitionCollection
$propertyCollections
$raw
public
array<string|int, mixed>
$raw
Methods
__construct()
public
__construct(array<string, mixed> $raw, string|null $label, string|null $iconIdentifier, string|null $group, int|null $groupSorting, array<string, mixed> $predefinedDefaults, EditorDefinitionCollection $editors, PropertyCollectionDefinitionCollection $propertyCollections) : mixed
Parameters
- $raw : array<string, mixed>
- $label : string|null
- $iconIdentifier : string|null
- $group : string|null
- $groupSorting : int|null
- $predefinedDefaults : array<string, mixed>
- $editors : EditorDefinitionCollection
- $propertyCollections : PropertyCollectionDefinitionCollection
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
getPropertyGridPropertyPaths()
public
getPropertyGridPropertyPaths() : array<int, string>
Return values
array<int, string>getPropertyGridPropertyPathsForCollection()
public
getPropertyGridPropertyPathsForCollection(string $identifier) : array<int, string>
Parameters
- $identifier : string
Return values
array<int, string>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