RouteAccess : string

Declares who may reach a backend route, via the route option "access":

  • "anonymous": reachable without backend user and without request token
  • "authenticated" (default): requires a backend user and a valid request token
  • "authenticated-without-token": requires a backend user, but no request token

Routes of backend modules use the option "access" for the identifier of a module access gate (e.g. "admin" or "user") and always require an authenticated backend user.

Table of Contents

Cases

Anonymous  = 'anonymous'
Authenticated  = 'authenticated'
AuthenticatedWithoutToken  = 'authenticated-without-token'

Methods

fromRoute()  : self
Any other value fails closed and is treated as "authenticated", as the option is also used with the identifiers of module access gates, such as "admin".
requiresAuthentication()  : bool
requiresRequestToken()  : bool

Cases

Methods

fromRoute()

Any other value fails closed and is treated as "authenticated", as the option is also used with the identifiers of module access gates, such as "admin".

public static fromRoute(Route|Route $route) : self
Parameters
$route : Route|Route
Return values
self

requiresAuthentication()

public requiresAuthentication() : bool
Return values
bool

requiresRequestToken()

public requiresRequestToken() : bool
Return values
bool
On this page

Search results