TYPO3\CMS\Backend\Form\FormResultCompiler Class Reference

Public Member Functions
	mergeResult (array $resultArray)
	JStop ()
	printNeededJSFunctions ()

Protected Member Functions
	JSbottom ($formname='forms[0]')
	loadJavascriptLib ($lib)
	getBackendUserAuthentication ()
	getLanguageService ()
	getPageRenderer ()

Protected Attributes
	$extJSCODE = ''
	$hiddenFieldAccum = []
	$doSaveFieldName = ''
	$inlineData = []
	$stylesheetFiles = []
	$additionalJS_post = []
	$additionalJS_submit = []
	$additionalInlineLanguageLabelFiles = []
	$requireJsModules = []
	$pageRenderer = null

Detailed Description

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

Definition at line 30 of file FormResultCompiler.php.

Member Function Documentation

getBackendUserAuthentication()

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

protected

Returns

BackendUserAuthentication

Definition at line 338 of file FormResultCompiler.php.

References $GLOBALS.

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

getLanguageService()

TYPO3\CMS\Backend\Form\FormResultCompiler::getLanguageService ( )

protected

Returns

LanguageService

Definition at line 346 of file FormResultCompiler.php.

References $GLOBALS.

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

getPageRenderer()

TYPO3\CMS\Backend\Form\FormResultCompiler::getPageRenderer ( )

protected

Wrapper for access to the current page renderer object

Returns

Definition at line 356 of file FormResultCompiler.php.

References TYPO3\CMS\Backend\Form\FormResultCompiler\$pageRenderer, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

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

JSbottom()

TYPO3\CMS\Backend\Form\FormResultCompiler::JSbottom (   $formname = 'forms[0]' )

protected

JavaScript bottom code

Parameters

string

$formname

The identification of the form on the page.

Returns

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

Definition at line 205 of file FormResultCompiler.php.

References TYPO3\CMS\Backend\Form\FormResultCompiler\$additionalJS_submit, TYPO3\CMS\Backend\Form\FormResultCompiler\$extJSCODE, $GLOBALS, TYPO3\CMS\Backend\Form\FormResultCompiler\$pageRenderer, TYPO3\CMS\Core\Utility\GeneralUtility\clientInfo(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extPath(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extRelPath(), TYPO3\CMS\Backend\Form\FormResultCompiler\getBackendUserAuthentication(), TYPO3\CMS\Backend\Form\FormResultCompiler\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getNoRecordTitle(), TYPO3\CMS\Backend\Form\FormResultCompiler\getPageRenderer(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), TYPO3\CMS\Backend\Form\FormResultCompiler\loadJavascriptLib(), TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), and TYPO3\CMS\Core\Utility\GeneralUtility\wrapJS().

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

JStop()

TYPO3\CMS\Backend\Form\FormResultCompiler::JStop

(

)

JavaScript code added BEFORE the form is drawn:

Returns

string A <script></script> section with JavaScript.

Definition at line 173 of file FormResultCompiler.php.

loadJavascriptLib()

TYPO3\CMS\Backend\Form\FormResultCompiler::loadJavascriptLib (   $lib )

protected

Includes a javascript library that exists in the core /typo3/ directory. The backpath is automatically applied.

Parameters

string

$lib

Library name. Call it with the full path like "sysext/core/Resources/Public/JavaScript/QueryGenerator.js" to load it

Returns

void

Definition at line 329 of file FormResultCompiler.php.

References TYPO3\CMS\Backend\Form\FormResultCompiler\$pageRenderer, and TYPO3\CMS\Backend\Form\FormResultCompiler\getPageRenderer().

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

mergeResult()

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

(

array

$resultArray

)

Merge existing data with the given result array

Parameters

array

$resultArray

Array returned by child

Returns

void

Definition at line 105 of file FormResultCompiler.php.

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

printNeededJSFunctions()

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 189 of file FormResultCompiler.php.

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

Member Data Documentation

$additionalInlineLanguageLabelFiles

TYPO3\CMS\Backend\Form\FormResultCompiler::$additionalInlineLanguageLabelFiles = []

protected

Definition at line 83 of file FormResultCompiler.php.

$additionalJS_post

TYPO3\CMS\Backend\Form\FormResultCompiler::$additionalJS_post = []

protected

Definition at line 68 of file FormResultCompiler.php.

$additionalJS_submit

TYPO3\CMS\Backend\Form\FormResultCompiler::$additionalJS_submit = []

protected

Definition at line 76 of file FormResultCompiler.php.

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

$doSaveFieldName

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

protected

Definition at line 49 of file FormResultCompiler.php.

$extJSCODE

TYPO3\CMS\Backend\Form\FormResultCompiler::$extJSCODE = ''

protected

Definition at line 35 of file FormResultCompiler.php.

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

$hiddenFieldAccum

TYPO3\CMS\Backend\Form\FormResultCompiler::$hiddenFieldAccum = []

protected

Definition at line 40 of file FormResultCompiler.php.

$inlineData

TYPO3\CMS\Backend\Form\FormResultCompiler::$inlineData = []

protected

Definition at line 54 of file FormResultCompiler.php.

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

$pageRenderer

TYPO3\CMS\Backend\Form\FormResultCompiler::$pageRenderer = null

protected

Definition at line 96 of file FormResultCompiler.php.

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

$requireJsModules

TYPO3\CMS\Backend\Form\FormResultCompiler::$requireJsModules = []

protected

Definition at line 91 of file FormResultCompiler.php.

$stylesheetFiles

TYPO3\CMS\Backend\Form\FormResultCompiler::$stylesheetFiles = []

protected

Definition at line 61 of file FormResultCompiler.php.