SiteInlineAjaxController extends AbstractFormEngineAjaxController
Site configuration FormEngine controller class. Receives inline "edit" and "new" commands to expand / create site configuration inline records.
This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
Attributes
- #[AsController]
Table of Contents
Methods
- __construct() : mixed
- newInlineChildAction() : ResponseInterface
- Inline "create" new child of site configuration child records
- openInlineChildAction() : ResponseInterface
- Show the details of site configuration child records.
- addJavaScriptModulesToJavaScriptItems() : void
- compileChild() : array<string|int, mixed>
- Compile a full child record
- 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.
Methods
__construct()
public
__construct(FormDataCompiler $formDataCompiler, SiteLanguagePresets $siteLanguagePresets, HashService $hashService, NodeFactory $nodeFactory, InlineStackProcessor $inlineStackProcessor) : mixed
Parameters
- $formDataCompiler : FormDataCompiler
- $siteLanguagePresets : SiteLanguagePresets
- $hashService : HashService
- $nodeFactory : NodeFactory
- $inlineStackProcessor : InlineStackProcessor
newInlineChildAction()
Inline "create" new child of site configuration child records
public
newInlineChildAction(ServerRequestInterface $request) : ResponseInterface
Parameters
- $request : ServerRequestInterface
Tags
Return values
ResponseInterfaceopenInlineChildAction()
Show the details of site configuration child records.
public
openInlineChildAction(ServerRequestInterface $request) : ResponseInterface
Parameters
- $request : ServerRequestInterface
Tags
Return values
ResponseInterfaceaddJavaScriptModulesToJavaScriptItems()
protected
addJavaScriptModulesToJavaScriptItems(array<string|int, mixed> $modules, JavaScriptItems $items) : void
Parameters
- $modules : array<string|int, mixed>
- $items : JavaScriptItems
compileChild()
Compile a full child record
protected
compileChild(ServerRequestInterface $request, array<string|int, mixed> $parentData, string $parentFieldName, int $childUid, array<string|int, mixed> $inlineStructure) : array<string|int, mixed>
Parameters
- $request : ServerRequestInterface
- $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
Return values
array<string|int, mixed> —Full result array
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
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|nullgetLanguageService()
protected
getLanguageService() : LanguageService|null
Return values
LanguageService|nullgetRelativePathToStylesheetFile()
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