Forward Class Reference

Inheritance diagram for Forward:

Public Member Functions
	__construct (RequestInterface $request)
	setModule ($module)
	setController ($controller)
	setParams (array $params)
	forward ($action)
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
	$request
	$module
	$controller
	$params = []
Protected Attributes inherited from AbstractResult
	$httpResponseCode
	$headers = []
	$statusHeaderCode
	$statusHeaderVersion
	$statusHeaderPhrase

Detailed Description

Definition at line 13 of file Forward.php.

Constructor & Destructor Documentation

__construct()

__construct

(

RequestInterface

$request

)

Parameters

RequestInterface

$request

Definition at line 38 of file Forward.php.

    {
        $this->request = $request;
    }

Member Function Documentation

forward()

forward

(

$action

)

Parameters

string

$action

Returns

$this

Definition at line 77 of file Forward.php.

    {
        $this->request->initForward();

        if (!empty($this->params)) {
            $this->request->setParams($this->params);
        }

        if (!empty($this->controller)) {
            $this->request->setControllerName($this->controller);

            // Module should only be reset if controller has been specified
            if (!empty($this->module)) {
                $this->request->setModuleName($this->module);
            }
        }

        $this->request->setActionName($action);
        $this->request->setDispatched(false);
        return $this;
    }

render()

render ( HttpResponseInterface  $response )

protected

{}

Definition at line 102 of file Forward.php.

    {
        return $this;
    }

setController()

setController

(

$controller

)

Parameters

string

$controller

Returns

$this

Definition at line 57 of file Forward.php.

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

setModule()

setModule

(

$module

)

Parameters

string

$module

Returns

$this

Definition at line 47 of file Forward.php.

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

setParams()

setParams

(

array

$params

)

Parameters

array

$params

Returns

$this

Definition at line 67 of file Forward.php.

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

Field Documentation

$controller

$controller

protected

Definition at line 28 of file Forward.php.

$module

$module

protected

Definition at line 23 of file Forward.php.

$params

$params = []

protected

Definition at line 33 of file Forward.php.

$request

$request

protected

Definition at line 18 of file Forward.php.

---

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

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