class WebRedirect extends AbstractEntryPoint (View source)

An authentication entry point, that redirects to another webpage.

Properties

protected array $options

The configurations options

from  AbstractEntryPoint
protected UriBuilder $uriBuilder
protected BaseUriProvider $baseUriProvider

Methods

void
setOptions(array $options)

Sets the options array

array
getOptions()

Returns the options array

ResponseInterface
startAuthentication(ServerRequestInterface $request, ResponseInterface $response)

Starts the authentication: Redirect to login page

string
generateUriFromRouteValues(array $routeValues, ServerRequestInterface $request)

No description

mixed
extractRouteValue(array $routeValues, string $key)

Returns the entry $key from the array $routeValues removing the original array item.

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: Redirect to login page

Parameters

ServerRequestInterface $request

The current request

ResponseInterface $response

The current response

Return Value

ResponseInterface

Exceptions

MissingConfigurationException

protected string generateUriFromRouteValues(array $routeValues, ServerRequestInterface $request)

No description

Parameters

array $routeValues
ServerRequestInterface $request

Return Value

string

Exceptions

MissingActionNameException

protected mixed extractRouteValue(array $routeValues, string $key)

Returns the entry $key from the array $routeValues removing the original array item.

If $key does not exist, NULL is returned.

Parameters

array $routeValues
string $key

Return Value

mixed

the specified route value or NULL if it is not set