SiteInlineAjaxController extends AbstractFormEngineAjaxController

Site configuration FormEngine controller class. Receives inline "edit" and "new" commands to expand / create site configuration inline records

Internal

This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.

Table of Contents

Methods

__construct()  : mixed
Default constructor
newInlineChildAction()  : ResponseInterface
Inline "create" new child of site configuration child records
openInlineChildAction()  : ResponseInterface
Show the details of site configuration child records.
addRegisteredRequireJsModulesToJavaScriptItems()  : void
compileChild()  : array<string|int, mixed>
Compile a full child record
createExecutableStringRepresentationOfRegisteredRequireJsModules()  : array<string|int, mixed>
Gets result array from FormEngine and returns string with js modules that need to be loaded and evaluated by JavaScript.
extractSignedParentConfigFromRequest()  : array<string|int, mixed>
Inline ajax helper method.
getInlineFirstPidFromDomObjectId()  : int|null
Get inlineFirstPid from a given objectId string
getLabelsFromLocalizationFile()  : array<string|int, mixed>
Parse a language file and get a label/value array from it.
getLanguageById()  : SiteLanguage|null
Find a site language by id. This will return the first occurrence of a language, even if the same language is used in other site configurations.
getLanguageService()  : LanguageService|null
getRelativePathToStylesheetFile()  : string
Resolve a CSS file position, possibly prefixed with 'EXT:'
mergeChildResultIntoJsonResult()  : array<string|int, mixed>
Merge stuff from child array into json array.
serializeJavaScriptModuleInstructionItems()  : array<string|int, mixed>

Methods

__construct()

Default constructor

public __construct() : mixed

newInlineChildAction()

Inline "create" new child of site configuration child records

public newInlineChildAction(ServerRequestInterface $request) : ResponseInterface
Parameters
$request : ServerRequestInterface
Tags
throws
RuntimeException
Return values
ResponseInterface

openInlineChildAction()

Show the details of site configuration child records.

public openInlineChildAction(ServerRequestInterface $request) : ResponseInterface
Parameters
$request : ServerRequestInterface
Tags
throws
RuntimeException
Return values
ResponseInterface

addRegisteredRequireJsModulesToJavaScriptItems()

protected addRegisteredRequireJsModulesToJavaScriptItems(array<string|int, mixed> $result, JavaScriptItems $items) : void
Parameters
$result : array<string|int, mixed>
$items : JavaScriptItems

compileChild()

Compile a full child record

protected compileChild(array<string|int, mixed> $parentData, string $parentFieldName, int $childUid, array<string|int, mixed> $inlineStructure) : array<string|int, mixed>
Parameters
$parentData : array<string|int, mixed>

Result array of parent

$parentFieldName : string

Name of parent field

$childUid : int

Uid of child to compile

$inlineStructure : array<string|int, mixed>

Current inline structure

Tags
throws
RuntimeException
todo:

This clones methods compileChild from TcaInline Provider. Find a better abstraction

todo:

to also encapsulate the more complex scenarios with combination child and friends.

Return values
array<string|int, mixed> —

Full result array

createExecutableStringRepresentationOfRegisteredRequireJsModules()

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

protected createExecutableStringRepresentationOfRegisteredRequireJsModules(array<string|int, mixed> $result[, bool $skipInstructions = false ]) : array<string|int, mixed>
Parameters
$result : array<string|int, mixed>
$skipInstructions : bool = false

whether to skip JavaScriptModuleInstruction

Return values
array<string|int, mixed>

extractSignedParentConfigFromRequest()

Inline ajax helper method.

protected extractSignedParentConfigFromRequest(string $contextString) : array<string|int, mixed>

Validates the config that is transferred over the wire to provide the correct TCA config for the parent table

Parameters
$contextString : string
Tags
throws
RuntimeException
Return values
array<string|int, mixed>

getInlineFirstPidFromDomObjectId()

Get inlineFirstPid from a given objectId string

protected getInlineFirstPidFromDomObjectId(string $domObjectId) : int|null
Parameters
$domObjectId : string

The id attribute of an element

Return values
int|null —

Pid or null

getLabelsFromLocalizationFile()

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

protected getLabelsFromLocalizationFile(string $file) : array<string|int, mixed>
Parameters
$file : string

EXT:path/to/file

Return values
array<string|int, mixed> —

Label/value array

getLanguageById()

Find a site language by id. This will return the first occurrence of a language, even if the same language is used in other site configurations.

protected getLanguageById(int $languageId) : SiteLanguage|null
Parameters
$languageId : int
Return values
SiteLanguage|null

getRelativePathToStylesheetFile()

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

protected getRelativePathToStylesheetFile(string $stylesheetFile) : string
Parameters
$stylesheetFile : string

Given file, possibly prefixed with EXT:

Return values
string —

Web root relative position to file

mergeChildResultIntoJsonResult()

Merge stuff from child array into json array.

protected mergeChildResultIntoJsonResult(array<string|int, mixed> $jsonResult, array<string|int, mixed> $childResult) : array<string|int, mixed>

This method is needed since ajax handling methods currently need to put scriptCalls before and after child code.

Parameters
$jsonResult : array<string|int, mixed>

Given json result

$childResult : array<string|int, mixed>

Given child result

Return values
array<string|int, mixed> —

Merged json array

serializeJavaScriptModuleInstructionItems()

protected serializeJavaScriptModuleInstructionItems(JavaScriptModuleInstruction $instruction) : array<string|int, mixed>
Parameters
$instruction : JavaScriptModuleInstruction
Tags
todo

This is a temporary "solution" and shall be handled in JavaScript directly

Return values
array<string|int, mixed> 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results