TYPO3\CMS\Backend\Controller\AbstractFormEngineAjaxController Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Controller\AbstractFormEngineAjaxController:

Protected Member Functions
array	createExecutableStringRepresentationOfRegisteredRequireJsModules (array $result, bool $skipInstructions=false)
	addRegisteredRequireJsModulesToJavaScriptItems (array $result, JavaScriptItems $items)
string	getRelativePathToStylesheetFile (string $stylesheetFile)
array	getLabelsFromLocalizationFile ($file)
LanguageService null	getLanguageService ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\Form\FormResultTrait
	serializeJavaScriptModuleInstructionItems (JavaScriptModuleInstruction $instruction)

Detailed Description

Abstract class for a couple of FormEngine controllers triggered by ajax calls. The class containers some helpers to for instance prepare the form render result for json output.

Marked as internal for now, methods in this class may change any time.

Definition at line 37 of file AbstractFormEngineAjaxController.php.

Member Function Documentation

addRegisteredRequireJsModulesToJavaScriptItems()

TYPO3\CMS\Backend\Controller\AbstractFormEngineAjaxController::addRegisteredRequireJsModulesToJavaScriptItems ( array  $result, JavaScriptItems  $items  )

protected

Definition at line 91 of file AbstractFormEngineAjaxController.php.

Referenced by TYPO3\CMS\Backend\Controller\FormFlexAjaxController\containerAdd(), TYPO3\CMS\Backend\Controller\SiteInlineAjaxController\mergeChildResultIntoJsonResult(), and TYPO3\CMS\Backend\Controller\FormInlineAjaxController\mergeChildResultIntoJsonResult().

createExecutableStringRepresentationOfRegisteredRequireJsModules()

array TYPO3\CMS\Backend\Controller\AbstractFormEngineAjaxController::createExecutableStringRepresentationOfRegisteredRequireJsModules ( array  $result, bool  $skipInstructions = false  )

protected

Gets result array from FormEngine and returns string with js modules that need to be loaded and evaluated by JavaScript.

Parameters

array	$result
bool	$skipInstructions	‪whether to skip JavaScriptModuleInstruction

Returns

‪array

Definition at line 48 of file AbstractFormEngineAjaxController.php.

References TYPO3\CMS\Backend\Form\FormResultTrait\serializeJavaScriptModuleInstructionItems().

Referenced by TYPO3\CMS\Backend\Controller\FormFlexAjaxController\containerAdd(), TYPO3\CMS\Backend\Controller\SiteInlineAjaxController\mergeChildResultIntoJsonResult(), and TYPO3\CMS\Backend\Controller\FormInlineAjaxController\mergeChildResultIntoJsonResult().

getLabelsFromLocalizationFile()

array TYPO3\CMS\Backend\Controller\AbstractFormEngineAjaxController::getLabelsFromLocalizationFile (   $file )

protected

Parse a language file and get a label/value array from it.

Parameters

string

$file

‪EXT:path/to/file

Returns

‪array Label/value array

Definition at line 126 of file AbstractFormEngineAjaxController.php.

References TYPO3\CMS\Backend\Controller\AbstractFormEngineAjaxController\getLanguageService(), and TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

Referenced by TYPO3\CMS\Backend\Controller\FormFlexAjaxController\containerAdd(), TYPO3\CMS\Backend\Controller\SiteInlineAjaxController\mergeChildResultIntoJsonResult(), and TYPO3\CMS\Backend\Controller\FormInlineAjaxController\mergeChildResultIntoJsonResult().

getLanguageService()

LanguageService null TYPO3\CMS\Backend\Controller\AbstractFormEngineAjaxController::getLanguageService ( )

protected

Returns

‪LanguageService|null

Definition at line 155 of file AbstractFormEngineAjaxController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\AbstractFormEngineAjaxController\getLabelsFromLocalizationFile().

getRelativePathToStylesheetFile()

string TYPO3\CMS\Backend\Controller\AbstractFormEngineAjaxController::getRelativePathToStylesheetFile ( string  $stylesheetFile )

protected

Resolve a CSS file position, possibly prefixed with 'EXT:'

Parameters

string

$stylesheetFile

‪Given file, possibly prefixed with EXT:

Returns

‪string Web root relative position to file

Definition at line 106 of file AbstractFormEngineAjaxController.php.

References TYPO3\CMS\Core\Utility\PathUtility\getAbsoluteWebPath(), TYPO3\CMS\Core\Core\Environment\getPublicPath(), TYPO3\CMS\Core\Utility\PathUtility\getPublicResourceWebPath(), TYPO3\CMS\Core\Utility\PathUtility\getRelativePathTo(), and TYPO3\CMS\Core\Utility\PathUtility\isExtensionPath().

Referenced by TYPO3\CMS\Backend\Controller\FormFlexAjaxController\containerAdd(), TYPO3\CMS\Backend\Controller\SiteInlineAjaxController\mergeChildResultIntoJsonResult(), and TYPO3\CMS\Backend\Controller\FormInlineAjaxController\mergeChildResultIntoJsonResult().