TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent Class Reference

Public Member Functions
	__construct (private array $configuration, private readonly array $linkDetails, private array $page, private array $queryParameters, private string $fragment)
	getConfiguration ()
	setConfiguration (array $configuration)
	getLinkDetails ()
	getPage ()
	setPage (array $page)
	getQueryParameters ()
	setQueryParameters (array $queryParameters)
	getFragment ()
	setFragment (string $fragment)
	pageWasModified ()

Protected Attributes
bool	$pageWasModified = false

Detailed Description

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.

Definition at line 26 of file ModifyPageLinkConfigurationEvent.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent::__construct	(	private array	$configuration,
		private readonly array	$linkDetails,
		private array	$page,
		private array	$queryParameters,
		private string	$fragment
	)

Definition at line 30 of file ModifyPageLinkConfigurationEvent.php.

Member Function Documentation

getConfiguration()

TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent::getConfiguration

(

)

Definition at line 38 of file ModifyPageLinkConfigurationEvent.php.

getFragment()

TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent::getFragment

(

)

Definition at line 74 of file ModifyPageLinkConfigurationEvent.php.

getLinkDetails()

TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent::getLinkDetails

(

)

Definition at line 48 of file ModifyPageLinkConfigurationEvent.php.

getPage()

TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent::getPage

(

)

Definition at line 53 of file ModifyPageLinkConfigurationEvent.php.

getQueryParameters()

TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent::getQueryParameters

(

)

Definition at line 64 of file ModifyPageLinkConfigurationEvent.php.

pageWasModified()

TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent::pageWasModified

(

)

Definition at line 84 of file ModifyPageLinkConfigurationEvent.php.

References TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent\$pageWasModified.

Referenced by TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent\setPage().

setConfiguration()

TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent::setConfiguration

(

array

$configuration

)

Definition at line 43 of file ModifyPageLinkConfigurationEvent.php.

setFragment()

TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent::setFragment

(

string

$fragment

)

Definition at line 79 of file ModifyPageLinkConfigurationEvent.php.

setPage()

TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent::setPage

(

array

$page

)

Definition at line 58 of file ModifyPageLinkConfigurationEvent.php.

References TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent\pageWasModified().

setQueryParameters()

TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent::setQueryParameters

(

array

$queryParameters

)

Definition at line 69 of file ModifyPageLinkConfigurationEvent.php.

Member Data Documentation

$pageWasModified

bool TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent::$pageWasModified = false

protected

Definition at line 28 of file ModifyPageLinkConfigurationEvent.php.

Referenced by TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent\pageWasModified().