TYPO3\CMS\Backend\Form\FormResultCompiler Class Reference

Public Member Functions
	mergeResult (array $resultArray)
string	addCssFiles ()
string	printNeededJSFunctions ()

Protected Member Functions
string	JSbottom ()
BackendUserAuthentication	getBackendUserAuthentication ()
TYPO3 CMS Core Localization LanguageService	getLanguageService ()
TYPO3 CMS Core Page PageRenderer	getPageRenderer ()

Protected Attributes
array	$hiddenFieldAccum = array( )
string	$doSaveFieldName = ''
array	$inlineData = array( )
array	$stylesheetFiles = array( )
array	$additionalJavaScriptPost = array( )
array	$additionalJavaScriptSubmit = array( )
array	$additionalInlineLanguageLabelFiles = array( )
array	$requireJsModules = array( )
PageRenderer	$pageRenderer

Detailed Description

This is form engine - Class for creating the backend editing forms.

This class and its exposed method and method signatures will change

Definition at line 27 of file FormResultCompiler.php.

Member Function Documentation

addCssFiles()

string TYPO3\CMS\Backend\Form\FormResultCompiler::addCssFiles

(

)

Adds CSS files BEFORE the form is drawn

Returns

‪string

Definition at line 155 of file FormResultCompiler.php.

References TYPO3\CMS\Backend\Form\FormResultCompiler\$pageRenderer, TYPO3\CMS\Core\Page\PageRenderer\addCssFile(), and TYPO3\CMS\Backend\Form\FormResultCompiler\getPageRenderer().

getBackendUserAuthentication()

BackendUserAuthentication TYPO3\CMS\Backend\Form\FormResultCompiler::getBackendUserAuthentication ( )

protected

Returns

‪BackendUserAuthentication

Definition at line 295 of file FormResultCompiler.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Form\FormResultCompiler\JSbottom().

getLanguageService()

TYPO3 CMS Core Localization LanguageService TYPO3\CMS\Backend\Form\FormResultCompiler::getLanguageService ( )

protected

Returns an instance of LanguageService

Returns

‪\TYPO3\CMS\Core\Localization\LanguageService

Definition at line 305 of file FormResultCompiler.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Form\FormResultCompiler\JSbottom().

getPageRenderer()

TYPO3 CMS Core Page PageRenderer TYPO3\CMS\Backend\Form\FormResultCompiler::getPageRenderer ( )

protected

Wrapper for access to the current page renderer object

Returns

‪\TYPO3\CMS\Core\Page\PageRenderer

Definition at line 315 of file FormResultCompiler.php.

References TYPO3\CMS\Backend\Form\FormResultCompiler\$pageRenderer.

Referenced by TYPO3\CMS\Backend\Form\FormResultCompiler\addCssFiles(), TYPO3\CMS\Backend\Form\FormResultCompiler\JSbottom(), and TYPO3\CMS\Backend\Form\FormResultCompiler\printNeededJSFunctions().

JSbottom()

string TYPO3\CMS\Backend\Form\FormResultCompiler::JSbottom ( )

protected

JavaScript bottom code

Returns

‪string A section with JavaScript - if $update is FALSE, embedded in <script></script>

Definition at line 185 of file FormResultCompiler.php.

References $GLOBALS, TYPO3\CMS\Backend\Form\FormResultCompiler\$pageRenderer, TYPO3\CMS\Core\Page\PageRenderer\addInlineLanguageLabelArray(), TYPO3\CMS\Core\Page\PageRenderer\addInlineLanguageLabelFile(), TYPO3\CMS\Core\Page\PageRenderer\addInlineSetting(), TYPO3\CMS\Core\Page\PageRenderer\addInlineSettingArray(), TYPO3\CMS\Core\Page\PageRenderer\addJsFile(), TYPO3\CMS\Backend\Form\FormResultCompiler\getBackendUserAuthentication(), TYPO3\CMS\Backend\Form\FormResultCompiler\getLanguageService(), TYPO3\CMS\Backend\Form\FormResultCompiler\getPageRenderer(), TYPO3\CMS\Core\Page\PageRenderer\JQUERY_NAMESPACE_NONE, TYPO3\CMS\Core\Page\PageRenderer\loadJquery(), TYPO3\CMS\Core\Page\PageRenderer\loadRequireJsModule(), and TYPO3\CMS\Core\Localization\LanguageService\sL().

Referenced by TYPO3\CMS\Backend\Form\FormResultCompiler\printNeededJSFunctions().

mergeResult()

TYPO3\CMS\Backend\Form\FormResultCompiler::mergeResult

(

array

$resultArray

)

Merge existing data with the given result array

Parameters

array

$resultArray

‪Array returned by child

Temporary method to use FormEngine class as final data merger

Definition at line 87 of file FormResultCompiler.php.

References TYPO3\CMS\Backend\Form\FormResultCompiler\$inlineData, and TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

printNeededJSFunctions()

string TYPO3\CMS\Backend\Form\FormResultCompiler::printNeededJSFunctions

(

)

Prints necessary JavaScript for TCEforms (after the form HTML). currently this is used to transform page-specific options in the TYPO3.Settings array for JS so the JS module can access these values

Returns

‪string

Definition at line 171 of file FormResultCompiler.php.

References TYPO3\CMS\Backend\Form\FormResultCompiler\$pageRenderer, TYPO3\CMS\Core\Page\PageRenderer\addInlineSetting(), TYPO3\CMS\Backend\Form\FormResultCompiler\getPageRenderer(), and TYPO3\CMS\Backend\Form\FormResultCompiler\JSbottom().

Member Data Documentation

$additionalInlineLanguageLabelFiles

array TYPO3\CMS\Backend\Form\FormResultCompiler::$additionalInlineLanguageLabelFiles = array( )

protected

Additional language label files to include.

Definition at line 68 of file FormResultCompiler.php.

$additionalJavaScriptPost

array TYPO3\CMS\Backend\Form\FormResultCompiler::$additionalJavaScriptPost = array( )

protected

Additional JavaScript printed after the form

Definition at line 55 of file FormResultCompiler.php.

$additionalJavaScriptSubmit

array TYPO3\CMS\Backend\Form\FormResultCompiler::$additionalJavaScriptSubmit = array( )

protected

Additional JavaScript executed on submit; If you set "OK" variable it will raise an error about RTEs not being loaded and offer to block further submission.

Definition at line 62 of file FormResultCompiler.php.

$doSaveFieldName

string TYPO3\CMS\Backend\Form\FormResultCompiler::$doSaveFieldName = ''

protected

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.

Definition at line 39 of file FormResultCompiler.php.

$hiddenFieldAccum

array TYPO3\CMS\Backend\Form\FormResultCompiler::$hiddenFieldAccum = array( )

protected

HTML of additional hidden fields rendered by sub containers

Definition at line 31 of file FormResultCompiler.php.

$inlineData

array TYPO3\CMS\Backend\Form\FormResultCompiler::$inlineData = array( )

protected

Data array from IRRE pushed to frontend as json array

Definition at line 43 of file FormResultCompiler.php.

Referenced by TYPO3\CMS\Backend\Form\FormResultCompiler\mergeResult().

$pageRenderer

PageRenderer TYPO3\CMS\Backend\Form\FormResultCompiler::$pageRenderer

protected

Definition at line 79 of file FormResultCompiler.php.

Referenced by TYPO3\CMS\Backend\Form\FormResultCompiler\addCssFiles(), TYPO3\CMS\Backend\Form\FormResultCompiler\getPageRenderer(), TYPO3\CMS\Backend\Form\FormResultCompiler\JSbottom(), and TYPO3\CMS\Backend\Form\FormResultCompiler\printNeededJSFunctions().

$requireJsModules

array TYPO3\CMS\Backend\Form\FormResultCompiler::$requireJsModules = array( )

protected

Array with requireJS modules, use module name as key, the value could be callback code. Use NULL as value if no callback is used.

Definition at line 75 of file FormResultCompiler.php.

$stylesheetFiles

array TYPO3\CMS\Backend\Form\FormResultCompiler::$stylesheetFiles = array( )

protected

List of additional style sheet files to load

Definition at line 49 of file FormResultCompiler.php.