TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer Class Reference

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

Public Member Functions
	__construct (array $configuration)
	buildResult (Route $route, array $results, array $remainingQueryParameters=[])
	enhanceForMatching (RouteCollection $collection)
	enhanceForGeneration (RouteCollection $collection, array $parameters)
array	inflateParameters (array $parameters, array $internals=[])
‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Routing\Enhancer\AbstractEnhancer
	setAspects (array $aspects)
	getAspects ()

Protected Member Functions
Route	getVariant (Route $defaultPageRoute, array $configuration)
array	getNamespacedRequirements ()
array	deflateParameters (Route $route, array $parameters)
‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Routing\Enhancer\AbstractEnhancer
	applyRouteAspects (Route $route, array $aspects, string $namespace=null)
	applyRequirements (Route $route, array $requirements, string $namespace=null)
array	filterValuesByPathVariables (Route $route, array $values)
array	overrideValuesByAspect (Route $route, array $values, string $targetValue)
array	defineValuesByAspect (Route $route, array $values, string $targetValue)
string	modifyRoutePath (string $routePath)
string	resolveType (Route $route, array &$remainingQueryParameters)
VariableProcessor	getVariableProcessor ()

Protected Attributes
array	$configuration
string	$namespace
‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Routing\Enhancer\AbstractEnhancer
AspectInterface[]	$aspects = array( )
VariableProcessor	$variableProcessor

Detailed Description

Used for plugins like EXT:felogin.

This is usually used for arguments that are built with a tx_myplugin_pi1 as namespace in GET / POST parameter.

routeEnhancers: ForgotPassword: type: Plugin routePath: '/forgot-pw/{user_id}/{hash}/' namespace: 'tx_felogin_pi1' _arguments: user_id: uid requirements: user_id: '[a-z]+' hash: '[a-z]{0-6}'

Definition at line 42 of file PluginEnhancer.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer::__construct

(

array

$configuration

)

Reimplemented in TYPO3\CMS\Extbase\Routing\ExtbasePluginEnhancer.

Definition at line 52 of file PluginEnhancer.php.

References TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer\$configuration.

Member Function Documentation

buildResult()

TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer::buildResult	(	Route	$route,
		array	$results,
		array	$remainingQueryParameters = []
	)

{

Parameters

Route	$route
array	$results
array	$remainingQueryParameters

Returns

‪PageArguments

}

Implements TYPO3\CMS\Core\Routing\Enhancer\ResultingInterface.

Definition at line 61 of file PluginEnhancer.php.

References TYPO3\CMS\Core\Routing\Enhancer\AbstractEnhancer\$variableProcessor, TYPO3\CMS\Core\Utility\ArrayUtility\arrayDiffKeyRecursive(), TYPO3\CMS\Core\Routing\Route\filterAspects(), TYPO3\CMS\Core\Routing\Enhancer\AbstractEnhancer\getVariableProcessor(), TYPO3\CMS\Core\Routing\Enhancer\VariableProcessor\inflateNamespaceParameters(), TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer\inflateParameters(), and TYPO3\CMS\Core\Routing\Enhancer\AbstractEnhancer\resolveType().

deflateParameters()

array TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer::deflateParameters ( Route  $route, array  $parameters  )

protected

Parameters

Route	$route
array	$parameters

Returns

‪array

Definition at line 178 of file PluginEnhancer.php.

References TYPO3\CMS\Core\Routing\Enhancer\VariableProcessor\deflateNamespaceParameters(), TYPO3\CMS\Core\Routing\Route\getArguments(), and TYPO3\CMS\Core\Routing\Enhancer\AbstractEnhancer\getVariableProcessor().

Referenced by TYPO3\CMS\Extbase\Routing\ExtbasePluginEnhancer\enhanceForGeneration(), and TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer\enhanceForGeneration().

enhanceForGeneration()

TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer::enhanceForGeneration	(	RouteCollection	$collection,
		array	$parameters
	)

{‪Extends route collection with routes that are relevant for given parameters. Used during URL generation.

Parameters

RouteCollection	$collection
array	$parameters

}

Implements TYPO3\CMS\Core\Routing\Enhancer\RoutingEnhancerInterface.

Reimplemented in TYPO3\CMS\Extbase\Routing\ExtbasePluginEnhancer.

Definition at line 135 of file PluginEnhancer.php.

References TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer\deflateParameters(), and TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer\getVariant().

enhanceForMatching()

TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer::enhanceForMatching

(

RouteCollection

$collection

)

{‪Extends route collection with all routes. Used during URL resolving.

Parameters

RouteCollection

$collection

}

Implements TYPO3\CMS\Core\Routing\Enhancer\RoutingEnhancerInterface.

Reimplemented in TYPO3\CMS\Extbase\Routing\ExtbasePluginEnhancer.

Definition at line 98 of file PluginEnhancer.php.

References TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer\getVariant().

getNamespacedRequirements()

array TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer::getNamespacedRequirements ( )

protected

Add the namespace of the plugin to all requirements, so they are unique for this plugin.

Returns

‪array

Deprecated:

‪Since TYPO3 v10.3, will be removed in TYPO3 v11.0. Use AbstractEnhancer::applyRequirements() instead.

Definition at line 163 of file PluginEnhancer.php.

getVariant()

Route TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer::getVariant ( Route  $defaultPageRoute, array  $configuration  )

protected

Builds a variant of a route based on the given configuration.

Parameters

Route	$defaultPageRoute
array	$configuration

Returns

‪Route

Reimplemented in TYPO3\CMS\Extbase\Routing\ExtbasePluginEnhancer.

Definition at line 113 of file PluginEnhancer.php.

References TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer\$configuration, TYPO3\CMS\Core\Routing\Enhancer\AbstractEnhancer\$variableProcessor, TYPO3\CMS\Core\Routing\Enhancer\AbstractEnhancer\applyRequirements(), TYPO3\CMS\Core\Routing\Enhancer\AbstractEnhancer\applyRouteAspects(), TYPO3\CMS\Core\Routing\Enhancer\VariableProcessor\deflateKeys(), TYPO3\CMS\Core\Routing\Enhancer\VariableProcessor\deflateRoutePath(), TYPO3\CMS\Core\Routing\Enhancer\AbstractEnhancer\filterValuesByPathVariables(), TYPO3\CMS\Core\Routing\Enhancer\AbstractEnhancer\getVariableProcessor(), and TYPO3\CMS\Core\Routing\Enhancer\AbstractEnhancer\modifyRoutePath().

Referenced by TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer\enhanceForGeneration(), and TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer\enhanceForMatching().

inflateParameters()

array TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer::inflateParameters	(	array	$parameters,
		array	$internals = []
	)

Parameters

array	$parameters	‪Actual parameter payload to be used
array	$internals	‪Internal instructions (_route, _controller, ...)

Returns

‪array

Implements TYPO3\CMS\Core\Routing\Enhancer\InflatableEnhancerInterface.

Reimplemented in TYPO3\CMS\Extbase\Routing\ExtbasePluginEnhancer.

Definition at line 192 of file PluginEnhancer.php.

References TYPO3\CMS\Core\Routing\Enhancer\AbstractEnhancer\getVariableProcessor(), and TYPO3\CMS\Core\Routing\Enhancer\VariableProcessor\inflateNamespaceParameters().

Referenced by TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer\buildResult().

Member Data Documentation

$configuration

array TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer::$configuration

protected

Definition at line 46 of file PluginEnhancer.php.

Referenced by TYPO3\CMS\Extbase\Routing\ExtbasePluginEnhancer\__construct(), TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer\__construct(), TYPO3\CMS\Extbase\Routing\ExtbasePluginEnhancer\enhanceForGeneration(), TYPO3\CMS\Extbase\Routing\ExtbasePluginEnhancer\enhanceForMatching(), TYPO3\CMS\Extbase\Routing\ExtbasePluginEnhancer\getVariant(), and TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer\getVariant().

$namespace

string TYPO3\CMS\Core\Routing\Enhancer\PluginEnhancer::$namespace

protected

Definition at line 50 of file PluginEnhancer.php.

Referenced by TYPO3\CMS\Extbase\Routing\ExtbasePluginEnhancer\inflateParameters().