ModifyPageLinkConfigurationEvent
final class \
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
Methods
- __construct() : mixed
- getConfiguration() : array
- getFragment() : string
- getLinkDetails() : array
- getPage() : array
- getQueryParameters() : array
- getRequest() : ServerRequestInterface
- pageWasModified() : bool
- setConfiguration() : void
- setFragment() : void
- setPage() : void
- setQueryParameters() : void
Methods
__construct()
public
__construct(array $configuration, array $linkDetails, array $page, array $queryParameters, string $fragment, ServerRequestInterface $request) : mixed
Parameters
- $configuration : array
- $linkDetails : array
- $page : array
- $queryParameters : array
- $fragment : string
- $request : ServerRequestInterface
getConfiguration()
public
getConfiguration() : array
Return values
arraygetFragment()
public
getFragment() : string
Return values
stringgetLinkDetails()
public
getLinkDetails() : array
Return values
arraygetPage()
public
getPage() : array
Return values
arraygetQueryParameters()
public
getQueryParameters() : array
Return values
arraygetRequest()
public
getRequest() : ServerRequestInterface
Return values
ServerRequestInterfacepageWasModified()
public
pageWasModified() : bool
Return values
boolsetConfiguration()
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