1. class
  2. Illuminate
  3. \
  4. Http
  5. \
  6. RedirectResponse

RedirectResponse

class RedirectResponse extends RedirectResponse (View source)

Traits

ForwardsCalls
ResponseTrait
Macroable

Properties

mixed $original

The original content of the response.

 from  ResponseTrait
Throwable|null $exception

The exception that triggered the error response (if applicable).

 from  ResponseTrait
static protected array $macros

The registered string macros.

 from  Macroable
protected Request $request

The request instance.
protected Store $session

The session store instance.

Methods

mixed
forwardCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object.

from  ForwardsCalls
mixed
forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object, returning $this if the forwarded call returned itself.

from  ForwardsCalls
static never
throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

from  ForwardsCalls
int
status()

Get the status code for the response.

from  ResponseTrait
string
statusText()

Get the status text for the response.

from  ResponseTrait
string
content()

Get the content of the response.

from  ResponseTrait
null
getOriginalContent()

Get the original response content.

$this
header(string $key, array|string $values, bool $replace = true)

Set a header on the Response.

from  ResponseTrait
$this
withHeaders(HeaderBag|array $headers)

Add an array of headers to the response.

from  ResponseTrait
$this
cookie(Cookie|mixed $cookie)

Add a cookie to the response.

from  ResponseTrait
$this
withCookie(Cookie|mixed $cookie)

Add a cookie to the response.

from  ResponseTrait
$this
withoutCookie(Cookie|mixed $cookie, string|null $path = null, string|null $domain = null)

Expire a cookie when sending the response.

from  ResponseTrait
string|null
getCallback()

Get the callback of the response.

from  ResponseTrait
$this
withException(Throwable $e)

Set the exception to attach to the response.

from  ResponseTrait
never
throwResponse()

Throws the response in a HttpResponseException instance.

from  ResponseTrait
static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically bind flash data in the session.

$this
with(string|array $key, mixed $value = null)

Flash a piece of data to the session.

$this
withCookies(array $cookies)

Add multiple cookies to the response.

$this
withInput(array|null $input = null)

Flash an array of input to the session.

array
removeFilesFromInput(array $input)

Remove all uploaded files form the given input array.

$this
onlyInput()

Flash an array of input to the session.

$this
exceptInput()

Flash an array of input to the session.

$this
withErrors(MessageProvider|array|string $provider, string $key = 'default')

Flash a container of errors to the session.

MessageBag
parseErrors(MessageProvider|array|string $provider)

Parse the given errors into an appropriate value.

$this
withFragment(string $fragment)

Add a fragment identifier to the URL.

$this
withoutFragment()

Remove any fragment identifier from the response URL.

Request|null
getRequest()

Get the request instance.

void
setRequest(Request $request)

Set the request instance.

Store|null
getSession()

Get the session store instance.

void
setSession(Store $session)

Set the session store instance.

Details

in ForwardsCalls at line 20
protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object.

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in ForwardsCalls at line 50
protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object, returning $this if the forwarded call returned itself.

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in ForwardsCalls at line 65
static protected never throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

Parameters

string $method

Return Value

never

Exceptions

BadMethodCallException

in ResponseTrait at line 30
int status()

Get the status code for the response.

Return Value

int

in ResponseTrait at line 40
string statusText()

Get the status text for the response.

Return Value

string

in ResponseTrait at line 50
string content()

Get the content of the response.

Return Value

string

at line 190
null getOriginalContent()

Get the original response content.

Return Value

null

in ResponseTrait at line 75
$this header(string $key, array|string $values, bool $replace = true)

Set a header on the Response.

Parameters

string $key
array|string $values
bool $replace

Return Value

$this

in ResponseTrait at line 88
$this withHeaders(HeaderBag|array $headers)

Add an array of headers to the response.

Parameters

HeaderBag|array $headers

Return Value

$this

Add a cookie to the response.

Parameters

Cookie|mixed $cookie

Return Value

$this

in ResponseTrait at line 118
$this withCookie(Cookie|mixed $cookie)

Add a cookie to the response.

Parameters

Cookie|mixed $cookie

Return Value

$this

in ResponseTrait at line 137
$this withoutCookie(Cookie|mixed $cookie, string|null $path = null, string|null $domain = null)

Expire a cookie when sending the response.

Parameters

Cookie|mixed $cookie
string|null $path
string|null $domain

Return Value

$this

in ResponseTrait at line 153
string|null getCallback()

Get the callback of the response.

Return Value

string|null

in ResponseTrait at line 164
$this withException(Throwable $e)

Set the exception to attach to the response.

Parameters

Throwable $e

Return Value

$this

in ResponseTrait at line 178
never throwResponse()

Throws the response in a HttpResponseException instance.

Return Value

never

Exceptions

HttpResponseException

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 246
mixed __call(string $method, array $parameters)

Dynamically bind flash data in the session.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 42
$this with(string|array $key, mixed $value = null)

Flash a piece of data to the session.

Parameters

string|array $key
mixed $value

Return Value

$this

at line 59
$this withCookies(array $cookies)

Add multiple cookies to the response.

Parameters

array $cookies

Return Value

$this

at line 74
$this withInput(array|null $input = null)

Flash an array of input to the session.

Parameters

array|null $input

Return Value

$this

at line 89
protected array removeFilesFromInput(array $input)

Remove all uploaded files form the given input array.

Parameters

array $input

Return Value

array

at line 109
$this onlyInput()

Flash an array of input to the session.

Return Value

$this

at line 119
$this exceptInput()

Flash an array of input to the session.

Return Value

$this

at line 131
$this withErrors(MessageProvider|array|string $provider, string $key = 'default')

Flash a container of errors to the session.

Parameters

MessageProvider|array|string $provider
string $key

Return Value

$this

at line 154
protected MessageBag parseErrors(MessageProvider|array|string $provider)

Parse the given errors into an appropriate value.

Parameters

MessageProvider|array|string $provider

Return Value

MessageBag

at line 169
$this withFragment(string $fragment)

Add a fragment identifier to the URL.

Parameters

string $fragment

Return Value

$this

at line 180
$this withoutFragment()

Remove any fragment identifier from the response URL.

Return Value

$this

at line 200
Request|null getRequest()

Get the request instance.

Return Value

Request|null

at line 211
void setRequest(Request $request)

Set the request instance.

Parameters

Request $request

Return Value

void

at line 221
Store|null getSession()

Get the session store instance.

Return Value

Store|null

at line 232
void setSession(Store $session)

Set the session store instance.

Parameters

Store $session

Return Value

void