PHP Class Neos\Flow\Security\DummyContext

These information can be set manually on the context as needed.
Inheritance: extends Context
Mostrar archivo Open project: neos/flow-development-collection

Protected Properties

Property Type Description
$csrfProtectionToken string
$initialized boolean TRUE if the context is initialized in the current request, FALSE or NULL otherwise.
$interceptedRequest Neos\Flow\Mvc\RequestInterface
$roles Neos\Flow\Security\Policy\Role[]
$tokens array Array of configured tokens (might have request patterns)

Public Methods

Method Description
clearContext ( ) : void Clears the security context.
getAuthenticationStrategy ( ) : integer Get the token authentication strategy
getAuthenticationTokens ( ) : Neos\Flow\Security\Authentication\TokenInterface[] Returns all Authentication\Tokens of the security context which are active for the current request. If a token has a request pattern that cannot match against the current request it is determined as not active.
getAuthenticationTokensOfType ( string $className ) : Neos\Flow\Security\Authentication\TokenInterface[] Returns all Authentication\Tokens of the security context which are active for the current request and of the given type. If a token has a request pattern that cannot match against the current request it is determined as not active.
getCsrfProtectionToken ( ) : string Returns the current CSRF protection token. A new one is created when needed, depending on the configured CSRF protection strategy.
getInterceptedRequest ( ) : ActionRequest Returns the request, that has been stored for later resuming after it has been intercepted by a security exception, NULL if there is none.
getRoles ( ) : Role[] Returns the roles of all authenticated accounts, including inherited roles.
hasCsrfProtectionTokens ( ) : boolean Returns TRUE if the context has CSRF protection tokens.
hasRole ( string $roleIdentifier ) : boolean Returns TRUE, if at least one of the currently authenticated accounts holds a role with the given identifier, also recursively.
isCsrfProtectionTokenValid ( string $csrfToken ) : boolean Returns TRUE if the given string is a valid CSRF protection token. The token will be removed if the configured csrf strategy is 'onePerUri'.
isInitialized ( ) : boolean
setAuthenticationTokens ( array $tokens ) : array Sets the Authentication\Tokens of the security context which should be active.
setCsrfProtectionToken ( string $csrfProtectionToken ) : void
setInitialized ( boolean $initialized ) : void
setInterceptedRequest ( ActionRequest $interceptedRequest = null ) : void Sets an action request, to be stored for later resuming after it has been intercepted by a security exception.
setRoles ( Role[] $roles ) : void Set an array of role objects.

Method Details

clearContext() public method

Clears the security context.
public clearContext ( ) : void
return void

getAuthenticationStrategy() public method

Get the token authentication strategy
public getAuthenticationStrategy ( ) : integer
return integer One of the AUTHENTICATE_* constants

getAuthenticationTokens() public method

Returns all Authentication\Tokens of the security context which are active for the current request. If a token has a request pattern that cannot match against the current request it is determined as not active.
public getAuthenticationTokens ( ) : Neos\Flow\Security\Authentication\TokenInterface[]
return Neos\Flow\Security\Authentication\TokenInterface[] Array of set tokens

getAuthenticationTokensOfType() public method

Returns all Authentication\Tokens of the security context which are active for the current request and of the given type. If a token has a request pattern that cannot match against the current request it is determined as not active.
public getAuthenticationTokensOfType ( string $className ) : Neos\Flow\Security\Authentication\TokenInterface[]
$className string The class name
return Neos\Flow\Security\Authentication\TokenInterface[] Array of set tokens of the specified type

getCsrfProtectionToken() public method

Returns the current CSRF protection token. A new one is created when needed, depending on the configured CSRF protection strategy.
public getCsrfProtectionToken ( ) : string
return string

getInterceptedRequest() public method

Returns the request, that has been stored for later resuming after it has been intercepted by a security exception, NULL if there is none.
public getInterceptedRequest ( ) : ActionRequest
return Neos\Flow\Mvc\ActionRequest

getRoles() public method

If no authenticated roles could be found the "Anonymous" role is returned. The "Neos.Flow:Everybody" roles is always returned.
public getRoles ( ) : Role[]
return Neos\Flow\Security\Policy\Role[]

hasCsrfProtectionTokens() public method

Returns TRUE if the context has CSRF protection tokens.
public hasCsrfProtectionTokens ( ) : boolean
return boolean TRUE, if the token is valid. FALSE otherwise.

hasRole() public method

Returns TRUE, if at least one of the currently authenticated accounts holds a role with the given identifier, also recursively.
public hasRole ( string $roleIdentifier ) : boolean
$roleIdentifier string The string representation of the role to search for
return boolean TRUE, if a role with the given string representation was found

isCsrfProtectionTokenValid() public method

Returns TRUE if the given string is a valid CSRF protection token. The token will be removed if the configured csrf strategy is 'onePerUri'.
public isCsrfProtectionTokenValid ( string $csrfToken ) : boolean
$csrfToken string The token string to be validated
return boolean TRUE, if the token is valid. FALSE otherwise.

isInitialized() public method

public isInitialized ( ) : boolean
return boolean TRUE if the Context is initialized, FALSE otherwise.

setAuthenticationTokens() public method

Sets the Authentication\Tokens of the security context which should be active.
public setAuthenticationTokens ( array $tokens ) : array
$tokens array Array of set tokens
return array

setCsrfProtectionToken() public method

public setCsrfProtectionToken ( string $csrfProtectionToken ) : void
$csrfProtectionToken string
return void

setInitialized() public method

public setInitialized ( boolean $initialized ) : void
$initialized boolean
return void

setInterceptedRequest() public method

Sets an action request, to be stored for later resuming after it has been intercepted by a security exception.
public setInterceptedRequest ( ActionRequest $interceptedRequest = null ) : void
$interceptedRequest Neos\Flow\Mvc\ActionRequest
return void

setRoles() public method

Set an array of role objects.
public setRoles ( Role[] $roles ) : void
$roles Neos\Flow\Security\Policy\Role[]
return void

Property Details

$csrfProtectionToken protected_oe property

protected string $csrfProtectionToken
return string

$initialized protected_oe property

TRUE if the context is initialized in the current request, FALSE or NULL otherwise.
protected bool $initialized
return boolean

$interceptedRequest protected_oe property

protected RequestInterface,Neos\Flow\Mvc $interceptedRequest
return Neos\Flow\Mvc\RequestInterface

$roles protected_oe property

protected Role[],Neos\Flow\Security\Policy $roles
return Neos\Flow\Security\Policy\Role[]

$tokens protected_oe property

Array of configured tokens (might have request patterns)
protected array $tokens
return array