DataStructureIdentifierHook

Hooks into flex form handling of backend for tt_content form elements:

  • Adds existing forms to flex form drop down list
  • Adds finisher settings if "override finishers" is active

Scope: backend

Internal

Table of Contents

Constants

L10N_PREFIX  = 'LLL:EXT:form/Resources/Private/Language/Database.xlf:'
Localisation prefix

Methods

__construct()  : mixed
getDataStructureIdentifierPostProcess()  : array<string|int, mixed>
The data structure depends on a current form selection (persistenceIdentifier) and if the field "overrideFinishers" is active. Add both to the identifier to hand these information over to parseDataStructureByIdentifierPostProcess() hook.
parseDataStructureByIdentifierPostProcess()  : array<string|int, mixed>
Returns a modified flexform data array.
addInvalidFrameworkConfigurationFlashMessage()  : mixed
addSelectedPersistenceIdentifier()  : array<string|int, mixed>
buildFlexformSheetIdentifier()  : string
getAdditionalFinisherSheets()  : array<string|int, mixed>
Returns additional flexform sheets with finisher fields
getLanguageService()  : LanguageService
initializeNewSheetArray()  : array<string|int, mixed>
Boilerplate XML array of a new sheet
translateFinisherDefinitionByIdentifier()  : array<string|int, mixed>

Constants

L10N_PREFIX

Localisation prefix

public mixed L10N_PREFIX = 'LLL:EXT:form/Resources/Private/Language/Database.xlf:'

Methods

getDataStructureIdentifierPostProcess()

The data structure depends on a current form selection (persistenceIdentifier) and if the field "overrideFinishers" is active. Add both to the identifier to hand these information over to parseDataStructureByIdentifierPostProcess() hook.

public getDataStructureIdentifierPostProcess(array<string|int, mixed> $fieldTca, string $tableName, string $fieldName, array<string|int, mixed> $row, array<string|int, mixed> $identifier) : array<string|int, mixed>
Parameters
$fieldTca : array<string|int, mixed>

Incoming field TCA

$tableName : string

Handled table

$fieldName : string

Handled field

$row : array<string|int, mixed>

Current data row

$identifier : array<string|int, mixed>

Already calculated identifier

Return values
array<string|int, mixed> —

Modified identifier

parseDataStructureByIdentifierPostProcess()

Returns a modified flexform data array.

public parseDataStructureByIdentifierPostProcess(array<string|int, mixed> $dataStructure, array<string|int, mixed> $identifier) : array<string|int, mixed>

This adds the list of existing form definitions to the form selection drop down and adds sheets to override finisher settings if requested.

Parameters
$dataStructure : array<string|int, mixed>
$identifier : array<string|int, mixed>
Return values
array<string|int, mixed>

addInvalidFrameworkConfigurationFlashMessage()

protected addInvalidFrameworkConfigurationFlashMessage(Exception $e) : mixed
Parameters
$e : Exception

addSelectedPersistenceIdentifier()

protected addSelectedPersistenceIdentifier(string $persistenceIdentifier, array<string|int, mixed> $dataStructure) : array<string|int, mixed>
Parameters
$persistenceIdentifier : string
$dataStructure : array<string|int, mixed>
Return values
array<string|int, mixed>

buildFlexformSheetIdentifier()

protected buildFlexformSheetIdentifier(string $persistenceIdentifier, string $prototypeName, string $formIdentifier, string $finisherIdentifier) : string
Parameters
$persistenceIdentifier : string
$prototypeName : string
$formIdentifier : string
$finisherIdentifier : string
Return values
string

getAdditionalFinisherSheets()

Returns additional flexform sheets with finisher fields

protected getAdditionalFinisherSheets(string $persistenceIdentifier, array<string|int, mixed> $formDefinition) : array<string|int, mixed>
Parameters
$persistenceIdentifier : string

Current persistence identifier

$formDefinition : array<string|int, mixed>

The form definition

Return values
array<string|int, mixed>

initializeNewSheetArray()

Boilerplate XML array of a new sheet

protected initializeNewSheetArray(string $sheetIdentifier, string $finisherName) : array<string|int, mixed>
Parameters
$sheetIdentifier : string
$finisherName : string
Tags
throws
InvalidArgumentException
Return values
array<string|int, mixed>

translateFinisherDefinitionByIdentifier()

protected translateFinisherDefinitionByIdentifier(string $finisherIdentifier, array<string|int, mixed> $finishersDefinition, array<string|int, mixed> $prototypeConfiguration) : array<string|int, mixed>
Parameters
$finisherIdentifier : string
$finishersDefinition : array<string|int, mixed>
$prototypeConfiguration : array<string|int, mixed>
Return values
array<string|int, mixed> 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results