Middleware
class Middleware (View source)
Properties
| protected array | $global | The user defined global middleware stack. |
|
| protected array | $prepends | The middleware that should be prepended to the global middleware stack. |
|
| protected array | $appends | The middleware that should be appended to the global middleware stack. |
|
| protected array | $removals | The middleware that should be removed from the global middleware stack. |
|
| protected array | $replacements | The middleware that should be replaced in the global middleware stack. |
|
| protected array | $groups | The user defined middleware groups. |
|
| protected array | $groupPrepends | The middleware that should be prepended to the specified groups. |
|
| protected array | $groupAppends | The middleware that should be appended to the specified groups. |
|
| protected array | $groupRemovals | The middleware that should be removed from the specified groups. |
|
| protected array | $groupReplacements | The middleware that should be replaced in the specified groups. |
|
| protected array | $pageMiddleware | The Folio / page middleware for the application. |
|
| protected bool | $trustHosts | Indicates if the "trust hosts" middleware is enabled. |
|
| protected bool | $statefulApi | Indicates if Sanctum's frontend state middleware is enabled. |
|
| protected string | $apiLimiter | Indicates the API middleware group's rate limiter. |
|
| protected bool | $throttleWithRedis | Indicates if Redis throttling should be applied. |
|
| protected bool | $authenticatedSessions | Indicates if sessions should be authenticated for the "web" middleware group. |
|
| protected array | $customAliases | The custom middleware aliases. |
|
| protected array | $priority | The custom middleware priority definition. |
|
| protected array | $prependPriority | The middleware to prepend to the middleware priority definition. |
|
| protected array | $appendPriority | The middleware to append to the middleware priority definition. |
Methods
Prepend middleware to the application's global middleware stack.
Append middleware to the application's global middleware stack.
Remove middleware from the application's global middleware stack.
Specify a middleware that should be replaced with another middleware.
Define the global middleware for the application.
Define a middleware group.
Prepend the given middleware to the specified group.
Append the given middleware to the specified group.
Remove the given middleware from the specified group.
Replace the given middleware in the specified group with another middleware.
Modify the middleware in the "web" group.
Modify the middleware in the "api" group.
Modify the middleware in the given group.
Register the Folio / page middleware for the application.
Register additional middleware aliases.
Define the middleware priority for the application.
Prepend middleware to the priority middleware.
Append middleware to the priority middleware.
Get the global middleware.
Get the middleware groups.
Configure where guests are redirected by the "auth" middleware.
Configure where users are redirected by the "guest" middleware.
Configure where users are redirected by the authentication and guest middleware.
Configure the cookie encryption middleware.
Configure the CSRF token validation middleware.
Configure the URL signature validation middleware.
Configure the empty string conversion middleware.
Configure the string trimming middleware.
No description
Configure the trusted proxies for the application.
Configure the middleware that prevents requests during maintenance mode.
Indicate that Sanctum's frontend state middleware should be enabled.
Indicate that the API middleware group's throttling middleware should be enabled.
Indicate that Laravel's throttling middleware should use Redis.
Indicate that sessions should be authenticated for the "web" middleware group.
Get the Folio / page middleware for the application.
Get the middleware aliases.
Get the default middleware aliases.
Get the middleware priority for the application.
Get the middleware to prepend to the middleware priority definition.
Get the middleware to append to the middleware priority definition.
Details
$this
prepend(array|string $middleware)
Prepend middleware to the application's global middleware stack.
$this
append(array|string $middleware)
Append middleware to the application's global middleware stack.
$this
remove(array|string $middleware)
Remove middleware from the application's global middleware stack.
$this
replace(string $search, string $replace)
Specify a middleware that should be replaced with another middleware.
$this
use(array $middleware)
Define the global middleware for the application.
$this
group(string $group, array $middleware)
Define a middleware group.
$this
prependToGroup(string $group, array|string $middleware)
Prepend the given middleware to the specified group.
$this
appendToGroup(string $group, array|string $middleware)
Append the given middleware to the specified group.
$this
removeFromGroup(string $group, array|string $middleware)
Remove the given middleware from the specified group.
$this
replaceInGroup(string $group, string $search, string $replace)
Replace the given middleware in the specified group with another middleware.
$this
web(array|string $append = [], array|string $prepend = [], array|string $remove = [], array $replace = [])
Modify the middleware in the "web" group.
$this
api(array|string $append = [], array|string $prepend = [], array|string $remove = [], array $replace = [])
Modify the middleware in the "api" group.
protected $this
modifyGroup(string $group, array|string $append, array|string $prepend, array|string $remove, array $replace)
Modify the middleware in the given group.
$this
pages(array $middleware)
Register the Folio / page middleware for the application.
$this
alias(array $aliases)
Register additional middleware aliases.
$this
priority(array $priority)
Define the middleware priority for the application.
$this
prependToPriorityList(array|string $before, string $prepend)
Prepend middleware to the priority middleware.
$this
appendToPriorityList(array|string $after, string $append)
Append middleware to the priority middleware.
array
getGlobalMiddleware()
Get the global middleware.
array
getMiddlewareGroups()
Get the middleware groups.
$this
redirectGuestsTo(callable|string $redirect)
Configure where guests are redirected by the "auth" middleware.
$this
redirectUsersTo(callable|string $redirect)
Configure where users are redirected by the "guest" middleware.
$this
redirectTo(callable|string|null $guests = null, callable|string|null $users = null)
Configure where users are redirected by the authentication and guest middleware.
$this
encryptCookies(array $except = [])
Configure the cookie encryption middleware.
$this
validateCsrfTokens(array $except = [])
Configure the CSRF token validation middleware.
$this
validateSignatures(array $except = [])
Configure the URL signature validation middleware.
$this
convertEmptyStringsToNull(array $except = [])
Configure the empty string conversion middleware.
$this
trimStrings(array $except = [])
Configure the string trimming middleware.
trustHosts(array|callable|null $at = null, bool $subdomains = true)
No description
$this
trustProxies(array|string|null $at = null, int|null $headers = null)
Configure the trusted proxies for the application.
$this
preventRequestsDuringMaintenance(array $except = [])
Configure the middleware that prevents requests during maintenance mode.
$this
statefulApi()
Indicate that Sanctum's frontend state middleware should be enabled.
$this
throttleApi(string $limiter = 'api', bool $redis = false)
Indicate that the API middleware group's throttling middleware should be enabled.
$this
throttleWithRedis()
Indicate that Laravel's throttling middleware should use Redis.
$this
authenticateSessions()
Indicate that sessions should be authenticated for the "web" middleware group.
array
getPageMiddleware()
Get the Folio / page middleware for the application.
array
getMiddlewareAliases()
Get the middleware aliases.
protected array
defaultAliases()
Get the default middleware aliases.
array
getMiddlewarePriority()
Get the middleware priority for the application.
array
getMiddlewarePriorityPrepends()
Get the middleware to prepend to the middleware priority definition.
array
getMiddlewarePriorityAppends()
Get the middleware to append to the middleware priority definition.