AuthRule

Aura Router rule to test user is authenticated.

class AuthRule implements RuleInterface

Instance Methods

Public
Returns	Signature and Description
`bool`	`__invoke`(`ServerRequestInterface $request`, `Route $route`) Check if the Request matches the Route.

Protected
Returns	Signature and Description
`Principal`	`getPrincipal`(`ServerRequestInterface $request`) Gets the stored principal, or the anonymous user if none was found.

public function __invoke(ServerRequestInterface $request, Route $route)

Check if the Request matches the Route.

Parameters
Name	Type	Description
`$request`	`ServerRequestInterface`	The HTTP request
`$route`	`Route`	The route.

Returns
Type	Description
`bool`	True on success, false on failure

protected function getPrincipal(ServerRequestInterface $request)

Gets the stored principal, or the anonymous user if none was found.

Parameters
Name	Type	Description
`$request`	`ServerRequestInterface`	The HTTP request

Returns
Type	Description
`Principal`	The authenticated principal