ResponseFormatterInterface

API reference › yii › web › ResponseFormatterInterface

interface	yii\web\ResponseFormatterInterface
Since	2.0
Source	framework/web/ResponseFormatterInterface.php

Implemented by 3 types

• HtmlResponseFormatter
• JsonResponseFormatter
• XmlResponseFormatter

ResponseFormatterInterface specifies the interface needed to format a response before it is sent out.

Methods

Method	Description	Defined by
format() abstract	Formats the specified response.	ResponseFormatterInterface

Method details

format()

abstract public function format(yii\web\Response $response): mixed

Formats the specified response.

Parameters

Parameter	Type	Description
$response	Response	The response to be formatted.

Returns

mixed