TYPO3 CMS  TYPO3_7-6
TYPO3\CMS\Frontend\Http\UrlProcessorInterface Interface Reference

Public Member Functions

 process ($context, $url, array $configuration, \TYPO3\CMS\Frontend\ContentObject\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.

Definition at line 23 of file UrlProcessorInterface.php.

Member Function Documentation

◆ process()

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

Generates the JumpURL for the given parameters.

See also
::processUrl()
Parameters
string$contextThe context in which the URL is generated (e.g. "typolink" or one of the constants above).
string$urlThe URL that should be processed.
array$configurationThe link configuration.
\TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer$contentObjectRendererThe calling content object renderer.
bool$keepProcessingIf 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'

◆ CONTEXT_EXTERNAL

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

◆ CONTEXT_FILE

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

◆ CONTEXT_MAIL

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