FormResultCompiler
This is form engine - Class for creating the backend editing forms.
This class and its exposed method and method signatures will change
Table of Contents
Properties
- $additionalInlineLanguageLabelFiles : array<string|int, mixed>
- Additional language label files to include.
- $additionalJavaScriptPost : array<string|int, mixed>
- Additional JavaScript printed after the form
- $doSaveFieldName : string
- Can be set to point to a field name in the form which will be set to '1' when the form is submitted with a *save* button. This way the recipient script can determine that the form was submitted for save and not "close" for example.
- $hiddenFieldAccum : array<string|int, mixed>
- $inlineData : array<string|int, mixed>
- $javaScriptModules : array<int, JavaScriptModuleInstruction>
- Array with instances of JavaScriptModuleInstruction.
- $pageRenderer : PageRenderer
- $requireJsModules : array<int, JavaScriptModuleInstruction>
- Array with requireJS modules, use module name as key, the value could be callback code.
- $stylesheetFiles : array<string|int, mixed>
- List of additional style sheet files to load
Methods
- addCssFiles() : string
- Adds CSS files BEFORE the form is drawn
- mergeResult() : mixed
- Merge existing data with the given result array
- printNeededJSFunctions() : string
- Prints necessary JavaScript for TCEforms (after the form HTML).
- getBackendUserAuthentication() : BackendUserAuthentication
- getLanguageService() : LanguageService
- getPageRenderer() : PageRenderer
- Wrapper for access to the current page renderer object
- JSbottom() : string
- JavaScript bottom code
Properties
$additionalInlineLanguageLabelFiles
Additional language label files to include.
protected
array<string|int, mixed>
$additionalInlineLanguageLabelFiles
= []
$additionalJavaScriptPost
Additional JavaScript printed after the form
protected
array<string|int, mixed>
$additionalJavaScriptPost
= []
$doSaveFieldName
Can be set to point to a field name in the form which will be set to '1' when the form is submitted with a *save* button. This way the recipient script can determine that the form was submitted for save and not "close" for example.
protected
string
$doSaveFieldName
= ''
$hiddenFieldAccum
protected
array<string|int, mixed>
$hiddenFieldAccum
= []
HTML of additional hidden fields rendered by sub containers
$inlineData
protected
array<string|int, mixed>
$inlineData
= []
Data array from IRRE pushed to frontend as json array
$javaScriptModules
Array with instances of JavaScriptModuleInstruction.
protected
array<int, JavaScriptModuleInstruction>
$javaScriptModules
= []
$pageRenderer
protected
PageRenderer
$pageRenderer
$requireJsModules
Array with requireJS modules, use module name as key, the value could be callback code.
will be removed in TYPO3 v13.0. Use $javaScriptModules instead.
protected
array<int, JavaScriptModuleInstruction>
$requireJsModules
= []
Use NULL as value if no callback is used.
$stylesheetFiles
List of additional style sheet files to load
protected
array<string|int, mixed>
$stylesheetFiles
= []
Methods
addCssFiles()
Adds CSS files BEFORE the form is drawn
public
addCssFiles() : string
Return values
stringmergeResult()
Merge existing data with the given result array
public
mergeResult(array<string|int, mixed> $resultArray) : mixed
Parameters
- $resultArray : array<string|int, mixed>
-
Array returned by child
Temporary method to use FormEngine class as final data merger
printNeededJSFunctions()
Prints necessary JavaScript for TCEforms (after the form HTML).
public
printNeededJSFunctions() : string
currently this is used to transform page-specific options in the TYPO3.Settings array for JS so the JS module can access these values
Return values
stringgetBackendUserAuthentication()
protected
getBackendUserAuthentication() : BackendUserAuthentication
Return values
BackendUserAuthenticationgetLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServicegetPageRenderer()
Wrapper for access to the current page renderer object
protected
getPageRenderer() : PageRenderer
Return values
PageRendererJSbottom()
JavaScript bottom code
protected
JSbottom() : string
Return values
string —A section with JavaScript - if $update is FALSE, embedded in <script></script>