RecordListHookInterface
Interface for classes which hook into \TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList and modify clip-icons
since TYPO3 v11 LTS, will be removed in TYPO3 v12.0. Use the PSR-14-based events instead.
Table of Contents
Methods
- makeClip() : array<string|int, mixed>
- Modifies Web>List clip icons (copy, cut, paste, etc.) of a displayed row
- makeControl() : array<string|int, mixed>
- Modifies Web>List control icons of a displayed row
- renderListHeader() : array<string|int, mixed>
- Modifies Web>List header row columns/cells
- renderListHeaderActions() : array<string|int, mixed>
- Modifies Web>List header row clipboard/action icons
Methods
makeClip()
Modifies Web>List clip icons (copy, cut, paste, etc.) of a displayed row
public
makeClip(string $table, array<string|int, mixed> $row, array<string|int, mixed> $cells, object &$parentObject) : array<string|int, mixed>
since v11, will be removed in v12. Use ModifyRecordListRecordActionsEvent instead.
Parameters
- $table : string
-
The current database table
- $row : array<string|int, mixed>
-
The current record row
- $cells : array<string|int, mixed>
-
The default clip-icons to get modified
- $parentObject : object
-
Instance of calling object
Return values
array<string|int, mixed> —The modified clip-icons
makeControl()
Modifies Web>List control icons of a displayed row
public
makeControl(string $table, array<string|int, mixed> $row, array<string|int, mixed> $cells, object &$parentObject) : array<string|int, mixed>
since v11, will be removed in v12. Use ModifyRecordListRecordActionsEvent instead.
Parameters
- $table : string
-
The current database table
- $row : array<string|int, mixed>
-
The current record row
- $cells : array<string|int, mixed>
-
The default control-icons to get modified
- $parentObject : object
-
Instance of calling object
Return values
array<string|int, mixed> —The modified control-icons
renderListHeader()
Modifies Web>List header row columns/cells
public
renderListHeader(string $table, array<string|int, mixed> $currentIdList, array<string|int, mixed> $headerColumns, object &$parentObject) : array<string|int, mixed>
since v11, will be removed in v12. Use ModifyRecordListHeaderColumnsEvent instead.
Parameters
- $table : string
-
The current database table
- $currentIdList : array<string|int, mixed>
-
Array of the currently displayed uids of the table
- $headerColumns : array<string|int, mixed>
-
An array of rendered cells/columns
- $parentObject : object
-
Instance of calling (parent) object
Return values
array<string|int, mixed> —Array of modified cells/columns
renderListHeaderActions()
Modifies Web>List header row clipboard/action icons
public
renderListHeaderActions(string $table, array<string|int, mixed> $currentIdList, array<string|int, mixed> $cells, object &$parentObject) : array<string|int, mixed>
since v11, will be removed in v12. Use ModifyRecordListTableActionsEvent instead.
Parameters
- $table : string
-
The current database table
- $currentIdList : array<string|int, mixed>
-
Array of the currently displayed uids of the table
- $cells : array<string|int, mixed>
-
An array of the current clipboard/action icons
- $parentObject : object
-
Instance of calling (parent) object
Return values
array<string|int, mixed> —Array of modified clipboard/action icons