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

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

Public Member Functions
	__construct (array $configuration)
	buildResult (Route $route, array $results, array $remainingQueryParameters=[])
	enhanceForMatching (RouteCollection $collection)
	enhanceForGeneration (RouteCollection $collection, array $parameters)
	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)
‪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
‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Routing\Enhancer\AbstractEnhancer
AspectInterface[]	$aspects = array( )
VariableProcessor	$variableProcessor

Detailed Description

This is usually used for simple GET arguments that have no namespace (e.g. not plugins).

routeEnhancers Categories: type: Simple routePath: '/cmd/{category_id}/{scope_id}' _arguments: category_id: 'category/id' scope_id: 'scope/id'

Definition at line 37 of file SimpleEnhancer.php.

Constructor & Destructor Documentation

__construct()

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

(

array

$configuration

)

Definition at line 43 of file SimpleEnhancer.php.

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

Member Function Documentation

buildResult()

TYPO3\CMS\Core\Routing\Enhancer\SimpleEnhancer::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 51 of file SimpleEnhancer.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\arrayDiffKeyRecursive(), TYPO3\CMS\Core\Routing\Route\filterAspects(), TYPO3\CMS\Core\Routing\Enhancer\SimpleEnhancer\inflateParameters(), and TYPO3\CMS\Core\Routing\Enhancer\AbstractEnhancer\resolveType().

enhanceForGeneration()

TYPO3\CMS\Core\Routing\Enhancer\SimpleEnhancer::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.

Definition at line 123 of file SimpleEnhancer.php.

References TYPO3\CMS\Core\Routing\Enhancer\VariableProcessor\deflateParameters(), TYPO3\CMS\Core\Routing\Enhancer\AbstractEnhancer\getVariableProcessor(), and TYPO3\CMS\Core\Routing\Enhancer\SimpleEnhancer\getVariant().

enhanceForMatching()

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

(

RouteCollection

$collection

)

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

Parameters

RouteCollection

$collection

}

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

Definition at line 86 of file SimpleEnhancer.php.

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

getVariant()

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

protected

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

Parameters

Route	$defaultPageRoute
array	$configuration

Returns

‪Route

Definition at line 101 of file SimpleEnhancer.php.

References TYPO3\CMS\Core\Routing\Enhancer\SimpleEnhancer\$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\SimpleEnhancer\enhanceForGeneration(), and TYPO3\CMS\Core\Routing\Enhancer\SimpleEnhancer\enhanceForMatching().

inflateParameters()

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

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

Definition at line 141 of file SimpleEnhancer.php.

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

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

Member Data Documentation

$configuration

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

protected

Definition at line 41 of file SimpleEnhancer.php.

Referenced by TYPO3\CMS\Core\Routing\Enhancer\SimpleEnhancer\__construct(), and TYPO3\CMS\Core\Routing\Enhancer\SimpleEnhancer\getVariant().