ModifyInlineElementControlsEvent
The PSR-14 event
\TYPO3\
is called after the markup for all enabled controls has been generated. It
can be used to either change the markup of a control, to add a new control
or to completely remove a control.
Example
<?php
declare(strict_types=1);
namespace MyVendor\MyExtension\Backend\EventListener;
use TYPO3\CMS\Backend\Form\Event\ModifyInlineElementControlsEvent;
use TYPO3\CMS\Backend\Form\Event\ModifyInlineElementEnabledControlsEvent;
use TYPO3\CMS\Core\Attribute\AsEventListener;
use TYPO3\CMS\Core\Imaging\IconFactory;
use TYPO3\CMS\Core\Imaging\IconSize;
use TYPO3\CMS\Core\Utility\GeneralUtility;
#[AsEventListener(
identifier: 'my-extension/backend/modify-enabled-controls',
method: 'modifyEnabledControls',
)]
#[AsEventListener(
identifier: 'my-extension/backend/modify-controls',
method: 'modifyControls',
)]
final readonly class MyEventListener
{
public function modifyEnabledControls(ModifyInlineElementEnabledControlsEvent $event): void
{
// Enable a control depending on the foreign table
if ($event->getForeignTable() === 'sys_file_reference' && $event->isControlEnabled('sort')) {
$event->enableControl('sort');
}
}
public function modifyControls(ModifyInlineElementControlsEvent $event): void
{
// Add a custom control depending on the parent table
if ($event->getElementData()['inlineParentTableName'] === 'tt_content') {
$iconFactory = GeneralUtility::makeInstance(IconFactory::class);
$event->setControl(
'tx_my_control',
'<a href="/some/url" class="btn btn-default t3js-modal-trigger">'
. $iconFactory->getIcon('my-icon-identifier', IconSize::SMALL)->render()
. '</a>',
);
}
}
}
New in version 13.0
The PHP attribute
\TYPO3\ has been
introduced to tag a PHP class as an event listener. Alternatively, or if you
need to be compatible with older TYPO3 versions, you can also register an
event listener via the Configuration/Services.yaml file. Switch to
an older version of this page for an example or have a look at the section
Implementing an event listener in your extension.
API
- class ModifyInlineElementControlsEvent
-
- Fully qualified name
-
\TYPO3\
CMS\ Backend\ Form\ Event\ Modify Inline Element Controls Event
Listeners to this Event will be able to modify the controls of an inline element
- getControl ( string $identifier)
-
Returns the markup for the requested control
- param $identifier
-
the identifier
- Returns
-
string
- setControl ( string $identifier, string $markup)
-
Set a control with the given identifier and markup IMPORTANT: Overwrites an existing control with the same identifier
- param $identifier
-
the identifier
- param $markup
-
the markup
- hasControl ( string $identifier)
-
Returns whether a control exists for the given identifier
- param $identifier
-
the identifier
- Returns
-
bool