class RedirectResponse extends RedirectResponse (View source)

Traits

Properties

mixed $original

The original content of the response.

from  ResponseTrait
Exception|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 implementation.

Methods

int
status()

Get the status code 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
withException(Exception $e)

Set the exception to attach to the response.

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)

Mix another object into the class.

static bool
hasMacro(string $name)

Checks if macro is registered.

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

Dynamically handle calls to the class.

$this
__call(string $method, array $parameters)

Dynamically bind flash data in the session.

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 $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.

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.

Request|null
getRequest()

Get the request instance.

void
setRequest(Request $request)

Set the request instance.

Store|null
getSession()

Get the session store implementation.

void
setSession(Store $session)

Set the session store implementation.

Details

int status()

Get the status code for the response.

Return Value

int

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 withException(Exception $e)

Set the exception to attach to the response.

Parameters

Exception $e

Return Value

$this

throwResponse()

Throws the response in a HttpResponseException instance.

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)

Mix another object into the class.

Parameters

object $mixin

Return Value

void

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

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

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

$this __call(string $method, array $parameters)

Dynamically bind flash data in the session.

Parameters

string $method
array $parameters

Return Value

$this

Exceptions

BadMethodCallException

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

Flash a piece of data to the session.

Parameters

string|array $key
mixed $value

Return Value

RedirectResponse

$this withCookies(array $cookies)

Add multiple cookies to the response.

Parameters

array $cookies

Return Value

$this

$this withInput(array $input = null)

Flash an array of input to the session.

Parameters

array $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

RedirectResponse exceptInput()

Flash an array of input to the session.

Return Value

RedirectResponse

$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

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 implementation.

Return Value

Store|null

void setSession(Store $session)

Set the session store implementation.

Parameters

Store $session

Return Value

void