api/laravel/Routing/Redirector.yaml

345 lines
6.9 KiB
YAML
Raw Normal View History

2024-09-26 09:03:21 +00:00
name: Redirector
class_comment: null
dependencies:
- name: RedirectResponse
type: class
source: Illuminate\Http\RedirectResponse
- name: SessionStore
type: class
source: Illuminate\Session\Store
- name: Macroable
type: class
source: Illuminate\Support\Traits\Macroable
- name: Macroable
type: class
source: Macroable
properties:
- name: generator
visibility: protected
comment: '# * The URL generator instance.
# *
# * @var \Illuminate\Routing\UrlGenerator'
- name: session
visibility: protected
comment: '# * The session store instance.
# *
# * @var \Illuminate\Session\Store'
methods:
- name: __construct
visibility: public
parameters:
- name: generator
comment: "# * The URL generator instance.\n# *\n# * @var \\Illuminate\\Routing\\\
UrlGenerator\n# */\n# protected $generator;\n# \n# /**\n# * The session store\
\ instance.\n# *\n# * @var \\Illuminate\\Session\\Store\n# */\n# protected $session;\n\
# \n# /**\n# * Create a new Redirector instance.\n# *\n# * @param \\Illuminate\\\
Routing\\UrlGenerator $generator\n# * @return void"
- name: back
visibility: public
parameters:
- name: status
default: '302'
- name: headers
default: '[]'
- name: fallback
default: 'false'
comment: '# * Create a new redirect response to the previous location.
# *
# * @param int $status
# * @param array $headers
# * @param mixed $fallback
# * @return \Illuminate\Http\RedirectResponse'
- name: refresh
visibility: public
parameters:
- name: status
default: '302'
- name: headers
default: '[]'
comment: '# * Create a new redirect response to the current URI.
# *
# * @param int $status
# * @param array $headers
# * @return \Illuminate\Http\RedirectResponse'
- name: guest
visibility: public
parameters:
- name: path
- name: status
default: '302'
- name: headers
default: '[]'
- name: secure
default: 'null'
comment: '# * Create a new redirect response, while putting the current URL in the
session.
# *
# * @param string $path
# * @param int $status
# * @param array $headers
# * @param bool|null $secure
# * @return \Illuminate\Http\RedirectResponse'
- name: intended
visibility: public
parameters:
- name: default
default: '''/'''
- name: status
default: '302'
- name: headers
default: '[]'
- name: secure
default: 'null'
comment: '# * Create a new redirect response to the previously intended location.
# *
# * @param mixed $default
# * @param int $status
# * @param array $headers
# * @param bool|null $secure
# * @return \Illuminate\Http\RedirectResponse'
- name: to
visibility: public
parameters:
- name: path
- name: status
default: '302'
- name: headers
default: '[]'
- name: secure
default: 'null'
comment: '# * Create a new redirect response to the given path.
# *
# * @param string $path
# * @param int $status
# * @param array $headers
# * @param bool|null $secure
# * @return \Illuminate\Http\RedirectResponse'
- name: away
visibility: public
parameters:
- name: path
- name: status
default: '302'
- name: headers
default: '[]'
comment: '# * Create a new redirect response to an external URL (no validation).
# *
# * @param string $path
# * @param int $status
# * @param array $headers
# * @return \Illuminate\Http\RedirectResponse'
- name: secure
visibility: public
parameters:
- name: path
- name: status
default: '302'
- name: headers
default: '[]'
comment: '# * Create a new redirect response to the given HTTPS path.
# *
# * @param string $path
# * @param int $status
# * @param array $headers
# * @return \Illuminate\Http\RedirectResponse'
- name: route
visibility: public
parameters:
- name: route
- name: parameters
default: '[]'
- name: status
default: '302'
- name: headers
default: '[]'
comment: '# * Create a new redirect response to a named route.
# *
# * @param string $route
# * @param mixed $parameters
# * @param int $status
# * @param array $headers
# * @return \Illuminate\Http\RedirectResponse'
- name: signedRoute
visibility: public
parameters:
- name: route
- name: parameters
default: '[]'
- name: expiration
default: 'null'
- name: status
default: '302'
- name: headers
default: '[]'
comment: '# * Create a new redirect response to a signed named route.
# *
# * @param string $route
# * @param mixed $parameters
# * @param \DateTimeInterface|\DateInterval|int|null $expiration
# * @param int $status
# * @param array $headers
# * @return \Illuminate\Http\RedirectResponse'
- name: temporarySignedRoute
visibility: public
parameters:
- name: route
- name: expiration
- name: parameters
default: '[]'
- name: status
default: '302'
- name: headers
default: '[]'
comment: '# * Create a new redirect response to a signed named route.
# *
# * @param string $route
# * @param \DateTimeInterface|\DateInterval|int|null $expiration
# * @param mixed $parameters
# * @param int $status
# * @param array $headers
# * @return \Illuminate\Http\RedirectResponse'
- name: action
visibility: public
parameters:
- name: action
- name: parameters
default: '[]'
- name: status
default: '302'
- name: headers
default: '[]'
comment: '# * Create a new redirect response to a controller action.
# *
# * @param string|array $action
# * @param mixed $parameters
# * @param int $status
# * @param array $headers
# * @return \Illuminate\Http\RedirectResponse'
- name: createRedirect
visibility: protected
parameters:
- name: path
- name: status
- name: headers
comment: '# * Create a new redirect response.
# *
# * @param string $path
# * @param int $status
# * @param array $headers
# * @return \Illuminate\Http\RedirectResponse'
- name: getUrlGenerator
visibility: public
parameters: []
comment: '# * Get the URL generator instance.
# *
# * @return \Illuminate\Routing\UrlGenerator'
- name: setSession
visibility: public
parameters:
- name: session
comment: '# * Set the active session store.
# *
# * @param \Illuminate\Session\Store $session
# * @return void'
- name: getIntendedUrl
visibility: public
parameters: []
comment: '# * Get the "intended" URL from the session.
# *
# * @return string|null'
- name: setIntendedUrl
visibility: public
parameters:
- name: url
comment: '# * Set the "intended" URL in the session.
# *
# * @param string $url
# * @return $this'
traits:
- Illuminate\Http\RedirectResponse
- Illuminate\Support\Traits\Macroable
- Macroable
interfaces: []