BeforePagePreviewUriGeneratedEvent implements StoppableEventInterface

FinalYes

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<string|int, mixed>
getContext()  : Context
getLanguageId()  : int
getOptions()  : array<string|int, mixed>
getPageId()  : int
getPreviewUri()  : UriInterface|null
getRootline()  : array<string|int, mixed>
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<string|int, mixed> $rootline, string $section, array<string|int, mixed> $additionalQueryParameters, Context $context, array<string|int, mixed> $options) : mixed
Parameters
$pageId : int
$languageId : int
$rootline : array<string|int, mixed>
$section : string
$additionalQueryParameters : array<string|int, mixed>
$context : Context
$options : array<string|int, mixed>

getAdditionalQueryParameters()

public getAdditionalQueryParameters() : array<string|int, mixed>
Return values
array<string|int, mixed>

getLanguageId()

public getLanguageId() : int
Return values
int

getOptions()

public getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPageId()

public getPageId() : int
Return values
int

getPreviewUri()

public getPreviewUri() : UriInterface|null
Return values
UriInterface|null

getRootline()

public getRootline() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSection()

public getSection() : string
Return values
string

isPropagationStopped()

public isPropagationStopped() : bool
Return values
bool

setAdditionalQueryParameters()

public setAdditionalQueryParameters(array<string|int, mixed> $additionalQueryParameters) : void
Parameters
$additionalQueryParameters : array<string|int, mixed>

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<string|int, mixed> $rootline) : void
Parameters
$rootline : array<string|int, mixed>

setSection()

public setSection(string $section) : void
Parameters
$section : string 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results