ModifyRecordOverlayIconIdentifierEvent¶
New in version 13.0
This PSR-14 event has been introduced, serving as a more flexible
replacement for the removed hook
$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['TYPO3\CMS\Core\Imaging\IconFactory']['overrideIconOverlay']
.
The PSR-14 event \TYPO3\CMS\Core\Imaging\Event\ModifyRecordOverlayIconIdentifierEvent
allows extension authors to modify the overlay icon identifier of any record
icon. Extensions can listen to this event and perform necessary modifications
to the overlay icon identifier based on their requirements.
Example¶
<?php
declare(strict_types=1);
namespace Vendor\MyExtension\Imaging\EventListener;
use TYPO3\CMS\Core\Attribute\AsEventListener;
use TYPO3\CMS\Core\Imaging\Event\ModifyRecordOverlayIconIdentifierEvent;
final readonly class MyEventListener
{
#[AsEventListener(
identifier: 'my-extension/imaging/modify-record-overlay-icon-identifier',
)]
public function __invoke(ModifyRecordOverlayIconIdentifierEvent $event): void
{
if ($event->getTable() === 'tx_myextension_domain_model_mytable') {
$event->setOverlayIconIdentifier('my-overlay-icon-identifier');
}
}
}
New in version 13.0
The PHP attribute \TYPO3\CMS\Core\Attribute\AsEventListener
has been
introduced to tag a PHP class as an event listener. Alternatively, you can also
register an event listener via the Configuration/Services.yaml
file. Have
a look into the section Implementing an event listener in your extension.
API¶
- class \TYPO3\CMS\Core\Imaging\Event\ ModifyRecordOverlayIconIdentifierEvent¶
-
Listeners to this event are able to modify the overlay icon identifier of any record icon
- setOverlayIconIdentifier ( string $overlayIconIdentifier) ¶
-
- param string $overlayIconIdentifier
-
the overlayIconIdentifier
- getOverlayIconIdentifier ( ) ¶
-
- returntype
-
string
- getTable ( ) ¶
-
- returntype
-
string
- getRow ( ) ¶
-
- returntype
-
array
- getStatus ( ) ¶
-
- returntype
-
array