ModifyLinkHandlersEvent

final class \TYPO3\CMS\Backend\Controller\Event\ModifyLinkHandlersEvent

This event allows extensions to modify the list of link handlers and their configuration before they are invoked.

Table of Contents

Methods

__construct()  : mixed
getCurrentLinkParts()  : array<string, mixed>
getLinkHandler()  : array<string, mixed>|null
Gets an individual handler by name.
getLinkHandlers()  : array<string, array>
setLinkHandler()  : $this
Sets a handler by name, overwriting it if it already exists.

Methods

__construct()

public __construct(array<string, array> $linkHandlers, array<string, mixed> $currentLinkParts) : mixed

Parameters

$linkHandlers : array<string, array>
$currentLinkParts : array<string, mixed>

getCurrentLinkParts()

public getCurrentLinkParts() : array<string, mixed>

Return values

array<string, mixed>

getLinkHandler()

Gets an individual handler by name.

public getLinkHandler(string $name) : array<string, mixed>|null

Parameters

$name : string

The handler name, including trailing period.

Return values

array<string, mixed>|null —

The handler definition, or null if not defined.

getLinkHandlers()

public getLinkHandlers() : array<string, array>

Return values

array<string, array>

setLinkHandler()

Sets a handler by name, overwriting it if it already exists.

public setLinkHandler(string $name, array<string, mixed> $handler) : $this

Parameters

$name : string

The handler name, including trailing period.

$handler : array<string, mixed>

Return values

$this
On this page