RecyclerAjaxController
Controller class for the 'recycler' extension. Handles the AJAX requests.
This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
Attributes
- #[AsController]
Table of Contents
Properties
- $backendViewFactory : BackendViewFactory
- $conf : array<string|int, mixed>
- The local configuration array
- $connectionPool : ConnectionPool
- $iconFactory : IconFactory
- $recordHistory : RecordHistory
- $runtimeCache : FrontendInterface
Methods
- __construct() : mixed
- dispatch() : ResponseInterface
- The main dispatcher function. Collect data and prepare HTML output.
- getBackendUser() : BackendUserAuthentication
- getBackendUserInformation() : array<string|int, mixed>
- Gets the username and real name of a given backend user
- getLanguageService() : LanguageService
- getPageTitle() : string
- Gets the page title of the given page id
- getRecordPath() : string
- Returns the path (visually) of a page $uid, fx. "/First page/Second page/Another subpage" Each part of the path will be limited to $titleLimit characters Deleted pages are filtered out.
- getTables() : array<string|int, mixed>
- isParentPageDeleted() : bool
- Check if parent record is deleted
- setDataInSession() : void
- Sets data in the session of the current backend user.
- transform() : array<string|int, mixed>
- Transforms the rows for the deleted records by grouping them by their corresponding table and processing the raw record data.
Properties
$backendViewFactory read-only
protected
BackendViewFactory
$backendViewFactory
$conf
The local configuration array
protected
array<string|int, mixed>
$conf
= []
$connectionPool read-only
protected
ConnectionPool
$connectionPool
$iconFactory read-only
protected
IconFactory
$iconFactory
$recordHistory read-only
protected
RecordHistory
$recordHistory
$runtimeCache read-only
protected
FrontendInterface
$runtimeCache
Attributes
- #[Autowire]
- $service: 'cache.runtime'
Methods
__construct()
public
__construct(BackendViewFactory $backendViewFactory, FrontendInterface $runtimeCache, IconFactory $iconFactory, ConnectionPool $connectionPool, RecordHistory $recordHistory) : mixed
Parameters
- $backendViewFactory : BackendViewFactory
- $runtimeCache : FrontendInterface
- $iconFactory : IconFactory
- $connectionPool : ConnectionPool
- $recordHistory : RecordHistory
dispatch()
The main dispatcher function. Collect data and prepare HTML output.
public
dispatch(ServerRequestInterface $request) : ResponseInterface
Parameters
- $request : ServerRequestInterface
Return values
ResponseInterfacegetBackendUser()
protected
getBackendUser() : BackendUserAuthentication
Return values
BackendUserAuthenticationgetBackendUserInformation()
Gets the username and real name of a given backend user
protected
getBackendUserInformation(int $userId) : array<string|int, mixed>
Parameters
- $userId : int
Return values
array<string|int, mixed>getLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServicegetPageTitle()
Gets the page title of the given page id
protected
getPageTitle(int $pageId) : string
Parameters
- $pageId : int
Return values
stringgetRecordPath()
Returns the path (visually) of a page $uid, fx. "/First page/Second page/Another subpage" Each part of the path will be limited to $titleLimit characters Deleted pages are filtered out.
protected
getRecordPath(int $uid) : string
Parameters
- $uid : int
-
Page uid for which to create record path
Return values
string —Path of record (string) OR array with short/long title if $fullTitleLimit is set.
getTables()
protected
getTables(int $startUid, int $depth) : array<string|int, mixed>
Parameters
- $startUid : int
-
UID from selected page
- $depth : int
-
How many levels recursive
Return values
array<string|int, mixed> —The tables to be displayed
isParentPageDeleted()
Check if parent record is deleted
protected
isParentPageDeleted(int $pid) : bool
Parameters
- $pid : int
Return values
boolsetDataInSession()
Sets data in the session of the current backend user.
protected
setDataInSession(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
-
The data to be stored in the session
transform()
Transforms the rows for the deleted records by grouping them by their corresponding table and processing the raw record data.
protected
transform(array<string, array<string|int, mixed>> $deletedRowsArray) : array<string|int, mixed>
Parameters
- $deletedRowsArray : array<string, array<string|int, mixed>>