Redirect Class Reference

Inheritance diagram for Redirect:

Public Member Functions
	__construct (App\Response\RedirectInterface $redirect, UrlInterface $urlBuilder)
	setRefererUrl ()
	setRefererOrBaseUrl ()
	setUrl ($url)
	setPath ($path, array $params=[])
Public Member Functions inherited from AbstractResult
	setHttpResponseCode ($httpCode)
	setHeader ($name, $value, $replace=false)
	setStatusHeader ($httpCode, $version=null, $phrase=null)
	renderResult (ResponseInterface $response)

Protected Member Functions
	render (HttpResponseInterface $response)
Protected Member Functions inherited from AbstractResult
	applyHttpHeaders (HttpResponseInterface $response)
	render (HttpResponseInterface $response)

Protected Attributes
	$redirect
	$urlBuilder
	$url
Protected Attributes inherited from AbstractResult
	$httpResponseCode
	$headers = []
	$statusHeaderCode
	$statusHeaderVersion
	$statusHeaderPhrase

Detailed Description

In many cases controller actions may result in a redirect so this is a result object that implements all necessary properties of a HTTP redirect

@api

Since

100.0.2

Definition at line 22 of file Redirect.php.

Constructor & Destructor Documentation

__construct()

__construct	(	App\Response\RedirectInterface	$redirect,
		UrlInterface	$urlBuilder
	)

Constructor

Parameters

App\Response\RedirectInterface	$redirect
UrlInterface	$urlBuilder

Definition at line 46 of file Redirect.php.

      {
        $this->redirect = $redirect;
        $this->urlBuilder = $urlBuilder;
    }

Member Function Documentation

render()

render ( HttpResponseInterface  $response )

protected

{}

Definition at line 103 of file Redirect.php.

    {
        if (empty($this->httpResponseCode)) {
            $response->setRedirect($this->url);
        } else {
            $response->setRedirect($this->url, $this->httpResponseCode);
        }
        return $this;
    }

setPath()

setPath	(		$path,
		array	$params = []
	)

Set url by path

Parameters

string	$path
array	$params

Returns

$this

Definition at line 94 of file Redirect.php.

    {
        $this->url = $this->urlBuilder->getUrl($path, $this->redirect->updatePathParams($params));
        return $this;
    }

setRefererOrBaseUrl()

setRefererOrBaseUrl

(

)

Set referer url or base if referer is not exist

Returns

$this

Definition at line 70 of file Redirect.php.

    {
        $this->url = $this->redirect->getRedirectUrl();
        return $this;
    }

setRefererUrl()

setRefererUrl

(

)

Set url from referer

Returns

$this

Definition at line 59 of file Redirect.php.

    {
        $this->url = $this->redirect->getRefererUrl();
        return $this;
    }

setUrl()

setUrl

(

$url

)

URL Setter

Parameters

string

$url

Returns

$this

Definition at line 81 of file Redirect.php.

    {
        $this->url = $url;
        return $this;
    }

Field Documentation

$redirect

$redirect

protected

Definition at line 28 of file Redirect.php.

$url

$url

protected

Definition at line 38 of file Redirect.php.

$urlBuilder

$urlBuilder

protected

Definition at line 33 of file Redirect.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Controller/Result/Redirect.php