FormManagerConfiguration uses ConfigurationValueNormalizationTrait

Read onlyYes
FinalYes

Typed representation of the "formManager" section of the form YAML configuration.

Internal

Table of Contents

Properties

$deleteActionErrorMessage  : string|null
$deleteActionErrorTitle  : string|null
$dynamicJavaScriptModules  : array<string|int, mixed>
$selectablePrototypesConfiguration  : array<string|int, mixed>
$stylesheets  : array<string|int, mixed>
$translationFiles  : array<string|int, mixed>

Methods

__construct()  : mixed
fromArray()  : self
Create the DTO from the raw "formManager" configuration array.
getSelectablePrototype()  : SelectablePrototypeConfiguration|null
Return the prototype configuration for the given identifier, if configured.
getSelectablePrototypeIdentifiers()  : array<int, string>
Return all identifiers defined within "selectablePrototypesConfiguration.*.identifier".
getSelectablePrototypesConfigurationAsArray()  : array<int, array<string, mixed>>
Reproduce the raw "selectablePrototypesConfiguration" array, e.g. to hand it over to the JavaScript form manager app.
hasTemplatePath()  : bool
Check whether the given template path is configured for the given prototype.

Properties

$deleteActionErrorMessage

public string|null $deleteActionErrorMessage = null

$deleteActionErrorTitle

public string|null $deleteActionErrorTitle = null

$dynamicJavaScriptModules

public array<string|int, mixed> $dynamicJavaScriptModules = []

$selectablePrototypesConfiguration

public array<string|int, mixed> $selectablePrototypesConfiguration = []

$stylesheets

public array<string|int, mixed> $stylesheets = []

$translationFiles

public array<string|int, mixed> $translationFiles = []

Methods

__construct()

public __construct([array<string, string> $dynamicJavaScriptModules = [] ][, array<int, string> $stylesheets = [] ][, array<int, string> $translationFiles = [] ][, array<int, SelectablePrototypeConfiguration> $selectablePrototypesConfiguration = [] ][, string|null $deleteActionErrorTitle = null ][, string|null $deleteActionErrorMessage = null ]) : mixed
Parameters
$dynamicJavaScriptModules : array<string, string> = []

JavaScript modules loaded by the form manager, keyed by role (e.g. "app", "viewModel")

$stylesheets : array<int, string> = []

Stylesheets loaded in the form manager module

$translationFiles : array<int, string> = []

Translation files keyed by priority

$selectablePrototypesConfiguration : array<int, SelectablePrototypeConfiguration> = []

Prototypes selectable when creating a new form

$deleteActionErrorTitle : string|null = null

Translation key for the delete error title

$deleteActionErrorMessage : string|null = null

Translation key for the delete error message

fromArray()

Create the DTO from the raw "formManager" configuration array.

public static fromArray(array<string, mixed> $configuration) : self
Parameters
$configuration : array<string, mixed>
Return values
self

getSelectablePrototypeIdentifiers()

Return all identifiers defined within "selectablePrototypesConfiguration.*.identifier".

public getSelectablePrototypeIdentifiers() : array<int, string>
Return values
array<int, string>

getSelectablePrototypesConfigurationAsArray()

Reproduce the raw "selectablePrototypesConfiguration" array, e.g. to hand it over to the JavaScript form manager app.

public getSelectablePrototypesConfigurationAsArray() : array<int, array<string, mixed>>
Return values
array<int, array<string, mixed>>

hasTemplatePath()

Check whether the given template path is configured for the given prototype.

public hasTemplatePath(string $prototypeIdentifier, string $templatePath) : bool

Multiple entries may share the same identifier (e.g. when configuration from different sources is merged), so all matching prototypes are checked.

Parameters
$prototypeIdentifier : string
$templatePath : string
Return values
bool
On this page

Search results