AbstractResult Class Reference

Inheritance diagram for AbstractResult:

Public Member Functions
	setHttpResponseCode ($httpCode)
	setHeader ($name, $value, $replace=false)
	setStatusHeader ($httpCode, $version=null, $phrase=null)
	renderResult (ResponseInterface $response)

Protected Member Functions
	applyHttpHeaders (HttpResponseInterface $response)
	render (HttpResponseInterface $response)

Protected Attributes
	$httpResponseCode
	$headers = []
	$statusHeaderCode
	$statusHeaderVersion
	$statusHeaderPhrase

Detailed Description

Definition at line 12 of file AbstractResult.php.

Member Function Documentation

applyHttpHeaders()

applyHttpHeaders ( HttpResponseInterface  $response )

protected

Parameters

HttpResponseInterface

$response

Returns

$this

Definition at line 90 of file AbstractResult.php.

    {
        if (!empty($this->httpResponseCode)) {
            $response->setHttpResponseCode($this->httpResponseCode);
        }
        if ($this->statusHeaderCode) {
            $response->setStatusHeader(
                $this->statusHeaderCode,
                $this->statusHeaderVersion,
                $this->statusHeaderPhrase
            );
        }
        if (!empty($this->headers)) {
            foreach ($this->headers as $headerData) {
                $response->setHeader($headerData['name'], $headerData['value'], $headerData['replace']);
            }
        }
        return $this;
    }

render()

render ( HttpResponseInterface  $response )

abstractprotected

Parameters

HttpResponseInterface

$response

Returns

$this

renderResult()

renderResult

(

ResponseInterface

$response

)

Render content

Parameters

HttpResponseInterface | ResponseInterface

$response

Returns

$this

Implements ResultInterface.

Definition at line 122 of file AbstractResult.php.

    {
        $this->applyHttpHeaders($response);
        return $this->render($response);
    }

setHeader()

setHeader	(		$name,
			$value,
			$replace = false
	)

Set a header

If $replace is true, replaces any headers already defined with that $name.

Parameters

string	$name
string	$value
boolean	$replace

Returns

$this

Implements ResultInterface.

Definition at line 62 of file AbstractResult.php.

    {
        $this->headers[] = [
            'name'    => $name,
            'value'   => $value,
            'replace' => $replace,
        ];
        return $this;
    }

setHttpResponseCode()

setHttpResponseCode

(

$httpCode

)

Set response code to result

Parameters

int

$httpCode

Returns

$this

Implements ResultInterface.

Definition at line 45 of file AbstractResult.php.

    {
        $this->httpResponseCode = $httpCode;
        return $this;
    }

setStatusHeader()

setStatusHeader	(		$httpCode,
			$version = null,
			$phrase = null
	)

Parameters

int | string	$httpCode
null | int | string	$version
null | string	$phrase

Returns

$this

Definition at line 78 of file AbstractResult.php.

    {
        $this->statusHeaderCode = $httpCode;
        $this->statusHeaderVersion = $version;
        $this->statusHeaderPhrase = $phrase;
        return $this;
    }

Field Documentation

$headers

$headers = []

protected

Definition at line 22 of file AbstractResult.php.

$httpResponseCode

$httpResponseCode

protected

Definition at line 17 of file AbstractResult.php.

$statusHeaderCode

$statusHeaderCode

protected

Definition at line 27 of file AbstractResult.php.

$statusHeaderPhrase

$statusHeaderPhrase

protected

Definition at line 37 of file AbstractResult.php.

$statusHeaderVersion

$statusHeaderVersion

protected

Definition at line 32 of file AbstractResult.php.

---

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

• vendor/magento/framework/Controller/AbstractResult.php