‪TYPO3CMS  ‪main
TYPO3\CMS\Frontend\Http\UrlProcessorInterface Interface Reference

Public Member Functions

string null process ($context, $url, array $configuration, ContentObjectRenderer $contentObjectRenderer, &$keepProcessing)
 

Public Attributes

const CONTEXT_COMMON = 'common'
 
const CONTEXT_FILE = 'file'
 
const CONTEXT_MAIL = 'mail'
 
const CONTEXT_EXTERNAL = 'external'
 

Detailed Description

This interface needs to be implemented by all classes that register for the hook in: $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['urlProcessing']['urlProcessors']

It can be used manipulate URLs that are generated by the ContentObjectRenderer.

Deprecated:
‪will be removed in TYPO3 v13.0. Use AfterLinkIsGeneratedEvent and LinkBuilder->getType() instead.

Definition at line 27 of file UrlProcessorInterface.php.

Member Function Documentation

◆ process()

string null TYPO3\CMS\Frontend\Http\UrlProcessorInterface::process (   $context,
  $url,
array  $configuration,
ContentObjectRenderer  $contentObjectRenderer,
$keepProcessing 
)

Generates the JumpURL for the given parameters.

Parameters
string$context‪The context in which the URL is generated (e.g. "typolink" or one of the constants above).
string$url‪The URL that should be processed.
array$configuration‪The link configuration.
\TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer$contentObjectRenderer‪The calling content object renderer.
bool$keepProcessing‪If this is set to FALSE no further hooks will be processed after the current one.
Returns
‪string|null

Member Data Documentation

◆ CONTEXT_COMMON

const TYPO3\CMS\Frontend\Http\UrlProcessorInterface::CONTEXT_COMMON = 'common'

Definition at line 29 of file UrlProcessorInterface.php.

◆ CONTEXT_EXTERNAL

const TYPO3\CMS\Frontend\Http\UrlProcessorInterface::CONTEXT_EXTERNAL = 'external'

Definition at line 32 of file UrlProcessorInterface.php.

◆ CONTEXT_FILE

const TYPO3\CMS\Frontend\Http\UrlProcessorInterface::CONTEXT_FILE = 'file'

Definition at line 30 of file UrlProcessorInterface.php.

◆ CONTEXT_MAIL

const TYPO3\CMS\Frontend\Http\UrlProcessorInterface::CONTEXT_MAIL = 'mail'

Definition at line 31 of file UrlProcessorInterface.php.