ModifyPageLinkConfigurationEvent

final class \TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent

A generic PSR 14 Event to allow modifying the incoming (and resolved) page when building a "page link".

This event allows Event Listener to change the page to be linked to, or add/remove possible query parameters / fragments to be generated.

Table of Contents

Properties

$pageWasModified  : bool

Methods

__construct()  : mixed
getConfiguration()  : array
getFragment()  : string
getLinkDetails()  : array
getPage()  : array
getQueryParameters()  : array
pageWasModified()  : bool
setConfiguration()  : void
setFragment()  : void
setPage()  : void
setQueryParameters()  : void

Properties

$pageWasModified

protected bool $pageWasModified = false

Methods

__construct()

public __construct(array $configuration, array $linkDetails, array $page, array $queryParameters, string $fragment) : mixed

Parameters

$configuration : array
$linkDetails : array
$page : array
$queryParameters : array
$fragment : string

getConfiguration()

public getConfiguration() : array

Return values

array

getFragment()

public getFragment() : string

Return values

string

getLinkDetails()

public getLinkDetails() : array

Return values

array

getPage()

public getPage() : array

Return values

array

getQueryParameters()

public getQueryParameters() : array

Return values

array

pageWasModified()

public pageWasModified() : bool

Return values

bool

setConfiguration()

public setConfiguration(array $configuration) : void

Parameters

$configuration : array

setFragment()

public setFragment(string $fragment) : void

Parameters

$fragment : string

setPage()

public setPage(array $page) : void

Parameters

$page : array

setQueryParameters()

public setQueryParameters(array $queryParameters) : void

Parameters

$queryParameters : array
On this page