FormTranslationKeychainBuilder
FinalYes
Builds ordered translation keychains for form-specific entities.
The chain follows a specificity-first order:
- form-specific + element/finisher-specific
- form-specific generic
- element/type-generic
Table of Contents
Methods
- buildForElementOption() : array<int, string>
- Builds the keychain for a single option entry inside an "options" array property on a regular element (e.g. Select / RadioButton / Checkbox groups).
- buildForElementProperty() : array<int, string>
- Builds the keychain for a scalar property on a regular form element (e.g. "label", "placeholder", any renderingOption).
- buildForFinisherOption() : array<int, string>
- Builds the keychain for a single finisher option.
- buildForFormRuntimeOption() : array<int, string>
- Builds the keychain for a single option entry on the FormRuntime itself, where the original form identifier is used as the element segment.
- buildForFormRuntimeProperty() : array<int, string>
- Builds the keychain for a scalar property on the FormRuntime itself, where the original form identifier is used as the element segment.
- buildForFormRuntimeValidationError() : array<int, string>
- Builds the keychain for a validation error code on the FormRuntime itself, where the original form identifier is used as the element segment.
- buildForValidationError() : array<int, string>
- Builds the keychain for a validation error code on a regular form element.
Methods
buildForElementOption()
Builds the keychain for a single option entry inside an "options" array property on a regular element (e.g. Select / RadioButton / Checkbox groups).
public
buildForElementOption(array<string|int, string> $translationFiles, string $formIdentifier, string $elementIdentifier, string $elementType, string $propertyType, string $property, string|int $optionValue, string|null $originalFormIdentifier) : array<int, string>
Parameters
- $translationFiles : array<string|int, string>
- $formIdentifier : string
- $elementIdentifier : string
- $elementType : string
- $propertyType : string
- $property : string
- $optionValue : string|int
- $originalFormIdentifier : string|null
Return values
array<int, string>buildForElementProperty()
Builds the keychain for a scalar property on a regular form element (e.g. "label", "placeholder", any renderingOption).
public
buildForElementProperty(array<string|int, string> $translationFiles, string $formIdentifier, string $elementIdentifier, string $elementType, string $propertyType, string $property, string|null $originalFormIdentifier) : array<int, string>
Parameters
- $translationFiles : array<string|int, string>
- $formIdentifier : string
- $elementIdentifier : string
- $elementType : string
- $propertyType : string
- $property : string
- $originalFormIdentifier : string|null
Return values
array<int, string>buildForFinisherOption()
Builds the keychain for a single finisher option.
public
buildForFinisherOption(array<string|int, string> $translationFiles, string $formIdentifier, string $finisherIdentifier, string $optionKey, string|null $originalFormIdentifier) : array<int, string>
Parameters
- $translationFiles : array<string|int, string>
- $formIdentifier : string
- $finisherIdentifier : string
- $optionKey : string
- $originalFormIdentifier : string|null
Return values
array<int, string>buildForFormRuntimeOption()
Builds the keychain for a single option entry on the FormRuntime itself, where the original form identifier is used as the element segment.
public
buildForFormRuntimeOption(array<string|int, string> $translationFiles, string $formIdentifier, string $elementIdentifier, string $elementType, string $propertyType, string $property, string|int $optionValue, string|null $originalFormIdentifier) : array<int, string>
Parameters
- $translationFiles : array<string|int, string>
- $formIdentifier : string
- $elementIdentifier : string
- $elementType : string
- $propertyType : string
- $property : string
- $optionValue : string|int
- $originalFormIdentifier : string|null
Return values
array<int, string>buildForFormRuntimeProperty()
Builds the keychain for a scalar property on the FormRuntime itself, where the original form identifier is used as the element segment.
public
buildForFormRuntimeProperty(array<string|int, string> $translationFiles, string $formIdentifier, string $elementIdentifier, string $elementType, string $propertyType, string $property, string|null $originalFormIdentifier) : array<int, string>
Parameters
- $translationFiles : array<string|int, string>
- $formIdentifier : string
- $elementIdentifier : string
- $elementType : string
- $propertyType : string
- $property : string
- $originalFormIdentifier : string|null
Return values
array<int, string>buildForFormRuntimeValidationError()
Builds the keychain for a validation error code on the FormRuntime itself, where the original form identifier is used as the element segment.
public
buildForFormRuntimeValidationError(array<string|int, string> $translationFiles, string $formIdentifier, string $elementIdentifier, int $code, string|null $originalFormIdentifier) : array<int, string>
Parameters
- $translationFiles : array<string|int, string>
- $formIdentifier : string
- $elementIdentifier : string
- $code : int
- $originalFormIdentifier : string|null
Return values
array<int, string>buildForValidationError()
Builds the keychain for a validation error code on a regular form element.
public
buildForValidationError(array<string|int, string> $translationFiles, string $formIdentifier, string $elementIdentifier, int $code, string|null $originalFormIdentifier) : array<int, string>
Parameters
- $translationFiles : array<string|int, string>
- $formIdentifier : string
- $elementIdentifier : string
- $code : int
- $originalFormIdentifier : string|null