PHP Class Neos\Flow\Security\Authentication\Token\AbstractToken

Inheritance: implements Neos\Flow\Security\Authentication\TokenInterface
Afficher le fichier Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Свойство Type Description
$account Neos\Flow\Security\Account
$authenticationProviderName string
$authenticationStatus integer Current authentication status of this token
$credentials array The credentials submitted by the client
$entryPoint Neos\Flow\Security\Authentication\EntryPointInterface The authentication entry point
$requestPatterns array

Méthodes publiques

Méthode Description
__toString ( ) : string Returns a string representation of the token for logging purposes.
getAccount ( ) : Account Returns the account if one is authenticated, NULL otherwise.
getAuthenticationEntryPoint ( ) : Neos\Flow\Security\Authentication\EntryPointInterface Returns the configured authentication entry point, NULL if none is available
getAuthenticationProviderName ( ) : string Returns the name of the authentication provider responsible for this token
getAuthenticationStatus ( ) : integer Returns the current authentication status
getCredentials ( ) : array Returns the credentials (username and password) of this token.
getRequestPatterns ( ) : array<\Neos\Flow\Security\RequestPatternInterface> Returns an array of set \Neos\Flow\Security\RequestPatternInterface, NULL if none was set
hasRequestPatterns ( ) : boolean Returns TRUE if any request pattern has been defined
isAuthenticated ( ) : boolean Returns TRUE if this token is currently authenticated
setAccount ( Account $account = null ) : void Set the (authenticated) account
setAuthenticationEntryPoint ( Neos\Flow\Security\Authentication\EntryPointInterface $entryPoint ) : void Sets the authentication entry point
setAuthenticationProviderName ( string $authenticationProviderName ) : void Sets the name of the authentication provider responsible for this token
setAuthenticationStatus ( integer $authenticationStatus ) : void Sets the authentication status. Usually called by the responsible \Neos\Flow\Security\Authentication\AuthenticationManagerInterface
setRequestPatterns ( array $requestPatterns ) : void Sets request patterns

Method Details

__toString() public méthode

Returns a string representation of the token for logging purposes.
public __toString ( ) : string
Résultat string The class name

getAccount() public méthode

Returns the account if one is authenticated, NULL otherwise.
public getAccount ( ) : Account
Résultat Neos\Flow\Security\Account An account object

getAuthenticationEntryPoint() public méthode

Returns the configured authentication entry point, NULL if none is available
public getAuthenticationEntryPoint ( ) : Neos\Flow\Security\Authentication\EntryPointInterface
Résultat Neos\Flow\Security\Authentication\EntryPointInterface The configured authentication entry point, NULL if none is available

getAuthenticationProviderName() public méthode

Returns the name of the authentication provider responsible for this token
public getAuthenticationProviderName ( ) : string
Résultat string The authentication provider name

getAuthenticationStatus() public méthode

Returns the current authentication status
public getAuthenticationStatus ( ) : integer
Résultat integer One of NO_CREDENTIALS_GIVEN, WRONG_CREDENTIALS, AUTHENTICATION_SUCCESSFUL, AUTHENTICATION_NEEDED

getCredentials() public méthode

Returns the credentials (username and password) of this token.
public getCredentials ( ) : array
Résultat array $credentials The needed credentials to authenticate this token

getRequestPatterns() public méthode

Returns an array of set \Neos\Flow\Security\RequestPatternInterface, NULL if none was set
See also: hasRequestPattern()
public getRequestPatterns ( ) : array<\Neos\Flow\Security\RequestPatternInterface>
Résultat array<\Neos\Flow\Security\RequestPatternInterface>

hasRequestPatterns() public méthode

Returns TRUE if any request pattern has been defined
public hasRequestPatterns ( ) : boolean
Résultat boolean

isAuthenticated() public méthode

Returns TRUE if this token is currently authenticated
public isAuthenticated ( ) : boolean
Résultat boolean TRUE if this this token is currently authenticated

setAccount() public méthode

Set the (authenticated) account
public setAccount ( Account $account = null ) : void
$account Neos\Flow\Security\Account An account object
Résultat void

setAuthenticationEntryPoint() public méthode

Sets the authentication entry point
public setAuthenticationEntryPoint ( Neos\Flow\Security\Authentication\EntryPointInterface $entryPoint ) : void
$entryPoint Neos\Flow\Security\Authentication\EntryPointInterface The authentication entry point
Résultat void

setAuthenticationProviderName() public méthode

Sets the name of the authentication provider responsible for this token
public setAuthenticationProviderName ( string $authenticationProviderName ) : void
$authenticationProviderName string The authentication provider name
Résultat void

setAuthenticationStatus() public méthode

Sets the authentication status. Usually called by the responsible \Neos\Flow\Security\Authentication\AuthenticationManagerInterface
public setAuthenticationStatus ( integer $authenticationStatus ) : void
$authenticationStatus integer One of NO_CREDENTIALS_GIVEN, WRONG_CREDENTIALS, AUTHENTICATION_SUCCESSFUL, AUTHENTICATION_NEEDED
Résultat void

setRequestPatterns() public méthode

Sets request patterns
public setRequestPatterns ( array $requestPatterns ) : void
$requestPatterns array Array of RequestPatternInterface to be set
Résultat void

Property Details

$account protected_oe property

protected Account,Neos\Flow\Security $account
Résultat Neos\Flow\Security\Account

$authenticationProviderName protected_oe property

protected string $authenticationProviderName
Résultat string

$authenticationStatus protected_oe property

Current authentication status of this token
protected int $authenticationStatus
Résultat integer

$credentials protected_oe property

The credentials submitted by the client
protected array $credentials
Résultat array

$entryPoint protected_oe property

The authentication entry point
protected EntryPointInterface,Neos\Flow\Security\Authentication $entryPoint
Résultat Neos\Flow\Security\Authentication\EntryPointInterface

$requestPatterns protected_oe property

protected array $requestPatterns
Résultat array