AbstractToken
abstract class AbstractToken implements TokenInterface (View source)
An abstract authentication token.
Properties
| protected string | $authenticationProviderName | ||
| protected int | $authenticationStatus | Current authentication status of this token |
|
| protected array | $credentials | The credentials submitted by the client |
|
| protected Account | $account | ||
| protected array | $requestPatterns | ||
| protected EntryPointInterface | $entryPoint | The authentication entry point |
|
| protected array | $options | Token options |
Methods
Build an instance of this token, potentially passing it options that can be configured via tokenOptions
Returns the name of the authentication provider responsible for this token
Sets the name of the authentication provider responsible for this token
Returns true if this token is currently authenticated
Returns the configured authentication entry point, NULL if none is available
Returns true if any request pattern has been defined
Sets request patterns
Returns an array of set \Neos\Flow\Security\RequestPatternInterface, NULL if none was set
Returns the credentials (username and password) of this token.
Returns the account if one is authenticated, NULL otherwise.
Sets the authentication status. Usually called by the responsible \Neos\Flow\Security\Authentication\AuthenticationManagerInterface
Returns the current authentication status
Returns a string representation of the token for logging purposes.
Details
__construct(array $options = null)
Build an instance of this token, potentially passing it options that can be configured via tokenOptions
string
getAuthenticationProviderName()
Returns the name of the authentication provider responsible for this token
void
setAuthenticationProviderName(string $authenticationProviderName)
Sets the name of the authentication provider responsible for this token
bool
isAuthenticated()
Returns true if this token is currently authenticated
void
setAuthenticationEntryPoint(EntryPointInterface $entryPoint)
Sets the authentication entry point
EntryPointInterface
getAuthenticationEntryPoint()
Returns the configured authentication entry point, NULL if none is available
bool
hasRequestPatterns()
Returns true if any request pattern has been defined
void
setRequestPatterns(array $requestPatterns)
Sets request patterns
RequestPatternInterface[]
getRequestPatterns()
Returns an array of set \Neos\Flow\Security\RequestPatternInterface, NULL if none was set
mixed
getCredentials()
Returns the credentials (username and password) of this token.
Account
getAccount()
Returns the account if one is authenticated, NULL otherwise.
void
setAccount(Account $account = null)
Set the (authenticated) account
void
setAuthenticationStatus(int $authenticationStatus)
Sets the authentication status. Usually called by the responsible \Neos\Flow\Security\Authentication\AuthenticationManagerInterface
int
getAuthenticationStatus()
Returns the current authentication status
string
__toString()
Returns a string representation of the token for logging purposes.