BeforePagePreviewUriGeneratedEvent

final class \TYPO3\CMS\Backend\Routing\Event\BeforePagePreviewUriGeneratedEvent

Implements
StoppableEventInterface

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.

Table of Contents

Interfaces

StoppableEventInterface

Methods

__construct()  : mixed
getAdditionalQueryParameters()  : array
getContext()  : Context
getLanguageId()  : int
getOptions()  : array
getPageId()  : int
getPreviewUri()  : UriInterface|null
getRootline()  : array
getSection()  : string
isPropagationStopped()  : bool
setAdditionalQueryParameters()  : void
setLanguageId()  : void
setPageId()  : void
setPreviewUri()  : void
setRootline()  : void
setSection()  : void

Methods

__construct()

public __construct(int $pageId, int $languageId, array $rootline, string $section, array $additionalQueryParameters, Context $context, array $options) : mixed

Parameters

$pageId : int
$languageId : int
$rootline : array
$section : string
$additionalQueryParameters : array
$context : Context
$options : array

getAdditionalQueryParameters()

public getAdditionalQueryParameters() : array

Return values

array

getLanguageId()

public getLanguageId() : int

Return values

int

getOptions()

public getOptions() : array

Return values

array

getPageId()

public getPageId() : int

Return values

int

getPreviewUri()

public getPreviewUri() : UriInterface|null

Return values

UriInterface|null

getRootline()

public getRootline() : array

Return values

array

getSection()

public getSection() : string

Return values

string

isPropagationStopped()

public isPropagationStopped() : bool

Return values

bool

setAdditionalQueryParameters()

public setAdditionalQueryParameters(array $additionalQueryParameters) : void

Parameters

$additionalQueryParameters : array

setLanguageId()

public setLanguageId(int $languageId) : void

Parameters

$languageId : int

setPageId()

public setPageId(int $pageId) : void

Parameters

$pageId : int

setPreviewUri()

public setPreviewUri(UriInterface $uri) : void

Parameters

$uri : UriInterface

setRootline()

public setRootline(array $rootline) : void

Parameters

$rootline : array

setSection()

public setSection(string $section) : void

Parameters

$section : string
On this page