Interface Yiisoft\DataResponse\DataResponseFormatterInterface

All Classes | Methods

Implemented by	Yiisoft\DataResponse\Formatter\HtmlDataResponseFormatter, Yiisoft\DataResponse\Formatter\JsonDataResponseFormatter, Yiisoft\DataResponse\Formatter\PlainTextDataResponseFormatter, Yiisoft\DataResponse\Formatter\XmlDataResponseFormatter
Deprecated since version	Use {@see \Yiisoft\DataResponse\Formatter\FormatterInterface} instead.

DataResponseFormatterInterface is the interface that should be implemented by data response formatters.

Public Methods

Method	Description	Defined By
format()	Returns an instance of the response with formatted response data.	Yiisoft\DataResponse\DataResponseFormatterInterface

format() public abstract method

Returns an instance of the response with formatted response data.

public abstract \Psr\Http\Message\ResponseInterface format ( Yiisoft\DataResponse\DataResponse $dataResponse )
$dataResponse	Yiisoft\DataResponse\DataResponse	The instance of the data response.
return	\Psr\Http\Message\ResponseInterface	The response with formatted response data.

                public function format(DataResponse $dataResponse): ResponseInterface;