ModifyPageLinkConfigurationEvent

FinalYes

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<string|int, mixed>
getFragment()  : string
getLinkDetails()  : array<string|int, mixed>
getPage()  : array<string|int, mixed>
getQueryParameters()  : array<string|int, mixed>
pageWasModified()  : bool
setConfiguration()  : void
setFragment()  : void
setPage()  : void
setQueryParameters()  : void

Properties

$pageWasModified

protected bool $pageWasModified = false

Methods

__construct()

public __construct(array<string|int, mixed> $configuration, array<string|int, mixed> $linkDetails, array<string|int, mixed> $page, array<string|int, mixed> $queryParameters, string $fragment) : mixed
Parameters
$configuration : array<string|int, mixed>
$linkDetails : array<string|int, mixed>
$page : array<string|int, mixed>
$queryParameters : array<string|int, mixed>
$fragment : string

getConfiguration()

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

getFragment()

public getFragment() : string
Return values
string

getLinkDetails()

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

getPage()

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

getQueryParameters()

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

pageWasModified()

public pageWasModified() : bool
Return values
bool

setConfiguration()

public setConfiguration(array<string|int, mixed> $configuration) : void
Parameters
$configuration : array<string|int, mixed>

setFragment()

public setFragment(string $fragment) : void
Parameters
$fragment : string

setPage()

public setPage(array<string|int, mixed> $page) : void
Parameters
$page : array<string|int, mixed>

setQueryParameters()

public setQueryParameters(array<string|int, mixed> $queryParameters) : void
Parameters
$queryParameters : array<string|int, mixed>

        
On this page

Search results