ModifyImageManipulationPreviewUrlEvent¶
New in version 12.0
This event serves as a direct replacement for the now removed
$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['Backend/Form/Element/ImageManipulationElement']['previewUrl']
hook.
The PSR-14 event
\TYPO3\CMS\Backend\Form\Event\ModifyImageManipulationPreviewUrlEvent
can be used to modify the preview URL within the
image manipulation element, used
for example for the crop field of the sys_file_reference table.
As soon as a preview URL is set, the image manipulation element will display a corresponding button in the footer of the modal window, next to the Cancel and Accept buttons. On click, the preview URL will be opened in a new window.
Note
The element's crop variants will always be appended to the preview URL
as JSON-encoded string, using the cropVariants parameter.
Example¶
Registration of the event listener in the extension's Services.yaml:
services:
# Place here the default dependency injection configuration
MyVendor\MyExtension\Backend\EventListener\MyEventListener:
tags:
- name: event.listener
identifier: 'my-extension/backend/modify-imagemanipulation-previewurl'
Read how to configure dependency injection in extensions.
The corresponding event listener class:
<?php
declare(strict_types=1);
namespace MyVendor\MyExtension\Backend\EventListener;
use TYPO3\CMS\Backend\Form\Event\ModifyImageManipulationPreviewUrlEvent;
final class MyEventListener
{
public function __invoke(ModifyImageManipulationPreviewUrlEvent $event): void
{
$event->setPreviewUrl('https://example.com/some/preview/url');
}
}
API¶
- class \TYPO3\CMS\Backend\Form\Event\ ModifyImageManipulationPreviewUrlEvent¶
-
Listeners to this Event will be able to modify the preview url, used in the ImageManipulation element
- getDatabaseRow ( ) ¶
-
- returntype
-
array
- getFieldConfiguration ( ) ¶
-
- returntype
-
array
- getFile ( ) ¶
-
- returntype
-
TYPO3\CMS\Core\Resource\File
- getPreviewUrl ( ) ¶
-
- returntype
-
string
- setPreviewUrl ( string $previewUrl) ¶
-
- param string $previewUrl
-
the previewUrl