‪TYPO3CMS  10.4
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Form\Domain\Configuration\ConfigurationService Class Reference
Inheritance diagram for TYPO3\CMS\Form\Domain\Configuration\ConfigurationService:
TYPO3\CMS\Core\SingletonInterface

Public Member Functions

 initializeObject ()
 
array getPrototypeConfiguration (string $prototypeName)
 
array getSelectablePrototypeNamesDefinedInFormEditorSetup ()
 
bool isFormElementPropertyDefinedInFormEditorSetup (ValidationDto $dto)
 
bool isPropertyCollectionPropertyDefinedInFormEditorSetup (ValidationDto $dto)
 
bool formElementPropertyHasLimitedAllowedValuesDefinedWithinFormEditorSetup (ValidationDto $dto)
 
array getAllowedValuesForFormElementPropertyFromFormEditorSetup (ValidationDto $dto, bool $translated=true)
 
bool propertyCollectionPropertyHasLimitedAllowedValuesDefinedWithinFormEditorSetup (ValidationDto $dto)
 
array getAllowedValuesForPropertyCollectionPropertyFromFormEditorSetup (ValidationDto $dto, bool $translated=true)
 
bool isFormElementPropertyDefinedInPredefinedDefaultsInFormEditorSetup (ValidationDto $dto)
 
mixed getFormElementPredefinedDefaultValueFromFormEditorSetup (ValidationDto $dto, bool $translated=true)
 
bool isPropertyCollectionPropertyDefinedInPredefinedDefaultsInFormEditorSetup (ValidationDto $dto)
 
mixed getPropertyCollectionPredefinedDefaultValueFromFormEditorSetup (ValidationDto $dto, bool $translated=true)
 
bool isFormElementTypeCreatableByFormEditor (ValidationDto $dto)
 
bool isPropertyCollectionElementIdentifierCreatableByFormEditor (ValidationDto $dto)
 
bool isFormElementTypeDefinedInFormSetup (ValidationDto $dto)
 
array getAllBackendTranslationsForTranslationKeys (array $keys, string $prototypeName)
 
array getAllBackendTranslationsForTranslationKey (string $key, string $prototypeName)
 

Protected Member Functions

string getBasePropertyPathFromMultiValueFormElementProperty (ValidationDto $dto)
 
string getBasePropertyPathFromMultiValuePropertyCollectionElement (ValidationDto $dto)
 
array buildFormDefinitionValidationConfigurationFromFormEditorSetup (string $prototypeName)
 
array executeBuildFormDefinitionValidationConfigurationHooks (string $prototypeName, array $configuration)
 
array addAdditionalPropertyPathsFromHook (string $hookClassName, string $prototypeName, array $propertyPathsFromHook, array $configuration)
 
bool isPropertyDefinedInFormEditorSetup (string $propertyPath, array $subConfig)
 
array translateValues (array $prototypeConfiguration, array $configuration)
 
array translatePredefinedDefaults (array $prototypeConfiguration, array $formElements)
 
array translateSelectOptions (array $prototypeConfiguration, array $formElements)
 
mixed getCacheEntry (string $cacheKey)
 
 setCacheEntry (string $cacheKey, $value)
 
TranslationService getTranslationService ()
 
FrontendInterface getCacheFrontend ()
 

Protected Attributes

array $formSettings
 
array $firstLevelCache = array( )
 
TranslationService $translationService
 

Detailed Description

Helper for configuration settings Scope: frontend / backend

Definition at line 50 of file ConfigurationService.php.

Member Function Documentation

◆ addAdditionalPropertyPathsFromHook()

array TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::addAdditionalPropertyPathsFromHook ( string  $hookClassName,
string  $prototypeName,
array  $propertyPathsFromHook,
array  $configuration 
)
protected
Parameters
string$hookClassName
string$prototypeName
array$propertyPathsFromHook
array$configuration
Returns
‪array
Exceptions
PropertyException

Definition at line 723 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\isFormElementTypeDefinedInFormSetup().

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\executeBuildFormDefinitionValidationConfigurationHooks().

◆ buildFormDefinitionValidationConfigurationFromFormEditorSetup()

array TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::buildFormDefinitionValidationConfigurationFromFormEditorSetup ( string  $prototypeName)
protected

Collect all the form editor configurations which are needed to check if a form definition property can be written or not.

Parameters
string$prototypeName
Returns
‪array

Definition at line 562 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\executeBuildFormDefinitionValidationConfigurationHooks(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getCacheEntry(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getPrototypeConfiguration(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\setCacheEntry(), and TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\translateValues().

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\formElementPropertyHasLimitedAllowedValuesDefinedWithinFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getAllowedValuesForFormElementPropertyFromFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getAllowedValuesForPropertyCollectionPropertyFromFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getBasePropertyPathFromMultiValueFormElementProperty(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getBasePropertyPathFromMultiValuePropertyCollectionElement(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getFormElementPredefinedDefaultValueFromFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getPropertyCollectionPredefinedDefaultValueFromFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\isFormElementPropertyDefinedInFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\isFormElementPropertyDefinedInPredefinedDefaultsInFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\isFormElementTypeCreatableByFormEditor(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\isPropertyCollectionElementIdentifierCreatableByFormEditor(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\isPropertyCollectionPropertyDefinedInFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\isPropertyCollectionPropertyDefinedInPredefinedDefaultsInFormEditorSetup(), and TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\propertyCollectionPropertyHasLimitedAllowedValuesDefinedWithinFormEditorSetup().

◆ executeBuildFormDefinitionValidationConfigurationHooks()

array TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::executeBuildFormDefinitionValidationConfigurationHooks ( string  $prototypeName,
array  $configuration 
)
protected

If you use a custom form editor "inspector editor" implementation which does not define the writable property paths by one of the described inspector editor properties (e.g "propertyPath") within the form setup, you must provide the writable property paths with a hook.

See also
‪isFormElementPropertyDefinedInFormEditorSetup()
‪isPropertyCollectionPropertyDefinedInFormEditorSetup() Connect to the hook: $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['buildFormDefinitionValidationConfiguration'][] = \Vendor\YourNamespace\YourClass::class; Use the hook: public function addAdditionalPropertyPaths(\TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto $validationDto): array { $textValidationDto = $validationDto->withFormElementType('Text'); $textValidatorsValidationDto = $textValidationDto->withPropertyCollectionName('validators'); $dateValidationDto = $validationDto->withFormElementType('Date'); $propertyPaths = [ $textValidationDto->withPropertyPath('properties.my.custom.property'), $textValidationDto->withPropertyPath('properties.my.other.custom.property'), $textValidatorsValidationDto->withPropertyCollectionElementIdentifier('StringLength')->withPropertyPath('options.custom.property'), $textValidatorsValidationDto->withPropertyCollectionElementIdentifier('CustomValidator')->withPropertyPath('options.other.custom.property'), $dateValidationDto->withPropertyPath('properties.custom.property'), // .. ]; return $propertyPaths; }
Parameters
string$prototypeName
array$configuration
Returns
‪array
Exceptions
PropertyException

Definition at line 690 of file ConfigurationService.php.

References $GLOBALS, and TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\addAdditionalPropertyPathsFromHook().

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\buildFormDefinitionValidationConfigurationFromFormEditorSetup().

◆ formElementPropertyHasLimitedAllowedValuesDefinedWithinFormEditorSetup()

bool TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::formElementPropertyHasLimitedAllowedValuesDefinedWithinFormEditorSetup ( ValidationDto  $dto)

If a form element editor has a property called "selectOptions" (e.g. editors with templateName "Inspector-SingleSelectEditor" or "Inspector-MultiSelectEditor") then only the defined values within the selectOptions are allowed to be written by the form editor.

Parameters
ValidationDto$dto
Returns
‪bool

Definition at line 200 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\buildFormDefinitionValidationConfigurationFromFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getBasePropertyPathFromMultiValueFormElementProperty(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getFormElementType(), and TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPrototypeName().

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getAllowedValuesForFormElementPropertyFromFormEditorSetup().

◆ getAllBackendTranslationsForTranslationKey()

array TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::getAllBackendTranslationsForTranslationKey ( string  $key,
string  $prototypeName 
)
Parameters
string$key
string$prototypeName
Returns
‪array

Definition at line 544 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getPrototypeConfiguration(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getTranslationService(), and TYPO3\CMS\Form\Service\TranslationService\translateToAllBackendLanguages().

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getAllBackendTranslationsForTranslationKeys(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\CreatableFormElementPropertiesValidator\validateFormElementPredefinedDefaultValue(), and TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\CreatablePropertyCollectionElementPropertiesValidator\validatePropertyCollectionElementPredefinedDefaultValue().

◆ getAllBackendTranslationsForTranslationKeys()

array TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::getAllBackendTranslationsForTranslationKeys ( array  $keys,
string  $prototypeName 
)
Parameters
array$keys
string$prototypeName
Returns
‪array

Definition at line 525 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getAllBackendTranslationsForTranslationKey().

Referenced by TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\CreatableFormElementPropertiesValidator\validateFormElementValue(), and TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\CreatablePropertyCollectionElementPropertiesValidator\validatePropertyCollectionPropertyValue().

◆ getAllowedValuesForFormElementPropertyFromFormEditorSetup()

array TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::getAllowedValuesForFormElementPropertyFromFormEditorSetup ( ValidationDto  $dto,
bool  $translated = true 
)

Get the "selectOptions" value for a form element property from the form setup.

Parameters
ValidationDto$dto
Returns
‪array
Parameters
bool$translated
Exceptions
PropertyException

Definition at line 222 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\buildFormDefinitionValidationConfigurationFromFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\formElementPropertyHasLimitedAllowedValuesDefinedWithinFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getBasePropertyPathFromMultiValueFormElementProperty(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getFormElementType(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyPath(), and TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPrototypeName().

Referenced by TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\CreatableFormElementPropertiesValidator\validateFormElementValue().

◆ getAllowedValuesForPropertyCollectionPropertyFromFormEditorSetup()

array TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::getAllowedValuesForPropertyCollectionPropertyFromFormEditorSetup ( ValidationDto  $dto,
bool  $translated = true 
)

Get the "selectOptions" value for a form elements finisher|validator property from the form setup.

Parameters
ValidationDto$dto
bool$translated
Returns
‪array
Exceptions
PropertyException

Definition at line 278 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\buildFormDefinitionValidationConfigurationFromFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getBasePropertyPathFromMultiValuePropertyCollectionElement(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyCollectionElementIdentifier(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyCollectionName(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyPath(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPrototypeName(), and TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\propertyCollectionPropertyHasLimitedAllowedValuesDefinedWithinFormEditorSetup().

Referenced by TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\CreatablePropertyCollectionElementPropertiesValidator\validatePropertyCollectionPropertyValue().

◆ getBasePropertyPathFromMultiValueFormElementProperty()

string TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::getBasePropertyPathFromMultiValueFormElementProperty ( ValidationDto  $dto)
protected
Parameters
ValidationDto$dto
Returns
‪string

Definition at line 307 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\buildFormDefinitionValidationConfigurationFromFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getFormElementType(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyPath(), and TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPrototypeName().

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\formElementPropertyHasLimitedAllowedValuesDefinedWithinFormEditorSetup(), and TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getAllowedValuesForFormElementPropertyFromFormEditorSetup().

◆ getBasePropertyPathFromMultiValuePropertyCollectionElement()

string TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::getBasePropertyPathFromMultiValuePropertyCollectionElement ( ValidationDto  $dto)
protected
Parameters
ValidationDto$dto
Returns
‪string

Definition at line 330 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\buildFormDefinitionValidationConfigurationFromFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyCollectionElementIdentifier(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyCollectionName(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyPath(), and TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPrototypeName().

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getAllowedValuesForPropertyCollectionPropertyFromFormEditorSetup(), and TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\propertyCollectionPropertyHasLimitedAllowedValuesDefinedWithinFormEditorSetup().

◆ getCacheEntry()

mixed TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::getCacheEntry ( string  $cacheKey)
protected
Parameters
string$cacheKey
Returns
‪mixed

Definition at line 885 of file ConfigurationService.php.

References TYPO3\CMS\Core\Cache\Frontend\FrontendInterface\get(), and TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getCacheFrontend().

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\buildFormDefinitionValidationConfigurationFromFormEditorSetup().

◆ getCacheFrontend()

FrontendInterface TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::getCacheFrontend ( )
protected
Returns
‪FrontendInterface

Definition at line 917 of file ConfigurationService.php.

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getCacheEntry(), and TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\setCacheEntry().

◆ getFormElementPredefinedDefaultValueFromFormEditorSetup()

mixed TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::getFormElementPredefinedDefaultValueFromFormEditorSetup ( ValidationDto  $dto,
bool  $translated = true 
)

Get the "predefinedDefaults" value for a form element property from the form setup. A form element default property is defined within the following form editor properties:

  • ‪formElementsDefinition.<formElementType>.formEditor.predefinedDefaults.<propertyPath> = "default value"
Parameters
ValidationDto$dto
bool$translated
Returns
‪mixed
Exceptions
PropertyException

Definition at line 382 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\buildFormDefinitionValidationConfigurationFromFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getFormElementType(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyPath(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPrototypeName(), and TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\isFormElementPropertyDefinedInPredefinedDefaultsInFormEditorSetup().

Referenced by TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\CreatableFormElementPropertiesValidator\validateFormElementPredefinedDefaultValue().

◆ getPropertyCollectionPredefinedDefaultValueFromFormEditorSetup()

mixed TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::getPropertyCollectionPredefinedDefaultValueFromFormEditorSetup ( ValidationDto  $dto,
bool  $translated = true 
)

Get the "predefinedDefaults" value for a form elements finisher|validator property from the form setup. A form elements finisher|validator default property is defined within the following form editor properties:

  • ‪<validatorsDefinition|finishersDefinition>.<index>.formEditor.predefinedDefaults.<propertyPath> = "default value"
Parameters
ValidationDto$dto
bool$translated
Returns
‪mixed
Exceptions
PropertyException

Definition at line 436 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\buildFormDefinitionValidationConfigurationFromFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyCollectionElementIdentifier(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyCollectionName(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyPath(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPrototypeName(), and TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\isPropertyCollectionPropertyDefinedInPredefinedDefaultsInFormEditorSetup().

Referenced by TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\CreatablePropertyCollectionElementPropertiesValidator\validatePropertyCollectionElementPredefinedDefaultValue().

◆ getPrototypeConfiguration()

array TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::getPrototypeConfiguration ( string  $prototypeName)

Get the prototype configuration

Parameters
string$prototypeName‪name of the prototype to get the configuration for
Returns
‪array the prototype configuration
Exceptions
PrototypeNotFoundException‪if prototype with the name $prototypeName was not found

Definition at line 82 of file ConfigurationService.php.

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\buildFormDefinitionValidationConfigurationFromFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getAllBackendTranslationsForTranslationKey(), and TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\isFormElementTypeDefinedInFormSetup().

◆ getSelectablePrototypeNamesDefinedInFormEditorSetup()

array TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::getSelectablePrototypeNamesDefinedInFormEditorSetup ( )

Return all prototype names which are defined within "formManager.selectablePrototypesConfiguration.*.identifier"

Returns
‪array

Definition at line 99 of file ConfigurationService.php.

◆ getTranslationService()

TranslationService TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::getTranslationService ( )
protected
Returns
‪TranslationService

Definition at line 907 of file ConfigurationService.php.

References TYPO3\CMS\Form\Service\TranslationService\getInstance().

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getAllBackendTranslationsForTranslationKey(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\translatePredefinedDefaults(), and TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\translateSelectOptions().

◆ initializeObject()

TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::initializeObject ( )

Definition at line 68 of file ConfigurationService.php.

References TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManagerInterface\CONFIGURATION_TYPE_YAML_SETTINGS.

◆ isFormElementPropertyDefinedInFormEditorSetup()

bool TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::isFormElementPropertyDefinedInFormEditorSetup ( ValidationDto  $dto)

Check if a form element property is defined in the form setup. If a form element property is defined in the form setup then it means that the form element property can be written by the form editor. A form element property can be written if the property path is defined within the following form editor properties:

  • ‪formElementsDefinition.<formElementType>.formEditor.editors.<index>.propertyPath
  • ‪formElementsDefinition.<formElementType>.formEditor.editors.<index>.*.propertyPath
  • ‪formElementsDefinition.<formElementType>.formEditor.editors.<index>.additionalElementPropertyPaths
  • ‪formElementsDefinition.<formElementType>.formEditor.propertyCollections.<finishers|validators>.<index>.editors.<index>.additionalElementPropertyPaths If a form editor property "templateName" is "Inspector-PropertyGridEditor" or "Inspector-MultiSelectEditor" or "Inspector-ValidationErrorMessageEditor" it means that the form editor property "propertyPath" is interpreted as a so called "multiValueProperty". A "multiValueProperty" can contain any subproperties relative to the value from "propertyPath" which are valid. If "formElementsDefinition.<formElementType>.formEditor.editors.<index>.templateName = Inspector-PropertyGridEditor" and "formElementsDefinition.<formElementType>.formEditor.editors.<index>.propertyPath = options.xxx" then (for example) "options.xxx.yyy" is a valid property path to write. If you use a custom form editor "inspector editor" implementation which does not define the writable property paths by one of the above described inspector editor properties (e.g "propertyPath") within the form setup, you must provide the writable property paths with a hook.
See also
‪executeBuildFormDefinitionValidationConfigurationHooks()
Parameters
ValidationDto$dto
Returns
‪bool

Definition at line 145 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\buildFormDefinitionValidationConfigurationFromFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getFormElementType(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyPath(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPrototypeName(), and TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\isPropertyDefinedInFormEditorSetup().

◆ isFormElementPropertyDefinedInPredefinedDefaultsInFormEditorSetup()

bool TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::isFormElementPropertyDefinedInPredefinedDefaultsInFormEditorSetup ( ValidationDto  $dto)

Check if a form element property is defined in "predefinedDefaults" in the form setup. If a form element property is defined in the "predefinedDefaults" in the form setup then it means that the form element property can be written by the form editor. A form element default property is defined within the following form editor properties:

  • ‪formElementsDefinition.<formElementType>.formEditor.predefinedDefaults.<propertyPath> = "default value"
Parameters
ValidationDto$dto
Returns
‪bool

Definition at line 360 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\buildFormDefinitionValidationConfigurationFromFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getFormElementType(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyPath(), and TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPrototypeName().

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getFormElementPredefinedDefaultValueFromFormEditorSetup().

◆ isFormElementTypeCreatableByFormEditor()

bool TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::isFormElementTypeCreatableByFormEditor ( ValidationDto  $dto)

Check if the form element is creatable through the form editor. A form element is creatable if the following properties are set:

  • ‪formElementsDefinition.<formElementType>.formEditor.group
  • ‪formElementsDefinition.<formElementType>.formEditor.groupSorting And the value from "formElementsDefinition.<formElementType>.formEditor.group" is one of the keys within "formEditor.formElementGroups"
Parameters
ValidationDto$dto
Returns
‪bool

Definition at line 470 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\buildFormDefinitionValidationConfigurationFromFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getFormElementType(), and TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPrototypeName().

◆ isFormElementTypeDefinedInFormSetup()

bool TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::isFormElementTypeDefinedInFormSetup ( ValidationDto  $dto)

Check if the form elements type is defined within the form setup.

Parameters
ValidationDto$dto
Returns
‪bool

Definition at line 509 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getFormElementType(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getPrototypeConfiguration(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPrototypeName(), and TYPO3\CMS\Core\Utility\ArrayUtility\isValidPath().

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\addAdditionalPropertyPathsFromHook().

◆ isPropertyCollectionElementIdentifierCreatableByFormEditor()

bool TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::isPropertyCollectionElementIdentifierCreatableByFormEditor ( ValidationDto  $dto)

Check if the form elements finisher|validator is creatable through the form editor. A form elements finisher|validator is creatable if the following conditions are true: "formElementsDefinition.<formElementType>.formEditor.editors.<index>.templateName = Inspector-FinishersEditor" or "formElementsDefinition.<formElementType>.formEditor.editors.<index>.templateName = Inspector-ValidatorsEditor" and "formElementsDefinition.<formElementType>.formEditor.editors.<index>.selectOptions.<index>.value = <finisherIdentifier|validatorIdentifier>"

Parameters
ValidationDto$dto
Returns
‪bool

Definition at line 494 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\buildFormDefinitionValidationConfigurationFromFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getFormElementType(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyCollectionElementIdentifier(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyCollectionName(), and TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPrototypeName().

◆ isPropertyCollectionPropertyDefinedInFormEditorSetup()

bool TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::isPropertyCollectionPropertyDefinedInFormEditorSetup ( ValidationDto  $dto)

Check if a form elements finisher|validator property is defined in the form setup. If a form elements finisher|validator property is defined in the form setup then it means that the form elements finisher|validator property can be written by the form editor. A form elements finisher|validator property can be written if the property path is defined within the following form editor properties:

  • ‪formElementsDefinition.<formElementType>.formEditor.propertyCollections.<finishers|validators>.<index>.editors.<index>.propertyPath
  • ‪formElementsDefinition.<formElementType>.formEditor.propertyCollections.<finishers|validators>.<index>.editors.<index>.*.propertyPath If a form elements finisher|validator property "templateName" is "Inspector-PropertyGridEditor" or "Inspector-MultiSelectEditor" or "Inspector-ValidationErrorMessageEditor" it means that the form editor property "propertyPath" is interpreted as a so called "multiValueProperty". A "multiValueProperty" can contain any subproperties relative to the value from "propertyPath" which are valid. If "formElementsDefinition.<formElementType>.formEditor.propertyCollections.<finishers|validators>.<index>.editors.<index>.templateName = Inspector-PropertyGridEditor" and "formElementsDefinition.<formElementType>.formEditor.propertyCollections.<finishers|validators>.<index>.editors.<index>.propertyPath = options.xxx" that (for example) "options.xxx.yyy" is a valid property path to write. If you use a custom form editor "inspector editor" implementation which not defines the writable property paths by one of the above described inspector editor properties (e.g "propertyPath") within the form setup, you must provide the writable property paths with a hook.
See also
‪executeBuildFormDefinitionValidationConfigurationHooks()
Parameters
ValidationDto$dto
Returns
‪bool

Definition at line 180 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\buildFormDefinitionValidationConfigurationFromFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getFormElementType(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyCollectionElementIdentifier(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyCollectionName(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyPath(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPrototypeName(), and TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\isPropertyDefinedInFormEditorSetup().

◆ isPropertyCollectionPropertyDefinedInPredefinedDefaultsInFormEditorSetup()

bool TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::isPropertyCollectionPropertyDefinedInPredefinedDefaultsInFormEditorSetup ( ValidationDto  $dto)

Check if a form elements finisher|validator property is defined in "predefinedDefaults" in the form setup. If a form elements finisher|validator property is defined in "predefinedDefaults" in the form setup then it means that the form elements finisher|validator property can be written by the form editor. A form elements finisher|validator default property is defined within the following form editor properties:

  • ‪<validatorsDefinition|finishersDefinition>.<index>.formEditor.predefinedDefaults.<propertyPath> = "default value"
Parameters
ValidationDto$dto
Returns
‪bool

Definition at line 414 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\buildFormDefinitionValidationConfigurationFromFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyCollectionElementIdentifier(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyCollectionName(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyPath(), and TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPrototypeName().

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getPropertyCollectionPredefinedDefaultValueFromFormEditorSetup().

◆ isPropertyDefinedInFormEditorSetup()

bool TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::isPropertyDefinedInFormEditorSetup ( string  $propertyPath,
array  $subConfig 
)
protected
Parameters
string$propertyPath
array$subConfig
Returns
‪bool

Definition at line 791 of file ConfigurationService.php.

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\isFormElementPropertyDefinedInFormEditorSetup(), and TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\isPropertyCollectionPropertyDefinedInFormEditorSetup().

◆ propertyCollectionPropertyHasLimitedAllowedValuesDefinedWithinFormEditorSetup()

bool TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::propertyCollectionPropertyHasLimitedAllowedValuesDefinedWithinFormEditorSetup ( ValidationDto  $dto)

If a form elements finisher|validator editor has a property called "selectOptions" (e.g. editors with templateName "Inspector-SingleSelectEditor" or "Inspector-MultiSelectEditor") then only the defined values within the selectOptions are allowed to be written by the form editor.

Parameters
ValidationDto$dto
Returns
‪bool

Definition at line 256 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\buildFormDefinitionValidationConfigurationFromFormEditorSetup(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getBasePropertyPathFromMultiValuePropertyCollectionElement(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyCollectionElementIdentifier(), TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPropertyCollectionName(), and TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto\getPrototypeName().

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getAllowedValuesForPropertyCollectionPropertyFromFormEditorSetup().

◆ setCacheEntry()

TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::setCacheEntry ( string  $cacheKey,
  $value 
)
protected
Parameters
string$cacheKey
mixed$value

Definition at line 898 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getCacheFrontend(), and TYPO3\CMS\Core\Cache\Frontend\FrontendInterface\set().

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\buildFormDefinitionValidationConfigurationFromFormEditorSetup().

◆ translatePredefinedDefaults()

array TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::translatePredefinedDefaults ( array  $prototypeConfiguration,
array  $formElements 
)
protected
Parameters
array$prototypeConfiguration
array$formElements
Returns
‪array

Definition at line 843 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getTranslationService(), and TYPO3\CMS\Form\Service\TranslationService\translateValuesRecursive().

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\translateValues().

◆ translateSelectOptions()

array TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::translateSelectOptions ( array  $prototypeConfiguration,
array  $formElements 
)
protected
Parameters
array$prototypeConfiguration
array$formElements
Returns
‪array

Definition at line 864 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getTranslationService(), and TYPO3\CMS\Form\Service\TranslationService\translateValuesRecursive().

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\translateValues().

◆ translateValues()

array TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::translateValues ( array  $prototypeConfiguration,
array  $configuration 
)
protected
Parameters
array$prototypeConfiguration
array$configuration
Returns
‪array

Definition at line 817 of file ConfigurationService.php.

References TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\translatePredefinedDefaults(), and TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\translateSelectOptions().

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\buildFormDefinitionValidationConfigurationFromFormEditorSetup().

Member Data Documentation

◆ $firstLevelCache

array TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::$firstLevelCache = array( )
protected

Definition at line 59 of file ConfigurationService.php.

◆ $formSettings

array TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::$formSettings
protected

Definition at line 55 of file ConfigurationService.php.

◆ $translationService

TranslationService TYPO3\CMS\Form\Domain\Configuration\ConfigurationService::$translationService
protected

Definition at line 63 of file ConfigurationService.php.