TYPO3\CMS\Core\Routing\Enhancer\DecoratingEnhancerInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Core\Routing\Enhancer\DecoratingEnhancerInterface:

Public Member Functions
string	getRoutePathRedecorationPattern ()
	decorateForMatching (RouteCollection $collection, string $routePath)
	decorateForGeneration (RouteCollection $collection, array $parameters)
‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Routing\Enhancer\EnhancerInterface
	setAspects (array $aspects)
AspectInterface[]	getAspects ()

Detailed Description

Decorates a route (or routes within a collection) with additional parameters.

Definition at line 25 of file DecoratingEnhancerInterface.php.

Member Function Documentation

decorateForGeneration()

TYPO3\CMS\Core\Routing\Enhancer\DecoratingEnhancerInterface::decorateForGeneration	(	RouteCollection	$collection,
		array	$parameters
	)

Decorates route collection during URL URL generation. Executed before invoking routing enhancers.

Parameters

array

$parameters

‪query parameters

decorateForMatching()

TYPO3\CMS\Core\Routing\Enhancer\DecoratingEnhancerInterface::decorateForMatching	(	RouteCollection	$collection,
		string	$routePath
	)

Decorates route collection to be processed during URL resolving. Executed before invoking routing enhancers.

Parameters

string

$routePath

‪URL path

Implemented in TYPO3\CMS\Core\Routing\Enhancer\PageTypeDecorator.

getRoutePathRedecorationPattern()

string TYPO3\CMS\Core\Routing\Enhancer\DecoratingEnhancerInterface::getRoutePathRedecorationPattern

(

)

Gets pattern that can be used to redecorate (undecorate) a potential previously decorated route path.

Example:

• ‪route path: 'first/second.html'
• ‪redecoration pattern: '(?:.html|.json)$' -> 'first/second' might be the redecorated route path after applying the redecoration pattern to preg_match/preg_replace

Returns

‪string regular expression pattern

Implemented in TYPO3\CMS\Core\Routing\Enhancer\PageTypeDecorator.

Referenced by TYPO3\CMS\Core\Routing\PageSlugCandidateProvider\getRoutePathRedecorationPattern().