class RedirectResponse extends RedirectResponse (View source)

Traits

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.

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

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

static never
throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

int
status()

Get the status code for the response.

string
statusText()

Get the status text for the response.

string
content()

Get the content of the response.

null
getOriginalContent()

Get the original response content.

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

Set a header on the Response.

$this
withHeaders(HeaderBag|array $headers)

Add an array of headers to the response.

$this
cookie(Cookie|mixed $cookie)

Add a cookie to the response.

$this
withCookie(Cookie|mixed $cookie)

Add a cookie to the response.

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

Expire a cookie when sending the response.

string|null
getCallback()

Get the callback of the response.

$this
withException(Throwable $e)

Set the exception to attach to the response.

never
throwResponse()

Throws the response in a HttpResponseException instance.

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

Register a custom macro.

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

Mix another object into the class.

static bool
hasMacro(string $name)

Checks if macro is registered.

static void
flushMacros()

Flush the existing macros.

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

Dynamically handle calls to the class.

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.

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

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

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

static protected never throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

Parameters

string $method

Return Value

never

Exceptions

BadMethodCallException

int status()

Get the status code for the response.

Return Value

int

string statusText()

Get the status text for the response.

Return Value

string

string content()

Get the content of the response.

Return Value

string

null getOriginalContent()

Get the original response content.

Return Value

null

$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

$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

$this withCookie(Cookie|mixed $cookie)

Add a cookie to the response.

Parameters

Cookie|mixed $cookie

Return Value

$this

$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

string|null getCallback()

Get the callback of the response.

Return Value

string|null

$this withException(Throwable $e)

Set the exception to attach to the response.

Parameters

Throwable $e

Return Value

$this

never throwResponse()

Throws the response in a HttpResponseException instance.

Return Value

never

Exceptions

HttpResponseException

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

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

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

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

static void flushMacros()

Flush the existing macros.

Return Value

void

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

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Dynamically bind flash data in the session.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

$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

$this withCookies(array $cookies)

Add multiple cookies to the response.

Parameters

array $cookies

Return Value

$this

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

Flash an array of input to the session.

Parameters

array|null $input

Return Value

$this

protected array removeFilesFromInput(array $input)

Remove all uploaded files form the given input array.

Parameters

array $input

Return Value

array

$this onlyInput()

Flash an array of input to the session.

Return Value

$this

$this exceptInput()

Flash an array of input to the session.

Return Value

$this

$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

protected MessageBag parseErrors(MessageProvider|array|string $provider)

Parse the given errors into an appropriate value.

Parameters

MessageProvider|array|string $provider

Return Value

MessageBag

$this withFragment(string $fragment)

Add a fragment identifier to the URL.

Parameters

string $fragment

Return Value

$this

$this withoutFragment()

Remove any fragment identifier from the response URL.

Return Value

$this

Request|null getRequest()

Get the request instance.

Return Value

Request|null

void setRequest(Request $request)

Set the request instance.

Parameters

Request $request

Return Value

void

Store|null getSession()

Get the session store instance.

Return Value

Store|null

void setSession(Store $session)

Set the session store instance.

Parameters

Store $session

Return Value

void