PHP Class Neos\Neos\Controller\LoginController

Inheritance: extends Neos\Flow\Security\Authentication\Controller\AbstractAuthenticationController
Show file Open project: neos/neos-development-collection

Protected Properties

Property Type Description
$backendRedirectionService Neos\Neos\Service\BackendRedirectionService
$domainRepository Neos\Neos\Domain\Repository\DomainRepository
$loginTokenCache Neos\Cache\Frontend\StringFrontend
$session Neos\Flow\Session\SessionInterface
$sessionManager Neos\Flow\Session\SessionManagerInterface
$sessionName string
$siteRepository Neos\Neos\Domain\Repository\SiteRepository
$supportedMediaTypes array
$viewFormatToObjectNameMap array

Public Methods

Method Description
indexAction ( string $username = null, boolean $unauthorized = false ) : void Default action, displays the login screen
initializeIndexAction ( ) : void
logoutAction ( ) : void Logs out a - possibly - currently logged in account.
tokenLoginAction ( string $token ) : void Logs a user in if a session identifier is available under the given token in the token cache.

Protected Methods

Method Description
getErrorFlashMessage ( ) : boolean Disable the default error flash message
onAuthenticationFailure ( AuthenticationRequiredException $exception = null ) : void Is called if authentication failed.
onAuthenticationSuccess ( ActionRequest $originalRequest = null ) : void Is called if authentication was successful.
replaceSessionCookie ( string $sessionIdentifier ) : void Sets the session cookie to the given identifier, overriding an existing cookie.

Method Details

getErrorFlashMessage() protected method

Disable the default error flash message
protected getErrorFlashMessage ( ) : boolean
return boolean

indexAction() public method

Default action, displays the login screen
public indexAction ( string $username = null, boolean $unauthorized = false ) : void
$username string Optional: A username to pre-fill into the username field
$unauthorized boolean
return void

initializeIndexAction() public method

public initializeIndexAction ( ) : void
return void

logoutAction() public method

The possible redirection URI is queried from the redirection service at first, before the actual logout takes place, and the session gets destroyed.
public logoutAction ( ) : void
return void

onAuthenticationFailure() protected method

Is called if authentication failed.
protected onAuthenticationFailure ( AuthenticationRequiredException $exception = null ) : void
$exception Neos\Flow\Security\Exception\AuthenticationRequiredException The exception thrown while the authentication process
return void

onAuthenticationSuccess() protected method

Is called if authentication was successful.
protected onAuthenticationSuccess ( ActionRequest $originalRequest = null ) : void
$originalRequest Neos\Flow\Mvc\ActionRequest The request that was intercepted by the security framework, NULL if there was none
return void

replaceSessionCookie() protected method

Sets the session cookie to the given identifier, overriding an existing cookie.
protected replaceSessionCookie ( string $sessionIdentifier ) : void
$sessionIdentifier string
return void

tokenLoginAction() public method

Logs a user in if a session identifier is available under the given token in the token cache.
public tokenLoginAction ( string $token ) : void
$token string
return void

Property Details

$backendRedirectionService protected property

protected BackendRedirectionService,Neos\Neos\Service $backendRedirectionService
return Neos\Neos\Service\BackendRedirectionService

$domainRepository protected property

protected DomainRepository,Neos\Neos\Domain\Repository $domainRepository
return Neos\Neos\Domain\Repository\DomainRepository

$loginTokenCache protected property

protected StringFrontend,Neos\Cache\Frontend $loginTokenCache
return Neos\Cache\Frontend\StringFrontend

$session protected property

protected SessionInterface,Neos\Flow\Session $session
return Neos\Flow\Session\SessionInterface

$sessionManager protected property

protected SessionManagerInterface,Neos\Flow\Session $sessionManager
return Neos\Flow\Session\SessionManagerInterface

$sessionName protected property

protected string $sessionName
return string

$siteRepository protected property

protected SiteRepository,Neos\Neos\Domain\Repository $siteRepository
return Neos\Neos\Domain\Repository\SiteRepository

$supportedMediaTypes protected property

protected array $supportedMediaTypes
return array

$viewFormatToObjectNameMap protected property

protected array $viewFormatToObjectNameMap
return array