Breaking: #107884 - Rework actions to use Buttons API with Components 

ModifyRecordListRecordActionsEvent 

The method setAction() now requires a ComponentInterface object, the method getAction() now returns null or a ComponentInterface object.

Similar behavior can be for ActionGroup and the $group parameter which requires a ActionGroup enum now and affects these methods:

• hasAction()
• getAction()
• removeAction()
• getActionGroup()

The method getRecord() no longer returns a raw data array but an instance of the Record API.

A new method getRequest() allows to access request context for the event.

Removed methods:

• getActions()
• setActions()
• getTable()

ProcessFileListActionsEvent 

The ProcessFileListActionsEvent has received identical changes to its API as the ModifyRecordListRecordActionsEvent, allowing to modify items in both supported ActionGroups (primary and secondary). Several new API methods have been created:

• setAction()
• getAction()
• removeAction()
• moveActionTo()
• getActionGroup()
• getRequest()

Buttons can now also be internally relocated, or placed at specific before/after positions.

Removed methods:

• getActionItems()
• setActionItems()

DatabaseRecordList::makeControl() 

// Before
public function makeControl($table, RecordInterface $record): string

// After
public function makeControl(RecordInterface $record): string

The $table parameter has been removed as the table name can be obtained from the RecordInterface via $record->getMainType().

Adjust code that calls this (internal) method to drop the $table argument:

// ...
public function render(): string
{
    $row = BackendUtility::getRecord($table, $someRowUid);
    $databaseRecordList = GeneralUtility::makeInstance(DatabaseRecordList::class);
-   return $databaseRecordList->makeControl($table, $row);
+   return $databaseRecordList->makeControl($row);
}

ProcessFileListActionsEvent 

Due to the changes in those events, event listeners now need to compose extra actions with the Button API and add each button ( $action) via the event's setAction($button) method.

Internally, buttons are now put into the new ActionGroup container which can be retrieved via TYPO3\CMS\Backend\Template\Components\ActionGroup::primary or TYPO3\CMS\Backend\Template\Components\ActionGroup::secondary.

The replacement for the old event method getActionItems() thus needs the context of which action group to retrieve, and can be done now via getActionGroup().

Instead of retrieving all items and modifying them, distinct event methods removeAction(), moveActionTo() and getAction() are now available, identifying each action button with a string like the former array key index.

Action buttons can now longer be submitted as raw HTML markup, but instead need to utilize either the Button API or the new ComponentFactory() (see forge#107823) for a convenience layer on top of the Button API.

// Before
class ProcessFileListActionsEventListener
{
    public function __invoke(ProcessFileListActionsEvent $event): void
    {
        $items = $event->getActionItems();
        $items['my-own-action'] = '<a href="..." class="btn btn-default">...</a>';
        unset($items['some-other-action']);
        $event->setActionItems($items);
    }
}

// After
class ProcessFileListActionsEventListener
{
    public function __construct(
        TYPO3\CMS\Backend\Template\Components\ComponentFactory $componentFactory,
        TYPO3\CMS\Core\Imaging\IconFactory $iconFactory,
    ) {
    }

    public function __invoke(ProcessFileListActionsEvent $event): void
    {
        $viewButton = $this->componentFactory->createGenericButton()
            ->setIcon($this->iconFactory->getIcon('actions-view'))
            ->setTitle('My title')
        $event->setAction($viewButton, 'my-own-action', ActionGroup::primary);

        $event->removeAction('some-other-action', ActionGroup::primary);
    }
}

ModifyRecordListRecordActionsEvent 

As with the event above, event listeners now need to compose extra actions with the Button API and add each button ( $action) via the event's setAction($button) method. Buttons can no longer contain raw HTML markup.

The signature of the existing event method setAction() has changed, so that $action needs to be an instance of ComponentInterface, which is retrieved via the ComponentFactory, and no longer a string.

Since (as mentioned above) the action groups are managed via the ActionGroup container, the event methods hasAction(), getAction(), removeAction(), getActionGroup() now need to specify a $group identifier like ActionGroup::primary or ActionGroup::secondary instead of a string.

The ability to inject multiple items at once with setActions() must be replaced with distinct calls to setAction().

Retrieving all action items can no longer be done with getActions() but must specifically access either the primary or secondary action group with getActionGroup().

The getRecord() method no longer returns an array with record data, but an object of the Record API.

The getTable() method can be replaced by retrieving the table name via getRecord()->getMainType() thanks to easily accessing the Record API object.

// Before
class ModifyRecordListRecordActionsEventListener
{
    public function __invoke(ModifyRecordListRecordActionsEvent $event): void
    {
        $items = $event->getActions();
        unset($items['my-own-action']);
        $items['my-own-action'] = '<a href="..." class="btn btn-default">...</a>';
        unset($existing['some-other-action']);
        $event->setActions($items);

        $event->setAction('<button ...></button>', 'my-other-own-action', 'secondary');
    }
}

// After
class ModifyRecordListRecordActionsEventListener
{
    public function __construct(
        TYPO3\CMS\Backend\Template\Components\ComponentFactory $componentFactory,
        TYPO3\CMS\Core\Imaging\IconFactory $iconFactory,
    ) {
    }

    public function __invoke(ModifyRecordListRecordActionsEventListener $event): void
    {
        $viewButton = $this->componentFactory->createGenericButton()
            ->setIcon($this->iconFactory->getIcon('actions-view'))
            ->setTitle('My title')
        $event->setAction($viewButton, 'my-own-action', ActionGroup::primary);
        $event->removeAction('some-other-action', ActionGroup::primary);

        $inputButton = $this->componentFactory->createInputButton()
            ->setTitle('My Button')
        $event->setAction($inputButton, 'my-other-own-action', ActionGroup::secondary);
    }
}

// Before
$event->getAction('my-button', 'primary');
$event->hasAction('my-button', 'primary');
$event->removeAction('my-button', 'primary');
$event->getActionGroup('primary');

// After
$event->getAction('my-button', ActionGroup::primary);
$event->hasAction('my-button', ActionGroup::primary);
$event->removeAction('my-button', ActionGroup::primary);
$event->getActionGroup(ActionGroup::primary);

// Before
$uid = $event->getRecord()['uid'];
$title = $event->getRecord()['title'];

// After
$uid = $event->getRecord()->getUid();
$title = $event->getRecord()->getRawRecord()['title'];

Dual-version compatibility 

The create extensions or custom code that works in both TYPO3 v13 and v14, a version switch can be added within event listeners:

class ModifyRecordListRecordActionsEventListener
{
    public function __invoke(ModifyRecordListRecordActionsEvent $event): void
    {
        if (new TYPO3\CMS\Core\Information\Typo3Version()->getMajorVersion() >= 14) {
            $viewButton = $this->componentFactory->createGenericButton()
                ->setIcon($this->iconFactory->getIcon('actions-view'))
                ->setTitle('My title')
            $event->setAction($viewButton, 'my-own-action', ActionGroup::primary);
            $event->removeAction('some-other-action', ActionGroup::primary);
        } else {
            $items = $event->getActions();
            unset($items['my-own-action']);
            $items['my-own-action'] = '<a href="..." class="btn btn-default">...</a>';
            unset($existing['some-other-action']);
            $event->setActions($items);
        }
    }
}