UrlProcessorInterface
This interface needs to be implemented by all classes that register for the hook in: $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['urlProcessing']['urlProcessors']
will be removed in TYPO3 v13.0. Use AfterLinkIsGeneratedEvent and LinkBuilder->getType() instead.
It can be used manipulate URLs that are generated by the ContentObjectRenderer.
Table of Contents
Constants
- CONTEXT_COMMON = 'common'
- CONTEXT_EXTERNAL = 'external'
- CONTEXT_FILE = 'file'
- CONTEXT_MAIL = 'mail'
Methods
- process() : string|null
- Generates the JumpURL for the given parameters.
Constants
CONTEXT_COMMON
public
mixed
CONTEXT_COMMON
= 'common'
CONTEXT_EXTERNAL
public
mixed
CONTEXT_EXTERNAL
= 'external'
CONTEXT_FILE
public
mixed
CONTEXT_FILE
= 'file'
CONTEXT_MAIL
public
mixed
CONTEXT_MAIL
= 'mail'
Methods
process()
Generates the JumpURL for the given parameters.
public
process(string $context, string $url, array<string|int, mixed> $configuration, ContentObjectRenderer $contentObjectRenderer, bool &$keepProcessing) : string|null
Parameters
- $context : string
-
The context in which the URL is generated (e.g. "typolink" or one of the constants above).
- $url : string
-
The URL that should be processed.
- $configuration : array<string|int, mixed>
-
The link configuration.
- $contentObjectRenderer : ContentObjectRenderer
-
The calling content object renderer.
- $keepProcessing : bool
-
If this is set to FALSE no further hooks will be processed after the current one.