685 lines
16 KiB
YAML
685 lines
16 KiB
YAML
name: Middleware
|
|
class_comment: null
|
|
dependencies:
|
|
- name: Closure
|
|
type: class
|
|
source: Closure
|
|
- name: AuthenticationException
|
|
type: class
|
|
source: Illuminate\Auth\AuthenticationException
|
|
- name: Authenticate
|
|
type: class
|
|
source: Illuminate\Auth\Middleware\Authenticate
|
|
- name: RedirectIfAuthenticated
|
|
type: class
|
|
source: Illuminate\Auth\Middleware\RedirectIfAuthenticated
|
|
- name: EncryptCookies
|
|
type: class
|
|
source: Illuminate\Cookie\Middleware\EncryptCookies
|
|
- name: ConvertEmptyStringsToNull
|
|
type: class
|
|
source: Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull
|
|
- name: PreventRequestsDuringMaintenance
|
|
type: class
|
|
source: Illuminate\Foundation\Http\Middleware\PreventRequestsDuringMaintenance
|
|
- name: TrimStrings
|
|
type: class
|
|
source: Illuminate\Foundation\Http\Middleware\TrimStrings
|
|
- name: ValidateCsrfToken
|
|
type: class
|
|
source: Illuminate\Foundation\Http\Middleware\ValidateCsrfToken
|
|
- name: TrustHosts
|
|
type: class
|
|
source: Illuminate\Http\Middleware\TrustHosts
|
|
- name: TrustProxies
|
|
type: class
|
|
source: Illuminate\Http\Middleware\TrustProxies
|
|
- name: ValidateSignature
|
|
type: class
|
|
source: Illuminate\Routing\Middleware\ValidateSignature
|
|
- name: AuthenticateSession
|
|
type: class
|
|
source: Illuminate\Session\Middleware\AuthenticateSession
|
|
- name: Arr
|
|
type: class
|
|
source: Illuminate\Support\Arr
|
|
properties:
|
|
- name: global
|
|
visibility: protected
|
|
comment: '# * The user defined global middleware stack.
|
|
|
|
# *
|
|
|
|
# * @var array'
|
|
- name: prepends
|
|
visibility: protected
|
|
comment: '# * The middleware that should be prepended to the global middleware stack.
|
|
|
|
# *
|
|
|
|
# * @var array'
|
|
- name: appends
|
|
visibility: protected
|
|
comment: '# * The middleware that should be appended to the global middleware stack.
|
|
|
|
# *
|
|
|
|
# * @var array'
|
|
- name: removals
|
|
visibility: protected
|
|
comment: '# * The middleware that should be removed from the global middleware stack.
|
|
|
|
# *
|
|
|
|
# * @var array'
|
|
- name: replacements
|
|
visibility: protected
|
|
comment: '# * The middleware that should be replaced in the global middleware stack.
|
|
|
|
# *
|
|
|
|
# * @var array'
|
|
- name: groups
|
|
visibility: protected
|
|
comment: '# * The user defined middleware groups.
|
|
|
|
# *
|
|
|
|
# * @var array'
|
|
- name: groupPrepends
|
|
visibility: protected
|
|
comment: '# * The middleware that should be prepended to the specified groups.
|
|
|
|
# *
|
|
|
|
# * @var array'
|
|
- name: groupAppends
|
|
visibility: protected
|
|
comment: '# * The middleware that should be appended to the specified groups.
|
|
|
|
# *
|
|
|
|
# * @var array'
|
|
- name: groupRemovals
|
|
visibility: protected
|
|
comment: '# * The middleware that should be removed from the specified groups.
|
|
|
|
# *
|
|
|
|
# * @var array'
|
|
- name: groupReplacements
|
|
visibility: protected
|
|
comment: '# * The middleware that should be replaced in the specified groups.
|
|
|
|
# *
|
|
|
|
# * @var array'
|
|
- name: pageMiddleware
|
|
visibility: protected
|
|
comment: '# * The Folio / page middleware for the application.
|
|
|
|
# *
|
|
|
|
# * @var array'
|
|
- name: trustHosts
|
|
visibility: protected
|
|
comment: '# * Indicates if the "trust hosts" middleware is enabled.
|
|
|
|
# *
|
|
|
|
# * @var bool'
|
|
- name: statefulApi
|
|
visibility: protected
|
|
comment: '# * Indicates if Sanctum''s frontend state middleware is enabled.
|
|
|
|
# *
|
|
|
|
# * @var bool'
|
|
- name: apiLimiter
|
|
visibility: protected
|
|
comment: '# * Indicates the API middleware group''s rate limiter.
|
|
|
|
# *
|
|
|
|
# * @var string'
|
|
- name: throttleWithRedis
|
|
visibility: protected
|
|
comment: '# * Indicates if Redis throttling should be applied.
|
|
|
|
# *
|
|
|
|
# * @var bool'
|
|
- name: authenticatedSessions
|
|
visibility: protected
|
|
comment: '# * Indicates if sessions should be authenticated for the "web" middleware
|
|
group.
|
|
|
|
# *
|
|
|
|
# * @var bool'
|
|
- name: customAliases
|
|
visibility: protected
|
|
comment: '# * The custom middleware aliases.
|
|
|
|
# *
|
|
|
|
# * @var array'
|
|
- name: priority
|
|
visibility: protected
|
|
comment: '# * The custom middleware priority definition.
|
|
|
|
# *
|
|
|
|
# * @var array'
|
|
methods:
|
|
- name: prepend
|
|
visibility: public
|
|
parameters:
|
|
- name: middleware
|
|
comment: "# * The user defined global middleware stack.\n# *\n# * @var array\n#\
|
|
\ */\n# protected $global = [];\n# \n# /**\n# * The middleware that should be\
|
|
\ prepended to the global middleware stack.\n# *\n# * @var array\n# */\n# protected\
|
|
\ $prepends = [];\n# \n# /**\n# * The middleware that should be appended to the\
|
|
\ global middleware stack.\n# *\n# * @var array\n# */\n# protected $appends =\
|
|
\ [];\n# \n# /**\n# * The middleware that should be removed from the global middleware\
|
|
\ stack.\n# *\n# * @var array\n# */\n# protected $removals = [];\n# \n# /**\n\
|
|
# * The middleware that should be replaced in the global middleware stack.\n#\
|
|
\ *\n# * @var array\n# */\n# protected $replacements = [];\n# \n# /**\n# * The\
|
|
\ user defined middleware groups.\n# *\n# * @var array\n# */\n# protected $groups\
|
|
\ = [];\n# \n# /**\n# * The middleware that should be prepended to the specified\
|
|
\ groups.\n# *\n# * @var array\n# */\n# protected $groupPrepends = [];\n# \n#\
|
|
\ /**\n# * The middleware that should be appended to the specified groups.\n#\
|
|
\ *\n# * @var array\n# */\n# protected $groupAppends = [];\n# \n# /**\n# * The\
|
|
\ middleware that should be removed from the specified groups.\n# *\n# * @var\
|
|
\ array\n# */\n# protected $groupRemovals = [];\n# \n# /**\n# * The middleware\
|
|
\ that should be replaced in the specified groups.\n# *\n# * @var array\n# */\n\
|
|
# protected $groupReplacements = [];\n# \n# /**\n# * The Folio / page middleware\
|
|
\ for the application.\n# *\n# * @var array\n# */\n# protected $pageMiddleware\
|
|
\ = [];\n# \n# /**\n# * Indicates if the \"trust hosts\" middleware is enabled.\n\
|
|
# *\n# * @var bool\n# */\n# protected $trustHosts = false;\n# \n# /**\n# * Indicates\
|
|
\ if Sanctum's frontend state middleware is enabled.\n# *\n# * @var bool\n# */\n\
|
|
# protected $statefulApi = false;\n# \n# /**\n# * Indicates the API middleware\
|
|
\ group's rate limiter.\n# *\n# * @var string\n# */\n# protected $apiLimiter;\n\
|
|
# \n# /**\n# * Indicates if Redis throttling should be applied.\n# *\n# * @var\
|
|
\ bool\n# */\n# protected $throttleWithRedis = false;\n# \n# /**\n# * Indicates\
|
|
\ if sessions should be authenticated for the \"web\" middleware group.\n# *\n\
|
|
# * @var bool\n# */\n# protected $authenticatedSessions = false;\n# \n# /**\n\
|
|
# * The custom middleware aliases.\n# *\n# * @var array\n# */\n# protected $customAliases\
|
|
\ = [];\n# \n# /**\n# * The custom middleware priority definition.\n# *\n# * @var\
|
|
\ array\n# */\n# protected $priority = [];\n# \n# /**\n# * Prepend middleware\
|
|
\ to the application's global middleware stack.\n# *\n# * @param array|string\
|
|
\ $middleware\n# * @return $this"
|
|
- name: append
|
|
visibility: public
|
|
parameters:
|
|
- name: middleware
|
|
comment: '# * Append middleware to the application''s global middleware stack.
|
|
|
|
# *
|
|
|
|
# * @param array|string $middleware
|
|
|
|
# * @return $this'
|
|
- name: remove
|
|
visibility: public
|
|
parameters:
|
|
- name: middleware
|
|
comment: '# * Remove middleware from the application''s global middleware stack.
|
|
|
|
# *
|
|
|
|
# * @param array|string $middleware
|
|
|
|
# * @return $this'
|
|
- name: replace
|
|
visibility: public
|
|
parameters:
|
|
- name: search
|
|
- name: replace
|
|
comment: '# * Specify a middleware that should be replaced with another middleware.
|
|
|
|
# *
|
|
|
|
# * @param string $search
|
|
|
|
# * @param string $replace
|
|
|
|
# * @return $this'
|
|
- name: use
|
|
visibility: public
|
|
parameters:
|
|
- name: middleware
|
|
comment: '# * Define the global middleware for the application.
|
|
|
|
# *
|
|
|
|
# * @param array $middleware
|
|
|
|
# * @return $this'
|
|
- name: group
|
|
visibility: public
|
|
parameters:
|
|
- name: group
|
|
- name: middleware
|
|
comment: '# * Define a middleware group.
|
|
|
|
# *
|
|
|
|
# * @param string $group
|
|
|
|
# * @param array $middleware
|
|
|
|
# * @return $this'
|
|
- name: prependToGroup
|
|
visibility: public
|
|
parameters:
|
|
- name: group
|
|
- name: middleware
|
|
comment: '# * Prepend the given middleware to the specified group.
|
|
|
|
# *
|
|
|
|
# * @param string $group
|
|
|
|
# * @param array|string $middleware
|
|
|
|
# * @return $this'
|
|
- name: appendToGroup
|
|
visibility: public
|
|
parameters:
|
|
- name: group
|
|
- name: middleware
|
|
comment: '# * Append the given middleware to the specified group.
|
|
|
|
# *
|
|
|
|
# * @param string $group
|
|
|
|
# * @param array|string $middleware
|
|
|
|
# * @return $this'
|
|
- name: removeFromGroup
|
|
visibility: public
|
|
parameters:
|
|
- name: group
|
|
- name: middleware
|
|
comment: '# * Remove the given middleware from the specified group.
|
|
|
|
# *
|
|
|
|
# * @param string $group
|
|
|
|
# * @param array|string $middleware
|
|
|
|
# * @return $this'
|
|
- name: replaceInGroup
|
|
visibility: public
|
|
parameters:
|
|
- name: group
|
|
- name: search
|
|
- name: replace
|
|
comment: '# * Replace the given middleware in the specified group with another middleware.
|
|
|
|
# *
|
|
|
|
# * @param string $group
|
|
|
|
# * @param string $search
|
|
|
|
# * @param string $replace
|
|
|
|
# * @return $this'
|
|
- name: web
|
|
visibility: public
|
|
parameters:
|
|
- name: append
|
|
default: '[]'
|
|
- name: prepend
|
|
default: '[]'
|
|
- name: remove
|
|
default: '[]'
|
|
- name: replace
|
|
default: '[]'
|
|
comment: '# * Modify the middleware in the "web" group.
|
|
|
|
# *
|
|
|
|
# * @param array|string $append
|
|
|
|
# * @param array|string $prepend
|
|
|
|
# * @param array|string $remove
|
|
|
|
# * @param array $replace
|
|
|
|
# * @return $this'
|
|
- name: api
|
|
visibility: public
|
|
parameters:
|
|
- name: append
|
|
default: '[]'
|
|
- name: prepend
|
|
default: '[]'
|
|
- name: remove
|
|
default: '[]'
|
|
- name: replace
|
|
default: '[]'
|
|
comment: '# * Modify the middleware in the "api" group.
|
|
|
|
# *
|
|
|
|
# * @param array|string $append
|
|
|
|
# * @param array|string $prepend
|
|
|
|
# * @param array|string $remove
|
|
|
|
# * @param array $replace
|
|
|
|
# * @return $this'
|
|
- name: modifyGroup
|
|
visibility: protected
|
|
parameters:
|
|
- name: group
|
|
- name: append
|
|
- name: prepend
|
|
- name: remove
|
|
- name: replace
|
|
comment: '# * Modify the middleware in the given group.
|
|
|
|
# *
|
|
|
|
# * @param string $group
|
|
|
|
# * @param array|string $append
|
|
|
|
# * @param array|string $prepend
|
|
|
|
# * @param array|string $remove
|
|
|
|
# * @param array $replace
|
|
|
|
# * @return $this'
|
|
- name: pages
|
|
visibility: public
|
|
parameters:
|
|
- name: middleware
|
|
comment: '# * Register the Folio / page middleware for the application.
|
|
|
|
# *
|
|
|
|
# * @param array $middleware
|
|
|
|
# * @return $this'
|
|
- name: alias
|
|
visibility: public
|
|
parameters:
|
|
- name: aliases
|
|
comment: '# * Register additional middleware aliases.
|
|
|
|
# *
|
|
|
|
# * @param array $aliases
|
|
|
|
# * @return $this'
|
|
- name: priority
|
|
visibility: public
|
|
parameters:
|
|
- name: priority
|
|
comment: '# * Define the middleware priority for the application.
|
|
|
|
# *
|
|
|
|
# * @param array $priority
|
|
|
|
# * @return $this'
|
|
- name: getGlobalMiddleware
|
|
visibility: public
|
|
parameters: []
|
|
comment: '# * Get the global middleware.
|
|
|
|
# *
|
|
|
|
# * @return array'
|
|
- name: getMiddlewareGroups
|
|
visibility: public
|
|
parameters: []
|
|
comment: '# * Get the middleware groups.
|
|
|
|
# *
|
|
|
|
# * @return array'
|
|
- name: redirectGuestsTo
|
|
visibility: public
|
|
parameters:
|
|
- name: redirect
|
|
comment: '# * Configure where guests are redirected by the "auth" middleware.
|
|
|
|
# *
|
|
|
|
# * @param callable|string $redirect
|
|
|
|
# * @return $this'
|
|
- name: redirectUsersTo
|
|
visibility: public
|
|
parameters:
|
|
- name: redirect
|
|
comment: '# * Configure where users are redirected by the "guest" middleware.
|
|
|
|
# *
|
|
|
|
# * @param callable|string $redirect
|
|
|
|
# * @return $this'
|
|
- name: redirectTo
|
|
visibility: public
|
|
parameters:
|
|
- name: guests
|
|
default: 'null'
|
|
- name: users
|
|
default: 'null'
|
|
comment: '# * Configure where users are redirected by the authentication and guest
|
|
middleware.
|
|
|
|
# *
|
|
|
|
# * @param callable|string $guests
|
|
|
|
# * @param callable|string $users
|
|
|
|
# * @return $this'
|
|
- name: encryptCookies
|
|
visibility: public
|
|
parameters:
|
|
- name: except
|
|
default: '[]'
|
|
comment: '# * Configure the cookie encryption middleware.
|
|
|
|
# *
|
|
|
|
# * @param array<int, string> $except
|
|
|
|
# * @return $this'
|
|
- name: validateCsrfTokens
|
|
visibility: public
|
|
parameters:
|
|
- name: except
|
|
default: '[]'
|
|
comment: '# * Configure the CSRF token validation middleware.
|
|
|
|
# *
|
|
|
|
# * @param array $except
|
|
|
|
# * @return $this'
|
|
- name: validateSignatures
|
|
visibility: public
|
|
parameters:
|
|
- name: except
|
|
default: '[]'
|
|
comment: '# * Configure the URL signature validation middleware.
|
|
|
|
# *
|
|
|
|
# * @param array $except
|
|
|
|
# * @return $this'
|
|
- name: convertEmptyStringsToNull
|
|
visibility: public
|
|
parameters:
|
|
- name: except
|
|
default: '[]'
|
|
comment: '# * Configure the empty string conversion middleware.
|
|
|
|
# *
|
|
|
|
# * @param array<int, (\Closure(\Illuminate\Http\Request): bool)> $except
|
|
|
|
# * @return $this'
|
|
- name: trimStrings
|
|
visibility: public
|
|
parameters:
|
|
- name: except
|
|
default: '[]'
|
|
comment: '# * Configure the string trimming middleware.
|
|
|
|
# *
|
|
|
|
# * @param array<int, (\Closure(\Illuminate\Http\Request): bool)|string> $except
|
|
|
|
# * @return $this'
|
|
- name: trustHosts
|
|
visibility: public
|
|
parameters:
|
|
- name: at
|
|
default: 'null'
|
|
- name: subdomains
|
|
default: 'true'
|
|
comment: '# * Indicate that the trusted host middleware should be enabled.
|
|
|
|
# *
|
|
|
|
# * @param array<int, string>|(callable(): array<int, string>)|null $at
|
|
|
|
# * @param bool $subdomains
|
|
|
|
# * @return $this'
|
|
- name: trustProxies
|
|
visibility: public
|
|
parameters:
|
|
- name: at
|
|
default: 'null'
|
|
- name: headers
|
|
default: 'null'
|
|
comment: '# * Configure the trusted proxies for the application.
|
|
|
|
# *
|
|
|
|
# * @param array<int, string>|string|null $at
|
|
|
|
# * @param int|null $headers
|
|
|
|
# * @return $this'
|
|
- name: preventRequestsDuringMaintenance
|
|
visibility: public
|
|
parameters:
|
|
- name: except
|
|
default: '[]'
|
|
comment: '# * Configure the middleware that prevents requests during maintenance
|
|
mode.
|
|
|
|
# *
|
|
|
|
# * @param array<int, string> $except
|
|
|
|
# * @return $this'
|
|
- name: statefulApi
|
|
visibility: public
|
|
parameters: []
|
|
comment: '# * Indicate that Sanctum''s frontend state middleware should be enabled.
|
|
|
|
# *
|
|
|
|
# * @return $this'
|
|
- name: throttleApi
|
|
visibility: public
|
|
parameters:
|
|
- name: limiter
|
|
default: '''api'''
|
|
- name: redis
|
|
default: 'false'
|
|
comment: '# * Indicate that the API middleware group''s throttling middleware should
|
|
be enabled.
|
|
|
|
# *
|
|
|
|
# * @param string $limiter
|
|
|
|
# * @param bool $redis
|
|
|
|
# * @return $this'
|
|
- name: throttleWithRedis
|
|
visibility: public
|
|
parameters: []
|
|
comment: '# * Indicate that Laravel''s throttling middleware should use Redis.
|
|
|
|
# *
|
|
|
|
# * @return $this'
|
|
- name: authenticateSessions
|
|
visibility: public
|
|
parameters: []
|
|
comment: '# * Indicate that sessions should be authenticated for the "web" middleware
|
|
group.
|
|
|
|
# *
|
|
|
|
# * @return $this'
|
|
- name: getPageMiddleware
|
|
visibility: public
|
|
parameters: []
|
|
comment: '# * Get the Folio / page middleware for the application.
|
|
|
|
# *
|
|
|
|
# * @return array'
|
|
- name: getMiddlewareAliases
|
|
visibility: public
|
|
parameters: []
|
|
comment: '# * Get the middleware aliases.
|
|
|
|
# *
|
|
|
|
# * @return array'
|
|
- name: defaultAliases
|
|
visibility: protected
|
|
parameters: []
|
|
comment: '# * Get the default middleware aliases.
|
|
|
|
# *
|
|
|
|
# * @return array'
|
|
- name: getMiddlewarePriority
|
|
visibility: public
|
|
parameters: []
|
|
comment: '# * Get the middleware priority for the application.
|
|
|
|
# *
|
|
|
|
# * @return array'
|
|
traits:
|
|
- Closure
|
|
- Illuminate\Auth\AuthenticationException
|
|
- Illuminate\Auth\Middleware\Authenticate
|
|
- Illuminate\Auth\Middleware\RedirectIfAuthenticated
|
|
- Illuminate\Cookie\Middleware\EncryptCookies
|
|
- Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull
|
|
- Illuminate\Foundation\Http\Middleware\PreventRequestsDuringMaintenance
|
|
- Illuminate\Foundation\Http\Middleware\TrimStrings
|
|
- Illuminate\Foundation\Http\Middleware\ValidateCsrfToken
|
|
- Illuminate\Http\Middleware\TrustHosts
|
|
- Illuminate\Http\Middleware\TrustProxies
|
|
- Illuminate\Routing\Middleware\ValidateSignature
|
|
- Illuminate\Session\Middleware\AuthenticateSession
|
|
- Illuminate\Support\Arr
|
|
interfaces: []
|