ForbiddenRouteException
extends ForbiddenException
in package
The Forbidden Route Exception class
This exception is thrown when accessing a route that require an authentication or more permissions.
Table of Contents
Properties
- $channel : string
- The log channel
- $domain : string|null
- The translation domain
- $route : ControllerRoute
Methods
- __construct() : mixed
- Constructor
- __toString() : string
- Get the string representation of this exception
- getChannel() : string
- getDomain() : string|null
- Get the domain
- getReport() : string
- Get the report from this exception
- getRoute() : ControllerRoute
- getText() : string
- Get the user's message
- setDomain() : void
- Set the domain
Properties
$channel
The log channel
protected
string
$channel
= LOGFILE_SYSTEM
$domain
The translation domain
protected
string|null
$domain
= null
$route
private
ControllerRoute
$route
Methods
__construct()
Constructor
public
__construct(ControllerRoute $route[, string|null $message = null ][, string|null $domain = null ][, Throwable|null $previous = null ]) : mixed
Parameters
- $route : ControllerRoute
- $message : string|null = null
-
The exception message
- $domain : string|null = null
-
The domain for the message
- $previous : Throwable|null = null
-
The previous exception
__toString()
Get the string representation of this exception
public
__toString() : string
Return values
stringgetChannel()
public
getChannel() : string
Return values
stringgetDomain()
Get the domain
public
getDomain() : string|null
Return values
string|nullgetReport()
Get the report from this exception
public
getReport() : string
Return values
string —The report
getRoute()
public
getRoute() : ControllerRoute
Return values
ControllerRoutegetText()
Get the user's message
public
getText() : string
Return values
string —The translated message from this exception
setDomain()
Set the domain
public
setDomain(string|null $domain) : void
Parameters
- $domain : string|null
-
The new domain