RedirectResponse.php
TLDR
This file contains the RedirectResponse class, which extends the BaseRedirectResponse class from Symfony. The RedirectResponse class provides methods for manipulating redirect responses, including flashing data to the session, adding cookies, manipulating input data, handling errors, and manipulating the URL.
Methods
with($key, $value = null)
This method is used to flash a piece of data to the session. It accepts either a key-value pair or an array of key-value pairs. The data will be available in the flash session for the next request.
withCookies(array $cookies)
This method is used to add multiple cookies to the response. It accepts an array of cookies and sets them in the response headers.
withInput(array $input = null)
This method is used to flash an array of input data to the session. If no input array is provided, it will use the input data from the current request. The method removes any uploaded files from the input array before flashing it to the session.
onlyInput()
This method is used to flash an array of specific input data to the session. It accepts multiple arguments representing the keys of the input data that should be flashed. The method only flashes the specified input data to the session.
exceptInput()
This method is used to flash an array of input data to the session, excluding specific keys. It accepts multiple arguments representing the keys of the input data that should be excluded. The method flashes all input data except the specified keys to the session.
withErrors($provider, $key = 'default')
This method is used to flash a container of errors to the session. It accepts a message provider, which can be an instance of MessageProvider or an array/string of errors. The method parses the errors and stores them in an error container in the session.
withFragment($fragment)
This method is used to add a fragment identifier to the URL. It appends the fragment to the current target URL of the response.
withoutFragment()
This method is used to remove any fragment identifier from the URL. It removes the fragment from the current target URL of the response.
getOriginalContent()
This method is used to get the original response content. However, in this implementation, it returns null.
getRequest()
This method is used to get the request instance associated with the response.
setRequest(Request $request)
This method is used to set the request instance associated with the response.
getSession()
This method is used to get the session store instance associated with the response.
setSession(SessionStore $session)
This method is used to set the session store instance associated with the response.
__call($method, $parameters)
This magic method is used to dynamically bind flash data to the session. It handles method calls in the format with{dataKey}() and converts them to with({snake_case_dataKey}).
Classes
There are no classes in this file.
<?php
namespace Illuminate\Http;
use Illuminate\Contracts\Support\MessageProvider;
use Illuminate\Session\Store as SessionStore;
use Illuminate\Support\MessageBag;
use Illuminate\Support\Str;
use Illuminate\Support\Traits\ForwardsCalls;
use Illuminate\Support\Traits\Macroable;
use Illuminate\Support\ViewErrorBag;
use Symfony\Component\HttpFoundation\File\UploadedFile as SymfonyUploadedFile;
use Symfony\Component\HttpFoundation\RedirectResponse as BaseRedirectResponse;
class RedirectResponse extends BaseRedirectResponse
{
use ForwardsCalls, ResponseTrait, Macroable {
Macroable::__call as macroCall;
}
/**
* The request instance.
*
* @var \Illuminate\Http\Request
*/
protected $request;
/**
* The session store instance.
*
* @var \Illuminate\Session\Store
*/
protected $session;
/**
* Flash a piece of data to the session.
*
* @param string|array $key
* @param mixed $value
* @return $this
*/
public function with($key, $value = null)
{
$key = is_array($key) ? $key : [$key => $value];
foreach ($key as $k => $v) {
$this->session->flash($k, $v);
}
return $this;
}
/**
* Add multiple cookies to the response.
*
* @param array $cookies
* @return $this
*/
public function withCookies(array $cookies)
{
foreach ($cookies as $cookie) {
$this->headers->setCookie($cookie);
}
return $this;
}
/**
* Flash an array of input to the session.
*
* @param array|null $input
* @return $this
*/
public function withInput(array $input = null)
{
$this->session->flashInput($this->removeFilesFromInput(
! is_null($input) ? $input : $this->request->input()
));
return $this;
}
/**
* Remove all uploaded files form the given input array.
*
* @param array $input
* @return array
*/
protected function removeFilesFromInput(array $input)
{
foreach ($input as $key => $value) {
if (is_array($value)) {
$input[$key] = $this->removeFilesFromInput($value);
}
if ($value instanceof SymfonyUploadedFile) {
unset($input[$key]);
}
}
return $input;
}
/**
* Flash an array of input to the session.
*
* @return $this
*/
public function onlyInput()
{
return $this->withInput($this->request->only(func_get_args()));
}
/**
* Flash an array of input to the session.
*
* @return $this
*/
public function exceptInput()
{
return $this->withInput($this->request->except(func_get_args()));
}
/**
* Flash a container of errors to the session.
*
* @param \Illuminate\Contracts\Support\MessageProvider|array|string $provider
* @param string $key
* @return $this
*/
public function withErrors($provider, $key = 'default')
{
$value = $this->parseErrors($provider);
$errors = $this->session->get('errors', new ViewErrorBag);
if (! $errors instanceof ViewErrorBag) {
$errors = new ViewErrorBag;
}
$this->session->flash(
'errors', $errors->put($key, $value)
);
return $this;
}
/**
* Parse the given errors into an appropriate value.
*
* @param \Illuminate\Contracts\Support\MessageProvider|array|string $provider
* @return \Illuminate\Support\MessageBag
*/
protected function parseErrors($provider)
{
if ($provider instanceof MessageProvider) {
return $provider->getMessageBag();
}
return new MessageBag((array) $provider);
}
/**
* Add a fragment identifier to the URL.
*
* @param string $fragment
* @return $this
*/
public function withFragment($fragment)
{
return $this->withoutFragment()
->setTargetUrl($this->getTargetUrl().'#'.Str::after($fragment, '#'));
}
/**
* Remove any fragment identifier from the response URL.
*
* @return $this
*/
public function withoutFragment()
{
return $this->setTargetUrl(Str::before($this->getTargetUrl(), '#'));
}
/**
* Get the original response content.
*
* @return null
*/
public function getOriginalContent()
{
//
}
/**
* Get the request instance.
*
* @return \Illuminate\Http\Request|null
*/
public function getRequest()
{
return $this->request;
}
/**
* Set the request instance.
*
* @param \Illuminate\Http\Request $request
* @return void
*/
public function setRequest(Request $request)
{
$this->request = $request;
}
/**
* Get the session store instance.
*
* @return \Illuminate\Session\Store|null
*/
public function getSession()
{
return $this->session;
}
/**
* Set the session store instance.
*
* @param \Illuminate\Session\Store $session
* @return void
*/
public function setSession(SessionStore $session)
{
$this->session = $session;
}
/**
* Dynamically bind flash data in the session.
*
* @param string $method
* @param array $parameters
* @return mixed
*
* @throws \BadMethodCallException
*/
public function __call($method, $parameters)
{
if (static::hasMacro($method)) {
return $this->macroCall($method, $parameters);
}
if (str_starts_with($method, 'with')) {
return $this->with(Str::snake(substr($method, 4)), $parameters[0]);
}
static::throwBadMethodCallException($method);
}
}