TYPO3\CMS\Backend\Routing\RouteRedirect Class Reference

Public Member Functions
	getName ()
	getParameters ()
	getFormattedParameters ()
	hasParameters ()
	resolve (Router $router)

Static Public Member Functions
static	create (string $name, $params)
static	createFromRoute (Route $route, array $parameters)
static	createFromRequest (ServerRequestInterface $request)

Private Member Functions
	__construct (string $name, array $params)
	sanitizeParameters (array $redirectParameters)

Private Attributes
string	$name
array	$parameters

Detailed Description

A value object representing redirects within Backend routing.

Definition at line 29 of file RouteRedirect.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Routing\RouteRedirect::__construct ( string  $name, array  $params  )

private

Definition at line 67 of file RouteRedirect.php.

References TYPO3\CMS\Backend\Routing\RouteRedirect\$name, and TYPO3\CMS\Backend\Routing\RouteRedirect\sanitizeParameters().

Member Function Documentation

create()

static TYPO3\CMS\Backend\Routing\RouteRedirect::create ( string  $name,   $params  )

static

Definition at line 42 of file RouteRedirect.php.

References TYPO3\CMS\Backend\Routing\RouteRedirect\$name.

Referenced by TYPO3\CMS\Backend\Routing\RouteRedirect\createFromRequest(), and TYPO3\CMS\Install\Controller\InstallerController\executeDefaultConfigurationAction().

createFromRequest()

static TYPO3\CMS\Backend\Routing\RouteRedirect::createFromRequest ( ServerRequestInterface  $request )

static

Definition at line 58 of file RouteRedirect.php.

References TYPO3\CMS\Backend\Routing\RouteRedirect\$name, and TYPO3\CMS\Backend\Routing\RouteRedirect\create().

Referenced by TYPO3\CMS\Backend\Controller\MfaSetupController\activateAction(), TYPO3\CMS\Backend\Controller\MfaController\authAction(), TYPO3\CMS\Backend\Controller\MfaSetupController\cancelAction(), TYPO3\CMS\Backend\Controller\LoginController\checkRedirect(), TYPO3\CMS\Backend\Controller\LoginController\createLoginLogoutForm(), TYPO3\CMS\Backend\Controller\BackendController\getStartupModule(), TYPO3\CMS\Backend\Controller\LoginController\init(), TYPO3\CMS\Backend\Controller\ResetPasswordController\initializeForgetPasswordView(), TYPO3\CMS\Backend\Controller\ResetPasswordController\initializeResetPasswordView(), and TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator\redirectToMfaEndpoint().

createFromRoute()

static TYPO3\CMS\Backend\Routing\RouteRedirect::createFromRoute ( Route  $route, array  $parameters  )

static

Definition at line 53 of file RouteRedirect.php.

References TYPO3\CMS\Backend\Routing\RouteRedirect\$parameters, and TYPO3\CMS\Backend\Routing\Route\getOption().

Referenced by TYPO3\CMS\Backend\Http\RequestHandler\handle(), TYPO3\CMS\Backend\Middleware\BackendModuleValidator\process(), and TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator\process().

getFormattedParameters()

TYPO3\CMS\Backend\Routing\RouteRedirect::getFormattedParameters

(

)

Definition at line 92 of file RouteRedirect.php.

getName()

TYPO3\CMS\Backend\Routing\RouteRedirect::getName

(

)

Definition at line 82 of file RouteRedirect.php.

References TYPO3\CMS\Backend\Routing\RouteRedirect\$name.

getParameters()

TYPO3\CMS\Backend\Routing\RouteRedirect::getParameters

(

)

Definition at line 87 of file RouteRedirect.php.

References TYPO3\CMS\Backend\Routing\RouteRedirect\$parameters.

hasParameters()

TYPO3\CMS\Backend\Routing\RouteRedirect::hasParameters

(

)

Definition at line 98 of file RouteRedirect.php.

resolve()

TYPO3\CMS\Backend\Routing\RouteRedirect::resolve

(

Router

$router

)

Checks if the route can be resolved as a redirect.

Exceptions

RouteNotFoundException
MethodNotAllowedException
RouteTypeNotAllowedException

Definition at line 110 of file RouteRedirect.php.

References TYPO3\CMS\Backend\Routing\Router\getRoute().

sanitizeParameters()

TYPO3\CMS\Backend\Routing\RouteRedirect::sanitizeParameters ( array  $redirectParameters )

private

Definition at line 73 of file RouteRedirect.php.

Referenced by TYPO3\CMS\Backend\Routing\RouteRedirect\__construct().

Member Data Documentation

$name

string TYPO3\CMS\Backend\Routing\RouteRedirect::$name

private

Name of route to be redirected to

Definition at line 34 of file RouteRedirect.php.

Referenced by TYPO3\CMS\Backend\Routing\RouteRedirect\__construct(), TYPO3\CMS\Backend\Routing\RouteRedirect\create(), TYPO3\CMS\Backend\Routing\RouteRedirect\createFromRequest(), and TYPO3\CMS\Backend\Routing\RouteRedirect\getName().

$parameters

array TYPO3\CMS\Backend\Routing\RouteRedirect::$parameters

private

Multi-dimensional query params array e.g. ‘['level1’ => ['level2' => 'value']]`

Definition at line 40 of file RouteRedirect.php.

Referenced by TYPO3\CMS\Backend\Routing\RouteRedirect\createFromRoute(), and TYPO3\CMS\Backend\Routing\RouteRedirect\getParameters().