‪TYPO3CMS  ‪main
TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent Class Reference
Inheritance diagram for TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent:

Public Member Functions

 __construct (private readonly string $tableName, private readonly int $uid, private ?UriInterface $previewUri, private readonly array $contextData)
 
 stop ()
 
 isPropagationStopped ()
 
 getPreviewUri ()
 
 setPreviewUri (UriInterface $previewUri)
 
 getTableName ()
 
 getUid ()
 
 getContextData ()
 

Private Attributes

bool $stopped = false
 

Detailed Description

Used to generate or adjust preview URLs being shown in workspaces backend module.

Definition at line 26 of file RetrievedPreviewUrlEvent.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::__construct ( private readonly string  $tableName,
private readonly int  $uid,
private ?UriInterface  $previewUri,
private readonly array  $contextData 
)

Definition at line 30 of file RetrievedPreviewUrlEvent.php.

Member Function Documentation

◆ getContextData()

TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::getContextData ( )

Definition at line 67 of file RetrievedPreviewUrlEvent.php.

◆ getPreviewUri()

TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::getPreviewUri ( )

Definition at line 47 of file RetrievedPreviewUrlEvent.php.

◆ getTableName()

TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::getTableName ( )

Definition at line 57 of file RetrievedPreviewUrlEvent.php.

◆ getUid()

TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::getUid ( )

Definition at line 62 of file RetrievedPreviewUrlEvent.php.

References TYPO3\CMS\Webhooks\Message\$uid.

◆ isPropagationStopped()

TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::isPropagationStopped ( )

◆ setPreviewUri()

TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::setPreviewUri ( UriInterface  $previewUri)

Definition at line 52 of file RetrievedPreviewUrlEvent.php.

◆ stop()

TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::stop ( )

Definition at line 37 of file RetrievedPreviewUrlEvent.php.

Member Data Documentation

◆ $stopped

bool TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::$stopped = false
private