TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent:

Public Member Functions
	__construct (private int $pageId, private int $languageId, private array $rootline, private string $section, private array $additionalQueryParameters, private readonly Context $context, private readonly array $options)
	setPreviewUri (UriInterface $uri)
	getPreviewUri ()
	isPropagationStopped ()
	getPageId ()
	setPageId (int $pageId)
	getLanguageId ()
	setLanguageId (int $languageId)
	getRootline ()
	setRootline (array $rootline)
	getSection ()
	setSection (string $section)
	getAdditionalQueryParameters ()
	setAdditionalQueryParameters (array $additionalQueryParameters)
	getContext ()
	getOptions ()

Private Attributes
UriInterface	$uri = null

Detailed Description

Listeners to this event will be able to modify the corresponding parameters, before the page preview URI is being generated, when linking to a page in the frontend.

Definition at line 28 of file BeforePagePreviewUriGeneratedEvent.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent::__construct	(	private int	$pageId,
		private int	$languageId,
		private array	$rootline,
		private string	$section,
		private array	$additionalQueryParameters,
		private readonly Context	$context,
		private readonly array	$options
	)

Definition at line 32 of file BeforePagePreviewUriGeneratedEvent.php.

Member Function Documentation

getAdditionalQueryParameters()

TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent::getAdditionalQueryParameters

(

)

Definition at line 97 of file BeforePagePreviewUriGeneratedEvent.php.

Referenced by TYPO3\CMS\Workspaces\Hook\BackendUtilityHook\createPageUriForWorkspaceVersion().

getContext()

TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent::getContext

(

)

Definition at line 107 of file BeforePagePreviewUriGeneratedEvent.php.

getLanguageId()

TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent::getLanguageId

(

)

Definition at line 67 of file BeforePagePreviewUriGeneratedEvent.php.

Referenced by TYPO3\CMS\Workspaces\Hook\BackendUtilityHook\createPageUriForWorkspaceVersion().

getOptions()

TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent::getOptions

(

)

Definition at line 112 of file BeforePagePreviewUriGeneratedEvent.php.

getPageId()

TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent::getPageId

(

)

Definition at line 57 of file BeforePagePreviewUriGeneratedEvent.php.

Referenced by TYPO3\CMS\Workspaces\Hook\BackendUtilityHook\createPageUriForWorkspaceVersion().

getPreviewUri()

TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent::getPreviewUri

(

)

Definition at line 47 of file BeforePagePreviewUriGeneratedEvent.php.

References TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent\$uri.

getRootline()

TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent::getRootline

(

)

Definition at line 77 of file BeforePagePreviewUriGeneratedEvent.php.

getSection()

TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent::getSection

(

)

Definition at line 87 of file BeforePagePreviewUriGeneratedEvent.php.

isPropagationStopped()

TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent::isPropagationStopped

(

)

Definition at line 52 of file BeforePagePreviewUriGeneratedEvent.php.

setAdditionalQueryParameters()

TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent::setAdditionalQueryParameters

(

array

$additionalQueryParameters

)

Definition at line 102 of file BeforePagePreviewUriGeneratedEvent.php.

setLanguageId()

TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent::setLanguageId

(

int

$languageId

)

Definition at line 72 of file BeforePagePreviewUriGeneratedEvent.php.

setPageId()

TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent::setPageId

(

int

$pageId

)

Definition at line 62 of file BeforePagePreviewUriGeneratedEvent.php.

setPreviewUri()

TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent::setPreviewUri

(

UriInterface

$uri

)

Definition at line 42 of file BeforePagePreviewUriGeneratedEvent.php.

References TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent\$uri.

Referenced by TYPO3\CMS\Workspaces\Hook\BackendUtilityHook\createPageUriForWorkspaceVersion().

setRootline()

TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent::setRootline

(

array

$rootline

)

Definition at line 82 of file BeforePagePreviewUriGeneratedEvent.php.

setSection()

TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent::setSection

(

string

$section

)

Definition at line 92 of file BeforePagePreviewUriGeneratedEvent.php.

Member Data Documentation

$uri

UriInterface TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent::$uri = null

private

Definition at line 30 of file BeforePagePreviewUriGeneratedEvent.php.

Referenced by TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent\getPreviewUri(), and TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent\setPreviewUri().