TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler Class Reference

Public Member Functions
	__construct (ServerRequestHandler $requestHandler, RedirectModeHandler $redirectModeHandler, Context $context)
string	processRedirect (string $loginType, RedirectConfiguration $configuration, string $redirectModeReferrer)
string	getLoginFormRedirectUrl (RedirectConfiguration $configuration, bool $redirectDisabled)
string	getLogoutFormRedirectUrl (RedirectConfiguration $configuration, int $redirectPageLogout, bool $redirectDisabled)

Protected Member Functions
string	getLogoutRedirectUrl (array $redirectModes, int $redirectPageLogout=0)
string	getGetpostRedirectUrl (array $redirectModes)
string	handleSuccessfulLogout (string $redirectMode, int $redirectPageLogout)
string	fetchReturnUrlFromList (array $redirectUrlList, $redirectFirstMethod)
string	handleSuccessfulLogin (string $redirectMode, int $redirectPageLogin=0, string $domains='', string $redirectModeReferrer='')
	isUserLoginFailedAndLoginErrorActive (array $redirectModes, string $loginType)
bool	isRedirectModeActive (array $redirectModes, string $mode)

Protected Attributes
bool	$userIsLoggedIn = false
ServerRequestHandler	$requestHandler
RedirectModeHandler	$redirectModeHandler

Detailed Description

Resolve felogin related redirects based on the current login type and the selected configuration (redirect mode)

this is a concrete TYPO3 implementation and solely used for EXT:felogin and not part of TYPO3's Core API.

Definition at line 29 of file RedirectHandler.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler::__construct	(	ServerRequestHandler	$requestHandler,
		RedirectModeHandler	$redirectModeHandler,
		Context	$context
	)

Definition at line 43 of file RedirectHandler.php.

References TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\$redirectModeHandler, TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\$requestHandler, and TYPO3\CMS\Core\Context\Context\getPropertyFromAspect().

Member Function Documentation

fetchReturnUrlFromList()

string TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler::fetchReturnUrlFromList ( array  $redirectUrlList,   $redirectFirstMethod  )

protected

Base on setting redirectFirstMethod get first or last entry from redirect url list.

Parameters

array	$redirectUrlList
string	$redirectFirstMethod

Returns

‪string

Definition at line 136 of file RedirectHandler.php.

Referenced by TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\processRedirect().

getGetpostRedirectUrl()

string TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler::getGetpostRedirectUrl ( array  $redirectModes )

protected

Is used for alternative redirect urls on redirect mode "getpost"

Parameters

array

$redirectModes

Returns

‪string

Definition at line 107 of file RedirectHandler.php.

References TYPO3\CMS\FrontendLogin\Redirect\RedirectMode\GETPOST, and TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\isRedirectModeActive().

Referenced by TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\getLoginFormRedirectUrl(), and TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\getLogoutRedirectUrl().

getLoginFormRedirectUrl()

string TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler::getLoginFormRedirectUrl	(	RedirectConfiguration	$configuration,
		bool	$redirectDisabled
	)

Returns the redirect Url that should be used in login form template for GET/POST redirect mode

Parameters

RedirectConfiguration	$configuration
bool	$redirectDisabled

Returns

‪string

Definition at line 221 of file RedirectHandler.php.

References TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\getGetpostRedirectUrl(), and TYPO3\CMS\FrontendLogin\Configuration\RedirectConfiguration\getModes().

getLogoutFormRedirectUrl()

string TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler::getLogoutFormRedirectUrl	(	RedirectConfiguration	$configuration,
		int	$redirectPageLogout,
		bool	$redirectDisabled
	)

Returns the redirect Url that should be used in logout form

Parameters

RedirectConfiguration	$configuration
int	$redirectPageLogout
bool	$redirectDisabled

Returns

‪string

Definition at line 237 of file RedirectHandler.php.

References TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\getLogoutRedirectUrl(), and TYPO3\CMS\FrontendLogin\Configuration\RedirectConfiguration\getModes().

getLogoutRedirectUrl()

string TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler::getLogoutRedirectUrl ( array  $redirectModes, int  $redirectPageLogout = 0  )

protected

Get alternative logout form redirect url if logout and page not accessible

Parameters

array	$redirectModes
int	$redirectPageLogout

Returns

‪string

Definition at line 93 of file RedirectHandler.php.

References TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\getGetpostRedirectUrl(), TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\isRedirectModeActive(), and TYPO3\CMS\FrontendLogin\Redirect\RedirectMode\LOGOUT.

Referenced by TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\getLogoutFormRedirectUrl().

handleSuccessfulLogin()

string TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler::handleSuccessfulLogin ( string  $redirectMode, int  $redirectPageLogin = 0, string  $domains = '', string  $redirectModeReferrer = ''  )

protected

Generate redirect_url for case that the user was successfully logged in

Parameters

string	$redirectMode
int	$redirectPageLogin
string	$domains
string	$redirectModeReferrer

Returns

‪string

Exceptions

Definition at line 162 of file RedirectHandler.php.

References TYPO3\CMS\FrontendLogin\Redirect\RedirectMode\GETPOST, TYPO3\CMS\FrontendLogin\Redirect\RedirectMode\GROUP_LOGIN, TYPO3\CMS\FrontendLogin\Redirect\RedirectMode\LOGIN, TYPO3\CMS\FrontendLogin\Redirect\RedirectMode\REFERER, TYPO3\CMS\FrontendLogin\Redirect\RedirectMode\REFERER_DOMAINS, and TYPO3\CMS\FrontendLogin\Redirect\RedirectMode\USER_LOGIN.

Referenced by TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\processRedirect().

handleSuccessfulLogout()

string TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler::handleSuccessfulLogout ( string  $redirectMode, int  $redirectPageLogout  )

protected

Handle redirect mode logout

Parameters

string	$redirectMode
int	$redirectPageLogout

Returns

‪string

Definition at line 121 of file RedirectHandler.php.

References TYPO3\CMS\FrontendLogin\Redirect\RedirectMode\LOGOUT.

Referenced by TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\processRedirect().

isRedirectModeActive()

bool TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler::isRedirectModeActive ( array  $redirectModes, string  $mode  )

protected

Checks if the give mode is active or not

Parameters

string	$mode
array	$redirectModes

Returns

‪bool

Definition at line 209 of file RedirectHandler.php.

Referenced by TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\getGetpostRedirectUrl(), TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\getLogoutRedirectUrl(), and TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\isUserLoginFailedAndLoginErrorActive().

isUserLoginFailedAndLoginErrorActive()

TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler::isUserLoginFailedAndLoginErrorActive ( array  $redirectModes, string  $loginType  )

protected

Definition at line 195 of file RedirectHandler.php.

References TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\isRedirectModeActive(), TYPO3\CMS\Core\Authentication\LoginType\LOGIN, and TYPO3\CMS\FrontendLogin\Redirect\RedirectMode\LOGIN_ERROR.

Referenced by TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\processRedirect().

processRedirect()

string TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler::processRedirect	(	string	$loginType,
		RedirectConfiguration	$configuration,
		string	$redirectModeReferrer
	)

Process redirect modes. The function searches for a redirect url using all configured modes.

Parameters

string	$loginType
RedirectConfiguration	$configuration
string	$redirectModeReferrer

Returns

‪string Redirect URL

Exceptions

Definition at line 62 of file RedirectHandler.php.

References TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\fetchReturnUrlFromList(), TYPO3\CMS\FrontendLogin\Configuration\RedirectConfiguration\getDomains(), TYPO3\CMS\FrontendLogin\Configuration\RedirectConfiguration\getFirstMode(), TYPO3\CMS\FrontendLogin\Configuration\RedirectConfiguration\getModes(), TYPO3\CMS\FrontendLogin\Configuration\RedirectConfiguration\getPageOnLogin(), TYPO3\CMS\FrontendLogin\Configuration\RedirectConfiguration\getPageOnLoginError(), TYPO3\CMS\FrontendLogin\Configuration\RedirectConfiguration\getPageOnLogout(), TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\handleSuccessfulLogin(), TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\handleSuccessfulLogout(), TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\isUserLoginFailedAndLoginErrorActive(), TYPO3\CMS\Core\Authentication\LoginType\LOGIN, and TYPO3\CMS\Core\Authentication\LoginType\LOGOUT.

Member Data Documentation

$redirectModeHandler

RedirectModeHandler TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler::$redirectModeHandler

protected

Definition at line 41 of file RedirectHandler.php.

Referenced by TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\__construct().

$requestHandler

ServerRequestHandler TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler::$requestHandler

protected

Definition at line 37 of file RedirectHandler.php.

Referenced by TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler\__construct().

$userIsLoggedIn

bool TYPO3\CMS\FrontendLogin\Redirect\RedirectHandler::$userIsLoggedIn = false

protected

Definition at line 33 of file RedirectHandler.php.