Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions
ResultInterface Interface Reference
Inheritance diagram for ResultInterface:
AbstractResult Forward Json Raw Redirect Layout Forward Redirect

Public Member Functions

 setHttpResponseCode ($httpCode)
 
 setHeader ($name, $value, $replace=false)
 
 renderResult (ResponseInterface $response)
 

Detailed Description

An abstraction of result that controller actions must return The point of this kind of object is to encapsulate all information/objects relevant to the result and be able to set it to the HTTP response

@api

Since
100.0.2

Definition at line 19 of file ResultInterface.php.

Member Function Documentation

◆ renderResult()

renderResult ( ResponseInterface  $response)

Render result and set to response

Parameters
ResponseInterface$response
Returns
$this

Implemented in Layout, and AbstractResult.

◆ 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

Implemented in AbstractResult.

◆ setHttpResponseCode()

setHttpResponseCode (   $httpCode)
Parameters
int$httpCode
Returns
$this

Implemented in AbstractResult.


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