interface EntryPointInterface (View source)

Contract for an authentication entry point

Methods

void
setOptions(array $options)

Sets the options array

array
getOptions()

Returns the options array

ResponseInterface
startAuthentication(ServerRequestInterface $request, ResponseInterface $response)

Starts the authentication. (e.g. redirect to login page or send 401 HTTP header)

Details

void setOptions(array $options)

Sets the options array

Parameters

array $options

An array of configuration options

Return Value

void

array getOptions()

Returns the options array

Return Value

array

An array of configuration options

ResponseInterface startAuthentication(ServerRequestInterface $request, ResponseInterface $response)

Starts the authentication. (e.g. redirect to login page or send 401 HTTP header)

Parameters

ServerRequestInterface $request

The current request

ResponseInterface $response

The current response

Return Value

ResponseInterface